DatabaseToolsDatabaseApiGatewayConfigDefault¶

class oci.database_tools.models.DatabaseToolsDatabaseApiGatewayConfigDefault(**kwargs)¶

Bases: oci.database_tools.models.database_tools_database_api_gateway_config.DatabaseToolsDatabaseApiGatewayConfig

Manage configuration related to database API gateway config resources.

Attributes

`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`METADATA_SOURCE_CLOUD`	str(object=’’) -> str
`METADATA_SOURCE_DATABASE`	str(object=’’) -> str
`TYPE_DEFAULT`	str(object=’’) -> str
`compartment_id`	[Required] Gets the compartment_id of this DatabaseToolsDatabaseApiGatewayConfig.
`defined_tags`	Gets the defined_tags of this DatabaseToolsDatabaseApiGatewayConfig.
`display_name`	[Required] Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfig.
`freeform_tags`	Gets the freeform_tags of this DatabaseToolsDatabaseApiGatewayConfig.
`id`	[Required] Gets the id of this DatabaseToolsDatabaseApiGatewayConfig.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseToolsDatabaseApiGatewayConfig.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseToolsDatabaseApiGatewayConfig.
`locks`	Gets the locks of this DatabaseToolsDatabaseApiGatewayConfig.
`metadata_source`	[Required] Gets the metadata_source of this DatabaseToolsDatabaseApiGatewayConfig.
`system_tags`	Gets the system_tags of this DatabaseToolsDatabaseApiGatewayConfig.
`time_created`	[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfig.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfig.
`type`	[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfig.

Methods

`__init__`(**kwargs)	Initializes a new DatabaseToolsDatabaseApiGatewayConfigDefault 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.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

METADATA_SOURCE_CLOUD = 'CLOUD'¶

METADATA_SOURCE_DATABASE = 'DATABASE'¶

TYPE_DEFAULT = 'DEFAULT'¶

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
type (str) – The value to assign to the type property of this DatabaseToolsDatabaseApiGatewayConfigDefault. Allowed values for this property are: “DEFAULT”
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
metadata_source (str) – The value to assign to the metadata_source property of this DatabaseToolsDatabaseApiGatewayConfigDefault. Allowed values for this property are: “DATABASE”, “CLOUD”
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsDatabaseApiGatewayConfigDefault. Allowed values for this property are: “ACTIVE”, “DELETED”
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsDatabaseApiGatewayConfigDefault.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsDatabaseApiGatewayConfigDefault.

compartment_id¶

[Required] Gets the compartment_id of this DatabaseToolsDatabaseApiGatewayConfig. The OCID of the compartment containing the Database Tools database API gateway config.

Returns:	The compartment_id of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	str

defined_tags¶

Gets the defined_tags of this DatabaseToolsDatabaseApiGatewayConfig. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfig. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DatabaseToolsDatabaseApiGatewayConfig. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	dict(str, 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.

id¶

[Required] Gets the id of this DatabaseToolsDatabaseApiGatewayConfig. The OCID of the Database Tools database API gateway config.

Returns:	The id of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this DatabaseToolsDatabaseApiGatewayConfig. A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsDatabaseApiGatewayConfig. The current state of the Database Tools database API gateway config.

Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	str

locks¶

Gets the locks of this DatabaseToolsDatabaseApiGatewayConfig. Locks associated with this resource.

Returns:	The locks of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	list[oci.database_tools.models.ResourceLock]

metadata_source¶

[Required] Gets the metadata_source of this DatabaseToolsDatabaseApiGatewayConfig. The RESTful service definition location.

Allowed values for this property are: “DATABASE”, “CLOUD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The metadata_source of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	str

system_tags¶

Gets the system_tags of this DatabaseToolsDatabaseApiGatewayConfig. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfig. The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfig. The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	datetime

type¶

[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfig. The Database Tools database API gateway config type.

Allowed values for this property are: “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this DatabaseToolsDatabaseApiGatewayConfig.
Return type:	str