EnumVariable

class oci.fleet_apps_management.models.EnumVariable(**kwargs)

Bases: oci.fleet_apps_management.models.base_variable.BaseVariable

Enum variable.

Attributes

TYPE_ARRAY str(object=’’) -> str
TYPE_BOOLEAN str(object=’’) -> str
TYPE_DATETIME str(object=’’) -> str
TYPE_DUMMY str(object=’’) -> str
TYPE_ENUM str(object=’’) -> str
TYPE_FILE str(object=’’) -> str
TYPE_INTEGER str(object=’’) -> str
TYPE_NUMBER str(object=’’) -> str
TYPE_OCI_APM_DOMAIN_ID str(object=’’) -> str
TYPE_OCI_BLOCKSTORAGE_POLICIES_ID str(object=’’) -> str
TYPE_OCI_CONTAINER_CLUSTER_ID str(object=’’) -> str
TYPE_OCI_CORE_IMAGE_ID str(object=’’) -> str
TYPE_OCI_CORE_INSTANCESHAPEWITHFLEX_NAME str(object=’’) -> str
TYPE_OCI_CORE_INSTANCESHAPE_NAME str(object=’’) -> str
TYPE_OCI_CORE_INSTANCE_ID str(object=’’) -> str
TYPE_OCI_CORE_NATGATEWAY_ID str(object=’’) -> str
TYPE_OCI_CORE_NSG_ID str(object=’’) -> str
TYPE_OCI_CORE_SERVICEGATEWAY_ID str(object=’’) -> str
TYPE_OCI_CORE_SSH_PUBLICKEY str(object=’’) -> str
TYPE_OCI_CORE_SUBNET_ID str(object=’’) -> str
TYPE_OCI_CORE_VCN_ID str(object=’’) -> str
TYPE_OCI_CORE_VCN_NETWORKSECURITYGROUP_ID str(object=’’) -> str
TYPE_OCI_CORE_VCN_SECLIST_ID str(object=’’) -> str
TYPE_OCI_CORE_VOLUME_ID str(object=’’) -> str
TYPE_OCI_DATABASE_AUTONOMOUSCONTAINERDATABASE_ID str(object=’’) -> str
TYPE_OCI_DATABASE_AUTONOMOUSDATABASEVERSION_ID str(object=’’) -> str
TYPE_OCI_DATABASE_AUTONOMOUSDATABASE_ID str(object=’’) -> str
TYPE_OCI_DATABASE_CDB_ID str(object=’’) -> str
TYPE_OCI_DATABASE_CLOUDVMCLUSTER_ID str(object=’’) -> str
TYPE_OCI_DATABASE_DATABASE_ID str(object=’’) -> str
TYPE_OCI_DATABASE_DATAGUARDASSOCIATION_ID str(object=’’) -> str
TYPE_OCI_DATABASE_DATAGUARD_ID str(object=’’) -> str
TYPE_OCI_DATABASE_DBHOME_DBVERSION str(object=’’) -> str
TYPE_OCI_DATABASE_DBHOME_ID str(object=’’) -> str
TYPE_OCI_DATABASE_DBNODE_ID str(object=’’) -> str
TYPE_OCI_DATABASE_DBSYSTEM_ID str(object=’’) -> str
TYPE_OCI_DATABASE_EXADATA_ID str(object=’’) -> str
TYPE_OCI_DATABASE_MYSQL_CONFIGURATION_ID str(object=’’) -> str
TYPE_OCI_DATABASE_MYSQL_SHAPE_ID str(object=’’) -> str
TYPE_OCI_IDENTITY_AVAILABILITYDOMAIN_NAME str(object=’’) -> str
TYPE_OCI_IDENTITY_COMPARTMENT_ID str(object=’’) -> str
TYPE_OCI_IDENTITY_DOMAINS_ID str(object=’’) -> str
TYPE_OCI_IDENTITY_DYNAMICGROUPS_ID str(object=’’) -> str
TYPE_OCI_IDENTITY_FAULTDOMAIN_NAME str(object=’’) -> str
TYPE_OCI_IDENTITY_GROUPS_ID str(object=’’) -> str
TYPE_OCI_IDENTITY_REGION_NAME str(object=’’) -> str
TYPE_OCI_IDENTITY_TAG_VALUE str(object=’’) -> str
TYPE_OCI_KMS_KEY_ID str(object=’’) -> str
TYPE_OCI_KMS_SECRET_ID str(object=’’) -> str
TYPE_OCI_KMS_VAULT_ID str(object=’’) -> str
TYPE_OCI_KUBERNETES_VERSIONS_ID str(object=’’) -> str
TYPE_OCI_LOADBALANCER_LOADBALANCER_ID str(object=’’) -> str
TYPE_OCI_LOADBALANCER_LOADBALANCER_RESERVEDIPS_ID str(object=’’) -> str
TYPE_OCI_LOADBALANCER_NETWORKLOADBALANCER_ID str(object=’’) -> str
TYPE_OCI_LOGAN_ENTITYTYPE_ID str(object=’’) -> str
TYPE_OCI_LOGAN_LOGENTITY_ID str(object=’’) -> str
TYPE_OCI_LOGAN_LOGGROUP_ID str(object=’’) -> str
TYPE_OCI_LOGAN_SCHEDULEDTASK_ID str(object=’’) -> str
TYPE_OCI_LOGAN_SOURCE_ID str(object=’’) -> str
TYPE_OCI_MGMT_AGENT_ID str(object=’’) -> str
TYPE_OCI_MOUNT_TARGET_ID str(object=’’) -> str
TYPE_OCI_ODS_PROJECT_ID str(object=’’) -> str
TYPE_OCI_RESOURCEMANAGER_PRIVATEENDPOINT_ID str(object=’’) -> str
TYPE_OCI_STORAGE_FILESTORAGE_EXPORTSET_ID str(object=’’) -> str
TYPE_OCI_STORAGE_FILESTORAGE_FILESYSTEM_ID str(object=’’) -> str
TYPE_OCI_STORAGE_FILESTORAGE_MOUNTTARGET_ID str(object=’’) -> str
TYPE_OCI_STORAGE_OBJECTSTORAGE_BUCKET_NAME str(object=’’) -> str
TYPE_PASSWORD str(object=’’) -> str
TYPE_STRING str(object=’’) -> str
TYPE_TEXT str(object=’’) -> str
can_allow_multiple Gets the can_allow_multiple of this EnumVariable.
default_value Gets the default_value of this EnumVariable.
description Gets the description of this BaseVariable.
enum_value Gets the enum_value of this EnumVariable.
is_required Gets the is_required of this BaseVariable.
title Gets the title of this BaseVariable.
type [Required] Gets the type of this BaseVariable.
visible Gets the visible of this BaseVariable.

Methods

__init__(**kwargs) Initializes a new EnumVariable object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
TYPE_ARRAY = 'ARRAY'
TYPE_BOOLEAN = 'BOOLEAN'
TYPE_DATETIME = 'DATETIME'
TYPE_DUMMY = 'DUMMY'
TYPE_ENUM = 'ENUM'
TYPE_FILE = 'FILE'
TYPE_INTEGER = 'INTEGER'
TYPE_NUMBER = 'NUMBER'
TYPE_OCI_APM_DOMAIN_ID = 'OCI_APM_DOMAIN_ID'
TYPE_OCI_BLOCKSTORAGE_POLICIES_ID = 'OCI_BLOCKSTORAGE_POLICIES_ID'
TYPE_OCI_CONTAINER_CLUSTER_ID = 'OCI_CONTAINER_CLUSTER_ID'
TYPE_OCI_CORE_IMAGE_ID = 'OCI_CORE_IMAGE_ID'
TYPE_OCI_CORE_INSTANCESHAPEWITHFLEX_NAME = 'OCI_CORE_INSTANCESHAPEWITHFLEX_NAME'
TYPE_OCI_CORE_INSTANCESHAPE_NAME = 'OCI_CORE_INSTANCESHAPE_NAME'
TYPE_OCI_CORE_INSTANCE_ID = 'OCI_CORE_INSTANCE_ID'
TYPE_OCI_CORE_NATGATEWAY_ID = 'OCI_CORE_NATGATEWAY_ID'
TYPE_OCI_CORE_NSG_ID = 'OCI_CORE_NSG_ID'
TYPE_OCI_CORE_SERVICEGATEWAY_ID = 'OCI_CORE_SERVICEGATEWAY_ID'
TYPE_OCI_CORE_SSH_PUBLICKEY = 'OCI_CORE_SSH_PUBLICKEY'
TYPE_OCI_CORE_SUBNET_ID = 'OCI_CORE_SUBNET_ID'
TYPE_OCI_CORE_VCN_ID = 'OCI_CORE_VCN_ID'
TYPE_OCI_CORE_VCN_NETWORKSECURITYGROUP_ID = 'OCI_CORE_VCN_NETWORKSECURITYGROUP_ID'
TYPE_OCI_CORE_VCN_SECLIST_ID = 'OCI_CORE_VCN_SECLIST_ID'
TYPE_OCI_CORE_VOLUME_ID = 'OCI_CORE_VOLUME_ID'
TYPE_OCI_DATABASE_AUTONOMOUSCONTAINERDATABASE_ID = 'OCI_DATABASE_AUTONOMOUSCONTAINERDATABASE_ID'
TYPE_OCI_DATABASE_AUTONOMOUSDATABASEVERSION_ID = 'OCI_DATABASE_AUTONOMOUSDATABASEVERSION_ID'
TYPE_OCI_DATABASE_AUTONOMOUSDATABASE_ID = 'OCI_DATABASE_AUTONOMOUSDATABASE_ID'
TYPE_OCI_DATABASE_CDB_ID = 'OCI_DATABASE_CDB_ID'
TYPE_OCI_DATABASE_CLOUDVMCLUSTER_ID = 'OCI_DATABASE_CLOUDVMCLUSTER_ID'
TYPE_OCI_DATABASE_DATABASE_ID = 'OCI_DATABASE_DATABASE_ID'
TYPE_OCI_DATABASE_DATAGUARDASSOCIATION_ID = 'OCI_DATABASE_DATAGUARDASSOCIATION_ID'
TYPE_OCI_DATABASE_DATAGUARD_ID = 'OCI_DATABASE_DATAGUARD_ID'
TYPE_OCI_DATABASE_DBHOME_DBVERSION = 'OCI_DATABASE_DBHOME_DBVERSION'
TYPE_OCI_DATABASE_DBHOME_ID = 'OCI_DATABASE_DBHOME_ID'
TYPE_OCI_DATABASE_DBNODE_ID = 'OCI_DATABASE_DBNODE_ID'
TYPE_OCI_DATABASE_DBSYSTEM_ID = 'OCI_DATABASE_DBSYSTEM_ID'
TYPE_OCI_DATABASE_EXADATA_ID = 'OCI_DATABASE_EXADATA_ID'
TYPE_OCI_DATABASE_MYSQL_CONFIGURATION_ID = 'OCI_DATABASE_MYSQL_CONFIGURATION_ID'
TYPE_OCI_DATABASE_MYSQL_SHAPE_ID = 'OCI_DATABASE_MYSQL_SHAPE_ID'
TYPE_OCI_IDENTITY_AVAILABILITYDOMAIN_NAME = 'OCI_IDENTITY_AVAILABILITYDOMAIN_NAME'
TYPE_OCI_IDENTITY_COMPARTMENT_ID = 'OCI_IDENTITY_COMPARTMENT_ID'
TYPE_OCI_IDENTITY_DOMAINS_ID = 'OCI_IDENTITY_DOMAINS_ID'
TYPE_OCI_IDENTITY_DYNAMICGROUPS_ID = 'OCI_IDENTITY_DYNAMICGROUPS_ID'
TYPE_OCI_IDENTITY_FAULTDOMAIN_NAME = 'OCI_IDENTITY_FAULTDOMAIN_NAME'
TYPE_OCI_IDENTITY_GROUPS_ID = 'OCI_IDENTITY_GROUPS_ID'
TYPE_OCI_IDENTITY_REGION_NAME = 'OCI_IDENTITY_REGION_NAME'
TYPE_OCI_IDENTITY_TAG_VALUE = 'OCI_IDENTITY_TAG_VALUE'
TYPE_OCI_KMS_KEY_ID = 'OCI_KMS_KEY_ID'
TYPE_OCI_KMS_SECRET_ID = 'OCI_KMS_SECRET_ID'
TYPE_OCI_KMS_VAULT_ID = 'OCI_KMS_VAULT_ID'
TYPE_OCI_KUBERNETES_VERSIONS_ID = 'OCI_KUBERNETES_VERSIONS_ID'
TYPE_OCI_LOADBALANCER_LOADBALANCER_ID = 'OCI_LOADBALANCER_LOADBALANCER_ID'
TYPE_OCI_LOADBALANCER_LOADBALANCER_RESERVEDIPS_ID = 'OCI_LOADBALANCER_LOADBALANCER_RESERVEDIPS_ID'
TYPE_OCI_LOADBALANCER_NETWORKLOADBALANCER_ID = 'OCI_LOADBALANCER_NETWORKLOADBALANCER_ID'
TYPE_OCI_LOGAN_ENTITYTYPE_ID = 'OCI_LOGAN_ENTITYTYPE_ID'
TYPE_OCI_LOGAN_LOGENTITY_ID = 'OCI_LOGAN_LOGENTITY_ID'
TYPE_OCI_LOGAN_LOGGROUP_ID = 'OCI_LOGAN_LOGGROUP_ID'
TYPE_OCI_LOGAN_SCHEDULEDTASK_ID = 'OCI_LOGAN_SCHEDULEDTASK_ID'
TYPE_OCI_LOGAN_SOURCE_ID = 'OCI_LOGAN_SOURCE_ID'
TYPE_OCI_MGMT_AGENT_ID = 'OCI_MGMT_AGENT_ID'
TYPE_OCI_MOUNT_TARGET_ID = 'OCI_MOUNT_TARGET_ID'
TYPE_OCI_ODS_PROJECT_ID = 'OCI_ODS_PROJECT_ID'
TYPE_OCI_RESOURCEMANAGER_PRIVATEENDPOINT_ID = 'OCI_RESOURCEMANAGER_PRIVATEENDPOINT_ID'
TYPE_OCI_STORAGE_FILESTORAGE_EXPORTSET_ID = 'OCI_STORAGE_FILESTORAGE_EXPORTSET_ID'
TYPE_OCI_STORAGE_FILESTORAGE_FILESYSTEM_ID = 'OCI_STORAGE_FILESTORAGE_FILESYSTEM_ID'
TYPE_OCI_STORAGE_FILESTORAGE_MOUNTTARGET_ID = 'OCI_STORAGE_FILESTORAGE_MOUNTTARGET_ID'
TYPE_OCI_STORAGE_OBJECTSTORAGE_BUCKET_NAME = 'OCI_STORAGE_OBJECTSTORAGE_BUCKET_NAME'
TYPE_PASSWORD = 'PASSWORD'
TYPE_STRING = 'STRING'
TYPE_TEXT = 'TEXT'
__init__(**kwargs)

Initializes a new EnumVariable object with values from keyword arguments. The default value of the type attribute of this class is ENUM and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • type (str) – The value to assign to the type property of this EnumVariable. Allowed values for this property are: “ARRAY”, “BOOLEAN”, “ENUM”, “INTEGER”, “NUMBER”, “STRING”, “TEXT”, “FILE”, “PASSWORD”, “DATETIME”, “DUMMY”, “OCI_IDENTITY_DOMAINS_ID”, “OCI_CORE_IMAGE_ID”, “OCI_CORE_INSTANCESHAPEWITHFLEX_NAME”, “OCI_CORE_INSTANCESHAPE_NAME”, “OCI_CORE_NATGATEWAY_ID”, “OCI_CORE_INSTANCE_ID”, “OCI_CORE_SUBNET_ID”, “OCI_CORE_SERVICEGATEWAY_ID”, “OCI_LOGAN_LOGGROUP_ID”, “OCI_LOGAN_SCHEDULEDTASK_ID”, “OCI_LOGAN_LOGENTITY_ID”, “OCI_LOGAN_ENTITYTYPE_ID”, “OCI_MGMT_AGENT_ID”, “OCI_LOGAN_SOURCE_ID”, “OCI_CORE_NSG_ID”, “OCI_CORE_VCN_ID”, “OCI_IDENTITY_AVAILABILITYDOMAIN_NAME”, “OCI_IDENTITY_COMPARTMENT_ID”, “OCI_IDENTITY_FAULTDOMAIN_NAME”, “OCI_IDENTITY_REGION_NAME”, “OCI_DATABASE_DBSYSTEM_ID”, “OCI_DATABASE_DBHOME_ID”, “OCI_DATABASE_DBHOME_DBVERSION”, “OCI_DATABASE_DATABASE_ID”, “OCI_DATABASE_AUTONOMOUSDATABASE_ID”, “OCI_DATABASE_AUTONOMOUSDATABASEVERSION_ID”, “OCI_DATABASE_AUTONOMOUSCONTAINERDATABASE_ID”, “OCI_KMS_KEY_ID”, “OCI_KMS_SECRET_ID”, “OCI_CONTAINER_CLUSTER_ID”, “OCI_KUBERNETES_VERSIONS_ID”, “OCI_BLOCKSTORAGE_POLICIES_ID”, “OCI_IDENTITY_GROUPS_ID”, “OCI_IDENTITY_DYNAMICGROUPS_ID”, “OCI_LOADBALANCER_LOADBALANCER_ID”, “OCI_MOUNT_TARGET_ID”, “OCI_IDENTITY_TAG_VALUE”, “OCI_ODS_PROJECT_ID”, “OCI_RESOURCEMANAGER_PRIVATEENDPOINT_ID”, “OCI_APM_DOMAIN_ID”, “OCI_CORE_SSH_PUBLICKEY”, “OCI_KMS_VAULT_ID”, “OCI_LOADBALANCER_NETWORKLOADBALANCER_ID”, “OCI_LOADBALANCER_LOADBALANCER_RESERVEDIPS_ID”, “OCI_DATABASE_MYSQL_SHAPE_ID”, “OCI_DATABASE_MYSQL_CONFIGURATION_ID”, “OCI_STORAGE_FILESTORAGE_EXPORTSET_ID”, “OCI_STORAGE_FILESTORAGE_FILESYSTEM_ID”, “OCI_STORAGE_OBJECTSTORAGE_BUCKET_NAME”, “OCI_CORE_VCN_SECLIST_ID”, “OCI_CORE_VOLUME_ID”, “OCI_DATABASE_DATAGUARD_ID”, “OCI_DATABASE_EXADATA_ID”, “OCI_DATABASE_CLOUDVMCLUSTER_ID”, “OCI_DATABASE_CDB_ID”, “OCI_DATABASE_DATAGUARDASSOCIATION_ID”, “OCI_DATABASE_DBNODE_ID”, “OCI_CORE_VCN_NETWORKSECURITYGROUP_ID”, “OCI_STORAGE_FILESTORAGE_MOUNTTARGET_ID”
  • title (str) – The value to assign to the title property of this EnumVariable.
  • description (str) – The value to assign to the description property of this EnumVariable.
  • is_required (bool) – The value to assign to the is_required property of this EnumVariable.
  • visible (str) – The value to assign to the visible property of this EnumVariable.
  • enum_value (list[str]) – The value to assign to the enum_value property of this EnumVariable.
  • default_value (str) – The value to assign to the default_value property of this EnumVariable.
  • can_allow_multiple (bool) – The value to assign to the can_allow_multiple property of this EnumVariable.
can_allow_multiple

Gets the can_allow_multiple of this EnumVariable. True if multiple selections are allowed for this variable.

Returns:The can_allow_multiple of this EnumVariable.
Return type:bool
default_value

Gets the default_value of this EnumVariable. efault value selected if the user does not provide a value.

Returns:The default_value of this EnumVariable.
Return type:str
description

Gets the description of this BaseVariable. Detailed information about this variable’s purpose and usage.

Returns:The description of this BaseVariable.
Return type:str
enum_value

Gets the enum_value of this EnumVariable. List of allowed string values for this enum variable.

Returns:The enum_value of this EnumVariable.
Return type:list[str]
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

is_required

Gets the is_required of this BaseVariable. Indicates if this input variable is required for stack execution.

Returns:The is_required of this BaseVariable.
Return type:bool
title

Gets the title of this BaseVariable. The display name for the variable as shown in the UI.

Returns:The title of this BaseVariable.
Return type:str
type

[Required] Gets the type of this BaseVariable. Type of the variable.

Allowed values for this property are: “ARRAY”, “BOOLEAN”, “ENUM”, “INTEGER”, “NUMBER”, “STRING”, “TEXT”, “FILE”, “PASSWORD”, “DATETIME”, “DUMMY”, “OCI_IDENTITY_DOMAINS_ID”, “OCI_CORE_IMAGE_ID”, “OCI_CORE_INSTANCESHAPEWITHFLEX_NAME”, “OCI_CORE_INSTANCESHAPE_NAME”, “OCI_CORE_NATGATEWAY_ID”, “OCI_CORE_INSTANCE_ID”, “OCI_CORE_SUBNET_ID”, “OCI_CORE_SERVICEGATEWAY_ID”, “OCI_LOGAN_LOGGROUP_ID”, “OCI_LOGAN_SCHEDULEDTASK_ID”, “OCI_LOGAN_LOGENTITY_ID”, “OCI_LOGAN_ENTITYTYPE_ID”, “OCI_MGMT_AGENT_ID”, “OCI_LOGAN_SOURCE_ID”, “OCI_CORE_NSG_ID”, “OCI_CORE_VCN_ID”, “OCI_IDENTITY_AVAILABILITYDOMAIN_NAME”, “OCI_IDENTITY_COMPARTMENT_ID”, “OCI_IDENTITY_FAULTDOMAIN_NAME”, “OCI_IDENTITY_REGION_NAME”, “OCI_DATABASE_DBSYSTEM_ID”, “OCI_DATABASE_DBHOME_ID”, “OCI_DATABASE_DBHOME_DBVERSION”, “OCI_DATABASE_DATABASE_ID”, “OCI_DATABASE_AUTONOMOUSDATABASE_ID”, “OCI_DATABASE_AUTONOMOUSDATABASEVERSION_ID”, “OCI_DATABASE_AUTONOMOUSCONTAINERDATABASE_ID”, “OCI_KMS_KEY_ID”, “OCI_KMS_SECRET_ID”, “OCI_CONTAINER_CLUSTER_ID”, “OCI_KUBERNETES_VERSIONS_ID”, “OCI_BLOCKSTORAGE_POLICIES_ID”, “OCI_IDENTITY_GROUPS_ID”, “OCI_IDENTITY_DYNAMICGROUPS_ID”, “OCI_LOADBALANCER_LOADBALANCER_ID”, “OCI_MOUNT_TARGET_ID”, “OCI_IDENTITY_TAG_VALUE”, “OCI_ODS_PROJECT_ID”, “OCI_RESOURCEMANAGER_PRIVATEENDPOINT_ID”, “OCI_APM_DOMAIN_ID”, “OCI_CORE_SSH_PUBLICKEY”, “OCI_KMS_VAULT_ID”, “OCI_LOADBALANCER_NETWORKLOADBALANCER_ID”, “OCI_LOADBALANCER_LOADBALANCER_RESERVEDIPS_ID”, “OCI_DATABASE_MYSQL_SHAPE_ID”, “OCI_DATABASE_MYSQL_CONFIGURATION_ID”, “OCI_STORAGE_FILESTORAGE_EXPORTSET_ID”, “OCI_STORAGE_FILESTORAGE_FILESYSTEM_ID”, “OCI_STORAGE_OBJECTSTORAGE_BUCKET_NAME”, “OCI_CORE_VCN_SECLIST_ID”, “OCI_CORE_VOLUME_ID”, “OCI_DATABASE_DATAGUARD_ID”, “OCI_DATABASE_EXADATA_ID”, “OCI_DATABASE_CLOUDVMCLUSTER_ID”, “OCI_DATABASE_CDB_ID”, “OCI_DATABASE_DATAGUARDASSOCIATION_ID”, “OCI_DATABASE_DBNODE_ID”, “OCI_CORE_VCN_NETWORKSECURITYGROUP_ID”, “OCI_STORAGE_FILESTORAGE_MOUNTTARGET_ID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The type of this BaseVariable.
Return type:str
visible

Gets the visible of this BaseVariable. Hint to control whether this variable is visible.

Returns:The visible of this BaseVariable.
Return type:str