databasetoolsruntime

type ActionTypeEnum string

type ApexFaIntegrationPrerequisitesCheck struct {

	// Status indicating the outcome of the prerequisites check.
	Status ApexFaIntegrationPrerequisitesCheckStatusEnum `mandatory:"false" json:"status,omitempty"`

	// Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure.
	StatusDetails []string `mandatory:"false" json:"statusDetails"`
}

type ApexFaIntegrationPrerequisitesCheckStatusEnum string

type CancelWorkRequestRequest struct {

	// The ID of the asynchronous request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent
	// accidental overwrites when multiple user agentss might be acting in parallel on the same
	// resource (i.e., to prevent the "lost update" problem). In general, it can be used with any
	// method that involves the selection or modification of a representation to abort the request
	// if the selected representation's current entity tag is not a member within the If-Match field value.
	// When specified on an action-specific subresource, the ETag value of the resource on which the
	// action is requested should be provided.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type CancelWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type ConnectionTypeEnum string

type CreateCredentialBasicDetails struct {

	// The credential_name to be created
	Key *string `mandatory:"true" json:"key"`

	// The username for the new credential.
	UserName *string `mandatory:"true" json:"userName"`

	// The password for the new credential.
	Password *string `mandatory:"true" json:"password"`
}

type CreateCredentialDetails interface {

	// The credential_name to be created
	GetKey() *string
}

type CreateCredentialExecuteGranteeDetails struct {

	// The name of the user to grant the EXECUTE privilege on the credential.
	Key *string `mandatory:"true" json:"key"`
}

type CreateCredentialExecuteGranteeRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools connection.
	DatabaseToolsConnectionId *string `mandatory:"true" contributesTo:"path" name:"databaseToolsConnectionId"`

	// The name of the credential
	CredentialKey *string `mandatory:"true" contributesTo:"path" name:"credentialKey"`

	// The payload to create an execute grantee.
	CreateCredentialExecuteGranteeDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent
	// accidental overwrites when multiple user agentss might be acting in parallel on the same
	// resource (i.e., to prevent the "lost update" problem). In general, it can be used with any
	// method that involves the selection or modification of a representation to abort the request
	// if the selected representation's current entity tag is not a member within the If-Match field value.
	// When specified on an action-specific subresource, the ETag value of the resource on which the
	// action is requested should be provided.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type CreateCredentialExecuteGranteeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CredentialExecuteGrantee instance
	CredentialExecuteGrantee `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// URI of the new resource which was created by the request.
	Location *string `presentIn:"header" name:"location"`
}

type CreateCredentialPublicSynonymDetails struct {

	// The name of the public synonym for the credential
	Key *string `mandatory:"true" json:"key"`
}

type CreateCredentialPublicSynonymRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools connection.
	DatabaseToolsConnectionId *string `mandatory:"true" contributesTo:"path" name:"databaseToolsConnectionId"`

	// The name of the credential
	CredentialKey *string `mandatory:"true" contributesTo:"path" name:"credentialKey"`

	// The payload to create a public synonym for the given credentials.
	CreateCredentialPublicSynonymDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent
	// accidental overwrites when multiple user agentss might be acting in parallel on the same
	// resource (i.e., to prevent the "lost update" problem). In general, it can be used with any
	// method that involves the selection or modification of a representation to abort the request
	// if the selected representation's current entity tag is not a member within the If-Match field value.
	// When specified on an action-specific subresource, the ETag value of the resource on which the
	// action is requested should be provided.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type CreateCredentialPublicSynonymResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CredentialPublicSynonym instance
	CredentialPublicSynonym `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// URI of the new resource which was created by the request.
	Location *string `presentIn:"header" name:"location"`
}

type CreateCredentialRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools connection.
	DatabaseToolsConnectionId *string `mandatory:"true" contributesTo:"path" name:"databaseToolsConnectionId"`

	// The payload to create credential.
	CreateCredentialDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent
	// accidental overwrites when multiple user agentss might be acting in parallel on the same
	// resource (i.e., to prevent the "lost update" problem). In general, it can be used with any
	// method that involves the selection or modification of a representation to abort the request
	// if the selected representation's current entity tag is not a member within the If-Match field value.
	// When specified on an action-specific subresource, the ETag value of the resource on which the
	// action is requested should be provided.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type CreateCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Credential instance
	Credential `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// URI of the new resource which was created by the request.
	Location *string `presentIn:"header" name:"location"`
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDefaultDetails struct {

	// A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The content of a string-escaped Open API spec in JSON format.
	Content *string `mandatory:"true" json:"content"`
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails interface {

	// A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
	GetDisplayName() *string

	// The content of a string-escaped Open API spec in JSON format.
	GetContent() *string
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config.
	DatabaseToolsDatabaseApiGatewayConfigId *string `mandatory:"true" contributesTo:"path" name:"databaseToolsDatabaseApiGatewayConfigId"`

	// The key of the pool config.
	PoolKey *string `mandatory:"true" contributesTo:"path" name:"poolKey"`

	// Details for the new Database Tools database API gateway config API spec resource.
	CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	// Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec instance
	DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec `presentIn:"body"`

	// URI of the new resource which was created by the request.
	Location *string `presentIn:"header" name:"location"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDefaultDetails struct {

	// A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The name of the database object.
	DatabaseObjectName *string `mandatory:"true" json:"databaseObjectName"`

	// Description of the autoApiSpec.
	Description *string `mandatory:"false" json:"description"`

	// Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
	Alias *string `mandatory:"false" json:"alias"`

	// The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
	Scope *string `mandatory:"false" json:"scope"`

	// The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
	Roles []string `mandatory:"false" json:"roles"`

	// The type of the database object.
	DatabaseObjectType CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsDatabaseObjectTypeEnum `mandatory:"true" json:"databaseObjectType"`

	// The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
	Operations []CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsOperationsEnum `mandatory:"false" json:"operations,omitempty"`

	// The security schemes that can access this resource. If not specified then the resource is public.
	SecuritySchemes []CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsSecuritySchemesEnum `mandatory:"false" json:"securitySchemes,omitempty"`
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails interface {

	// A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
	GetDisplayName() *string

	// The name of the database object.
	GetDatabaseObjectName() *string

	// The type of the database object.
	GetDatabaseObjectType() CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsDatabaseObjectTypeEnum

	// Description of the autoApiSpec.
	GetDescription() *string

	// Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
	GetAlias() *string

	// The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
	GetOperations() []CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsOperationsEnum

	// The security schemes that can access this resource. If not specified then the resource is public.
	GetSecuritySchemes() []CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsSecuritySchemesEnum

	// The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
	GetScope() *string

	// The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
	GetRoles() []string
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsDatabaseObjectTypeEnum string

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsOperationsEnum string

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetailsSecuritySchemesEnum string

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config.
	DatabaseToolsDatabaseApiGatewayConfigId *string `mandatory:"true" contributesTo:"path" name:"databaseToolsDatabaseApiGatewayConfigId"`

	// The key of the pool config.
	PoolKey *string `mandatory:"true" contributesTo:"path" name:"poolKey"`

	// Details for the new Database Tools database API gateway config auto API spec resource.
	CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	// Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec instance
	DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec `presentIn:"body"`

	// URI of the new resource which was created by the request.
	Location *string `presentIn:"header" name:"location"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolDefaultDetails struct {

	// A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The pool route value provided in requests to target this pool.
	PoolRouteValue *string `mandatory:"true" json:"poolRouteValue"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.
	DatabaseToolsConnectionId *string `mandatory:"true" json:"databaseToolsConnectionId"`

	// Specifies the maximum number of database connections allowed for the pool.
	MaxPoolSize *int `mandatory:"false" json:"maxPoolSize"`

	// Specifies the minimum number of database connections allowed for the pool.
	MinPoolSize *int `mandatory:"false" json:"minPoolSize"`

	// Specifies the initial size for the number of database connections that will be created for the pool.
	InitialPoolSize *int `mandatory:"false" json:"initialPoolSize"`

	// Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
	JwtProfileJwkUrl *string `mandatory:"false" json:"jwtProfileJwkUrl"`

	// Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
	JwtProfileIssuer *string `mandatory:"false" json:"jwtProfileIssuer"`

	// Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
	JwtProfileAudience *string `mandatory:"false" json:"jwtProfileAudience"`

	// Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
	JwtProfileRoleClaimName *string `mandatory:"false" json:"jwtProfileRoleClaimName"`

	// Advanced pool properties.
	AdvancedProperties map[string]string `mandatory:"false" json:"advancedProperties"`

	// Specifies to enable the Database Actions feature.
	DatabaseActionsStatus CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetailsDatabaseActionsStatusEnum `mandatory:"false" json:"databaseActionsStatus,omitempty"`

	// Specifies whether the REST-Enabled SQL service is active.
	RestEnabledSqlStatus CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetailsRestEnabledSqlStatusEnum `mandatory:"false" json:"restEnabledSqlStatus,omitempty"`
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails interface {

	// A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
	GetDisplayName() *string

	// The pool route value provided in requests to target this pool.
	GetPoolRouteValue() *string

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.
	GetDatabaseToolsConnectionId() *string

	// Specifies the maximum number of database connections allowed for the pool.
	GetMaxPoolSize() *int

	// Specifies the minimum number of database connections allowed for the pool.
	GetMinPoolSize() *int

	// Specifies the initial size for the number of database connections that will be created for the pool.
	GetInitialPoolSize() *int

	// Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
	GetJwtProfileJwkUrl() *string

	// Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
	GetJwtProfileIssuer() *string

	// Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
	GetJwtProfileAudience() *string

	// Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
	GetJwtProfileRoleClaimName() *string

	// Specifies to enable the Database Actions feature.
	GetDatabaseActionsStatus() CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetailsDatabaseActionsStatusEnum

	// Specifies whether the REST-Enabled SQL service is active.
	GetRestEnabledSqlStatus() CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetailsRestEnabledSqlStatusEnum

	// Advanced pool properties.
	GetAdvancedProperties() map[string]string
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetailsDatabaseActionsStatusEnum string

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetailsRestEnabledSqlStatusEnum string

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config.
	DatabaseToolsDatabaseApiGatewayConfigId *string `mandatory:"true" contributesTo:"path" name:"databaseToolsDatabaseApiGatewayConfigId"`

	// Details for the new Database Tools database API gateway config pool resource.
	CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	// Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type CreateDatabaseToolsDatabaseApiGatewayConfigPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DatabaseToolsDatabaseApiGatewayConfigPool instance
	DatabaseToolsDatabaseApiGatewayConfigPool `presentIn:"body"`

	// URI of the new resource which was created by the request.
	Location *string `presentIn:"header" name:"location"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type Credential struct {

	// Name of the credential
	Key *string `mandatory:"true" json:"key"`

	// Name of the user that will be used to log in to the remote database or the remote or local operating system
	UserName *string `mandatory:"true" json:"userName"`

	// Indicates whether this credential is enabled (TRUE) or not (FALSE)
	Enabled *string `mandatory:"true" json:"enabled"`

	// Owner of the credential
	Owner *string `mandatory:"true" json:"owner"`

	// For a Windows target, the Windows domain to use when logging in
	WindowsDomain *string `mandatory:"false" json:"windowsDomain"`

	// Indicates whether this refers to a public synonym or not.
	KeyType CredentialKeyTypeEnum `mandatory:"false" json:"keyType,omitempty"`

	RelatedResource *CredentialRelatedResource `mandatory:"false" json:"relatedResource"`
}

type CredentialCollection struct {

	// Array of `CredentialSummary` items.
	Items []CredentialSummary `mandatory:"true" json:"items"`
}

type CredentialExecuteGrantee struct {

	// The name of the user to grant the EXECUTE privilege on the credential.
	Key *string `mandatory:"true" json:"key"`
}

type CredentialExecuteGranteeCollection struct {

	// Array of `CredentialExecuteGranteeSummary` items.
	Items []CredentialExecuteGranteeSummary `mandatory:"true" json:"items"`
}

type CredentialExecuteGranteeSummary struct {

	// The name of the user to grant the EXECUTE privilege on the credential.
	Key *string `mandatory:"true" json:"key"`
}

type CredentialKeyTypeEnum string

type CredentialPublicSynonym struct {

	// The name of the public synonym for the credential
	Key *string `mandatory:"true" json:"key"`
}

type CredentialPublicSynonymCollection struct {

	// Array of `CredentialPublicSynonymSummary` items.
	Items []CredentialPublicSynonymSummary `mandatory:"true" json:"items"`
}

type CredentialPublicSynonymSummary struct {

	// The name of the public synonym for the credential
	Key *string `mandatory:"true" json:"key"`
}

type CredentialRelatedResource struct {

	// The related resource type.
	Type CredentialRelatedResourceTypeEnum `mandatory:"true" json:"type"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource.
	Identifier *string `mandatory:"true" json:"identifier"`
}

type CredentialRelatedResourceTypeEnum string

type CredentialSummary struct {

	// Name of the credential
	Key *string `mandatory:"true" json:"key"`

	// Name of the user that will be used to log in to the remote database or the remote or local operating system
	UserName *string `mandatory:"true" json:"userName"`

	// Indicates whether this credential is enabled (TRUE) or not (FALSE)
	Enabled *string `mandatory:"true" json:"enabled"`

	// Owner of the credential
	Owner *string `mandatory:"true" json:"owner"`

	// For a Windows target, the Windows domain to use when logging in
	WindowsDomain *string `mandatory:"false" json:"windowsDomain"`

	// Indicates whether this refers to a public synonym or not.
	KeyType CredentialKeyTypeEnum `mandatory:"false" json:"keyType,omitempty"`

	RelatedResource *CredentialRelatedResource `mandatory:"false" json:"relatedResource"`
}

type CredentialTypeEnum string

type DatabaseApiGatewayConfigAdvancedPropertyConfigTypeEnum string

type DatabaseApiGatewayConfigCertificateBundle interface {
}

type DatabaseApiGatewayConfigCertificateBundleFileName struct {
	CertificatePublic *DatabaseApiGatewayConfigCertificatePublicFileName `mandatory:"false" json:"certificatePublic"`

	CertificatePrivateKey *DatabaseApiGatewayConfigCertificatePrivateKeyFileName `mandatory:"false" json:"certificatePrivateKey"`
}

type DatabaseApiGatewayConfigCertificateBundleSelfSigned struct {
}

type DatabaseApiGatewayConfigCertificateBundleTypeEnum string

type DatabaseApiGatewayConfigCertificatePrivateKeyFileName struct {

	// The format of the file
	Format DatabaseApiGatewayConfigCertificatePrivateKeyFileNameFormatEnum `mandatory:"false" json:"format,omitempty"`

	// The path to the file
	Path *string `mandatory:"false" json:"path"`
}

type DatabaseApiGatewayConfigCertificatePrivateKeyFileNameFormatEnum string

type DatabaseApiGatewayConfigCertificatePublicFileName struct {

	// The format of the file
	Format DatabaseApiGatewayConfigCertificatePublicFileNameFormatEnum `mandatory:"false" json:"format,omitempty"`

	// The path to the file
	Path *string `mandatory:"false" json:"path"`
}

type DatabaseApiGatewayConfigCertificatePublicFileNameFormatEnum string

type DatabaseApiGatewayConfigGlobalKeyEnum string

type DatabaseApiGatewayConfigTypeEnum string

type DatabaseToolsConnection struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools connection.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools connection.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The current state of the Database Tools connection.
	LifecycleState DatabaseToolsConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The time the Database Tools connection was created. An RFC3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The time the DatabaseToolsConnection was updated. An RFC3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The Database Tools connection type.
	Type ConnectionTypeEnum `mandatory:"true" json:"type"`

	// 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.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

type DatabaseToolsConnectionLifecycleStateEnum string

type DatabaseToolsDatabaseApiGatewayConfig struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools database API gateway config.
	Id *string `mandatory:"true" json:"id"`

	// The Database Tools database API gateway config type.
	Type DatabaseApiGatewayConfigTypeEnum `mandatory:"true" json:"type"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools database API gateway config.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The current state of the Database Tools database API gateway config.
	LifecycleState DatabaseToolsDatabaseApiGatewayConfigLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// 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.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

type DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary struct {

	// A string that uniquely identifies a Database Tools database API gateway config global settings resource.
	Key *string `mandatory:"true" json:"key"`

	// A user-friendly name.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The data type of a database API gateway config setting.
	DataType DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryDataTypeEnum `mandatory:"true" json:"dataType"`

	// The config types that support this advanced property. The supported types are GLOBAL and POOL.
	ConfigTypes []DatabaseApiGatewayConfigAdvancedPropertyConfigTypeEnum `mandatory:"false" json:"configTypes,omitempty"`

	// The category of the Database Tools database API gateway config global setting.
	CategoryKey *string `mandatory:"false" json:"categoryKey"`

	// A user-friendly name of a category.
	CategoryDisplayName *string `mandatory:"false" json:"categoryDisplayName"`

	// The type of database (as determined by a type of Database Tools connection) to which this setting applies.
	// The advancedProperty applies to all types of Database Tools connection when null. This is only applicable
	// when configTypes includes POOL.
	DatabaseToolsConnectionTypes []DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryDatabaseToolsConnectionTypesEnum `mandatory:"false" json:"databaseToolsConnectionTypes,omitempty"`

	// Uniform resource locator (URL) of documentation related to this setting.
	DocumentationUrl *string `mandatory:"false" json:"documentationUrl"`

	// A user-friendly description of a database API gateway config setting.
	Description *string `mandatory:"false" json:"description"`

	// The default value (if applicable) of a database API gateway config setting.
	DefaultValue *string `mandatory:"false" json:"defaultValue"`

	// A minimum numeric value (if applicable) of a database API gateway config setting.
	MinValue *int `mandatory:"false" json:"minValue"`

	// A maximum numeric value (if applicable) of a database API gateway config setting.
	MaxValue *int `mandatory:"false" json:"maxValue"`

	// A list of string values (if applicable) supported by this database API gateway config setting.
	ListOfValues []string `mandatory:"false" json:"listOfValues"`

	// Hint text for a database API gateway config setting.
	HintText *string `mandatory:"false" json:"hintText"`
}

type DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollection struct {

	// List of database API gateway config setting descriptions to be provided as advanced properties.
	Items []DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary `mandatory:"true" json:"items"`
}

type DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryDataTypeEnum string

type DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryDatabaseToolsConnectionTypesEnum string

type DatabaseToolsDatabaseApiGatewayConfigContent struct {
	Global DatabaseToolsDatabaseApiGatewayConfigGlobal `mandatory:"true" json:"global"`

	// The content of the Database Tools database API gateway config pools each with API spec and auto API spec definitions.
	Pools []DatabaseToolsDatabaseApiGatewayConfigPoolContent `mandatory:"false" json:"pools"`
}

type DatabaseToolsDatabaseApiGatewayConfigGlobal interface {

	// A string that uniquely identifies a Database Tools database API gateway config global settings resource.
	GetKey() *string

	// The time the resource was created. An RFC3339 formatted datetime string.
	GetTimeCreated() *common.SDKTime

	// The time the resource was updated. An RFC3339 formatted datetime string.
	GetTimeUpdated() *common.SDKTime

	// How the target pool route value is determined for a HTTP request.
	GetPoolRoute() DatabaseToolsDatabaseApiGatewayConfigGlobalPoolRouteEnum

	// The request header name providing the pool route value.
	GetPoolRoutingHeader() *string

	// ORDS database API is a database management and monitoring REST API. Database Actions requires this feature.
	GetDatabaseApiStatus() DatabaseToolsDatabaseApiGatewayConfigGlobalDatabaseApiStatusEnum

	// The RESTful service definition location.
	GetMetadataSource() DatabaseToolsDatabaseApiGatewayConfigGlobalMetadataSourceEnum

	// Specifies the HTTP listen port. 0 disables HTTP. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended.
	GetHttpPort() *int

	// Specifies the HTTPS listen port. 0 disables HTTPS. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.
	GetHttpsPort() *int

	GetCertificateBundle() DatabaseApiGatewayConfigCertificateBundle

	// The location of the static resources to be served under the / root server path.
	GetDocumentRoot() *string

	// Advanced global properties.
	GetAdvancedProperties() map[string]string
}

type DatabaseToolsDatabaseApiGatewayConfigGlobalDatabaseApiStatusEnum string

type DatabaseToolsDatabaseApiGatewayConfigGlobalDefault struct {

	// A string that uniquely identifies a Database Tools database API gateway config global settings resource.
	Key *string `mandatory:"true" json:"key"`

	// The time the resource was created. An RFC3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The time the resource was updated. An RFC3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The request header name providing the pool route value.
	PoolRoutingHeader *string `mandatory:"false" json:"poolRoutingHeader"`

	// Specifies the HTTP listen port. 0 disables HTTP. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended.
	HttpPort *int `mandatory:"false" json:"httpPort"`

	// Specifies the HTTPS listen port. 0 disables HTTPS. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.
	HttpsPort *int `mandatory:"false" json:"httpsPort"`

	CertificateBundle DatabaseApiGatewayConfigCertificateBundle `mandatory:"false" json:"certificateBundle"`

	// The location of the static resources to be served under the / root server path.
	DocumentRoot *string `mandatory:"false" json:"documentRoot"`

	// Advanced global properties.
	AdvancedProperties map[string]string `mandatory:"false" json:"advancedProperties"`

	// How the target pool route value is determined for a HTTP request.
	PoolRoute DatabaseToolsDatabaseApiGatewayConfigGlobalPoolRouteEnum `mandatory:"false" json:"poolRoute,omitempty"`

	// ORDS database API is a database management and monitoring REST API. Database Actions requires this feature.
	DatabaseApiStatus DatabaseToolsDatabaseApiGatewayConfigGlobalDatabaseApiStatusEnum `mandatory:"false" json:"databaseApiStatus,omitempty"`

	// The RESTful service definition location.
	MetadataSource DatabaseToolsDatabaseApiGatewayConfigGlobalMetadataSourceEnum `mandatory:"false" json:"metadataSource,omitempty"`
}

type DatabaseToolsDatabaseApiGatewayConfigGlobalMetadataSourceEnum string

type DatabaseToolsDatabaseApiGatewayConfigGlobalPoolRouteEnum string

type DatabaseToolsDatabaseApiGatewayConfigLifecycleStateEnum string

type DatabaseToolsDatabaseApiGatewayConfigPool interface {

	// A system generated string that uniquely identifies a pool sub resource.
	GetKey() *string

	// The time the resource was created. An RFC3339 formatted datetime string.
	GetTimeCreated() *common.SDKTime

	// The time the resource was updated. An RFC3339 formatted datetime string.
	GetTimeUpdated() *common.SDKTime

	// A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
	GetDisplayName() *string

	// The pool route value provided in requests to target this pool.
	GetPoolRouteValue() *string

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.
	GetDatabaseToolsConnectionId() *string

	// Specifies the maximum number of database connections allowed for the pool.
	GetMaxPoolSize() *int

	// Specifies the minimum number of database connections allowed for the pool.
	GetMinPoolSize() *int

	// Specifies the initial size for the number of database connections that will be created for the pool.
	GetInitialPoolSize() *int

	// Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
	GetJwtProfileJwkUrl() *string

	// Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
	GetJwtProfileIssuer() *string

	// Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
	GetJwtProfileAudience() *string

	// Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
	GetJwtProfileRoleClaimName() *string

	// Specifies to enable the Database Actions feature.
	GetDatabaseActionsStatus() DatabaseToolsDatabaseApiGatewayConfigPoolDatabaseActionsStatusEnum

	// Specifies whether the REST-Enabled SQL service is active.
	GetRestEnabledSqlStatus() DatabaseToolsDatabaseApiGatewayConfigPoolRestEnabledSqlStatusEnum

	// Advanced pool properties.
	GetAdvancedProperties() map[string]string
}