CreateDatabaseToolsDatabaseApiGatewayConfigDetails

class oci.database_tools.models.CreateDatabaseToolsDatabaseApiGatewayConfigDetails(**kwargs)

Bases: object

Details for the new Database Tools database API gateway config.

Attributes:

METADATA_SOURCE_CLOUD	A constant which can be used with the metadata_source property of a CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
METADATA_SOURCE_DATABASE	A constant which can be used with the metadata_source property of a CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
TYPE_DEFAULT	A constant which can be used with the type property of a CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
compartment_id	[Required] Gets the compartment_id of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
defined_tags	Gets the defined_tags of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
display_name	[Required] Gets the display_name of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
freeform_tags	Gets the freeform_tags of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
locks	Gets the locks of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
metadata_source	[Required] Gets the metadata_source of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.
type	[Required] Gets the type of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

Methods:

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

METADATA_SOURCE_CLOUD = 'CLOUD'

A constant which can be used with the metadata_source property of a CreateDatabaseToolsDatabaseApiGatewayConfigDetails. This constant has a value of “CLOUD”

METADATA_SOURCE_DATABASE = 'DATABASE'

A constant which can be used with the metadata_source property of a CreateDatabaseToolsDatabaseApiGatewayConfigDetails. This constant has a value of “DATABASE”

TYPE_DEFAULT = 'DEFAULT'

A constant which can be used with the type property of a CreateDatabaseToolsDatabaseApiGatewayConfigDetails. This constant has a value of “DEFAULT”

__init__(**kwargs)

Initializes a new CreateDatabaseToolsDatabaseApiGatewayConfigDetails 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:

• CreateDatabaseToolsDatabaseApiGatewayConfigDefaultDetails

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 CreateDatabaseToolsDatabaseApiGatewayConfigDetails. Allowed values for this property are: “DEFAULT”

• compartment_id (str) – The value to assign to the compartment_id property of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

• display_name (str) – The value to assign to the display_name property of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

• metadata_source (str) – The value to assign to the metadata_source property of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails. Allowed values for this property are: “DATABASE”, “CLOUD”

• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

• freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

• locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

property compartment_id

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

Returns

The compartment_id of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails. 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 CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails. 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 CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

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 locks

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

Returns

The locks of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

Return type

list[oci.database_tools.models.ResourceLock]

property metadata_source

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

Allowed values for this property are: “DATABASE”, “CLOUD”

Returns

The metadata_source of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

Return type

str

property type

[Required] Gets the type of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails. The Database Tools DP API gateway config type.

Allowed values for this property are: “DEFAULT”

Returns

The type of this CreateDatabaseToolsDatabaseApiGatewayConfigDetails.

Return type

str