DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec

class oci.database_tools_runtime.models.DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(**kwargs)

Bases: object

The content of a Database Tools database API gateway config auto API spec sub resource defined within a pool.

Attributes:

DATABASE_OBJECT_TYPE_DUALITYVIEW

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

DATABASE_OBJECT_TYPE_FUNCTION

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

DATABASE_OBJECT_TYPE_MVIEW

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

DATABASE_OBJECT_TYPE_PACKAGE

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

DATABASE_OBJECT_TYPE_PROCEDURE

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

DATABASE_OBJECT_TYPE_TABLE

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

DATABASE_OBJECT_TYPE_VIEW

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

OPERATIONS_READ

A constant which can be used with the operations property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

OPERATIONS_WRITE

A constant which can be used with the operations property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

SECURITY_SCHEMES_BASIC

A constant which can be used with the security_schemes property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

SECURITY_SCHEMES_BEARER

A constant which can be used with the security_schemes property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

TYPE_DEFAULT

A constant which can be used with the type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

alias

Gets the alias of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

database_object_name

Gets the database_object_name of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

database_object_type

Gets the database_object_type of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

description

Gets the description of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

display_name

[Required] Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

key

[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

operations

Gets the operations of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

roles

Gets the roles of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

scope

Gets the scope of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

security_schemes

Gets the security_schemes of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

time_created

[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

time_updated

[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

type

[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Methods:

__init__(**kwargs)

Initializes a new DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 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.

DATABASE_OBJECT_TYPE_DUALITYVIEW = 'DUALITYVIEW'

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “DUALITYVIEW”

DATABASE_OBJECT_TYPE_FUNCTION = 'FUNCTION'

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “FUNCTION”

DATABASE_OBJECT_TYPE_MVIEW = 'MVIEW'

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “MVIEW”

DATABASE_OBJECT_TYPE_PACKAGE = 'PACKAGE'

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “PACKAGE”

DATABASE_OBJECT_TYPE_PROCEDURE = 'PROCEDURE'

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “PROCEDURE”

DATABASE_OBJECT_TYPE_TABLE = 'TABLE'

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “TABLE”

DATABASE_OBJECT_TYPE_VIEW = 'VIEW'

A constant which can be used with the database_object_type property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “VIEW”

OPERATIONS_READ = 'READ'

A constant which can be used with the operations property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “READ”

OPERATIONS_WRITE = 'WRITE'

A constant which can be used with the operations property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “WRITE”

SECURITY_SCHEMES_BASIC = 'BASIC'

A constant which can be used with the security_schemes property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “BASIC”

SECURITY_SCHEMES_BEARER = 'BEARER'

A constant which can be used with the security_schemes property of a DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. This constant has a value of “BEARER”

TYPE_DEFAULT = 'DEFAULT'

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

__init__(**kwargs)

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

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • key (str) – The value to assign to the key property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

  • type (str) – The value to assign to the type property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. Allowed values for this property are: “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • database_object_name (str) – The value to assign to the database_object_name property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

  • database_object_type (str) – The value to assign to the database_object_type property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. Allowed values for this property are: “FUNCTION”, “MVIEW”, “PACKAGE”, “PROCEDURE”, “TABLE”, “VIEW”, “DUALITYVIEW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • description (str) – The value to assign to the description property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

  • alias (str) – The value to assign to the alias property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

  • operations (list[str]) – The value to assign to the operations property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. Allowed values for items in this list are: “READ”, “WRITE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • security_schemes (list[str]) – The value to assign to the security_schemes property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. Allowed values for items in this list are: “BASIC”, “BEARER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • scope (str) – The value to assign to the scope property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

  • roles (list[str]) – The value to assign to the roles property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

  • time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

  • time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

property alias

Gets the alias of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. Used as the URI path element for this object. When not specified the objectName lowercase is the default value.

Returns

The alias of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

str

property database_object_name

Gets the database_object_name of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The name of the database object.

Returns

The database_object_name of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

str

property database_object_type

Gets the database_object_type of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The type of the database object.

Allowed values for this property are: “FUNCTION”, “MVIEW”, “PACKAGE”, “PROCEDURE”, “TABLE”, “VIEW”, “DUALITYVIEW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The database_object_type of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

str

property description

Gets the description of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. Description of the autoApiSpec.

Returns

The description of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

str

property display_name

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

Returns

The display_name of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

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 key

[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. A system generated string that uniquely identifies an auto API spec sub resource within a given pool.

Returns

The key of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

str

property operations

Gets the operations of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The operations to limit access to this resource. If not specified then the default is [“READ”,”WRITE”].

Allowed values for items in this list are: “READ”, “WRITE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The operations of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

list[str]

property roles

Gets the roles of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.

Returns

The roles of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

list[str]

property scope

Gets the scope of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.

Returns

The scope of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

str

property security_schemes

Gets the security_schemes of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The security schemes that can access this resource. If not specified then the resource is public.

Allowed values for items in this list are: “BASIC”, “BEARER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The security_schemes of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

list[str]

property time_created

[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The time the resource was created. An RFC3339 formatted datetime string.

Returns

The time_created of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The time the resource was updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec.

Return type

datetime

property type

[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec. The type of the Database Tools database API gateway config auto API spec sub resource.

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

Return type

str