DatabaseToolsDatabaseApiGatewayConfig¶

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

Bases: object

Manage configuration related to database API gateway config resources.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseToolsDatabaseApiGatewayConfig.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsDatabaseApiGatewayConfig.
`METADATA_SOURCE_CLOUD`	A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfig.
`METADATA_SOURCE_DATABASE`	A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfig.
`TYPE_DEFAULT`	A constant which can be used with the type property of a DatabaseToolsDatabaseApiGatewayConfig.
`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 DatabaseToolsDatabaseApiGatewayConfig 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'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsDatabaseApiGatewayConfig. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsDatabaseApiGatewayConfig. This constant has a value of “DELETED”

METADATA_SOURCE_CLOUD = 'CLOUD'¶: A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfig. This constant has a value of “CLOUD”

METADATA_SOURCE_DATABASE = 'DATABASE'¶: A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfig. This constant has a value of “DATABASE”

TYPE_DEFAULT = 'DEFAULT'¶: A constant which can be used with the type property of a DatabaseToolsDatabaseApiGatewayConfig. This constant has a value of “DEFAULT”

__init__(**kwargs)¶

Initializes a new DatabaseToolsDatabaseApiGatewayConfig object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

DatabaseToolsDatabaseApiGatewayConfigDefault

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 DatabaseToolsDatabaseApiGatewayConfig.
type (str) – The value to assign to the type property of this DatabaseToolsDatabaseApiGatewayConfig. Allowed values for this property are: “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsDatabaseApiGatewayConfig.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsDatabaseApiGatewayConfig.
metadata_source (str) – The value to assign to the metadata_source property of this DatabaseToolsDatabaseApiGatewayConfig. 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’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsDatabaseApiGatewayConfig. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsDatabaseApiGatewayConfig.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsDatabaseApiGatewayConfig.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsDatabaseApiGatewayConfig.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsDatabaseApiGatewayConfig.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsDatabaseApiGatewayConfig.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsDatabaseApiGatewayConfig.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsDatabaseApiGatewayConfig.

property 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

property 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))

property 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

property 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.

property 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

property 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

property 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

property 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]

property 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

property 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))

property 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

property 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

property 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