DatabaseToolsDatabaseApiGatewayConfigDefaultSummary¶

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

Bases: oci.database_tools.models.database_tools_database_api_gateway_config_summary.DatabaseToolsDatabaseApiGatewayConfigSummary

Summary of the Database Tools database API gateway config.

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 DatabaseToolsDatabaseApiGatewayConfigSummary.
`defined_tags`	Gets the defined_tags of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`display_name`	[Required] Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`freeform_tags`	Gets the freeform_tags of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`id`	[Required] Gets the id of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`locks`	Gets the locks of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`metadata_source`	[Required] Gets the metadata_source of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`system_tags`	Gets the system_tags of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`time_created`	[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigSummary.
`type`	[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigSummary.

Methods

`__init__`(**kwargs)	Initializes a new DatabaseToolsDatabaseApiGatewayConfigDefaultSummary 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 DatabaseToolsDatabaseApiGatewayConfigDefaultSummary 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 DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
type (str) – The value to assign to the type property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary. Allowed values for this property are: “DEFAULT”
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
metadata_source (str) – The value to assign to the metadata_source property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary. Allowed values for this property are: “DATABASE”, “CLOUD”
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary. Allowed values for this property are: “ACTIVE”, “DELETED”
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsDatabaseApiGatewayConfigDefaultSummary.

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this DatabaseToolsDatabaseApiGatewayConfigSummary. 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 DatabaseToolsDatabaseApiGatewayConfigSummary.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this DatabaseToolsDatabaseApiGatewayConfigSummary. 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 DatabaseToolsDatabaseApiGatewayConfigSummary.
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 DatabaseToolsDatabaseApiGatewayConfigSummary. The OCID of the Database Tools database API gateway config.

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

lifecycle_details¶

Gets the lifecycle_details of this DatabaseToolsDatabaseApiGatewayConfigSummary. 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 DatabaseToolsDatabaseApiGatewayConfigSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsDatabaseApiGatewayConfigSummary. 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 DatabaseToolsDatabaseApiGatewayConfigSummary.
Return type:	str

locks¶

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

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

metadata_source¶

[Required] Gets the metadata_source of this DatabaseToolsDatabaseApiGatewayConfigSummary. 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 DatabaseToolsDatabaseApiGatewayConfigSummary.
Return type:	str

system_tags¶

Gets the system_tags of this DatabaseToolsDatabaseApiGatewayConfigSummary. 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 DatabaseToolsDatabaseApiGatewayConfigSummary.
Return type:	dict(str, dict(str, object))

time_created¶

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

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

time_updated¶

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

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

type¶

[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigSummary. 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 DatabaseToolsDatabaseApiGatewayConfigSummary.
Return type:	str