func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetCreateDedicatedShardedDatabaseDbWorkloadEnumStringValues() []string
GetCreateDedicatedShardedDatabaseDbWorkloadEnumStringValues Enumerates the set of values in String for CreateDedicatedShardedDatabaseDbWorkloadEnum
func GetCreateDedicatedShardedDatabaseShardingMethodEnumStringValues() []string
GetCreateDedicatedShardedDatabaseShardingMethodEnumStringValues Enumerates the set of values in String for CreateDedicatedShardedDatabaseShardingMethodEnum
func GetCreateShardedDatabaseDetailsDbDeploymentTypeEnumStringValues() []string
GetCreateShardedDatabaseDetailsDbDeploymentTypeEnumStringValues Enumerates the set of values in String for CreateShardedDatabaseDetailsDbDeploymentTypeEnum
func GetDedicatedCatalogDetailsStatusEnumStringValues() []string
GetDedicatedCatalogDetailsStatusEnumStringValues Enumerates the set of values in String for DedicatedCatalogDetailsStatusEnum
func GetDedicatedShardDetailsStatusEnumStringValues() []string
GetDedicatedShardDetailsStatusEnumStringValues Enumerates the set of values in String for DedicatedShardDetailsStatusEnum
func GetDedicatedShardedDatabaseDbWorkloadEnumStringValues() []string
GetDedicatedShardedDatabaseDbWorkloadEnumStringValues Enumerates the set of values in String for DedicatedShardedDatabaseDbWorkloadEnum
func GetDedicatedShardedDatabaseShardingMethodEnumStringValues() []string
GetDedicatedShardedDatabaseShardingMethodEnumStringValues Enumerates the set of values in String for DedicatedShardedDatabaseShardingMethodEnum
func GetDedicatedShardedDatabaseSummaryDbWorkloadEnumStringValues() []string
GetDedicatedShardedDatabaseSummaryDbWorkloadEnumStringValues Enumerates the set of values in String for DedicatedShardedDatabaseSummaryDbWorkloadEnum
func GetDedicatedShardedDatabaseSummaryShardingMethodEnumStringValues() []string
GetDedicatedShardedDatabaseSummaryShardingMethodEnumStringValues Enumerates the set of values in String for DedicatedShardedDatabaseSummaryShardingMethodEnum
func GetFetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnumStringValues() []string
GetFetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnumStringValues Enumerates the set of values in String for FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum
func GetGsmDetailsStatusEnumStringValues() []string
GetGsmDetailsStatusEnumStringValues Enumerates the set of values in String for GsmDetailsStatusEnum
func GetListPrivateEndpointsSortByEnumStringValues() []string
GetListPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListPrivateEndpointsSortByEnum
func GetListPrivateEndpointsSortOrderEnumStringValues() []string
GetListPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListPrivateEndpointsSortOrderEnum
func GetListShardedDatabasesSortByEnumStringValues() []string
GetListShardedDatabasesSortByEnumStringValues Enumerates the set of values in String for ListShardedDatabasesSortByEnum
func GetListShardedDatabasesSortOrderEnumStringValues() []string
GetListShardedDatabasesSortOrderEnumStringValues Enumerates the set of values in String for ListShardedDatabasesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPatchInstructionOperationEnumStringValues() []string
GetPatchInstructionOperationEnumStringValues Enumerates the set of values in String for PatchInstructionOperationEnum
func GetPrevalidatePayloadOperationEnumStringValues() []string
GetPrevalidatePayloadOperationEnumStringValues Enumerates the set of values in String for PrevalidatePayloadOperationEnum
func GetPrivateEndpointLifecycleStateEnumStringValues() []string
GetPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for PrivateEndpointLifecycleStateEnum
func GetShardableCloudAutonomousVmClusterSummaryLifecycleStateEnumStringValues() []string
GetShardableCloudAutonomousVmClusterSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum
func GetShardedDatabaseDbDeploymentTypeEnumStringValues() []string
GetShardedDatabaseDbDeploymentTypeEnumStringValues Enumerates the set of values in String for ShardedDatabaseDbDeploymentTypeEnum
func GetShardedDatabaseLifecycleStateEnumStringValues() []string
GetShardedDatabaseLifecycleStateEnumStringValues Enumerates the set of values in String for ShardedDatabaseLifecycleStateEnum
func GetShardedDatabaseSummaryDbDeploymentTypeEnumStringValues() []string
GetShardedDatabaseSummaryDbDeploymentTypeEnumStringValues Enumerates the set of values in String for ShardedDatabaseSummaryDbDeploymentTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangePrivateEndpointCompartmentDetails The configuration details for moving the resource for private endpoint to other compartment.
type ChangePrivateEndpointCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePrivateEndpointCompartmentDetails) String() string
func (m ChangePrivateEndpointCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangePrivateEndpointCompartmentRequest wrapper for the ChangePrivateEndpointCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ChangePrivateEndpointCompartment.go.html to see an example of how to use ChangePrivateEndpointCompartmentRequest.
type ChangePrivateEndpointCompartmentRequest struct {
// Request to move the private endpoint to a different compartment.
ChangePrivateEndpointCompartmentDetails `contributesTo:"body"`
// Oracle Sharded Database PrivateEndpoint identifier
PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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.
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
}
func (request ChangePrivateEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangePrivateEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangePrivateEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangePrivateEndpointCompartmentRequest) String() string
func (request ChangePrivateEndpointCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangePrivateEndpointCompartmentResponse wrapper for the ChangePrivateEndpointCompartment operation
type ChangePrivateEndpointCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangePrivateEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangePrivateEndpointCompartmentResponse) String() string
ChangeShardedDatabaseCompartmentDetails The configuration details for moving the resource for sharded database to other compartment.
type ChangeShardedDatabaseCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeShardedDatabaseCompartmentDetails) String() string
func (m ChangeShardedDatabaseCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeShardedDatabaseCompartmentRequest wrapper for the ChangeShardedDatabaseCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ChangeShardedDatabaseCompartment.go.html to see an example of how to use ChangeShardedDatabaseCompartmentRequest.
type ChangeShardedDatabaseCompartmentRequest struct {
// Request to move the sharded database to a different compartment.
ChangeShardedDatabaseCompartmentDetails `contributesTo:"body"`
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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.
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
}
func (request ChangeShardedDatabaseCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeShardedDatabaseCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeShardedDatabaseCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeShardedDatabaseCompartmentRequest) String() string
func (request ChangeShardedDatabaseCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeShardedDatabaseCompartmentResponse wrapper for the ChangeShardedDatabaseCompartment operation
type ChangeShardedDatabaseCompartmentResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeShardedDatabaseCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeShardedDatabaseCompartmentResponse) String() string
ConfigureShardedDatabaseGsmsDetails Details of the request to configure new global service manager(GSM) instances for the sharded database.
type ConfigureShardedDatabaseGsmsDetails struct {
// Names of old global service manager(GSM) instances corresponding to which new GSM instances need to be configured.
OldGsmNames []string `mandatory:"true" json:"oldGsmNames"`
// Flag to indicate if new global service manager(GSM) instances shall use latest image or re-use image used by existing
// GSM instances.
IsLatestGsmImage *bool `mandatory:"true" json:"isLatestGsmImage"`
}
func (m ConfigureShardedDatabaseGsmsDetails) String() string
func (m ConfigureShardedDatabaseGsmsDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConfigureShardedDatabaseGsmsRequest wrapper for the ConfigureShardedDatabaseGsms operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ConfigureShardedDatabaseGsms.go.html to see an example of how to use ConfigureShardedDatabaseGsmsRequest.
type ConfigureShardedDatabaseGsmsRequest struct {
// Details to configure the new GSM instances for the sharded database.
ConfigureShardedDatabaseGsmsDetails `contributesTo:"body"`
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request ConfigureShardedDatabaseGsmsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ConfigureShardedDatabaseGsmsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ConfigureShardedDatabaseGsmsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ConfigureShardedDatabaseGsmsRequest) String() string
func (request ConfigureShardedDatabaseGsmsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConfigureShardedDatabaseGsmsResponse wrapper for the ConfigureShardedDatabaseGsms operation
type ConfigureShardedDatabaseGsmsResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ConfigureShardedDatabaseGsmsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ConfigureShardedDatabaseGsmsResponse) String() string
ConfigureShardingRequest wrapper for the ConfigureSharding operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ConfigureSharding.go.html to see an example of how to use ConfigureShardingRequest.
type ConfigureShardingRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// The flag to indicate whether chunks need to be re-balanced. This flag is not applicable for USER-defined
// sharding type.
IsRebalanceRequired *bool `mandatory:"false" contributesTo:"query" name:"isRebalanceRequired"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request ConfigureShardingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ConfigureShardingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ConfigureShardingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ConfigureShardingRequest) String() string
func (request ConfigureShardingRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConfigureShardingResponse wrapper for the ConfigureSharding operation
type ConfigureShardingResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ConfigureShardingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ConfigureShardingResponse) String() string
ConnectionString Details of sharded database connection String.
type ConnectionString struct {
// Collection of connection strings.
AllConnectionStrings map[string]string `mandatory:"true" json:"allConnectionStrings"`
}
func (m ConnectionString) String() string
func (m ConnectionString) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDedicatedCatalogDetail Details required for creation of ATP-D based catalog.
type CreateDedicatedCatalogDetail struct {
// Admin password for the catalog database.
AdminPassword *string `mandatory:"true" json:"adminPassword"`
// The compute count for the catalog database. It has to be in multiple of 2.
ComputeCount *float32 `mandatory:"true" json:"computeCount"`
// The data disk group size to be allocated in GBs for the catalog database.
DataStorageSizeInGbs *float64 `mandatory:"true" json:"dataStorageSizeInGbs"`
// Determines the auto-scaling mode for the catalog database.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster.
CloudAutonomousVmClusterId *string `mandatory:"true" json:"cloudAutonomousVmClusterId"`
EncryptionKeyDetails *DedicatedShardOrCatalogEncryptionKeyDetails `mandatory:"false" json:"encryptionKeyDetails"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster.
PeerCloudAutonomousVmClusterId *string `mandatory:"false" json:"peerCloudAutonomousVmClusterId"`
}
func (m CreateDedicatedCatalogDetail) String() string
func (m CreateDedicatedCatalogDetail) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDedicatedShardDetail Details required for creation of ATP-D based shard.
type CreateDedicatedShardDetail struct {
// Admin password for shard database.
AdminPassword *string `mandatory:"true" json:"adminPassword"`
// The compute count for the shard database. It has to be in multiples of 2.
ComputeCount *float32 `mandatory:"true" json:"computeCount"`
// The data disk group size to be allocated in GBs for the shard database.
DataStorageSizeInGbs *float64 `mandatory:"true" json:"dataStorageSizeInGbs"`
// Determines the auto-scaling mode for the shard database.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster.
CloudAutonomousVmClusterId *string `mandatory:"true" json:"cloudAutonomousVmClusterId"`
EncryptionKeyDetails *DedicatedShardOrCatalogEncryptionKeyDetails `mandatory:"false" json:"encryptionKeyDetails"`
// The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created.
// Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique
// shard space name. For system defined sharding, shard space name is not required.
ShardSpace *string `mandatory:"false" json:"shardSpace"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster.
PeerCloudAutonomousVmClusterId *string `mandatory:"false" json:"peerCloudAutonomousVmClusterId"`
}
func (m CreateDedicatedShardDetail) String() string
func (m CreateDedicatedShardDetail) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDedicatedShardedDatabase Request details for creation of ATP-Dedicated based sharded database.
type CreateDedicatedShardedDatabase struct {
// Identifier of the compartment where sharded database is to be created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Oracle sharded database display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Oracle Database version of the Autonomous Container Database.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to
// get the list of allowed character set for autonomous dedicated database. See documentation:
// https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
CharacterSet *string `mandatory:"true" json:"characterSet"`
// The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to
// get the list of allowed national character set for autonomous dedicated database. See documentation:
// https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
NcharacterSet *string `mandatory:"true" json:"ncharacterSet"`
// The listener port number for sharded database.
ListenerPort *int `mandatory:"true" json:"listenerPort"`
// The TLS listener port number for sharded database.
ListenerPortTls *int `mandatory:"true" json:"listenerPortTls"`
// Ons port local for sharded database.
OnsPortLocal *int `mandatory:"true" json:"onsPortLocal"`
// Ons remote port for sharded database.
OnsPortRemote *int `mandatory:"true" json:"onsPortRemote"`
// Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character
// has to be a letter followed by any combination of letter and number.
Prefix *string `mandatory:"true" json:"prefix"`
// Collection of ATP-Dedicated shards that needs to be created.
ShardDetails []CreateDedicatedShardDetail `mandatory:"true" json:"shardDetails"`
// Collection of ATP-Dedicated catalogs that needs to be created.
CatalogDetails []CreateDedicatedCatalogDetail `mandatory:"true" json:"catalogDetails"`
// 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"`
// 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"`
// The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production.
// All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for
// clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
ClusterCertificateCommonName *string `mandatory:"false" json:"clusterCertificateCommonName"`
// The default number of unique chunks in a shardspace. The value of chunks must be
// greater than 2 times the size of the largest shardgroup in any shardspace.
Chunks *int `mandatory:"false" json:"chunks"`
// Possible workload types.
DbWorkload CreateDedicatedShardedDatabaseDbWorkloadEnum `mandatory:"true" json:"dbWorkload"`
// Sharding Method.
ShardingMethod CreateDedicatedShardedDatabaseShardingMethodEnum `mandatory:"true" json:"shardingMethod"`
}
func (m CreateDedicatedShardedDatabase) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateDedicatedShardedDatabase) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateDedicatedShardedDatabase) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateDedicatedShardedDatabase) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateDedicatedShardedDatabase) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDedicatedShardedDatabase) String() string
func (m CreateDedicatedShardedDatabase) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDedicatedShardedDatabaseDbWorkloadEnum Enum with underlying type: string
type CreateDedicatedShardedDatabaseDbWorkloadEnum string
Set of constants representing the allowable values for CreateDedicatedShardedDatabaseDbWorkloadEnum
const (
CreateDedicatedShardedDatabaseDbWorkloadOltp CreateDedicatedShardedDatabaseDbWorkloadEnum = "OLTP"
CreateDedicatedShardedDatabaseDbWorkloadDw CreateDedicatedShardedDatabaseDbWorkloadEnum = "DW"
)
func GetCreateDedicatedShardedDatabaseDbWorkloadEnumValues() []CreateDedicatedShardedDatabaseDbWorkloadEnum
GetCreateDedicatedShardedDatabaseDbWorkloadEnumValues Enumerates the set of values for CreateDedicatedShardedDatabaseDbWorkloadEnum
func GetMappingCreateDedicatedShardedDatabaseDbWorkloadEnum(val string) (CreateDedicatedShardedDatabaseDbWorkloadEnum, bool)
GetMappingCreateDedicatedShardedDatabaseDbWorkloadEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDedicatedShardedDatabaseShardingMethodEnum Enum with underlying type: string
type CreateDedicatedShardedDatabaseShardingMethodEnum string
Set of constants representing the allowable values for CreateDedicatedShardedDatabaseShardingMethodEnum
const (
CreateDedicatedShardedDatabaseShardingMethodUser CreateDedicatedShardedDatabaseShardingMethodEnum = "USER"
CreateDedicatedShardedDatabaseShardingMethodSystem CreateDedicatedShardedDatabaseShardingMethodEnum = "SYSTEM"
)
func GetCreateDedicatedShardedDatabaseShardingMethodEnumValues() []CreateDedicatedShardedDatabaseShardingMethodEnum
GetCreateDedicatedShardedDatabaseShardingMethodEnumValues Enumerates the set of values for CreateDedicatedShardedDatabaseShardingMethodEnum
func GetMappingCreateDedicatedShardedDatabaseShardingMethodEnum(val string) (CreateDedicatedShardedDatabaseShardingMethodEnum, bool)
GetMappingCreateDedicatedShardedDatabaseShardingMethodEnum performs case Insensitive comparison on enum value and return the desired enum
CreatePrivateEndpointDetails Details required for private endpoint creation.
type CreatePrivateEndpointDetails struct {
// Identifier of the compartment where private endpoint is to be created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Identifier of the customer subnet against which private endpoint is to be created.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Private endpoint display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// PrivateEndpoint description.
Description *string `mandatory:"false" json:"description"`
// The OCIDs of the network security groups that the private endpoint belongs to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// 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"`
// 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"`
}
func (m CreatePrivateEndpointDetails) String() string
func (m CreatePrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePrivateEndpointRequest wrapper for the CreatePrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/CreatePrivateEndpoint.go.html to see an example of how to use CreatePrivateEndpointRequest.
type CreatePrivateEndpointRequest struct {
// Details of PrivateEndpoint to be created.
CreatePrivateEndpointDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request CreatePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePrivateEndpointRequest) String() string
func (request CreatePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePrivateEndpointResponse wrapper for the CreatePrivateEndpoint operation
type CreatePrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivateEndpoint instance
PrivateEndpoint `presentIn:"body"`
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreatePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePrivateEndpointResponse) String() string
CreateShardedDatabaseDetails Details required for Sharded database creation.
type CreateShardedDatabaseDetails interface {
// Identifier of the compartment where sharded database is to be created.
GetCompartmentId() *string
// Oracle sharded database display name.
GetDisplayName() *string
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
CreateShardedDatabaseDetailsDbDeploymentTypeEnum Enum with underlying type: string
type CreateShardedDatabaseDetailsDbDeploymentTypeEnum string
Set of constants representing the allowable values for CreateShardedDatabaseDetailsDbDeploymentTypeEnum
const (
CreateShardedDatabaseDetailsDbDeploymentTypeDedicated CreateShardedDatabaseDetailsDbDeploymentTypeEnum = "DEDICATED"
)
func GetCreateShardedDatabaseDetailsDbDeploymentTypeEnumValues() []CreateShardedDatabaseDetailsDbDeploymentTypeEnum
GetCreateShardedDatabaseDetailsDbDeploymentTypeEnumValues Enumerates the set of values for CreateShardedDatabaseDetailsDbDeploymentTypeEnum
func GetMappingCreateShardedDatabaseDetailsDbDeploymentTypeEnum(val string) (CreateShardedDatabaseDetailsDbDeploymentTypeEnum, bool)
GetMappingCreateShardedDatabaseDetailsDbDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateShardedDatabaseRequest wrapper for the CreateShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/CreateShardedDatabase.go.html to see an example of how to use CreateShardedDatabaseRequest.
type CreateShardedDatabaseRequest struct {
// Details of Sharded database to be created.
CreateShardedDatabaseDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request CreateShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateShardedDatabaseRequest) String() string
func (request CreateShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateShardedDatabaseResponse wrapper for the CreateShardedDatabase operation
type CreateShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The ShardedDatabase instance
ShardedDatabase `presentIn:"body"`
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateShardedDatabaseResponse) String() string
DedicatedCatalogDetails Details of ATP-D based catalog.
type DedicatedCatalogDetails struct {
// Catalog name
Name *string `mandatory:"true" json:"name"`
// The compute amount available to the underlying autonomous database associated with shard or catalog.
ComputeCount *float32 `mandatory:"true" json:"computeCount"`
// The data disk group size to be allocated in GBs.
DataStorageSizeInGbs *float64 `mandatory:"true" json:"dataStorageSizeInGbs"`
// Name of the shard-group to which the catalog belongs.
ShardGroup *string `mandatory:"true" json:"shardGroup"`
// The time the catalog was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the catalog was last created. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Status of shard or catalog or gsm for the sharded database.
Status DedicatedCatalogDetailsStatusEnum `mandatory:"true" json:"status"`
// Determines the auto-scaling mode.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
// Identifier of the primary cloudAutonomousVmCluster for the catalog.
CloudAutonomousVmClusterId *string `mandatory:"true" json:"cloudAutonomousVmClusterId"`
EncryptionKeyDetails *DedicatedShardOrCatalogEncryptionKeyDetails `mandatory:"false" json:"encryptionKeyDetails"`
// The time the ssl certificate associated with catalog expires. An RFC3339 formatted datetime string
TimeSslCertificateExpires *common.SDKTime `mandatory:"false" json:"timeSslCertificateExpires"`
// Identifier of the underlying supporting resource.
SupportingResourceId *string `mandatory:"false" json:"supportingResourceId"`
// Identifier of the underlying container database.
ContainerDatabaseId *string `mandatory:"false" json:"containerDatabaseId"`
// Identifier of the underlying container database parent.
ContainerDatabaseParentId *string `mandatory:"false" json:"containerDatabaseParentId"`
// Identifier of the peer cloudAutonomousVmCluster for the catalog.
PeerCloudAutonomousVmClusterId *string `mandatory:"false" json:"peerCloudAutonomousVmClusterId"`
// Additional metadata related to catalog's underlying supporting resource.
Metadata map[string]interface{} `mandatory:"false" json:"metadata"`
}
func (m DedicatedCatalogDetails) String() string
func (m DedicatedCatalogDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DedicatedCatalogDetailsStatusEnum Enum with underlying type: string
type DedicatedCatalogDetailsStatusEnum string
Set of constants representing the allowable values for DedicatedCatalogDetailsStatusEnum
const (
DedicatedCatalogDetailsStatusFailed DedicatedCatalogDetailsStatusEnum = "FAILED"
DedicatedCatalogDetailsStatusDeleting DedicatedCatalogDetailsStatusEnum = "DELETING"
DedicatedCatalogDetailsStatusDeleted DedicatedCatalogDetailsStatusEnum = "DELETED"
DedicatedCatalogDetailsStatusUpdating DedicatedCatalogDetailsStatusEnum = "UPDATING"
DedicatedCatalogDetailsStatusCreating DedicatedCatalogDetailsStatusEnum = "CREATING"
DedicatedCatalogDetailsStatusCreated DedicatedCatalogDetailsStatusEnum = "CREATED"
DedicatedCatalogDetailsStatusReadyForConfiguration DedicatedCatalogDetailsStatusEnum = "READY_FOR_CONFIGURATION"
DedicatedCatalogDetailsStatusConfigured DedicatedCatalogDetailsStatusEnum = "CONFIGURED"
DedicatedCatalogDetailsStatusNeedsAttention DedicatedCatalogDetailsStatusEnum = "NEEDS_ATTENTION"
)
func GetDedicatedCatalogDetailsStatusEnumValues() []DedicatedCatalogDetailsStatusEnum
GetDedicatedCatalogDetailsStatusEnumValues Enumerates the set of values for DedicatedCatalogDetailsStatusEnum
func GetMappingDedicatedCatalogDetailsStatusEnum(val string) (DedicatedCatalogDetailsStatusEnum, bool)
GetMappingDedicatedCatalogDetailsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedShardDetails Details of ATP-D based shard.
type DedicatedShardDetails struct {
// Name of the shard.
Name *string `mandatory:"true" json:"name"`
// The compute amount available to the underlying autonomous database associated with shard.
ComputeCount *float32 `mandatory:"true" json:"computeCount"`
// The data disk group size to be allocated in GBs.
DataStorageSizeInGbs *float64 `mandatory:"true" json:"dataStorageSizeInGbs"`
// Name of the shard-group to which the shard belongs.
ShardGroup *string `mandatory:"true" json:"shardGroup"`
// The time the the shard was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the shard was last updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Status of shard or catalog or gsm for the sharded database.
Status DedicatedShardDetailsStatusEnum `mandatory:"true" json:"status"`
// Determines the auto-scaling mode.
IsAutoScalingEnabled *bool `mandatory:"true" json:"isAutoScalingEnabled"`
// Identifier of the primary cloudAutonomousVmCluster for the shard.
CloudAutonomousVmClusterId *string `mandatory:"true" json:"cloudAutonomousVmClusterId"`
EncryptionKeyDetails *DedicatedShardOrCatalogEncryptionKeyDetails `mandatory:"false" json:"encryptionKeyDetails"`
// The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
TimeSslCertificateExpires *common.SDKTime `mandatory:"false" json:"timeSslCertificateExpires"`
// Shard space name.
ShardSpace *string `mandatory:"false" json:"shardSpace"`
// Identifier of the underlying supporting resource.
SupportingResourceId *string `mandatory:"false" json:"supportingResourceId"`
// Identifier of the underlying container database.
ContainerDatabaseId *string `mandatory:"false" json:"containerDatabaseId"`
// Identifier of the underlying container database parent.
ContainerDatabaseParentId *string `mandatory:"false" json:"containerDatabaseParentId"`
// Identifier of the peer cloudAutonomousVmCluster for the shard.
PeerCloudAutonomousVmClusterId *string `mandatory:"false" json:"peerCloudAutonomousVmClusterId"`
// Additional metadata related to shard's underlying supporting resource.
Metadata map[string]interface{} `mandatory:"false" json:"metadata"`
}
func (m DedicatedShardDetails) String() string
func (m DedicatedShardDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DedicatedShardDetailsStatusEnum Enum with underlying type: string
type DedicatedShardDetailsStatusEnum string
Set of constants representing the allowable values for DedicatedShardDetailsStatusEnum
const (
DedicatedShardDetailsStatusFailed DedicatedShardDetailsStatusEnum = "FAILED"
DedicatedShardDetailsStatusDeleting DedicatedShardDetailsStatusEnum = "DELETING"
DedicatedShardDetailsStatusDeleted DedicatedShardDetailsStatusEnum = "DELETED"
DedicatedShardDetailsStatusUpdating DedicatedShardDetailsStatusEnum = "UPDATING"
DedicatedShardDetailsStatusCreating DedicatedShardDetailsStatusEnum = "CREATING"
DedicatedShardDetailsStatusCreated DedicatedShardDetailsStatusEnum = "CREATED"
DedicatedShardDetailsStatusReadyForConfiguration DedicatedShardDetailsStatusEnum = "READY_FOR_CONFIGURATION"
DedicatedShardDetailsStatusConfigured DedicatedShardDetailsStatusEnum = "CONFIGURED"
DedicatedShardDetailsStatusNeedsAttention DedicatedShardDetailsStatusEnum = "NEEDS_ATTENTION"
)
func GetDedicatedShardDetailsStatusEnumValues() []DedicatedShardDetailsStatusEnum
GetDedicatedShardDetailsStatusEnumValues Enumerates the set of values for DedicatedShardDetailsStatusEnum
func GetMappingDedicatedShardDetailsStatusEnum(val string) (DedicatedShardDetailsStatusEnum, bool)
GetMappingDedicatedShardDetailsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedShardOrCatalogEncryptionKeyDetails Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
type DedicatedShardOrCatalogEncryptionKeyDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the vault in customer tenancy where KMS key is present.
// For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only,
// which is also replicated in the region of standby shard.
VaultId *string `mandatory:"true" json:"vaultId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the KMS key in vault identified by vaultId in customer tenancy
// that is used as the master encryption key.
KmsKeyId *string `mandatory:"true" json:"kmsKeyId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the KMS key version for key identified by kmsKeyId
// that is used in data encryption (TDE) operations.
KmsKeyVersionId *string `mandatory:"false" json:"kmsKeyVersionId"`
}
func (m DedicatedShardOrCatalogEncryptionKeyDetails) String() string
func (m DedicatedShardOrCatalogEncryptionKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DedicatedShardedDatabase Details of ATP-D based sharded database.
type DedicatedShardedDatabase struct {
// Sharded Database identifier
Id *string `mandatory:"true" json:"id"`
// Identifier of the compartment in which sharded database exists.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Oracle sharded database display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the Sharded Database was last updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Detailed message for the lifecycle state.
LifecycleStateDetails *string `mandatory:"true" json:"lifecycleStateDetails"`
// The character set for the database.
CharacterSet *string `mandatory:"true" json:"characterSet"`
// The national character set for the database.
NcharacterSet *string `mandatory:"true" json:"ncharacterSet"`
// Oracle Database version number.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// Unique prefix for the sharded database.
Prefix *string `mandatory:"true" json:"prefix"`
// 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"`
// 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"`
// 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"`
// The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production.
// All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for
// clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
ClusterCertificateCommonName *string `mandatory:"false" json:"clusterCertificateCommonName"`
// The default number of unique chunks in a shardspace. The value of chunks must be
// greater than 2 times the size of the largest shardgroup in any shardspace.
Chunks *int `mandatory:"false" json:"chunks"`
// The GSM listener port number.
ListenerPort *int `mandatory:"false" json:"listenerPort"`
// The TLS listener port number for sharded database.
ListenerPortTls *int `mandatory:"false" json:"listenerPortTls"`
// Ons local port number.
OnsPortLocal *int `mandatory:"false" json:"onsPortLocal"`
// Ons remote port number.
OnsPortRemote *int `mandatory:"false" json:"onsPortRemote"`
// The OCID of private endpoint being used by the sharded database.
PrivateEndpoint *string `mandatory:"false" json:"privateEndpoint"`
ConnectionStrings *ConnectionString `mandatory:"false" json:"connectionStrings"`
// Timezone associated with the sharded database.
TimeZone *string `mandatory:"false" json:"timeZone"`
// Details of GSM instances for the sharded database.
Gsms []GsmDetails `mandatory:"false" json:"gsms"`
// Details of ATP-D based shards.
ShardDetails []DedicatedShardDetails `mandatory:"false" json:"shardDetails"`
// Details of ATP-D based catalogs.
CatalogDetails []DedicatedCatalogDetails `mandatory:"false" json:"catalogDetails"`
// Possible workload types.
DbWorkload DedicatedShardedDatabaseDbWorkloadEnum `mandatory:"false" json:"dbWorkload,omitempty"`
// Sharding Method.
ShardingMethod DedicatedShardedDatabaseShardingMethodEnum `mandatory:"true" json:"shardingMethod"`
// Lifecycle states for sharded databases.
LifecycleState ShardedDatabaseLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m DedicatedShardedDatabase) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m DedicatedShardedDatabase) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m DedicatedShardedDatabase) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m DedicatedShardedDatabase) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m DedicatedShardedDatabase) GetId() *string
GetId returns Id
func (m DedicatedShardedDatabase) GetLifecycleState() ShardedDatabaseLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m DedicatedShardedDatabase) GetLifecycleStateDetails() *string
GetLifecycleStateDetails returns LifecycleStateDetails
func (m DedicatedShardedDatabase) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m DedicatedShardedDatabase) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m DedicatedShardedDatabase) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m DedicatedShardedDatabase) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DedicatedShardedDatabase) String() string
func (m DedicatedShardedDatabase) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DedicatedShardedDatabaseDbWorkloadEnum Enum with underlying type: string
type DedicatedShardedDatabaseDbWorkloadEnum string
Set of constants representing the allowable values for DedicatedShardedDatabaseDbWorkloadEnum
const (
DedicatedShardedDatabaseDbWorkloadOltp DedicatedShardedDatabaseDbWorkloadEnum = "OLTP"
DedicatedShardedDatabaseDbWorkloadDw DedicatedShardedDatabaseDbWorkloadEnum = "DW"
)
func GetDedicatedShardedDatabaseDbWorkloadEnumValues() []DedicatedShardedDatabaseDbWorkloadEnum
GetDedicatedShardedDatabaseDbWorkloadEnumValues Enumerates the set of values for DedicatedShardedDatabaseDbWorkloadEnum
func GetMappingDedicatedShardedDatabaseDbWorkloadEnum(val string) (DedicatedShardedDatabaseDbWorkloadEnum, bool)
GetMappingDedicatedShardedDatabaseDbWorkloadEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedShardedDatabaseShardingMethodEnum Enum with underlying type: string
type DedicatedShardedDatabaseShardingMethodEnum string
Set of constants representing the allowable values for DedicatedShardedDatabaseShardingMethodEnum
const (
DedicatedShardedDatabaseShardingMethodUser DedicatedShardedDatabaseShardingMethodEnum = "USER"
DedicatedShardedDatabaseShardingMethodSystem DedicatedShardedDatabaseShardingMethodEnum = "SYSTEM"
)
func GetDedicatedShardedDatabaseShardingMethodEnumValues() []DedicatedShardedDatabaseShardingMethodEnum
GetDedicatedShardedDatabaseShardingMethodEnumValues Enumerates the set of values for DedicatedShardedDatabaseShardingMethodEnum
func GetMappingDedicatedShardedDatabaseShardingMethodEnum(val string) (DedicatedShardedDatabaseShardingMethodEnum, bool)
GetMappingDedicatedShardedDatabaseShardingMethodEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedShardedDatabaseSummary Summary of ATP-D based sharded database.
type DedicatedShardedDatabaseSummary struct {
// Sharded Database identifier
Id *string `mandatory:"true" json:"id"`
// Identifier of the compartment where sharded database exists.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Oracle sharded database display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the Sharded Database was last updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Detailed message for the lifecycle state.
LifecycleStateDetails *string `mandatory:"true" json:"lifecycleStateDetails"`
// The character set for the sharded database.
CharacterSet *string `mandatory:"true" json:"characterSet"`
// The national character set for the sharded database.
NcharacterSet *string `mandatory:"true" json:"ncharacterSet"`
// 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"`
// 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"`
// 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"`
// The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production.
// All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for
// clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
ClusterCertificateCommonName *string `mandatory:"false" json:"clusterCertificateCommonName"`
// The default number of unique chunks in a shardspace. The value of chunks must be
// greater than 2 times the size of the largest shardgroup in any shardspace.
Chunks *int `mandatory:"false" json:"chunks"`
// Oracle Database version of the Autonomous Container Database.
DbVersion *string `mandatory:"false" json:"dbVersion"`
// The listener port number for the sharded database.
ListenerPort *int `mandatory:"false" json:"listenerPort"`
// The TLS listener port number for sharded database.
ListenerPortTls *int `mandatory:"false" json:"listenerPortTls"`
// Ons local port number.
OnsPortLocal *int `mandatory:"false" json:"onsPortLocal"`
// Ons remote port number.
OnsPortRemote *int `mandatory:"false" json:"onsPortRemote"`
// Name prefix for the sharded databases.
Prefix *string `mandatory:"false" json:"prefix"`
// Total cpu count usage for shards and catalogs of the sharded database.
TotalCpuCount *int `mandatory:"false" json:"totalCpuCount"`
// The aggregarted value of dataStorageSizeInGbs for all shards and catalogs.
TotalDataStorageSizeInGbs *float64 `mandatory:"false" json:"totalDataStorageSizeInGbs"`
// Possible workload types.
DbWorkload DedicatedShardedDatabaseSummaryDbWorkloadEnum `mandatory:"true" json:"dbWorkload"`
// Sharding Method.
ShardingMethod DedicatedShardedDatabaseSummaryShardingMethodEnum `mandatory:"true" json:"shardingMethod"`
// Lifecycle state of sharded database.
LifecycleState ShardedDatabaseLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m DedicatedShardedDatabaseSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m DedicatedShardedDatabaseSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m DedicatedShardedDatabaseSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m DedicatedShardedDatabaseSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m DedicatedShardedDatabaseSummary) GetId() *string
GetId returns Id
func (m DedicatedShardedDatabaseSummary) GetLifecycleState() ShardedDatabaseLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m DedicatedShardedDatabaseSummary) GetLifecycleStateDetails() *string
GetLifecycleStateDetails returns LifecycleStateDetails
func (m DedicatedShardedDatabaseSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m DedicatedShardedDatabaseSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m DedicatedShardedDatabaseSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m DedicatedShardedDatabaseSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DedicatedShardedDatabaseSummary) String() string
func (m DedicatedShardedDatabaseSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DedicatedShardedDatabaseSummaryDbWorkloadEnum Enum with underlying type: string
type DedicatedShardedDatabaseSummaryDbWorkloadEnum string
Set of constants representing the allowable values for DedicatedShardedDatabaseSummaryDbWorkloadEnum
const (
DedicatedShardedDatabaseSummaryDbWorkloadOltp DedicatedShardedDatabaseSummaryDbWorkloadEnum = "OLTP"
DedicatedShardedDatabaseSummaryDbWorkloadDw DedicatedShardedDatabaseSummaryDbWorkloadEnum = "DW"
)
func GetDedicatedShardedDatabaseSummaryDbWorkloadEnumValues() []DedicatedShardedDatabaseSummaryDbWorkloadEnum
GetDedicatedShardedDatabaseSummaryDbWorkloadEnumValues Enumerates the set of values for DedicatedShardedDatabaseSummaryDbWorkloadEnum
func GetMappingDedicatedShardedDatabaseSummaryDbWorkloadEnum(val string) (DedicatedShardedDatabaseSummaryDbWorkloadEnum, bool)
GetMappingDedicatedShardedDatabaseSummaryDbWorkloadEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedShardedDatabaseSummaryShardingMethodEnum Enum with underlying type: string
type DedicatedShardedDatabaseSummaryShardingMethodEnum string
Set of constants representing the allowable values for DedicatedShardedDatabaseSummaryShardingMethodEnum
const (
DedicatedShardedDatabaseSummaryShardingMethodUser DedicatedShardedDatabaseSummaryShardingMethodEnum = "USER"
DedicatedShardedDatabaseSummaryShardingMethodSystem DedicatedShardedDatabaseSummaryShardingMethodEnum = "SYSTEM"
)
func GetDedicatedShardedDatabaseSummaryShardingMethodEnumValues() []DedicatedShardedDatabaseSummaryShardingMethodEnum
GetDedicatedShardedDatabaseSummaryShardingMethodEnumValues Enumerates the set of values for DedicatedShardedDatabaseSummaryShardingMethodEnum
func GetMappingDedicatedShardedDatabaseSummaryShardingMethodEnum(val string) (DedicatedShardedDatabaseSummaryShardingMethodEnum, bool)
GetMappingDedicatedShardedDatabaseSummaryShardingMethodEnum performs case Insensitive comparison on enum value and return the desired enum
DeletePrivateEndpointRequest wrapper for the DeletePrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/DeletePrivateEndpoint.go.html to see an example of how to use DeletePrivateEndpointRequest.
type DeletePrivateEndpointRequest struct {
// Oracle Sharded Database PrivateEndpoint identifier
PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request DeletePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePrivateEndpointRequest) String() string
func (request DeletePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeletePrivateEndpointResponse wrapper for the DeletePrivateEndpoint operation
type DeletePrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeletePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePrivateEndpointResponse) String() string
DeleteShardedDatabaseRequest wrapper for the DeleteShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/DeleteShardedDatabase.go.html to see an example of how to use DeleteShardedDatabaseRequest.
type DeleteShardedDatabaseRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request DeleteShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteShardedDatabaseRequest) String() string
func (request DeleteShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteShardedDatabaseResponse wrapper for the DeleteShardedDatabase operation
type DeleteShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteShardedDatabaseResponse) String() string
DownloadGsmCertificateSigningRequestRequest wrapper for the DownloadGsmCertificateSigningRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/DownloadGsmCertificateSigningRequest.go.html to see an example of how to use DownloadGsmCertificateSigningRequestRequest.
type DownloadGsmCertificateSigningRequestRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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.
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
}
func (request DownloadGsmCertificateSigningRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DownloadGsmCertificateSigningRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DownloadGsmCertificateSigningRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DownloadGsmCertificateSigningRequestRequest) String() string
func (request DownloadGsmCertificateSigningRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DownloadGsmCertificateSigningRequestResponse wrapper for the DownloadGsmCertificateSigningRequest operation
type DownloadGsmCertificateSigningRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Size of the file.
ContentLength *int64 `presentIn:"header" name:"content-length"`
// The date and time the certificate signing request was created.
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
}
func (response DownloadGsmCertificateSigningRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DownloadGsmCertificateSigningRequestResponse) String() string
FetchConnectionStringRequest wrapper for the FetchConnectionString operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/FetchConnectionString.go.html to see an example of how to use FetchConnectionStringRequest.
type FetchConnectionStringRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request FetchConnectionStringRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request FetchConnectionStringRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request FetchConnectionStringRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request FetchConnectionStringRequest) String() string
func (request FetchConnectionStringRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchConnectionStringResponse wrapper for the FetchConnectionString operation
type FetchConnectionStringResponse struct {
// The underlying http response
RawResponse *http.Response
// The ConnectionString instance
ConnectionString `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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response FetchConnectionStringResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response FetchConnectionStringResponse) String() string
FetchShardableCloudAutonomousVmClustersDetails Details required for fetch sharded cloud autonomous vm clusters.
type FetchShardableCloudAutonomousVmClustersDetails struct {
// Compartment id of cloud autonomous vm clusters.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Lifecycle states for shardable Cloud autonomous vm cluster.
LifecycleState FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Detailed message for the lifecycle state.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// List only clusters for which atleast given minimum CDB count is available.
MinimumAvailableCdbCount *int `mandatory:"false" json:"minimumAvailableCdbCount"`
// Flag to indicate of response shall also include clusters for which no more capacity is left to create new resources.
AreDepletedClustersIncluded *bool `mandatory:"false" json:"areDepletedClustersIncluded"`
// Region code of regions for which sharded cloud autonomous vm clusters need to be fetched.
Regions []string `mandatory:"false" json:"regions"`
}
func (m FetchShardableCloudAutonomousVmClustersDetails) String() string
func (m FetchShardableCloudAutonomousVmClustersDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum Enum with underlying type: string
type FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum string
Set of constants representing the allowable values for FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum
const (
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateActive FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "ACTIVE"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateFailed FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "FAILED"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateNeedsAttention FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "NEEDS_ATTENTION"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateInactive FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "INACTIVE"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateDeleting FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "DELETING"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateDeleted FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "DELETED"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateUpdating FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "UPDATING"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateCreating FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "CREATING"
FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum = "UNAVAILABLE"
)
func GetFetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnumValues() []FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum
GetFetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnumValues Enumerates the set of values for FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum
func GetMappingFetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum(val string) (FetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum, bool)
GetMappingFetchShardableCloudAutonomousVmClustersDetailsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FetchShardableCloudAutonomousVmClustersRequest wrapper for the FetchShardableCloudAutonomousVmClusters operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/FetchShardableCloudAutonomousVmClusters.go.html to see an example of how to use FetchShardableCloudAutonomousVmClustersRequest.
type FetchShardableCloudAutonomousVmClustersRequest struct {
// Request payload to get sharded cloud autonomous vm clusters.
FetchShardableCloudAutonomousVmClustersDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request FetchShardableCloudAutonomousVmClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request FetchShardableCloudAutonomousVmClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request FetchShardableCloudAutonomousVmClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request FetchShardableCloudAutonomousVmClustersRequest) String() string
func (request FetchShardableCloudAutonomousVmClustersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchShardableCloudAutonomousVmClustersResponse wrapper for the FetchShardableCloudAutonomousVmClusters operation
type FetchShardableCloudAutonomousVmClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// The ShardableCloudAutonomousVmClusters instance
ShardableCloudAutonomousVmClusters `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"`
}
func (response FetchShardableCloudAutonomousVmClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response FetchShardableCloudAutonomousVmClustersResponse) String() string
GenerateGsmCertificateSigningRequestRequest wrapper for the GenerateGsmCertificateSigningRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GenerateGsmCertificateSigningRequest.go.html to see an example of how to use GenerateGsmCertificateSigningRequestRequest.
type GenerateGsmCertificateSigningRequestRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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.
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
}
func (request GenerateGsmCertificateSigningRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateGsmCertificateSigningRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateGsmCertificateSigningRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateGsmCertificateSigningRequestRequest) String() string
func (request GenerateGsmCertificateSigningRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateGsmCertificateSigningRequestResponse wrapper for the GenerateGsmCertificateSigningRequest operation
type GenerateGsmCertificateSigningRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response GenerateGsmCertificateSigningRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateGsmCertificateSigningRequestResponse) String() string
GenerateWalletDetails Details to create and download an Oracle Sharded Database wallet.
type GenerateWalletDetails struct {
// The password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character.
Password *string `mandatory:"true" json:"password"`
}
func (m GenerateWalletDetails) String() string
func (m GenerateWalletDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateWalletRequest wrapper for the GenerateWallet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GenerateWallet.go.html to see an example of how to use GenerateWalletRequest.
type GenerateWalletRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// Details for generating sharded database wallet.
GenerateWalletDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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.
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
}
func (request GenerateWalletRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateWalletRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateWalletRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateWalletRequest) String() string
func (request GenerateWalletRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateWalletResponse wrapper for the GenerateWallet operation
type GenerateWalletResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Size of the file.
ContentLength *int64 `presentIn:"header" name:"content-length"`
// The date and time the wallet was created.
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
}
func (response GenerateWalletResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateWalletResponse) String() string
GetPrivateEndpointRequest wrapper for the GetPrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GetPrivateEndpoint.go.html to see an example of how to use GetPrivateEndpointRequest.
type GetPrivateEndpointRequest struct {
// Oracle Sharded Database PrivateEndpoint identifier
PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request GetPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPrivateEndpointRequest) String() string
func (request GetPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPrivateEndpointResponse wrapper for the GetPrivateEndpoint operation
type GetPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivateEndpoint instance
PrivateEndpoint `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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPrivateEndpointResponse) String() string
GetShardedDatabaseRequest wrapper for the GetShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GetShardedDatabase.go.html to see an example of how to use GetShardedDatabaseRequest.
type GetShardedDatabaseRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO.
// An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
Metadata *string `mandatory:"false" contributesTo:"query" name:"metadata"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request GetShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetShardedDatabaseRequest) String() string
func (request GetShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetShardedDatabaseResponse wrapper for the GetShardedDatabase operation
type GetShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The ShardedDatabase instance
ShardedDatabase `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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetShardedDatabaseResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest 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"`
// 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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
GsmDetails Details of global service manager(GSM also known as shard director) instances for sharded database.
type GsmDetails struct {
// Name of the GSM instance
Name *string `mandatory:"true" json:"name"`
// The compute count for the GSM instance.
ComputeCount *float32 `mandatory:"true" json:"computeCount"`
// The data disk group size to be allocated in GBs.
DataStorageSizeInGbs *float64 `mandatory:"true" json:"dataStorageSizeInGbs"`
// The time the GSM instance was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the GSM instance was last updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Status of shard or catalog or gsm for the sharded database.
Status GsmDetailsStatusEnum `mandatory:"true" json:"status"`
// The time the ssl certificate associated with GSM expires. An RFC3339 formatted datetime string
TimeSslCertificateExpires *common.SDKTime `mandatory:"false" json:"timeSslCertificateExpires"`
// Identifier of the underlying supporting resource.
SupportingResourceId *string `mandatory:"false" json:"supportingResourceId"`
// Additional metadata related to GSM's underlying supporting resource.
Metadata map[string]interface{} `mandatory:"false" json:"metadata"`
}
func (m GsmDetails) String() string
func (m GsmDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GsmDetailsStatusEnum Enum with underlying type: string
type GsmDetailsStatusEnum string
Set of constants representing the allowable values for GsmDetailsStatusEnum
const (
GsmDetailsStatusFailed GsmDetailsStatusEnum = "FAILED"
GsmDetailsStatusDeleting GsmDetailsStatusEnum = "DELETING"
GsmDetailsStatusDeleted GsmDetailsStatusEnum = "DELETED"
GsmDetailsStatusUpdating GsmDetailsStatusEnum = "UPDATING"
GsmDetailsStatusCreating GsmDetailsStatusEnum = "CREATING"
GsmDetailsStatusCreated GsmDetailsStatusEnum = "CREATED"
GsmDetailsStatusReadyForConfiguration GsmDetailsStatusEnum = "READY_FOR_CONFIGURATION"
GsmDetailsStatusConfigured GsmDetailsStatusEnum = "CONFIGURED"
GsmDetailsStatusNeedsAttention GsmDetailsStatusEnum = "NEEDS_ATTENTION"
)
func GetGsmDetailsStatusEnumValues() []GsmDetailsStatusEnum
GetGsmDetailsStatusEnumValues Enumerates the set of values for GsmDetailsStatusEnum
func GetMappingGsmDetailsStatusEnum(val string) (GsmDetailsStatusEnum, bool)
GetMappingGsmDetailsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivateEndpointsRequest wrapper for the ListPrivateEndpoints operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListPrivateEndpoints.go.html to see an example of how to use ListPrivateEndpointsRequest.
type ListPrivateEndpointsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListPrivateEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListPrivateEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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
}
func (request ListPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPrivateEndpointsRequest) String() string
func (request ListPrivateEndpointsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPrivateEndpointsResponse wrapper for the ListPrivateEndpoints operation
type ListPrivateEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PrivateEndpointCollection instances
PrivateEndpointCollection `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"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPrivateEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPrivateEndpointsResponse) String() string
ListPrivateEndpointsSortByEnum Enum with underlying type: string
type ListPrivateEndpointsSortByEnum string
Set of constants representing the allowable values for ListPrivateEndpointsSortByEnum
const (
ListPrivateEndpointsSortByTimecreated ListPrivateEndpointsSortByEnum = "timeCreated"
ListPrivateEndpointsSortByTimeupdated ListPrivateEndpointsSortByEnum = "timeUpdated"
)
func GetListPrivateEndpointsSortByEnumValues() []ListPrivateEndpointsSortByEnum
GetListPrivateEndpointsSortByEnumValues Enumerates the set of values for ListPrivateEndpointsSortByEnum
func GetMappingListPrivateEndpointsSortByEnum(val string) (ListPrivateEndpointsSortByEnum, bool)
GetMappingListPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivateEndpointsSortOrderEnum Enum with underlying type: string
type ListPrivateEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListPrivateEndpointsSortOrderEnum
const (
ListPrivateEndpointsSortOrderAsc ListPrivateEndpointsSortOrderEnum = "ASC"
ListPrivateEndpointsSortOrderDesc ListPrivateEndpointsSortOrderEnum = "DESC"
)
func GetListPrivateEndpointsSortOrderEnumValues() []ListPrivateEndpointsSortOrderEnum
GetListPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListPrivateEndpointsSortOrderEnum
func GetMappingListPrivateEndpointsSortOrderEnum(val string) (ListPrivateEndpointsSortOrderEnum, bool)
GetMappingListPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListShardedDatabasesRequest wrapper for the ListShardedDatabases operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListShardedDatabases.go.html to see an example of how to use ListShardedDatabasesRequest.
type ListShardedDatabasesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ShardedDatabaseLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListShardedDatabasesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListShardedDatabasesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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
}
func (request ListShardedDatabasesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListShardedDatabasesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListShardedDatabasesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListShardedDatabasesRequest) String() string
func (request ListShardedDatabasesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListShardedDatabasesResponse wrapper for the ListShardedDatabases operation
type ListShardedDatabasesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ShardedDatabaseCollection instances
ShardedDatabaseCollection `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"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListShardedDatabasesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListShardedDatabasesResponse) String() string
ListShardedDatabasesSortByEnum Enum with underlying type: string
type ListShardedDatabasesSortByEnum string
Set of constants representing the allowable values for ListShardedDatabasesSortByEnum
const (
ListShardedDatabasesSortByTimecreated ListShardedDatabasesSortByEnum = "timeCreated"
ListShardedDatabasesSortByTimeupdated ListShardedDatabasesSortByEnum = "timeUpdated"
)
func GetListShardedDatabasesSortByEnumValues() []ListShardedDatabasesSortByEnum
GetListShardedDatabasesSortByEnumValues Enumerates the set of values for ListShardedDatabasesSortByEnum
func GetMappingListShardedDatabasesSortByEnum(val string) (ListShardedDatabasesSortByEnum, bool)
GetMappingListShardedDatabasesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListShardedDatabasesSortOrderEnum Enum with underlying type: string
type ListShardedDatabasesSortOrderEnum string
Set of constants representing the allowable values for ListShardedDatabasesSortOrderEnum
const (
ListShardedDatabasesSortOrderAsc ListShardedDatabasesSortOrderEnum = "ASC"
ListShardedDatabasesSortOrderDesc ListShardedDatabasesSortOrderEnum = "DESC"
)
func GetListShardedDatabasesSortOrderEnumValues() []ListShardedDatabasesSortOrderEnum
GetListShardedDatabasesSortOrderEnumValues Enumerates the set of values for ListShardedDatabasesSortOrderEnum
func GetMappingListShardedDatabasesSortOrderEnum(val string) (ListShardedDatabasesSortOrderEnum, bool)
GetMappingListShardedDatabasesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest 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"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest 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"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources their lifecycleState matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateShardedDatabase OperationTypeEnum = "CREATE_SHARDED_DATABASE"
OperationTypeDeleteShardedDatabase OperationTypeEnum = "DELETE_SHARDED_DATABASE"
OperationTypeUpdateShardedDatabase OperationTypeEnum = "UPDATE_SHARDED_DATABASE"
OperationTypeConfigureShardedDatabaseGsms OperationTypeEnum = "CONFIGURE_SHARDED_DATABASE_GSMS"
OperationTypeStartShardedDatabase OperationTypeEnum = "START_SHARDED_DATABASE"
OperationTypeStopShardedDatabase OperationTypeEnum = "STOP_SHARDED_DATABASE"
OperationTypeValidateNetwork OperationTypeEnum = "VALIDATE_NETWORK"
OperationTypeChangeShardedDbCompartment OperationTypeEnum = "CHANGE_SHARDED_DB_COMPARTMENT"
OperationTypeCreatePrivateEndpoint OperationTypeEnum = "CREATE_PRIVATE_ENDPOINT"
OperationTypeUpdatePrivateEndpoint OperationTypeEnum = "UPDATE_PRIVATE_ENDPOINT"
OperationTypeDeletePrivateEndpoint OperationTypeEnum = "DELETE_PRIVATE_ENDPOINT"
OperationTypeChangePrivateEndpointCompartment OperationTypeEnum = "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT"
OperationTypeInsertShards OperationTypeEnum = "INSERT_SHARDS"
OperationTypeRemoveShards OperationTypeEnum = "REMOVE_SHARDS"
OperationTypeMergeCatalogShards OperationTypeEnum = "MERGE_CATALOG_SHARDS"
OperationTypeUploadSignedCertAndGenerateWallet OperationTypeEnum = "UPLOAD_SIGNED_CERT_AND_GENERATE_WALLET"
OperationTypeGenerateGsmCertSigningReq OperationTypeEnum = "GENERATE_GSM_CERT_SIGNING_REQ"
OperationTypeConfigureSharding OperationTypeEnum = "CONFIGURE_SHARDING"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PatchInsertInstruction An operation that inserts a value into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.
type PatchInsertInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be inserted into the target.
Value *interface{} `mandatory:"true" json:"value"`
}
func (m PatchInsertInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchInsertInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchInsertInstruction) String() string
func (m PatchInsertInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchInstruction A single instruction to be included as part of Patch request content.
type PatchInstruction interface {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
GetSelection() *string
}
PatchInstructionOperationEnum Enum with underlying type: string
type PatchInstructionOperationEnum string
Set of constants representing the allowable values for PatchInstructionOperationEnum
const (
PatchInstructionOperationInsert PatchInstructionOperationEnum = "INSERT"
PatchInstructionOperationRemove PatchInstructionOperationEnum = "REMOVE"
PatchInstructionOperationMerge PatchInstructionOperationEnum = "MERGE"
)
func GetMappingPatchInstructionOperationEnum(val string) (PatchInstructionOperationEnum, bool)
GetMappingPatchInstructionOperationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchInstructionOperationEnumValues() []PatchInstructionOperationEnum
GetPatchInstructionOperationEnumValues Enumerates the set of values for PatchInstructionOperationEnum
PatchMergeInstruction An operation that recursively updates items of the selection, or adding the value if the selection is empty. If the value is not an object, it is used directly, otherwise each key-value member is used to create or update a member of the same name in the target and the same process is applied recursively for each object-typed value (similar to RFC 7396 (https://tools.ietf.org/html/rfc7396#section-2) JSON Merge Patch, except that null values are copied rather than transformed into deletions). NOT_FOUND exceptions are handled by creating the implied containing structure. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchMergeInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be merged into the target.
Value *interface{} `mandatory:"false" json:"value"`
}
func (m PatchMergeInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchMergeInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchMergeInstruction) String() string
func (m PatchMergeInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchRemoveInstruction An operation that deletes items, ignoring NOT_FOUND exceptions. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchRemoveInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
}
func (m PatchRemoveInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchRemoveInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchRemoveInstruction) String() string
func (m PatchRemoveInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchShardedDatabaseDetails Provide PatchInstuction(s) in items array. All instructions in items have to be of same type. All instructions in items have to either PatchInsertInstruction type, PatchRemoveInstruction or PatchMergeInstruction. Multiple instructions of different types is not allowed to be performed in single operation.
type PatchShardedDatabaseDetails struct {
// List of patch instructions.
Items []PatchInstruction `mandatory:"false" json:"items"`
}
func (m PatchShardedDatabaseDetails) String() string
func (m *PatchShardedDatabaseDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PatchShardedDatabaseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchShardedDatabaseRequest wrapper for the PatchShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/PatchShardedDatabase.go.html to see an example of how to use PatchShardedDatabaseRequest.
type PatchShardedDatabaseRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// The payload containing instructions to patch the sharded database.
PatchShardedDatabaseDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request PatchShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PatchShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PatchShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PatchShardedDatabaseRequest) String() string
func (request PatchShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchShardedDatabaseResponse wrapper for the PatchShardedDatabase operation
type PatchShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response PatchShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PatchShardedDatabaseResponse) String() string
PrevalidateCreatePayload Payload to prevalidate create sharded database operation.
type PrevalidateCreatePayload struct {
PrevalidatePayload CreateShardedDatabaseDetails `mandatory:"true" json:"prevalidatePayload"`
}
func (m PrevalidateCreatePayload) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PrevalidateCreatePayload) String() string
func (m *PrevalidateCreatePayload) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PrevalidateCreatePayload) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrevalidatePatchPayload Payload to prevalidate patch sharded database operation.
type PrevalidatePatchPayload struct {
PrevalidatePayload *PatchShardedDatabaseDetails `mandatory:"true" json:"prevalidatePayload"`
// Sharded database identifier
ShardedDatabaseId *string `mandatory:"true" json:"shardedDatabaseId"`
}
func (m PrevalidatePatchPayload) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PrevalidatePatchPayload) String() string
func (m PrevalidatePatchPayload) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrevalidatePayload Payload required to run prevalidation operation for create sharded database or patch sharded database, based on operation selected.
type PrevalidatePayload interface {
}
PrevalidatePayloadOperationEnum Enum with underlying type: string
type PrevalidatePayloadOperationEnum string
Set of constants representing the allowable values for PrevalidatePayloadOperationEnum
const (
PrevalidatePayloadOperationCreate PrevalidatePayloadOperationEnum = "CREATE"
PrevalidatePayloadOperationPatch PrevalidatePayloadOperationEnum = "PATCH"
)
func GetMappingPrevalidatePayloadOperationEnum(val string) (PrevalidatePayloadOperationEnum, bool)
GetMappingPrevalidatePayloadOperationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrevalidatePayloadOperationEnumValues() []PrevalidatePayloadOperationEnum
GetPrevalidatePayloadOperationEnumValues Enumerates the set of values for PrevalidatePayloadOperationEnum
PrevalidateShardedDatabaseDetails Input for prevalidate sharded database API to validate various operations payload.
type PrevalidateShardedDatabaseDetails struct {
PrevalidateShardedDatabaseDetails PrevalidatePayload `mandatory:"true" json:"prevalidateShardedDatabaseDetails"`
}
func (m PrevalidateShardedDatabaseDetails) String() string
func (m *PrevalidateShardedDatabaseDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PrevalidateShardedDatabaseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrevalidateShardedDatabaseRequest wrapper for the PrevalidateShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/PrevalidateShardedDatabase.go.html to see an example of how to use PrevalidateShardedDatabaseRequest.
type PrevalidateShardedDatabaseRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Request to pre-validate sharded database operation like CREATE, PATCH payload before executing them.
PrevalidateShardedDatabaseDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request PrevalidateShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PrevalidateShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PrevalidateShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PrevalidateShardedDatabaseRequest) String() string
func (request PrevalidateShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrevalidateShardedDatabaseResponse wrapper for the PrevalidateShardedDatabase operation
type PrevalidateShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrevalidateShardedDatabaseResult instance
PrevalidateShardedDatabaseResult `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"`
}
func (response PrevalidateShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PrevalidateShardedDatabaseResponse) String() string
PrevalidateShardedDatabaseResult Response of prevalidation api.
type PrevalidateShardedDatabaseResult struct {
// Prevalidation result based on input payload.
ValidationResult map[string]interface{} `mandatory:"true" json:"validationResult"`
}
func (m PrevalidateShardedDatabaseResult) String() string
func (m PrevalidateShardedDatabaseResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpoint PrivateEndpoint resource.
type PrivateEndpoint struct {
// The identifier of the Private Endpoint.
Id *string `mandatory:"true" json:"id"`
// Identifier of the compartment in which private endpoint exists.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Identifier of the subnet in which private endpoint exists.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Identifier of the VCN in which subnet exists.
VcnId *string `mandatory:"true" json:"vcnId"`
// PrivateEndpoint display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Lifecycle states for private endpoint.
LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// PrivateEndpoint description.
Description *string `mandatory:"false" json:"description"`
// IP address of the Private Endpoint.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The OCIDs of the network security groups that the private endpoint belongs to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCIDs of sharded databases that consumes the given private endpoint.
ShardedDatabases []string `mandatory:"false" json:"shardedDatabases"`
// Detailed message for the lifecycle state.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// 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"`
// 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"`
// 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"`
}
func (m PrivateEndpoint) String() string
func (m PrivateEndpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpointCollection Collection of private endpoints.
type PrivateEndpointCollection struct {
// Array of private endpoint summaries.
Items []PrivateEndpointSummary `mandatory:"true" json:"items"`
}
func (m PrivateEndpointCollection) String() string
func (m PrivateEndpointCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpointLifecycleStateEnum Enum with underlying type: string
type PrivateEndpointLifecycleStateEnum string
Set of constants representing the allowable values for PrivateEndpointLifecycleStateEnum
const (
PrivateEndpointLifecycleStateActive PrivateEndpointLifecycleStateEnum = "ACTIVE"
PrivateEndpointLifecycleStateFailed PrivateEndpointLifecycleStateEnum = "FAILED"
PrivateEndpointLifecycleStateInactive PrivateEndpointLifecycleStateEnum = "INACTIVE"
PrivateEndpointLifecycleStateDeleting PrivateEndpointLifecycleStateEnum = "DELETING"
PrivateEndpointLifecycleStateDeleted PrivateEndpointLifecycleStateEnum = "DELETED"
PrivateEndpointLifecycleStateUpdating PrivateEndpointLifecycleStateEnum = "UPDATING"
PrivateEndpointLifecycleStateCreating PrivateEndpointLifecycleStateEnum = "CREATING"
)
func GetMappingPrivateEndpointLifecycleStateEnum(val string) (PrivateEndpointLifecycleStateEnum, bool)
GetMappingPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrivateEndpointLifecycleStateEnumValues() []PrivateEndpointLifecycleStateEnum
GetPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for PrivateEndpointLifecycleStateEnum
PrivateEndpointSummary PrivateEndpoint resource summary.
type PrivateEndpointSummary struct {
// PrivateEndpoint identifier
Id *string `mandatory:"true" json:"id"`
// Identifier of the compartment where private endpoint exists.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Identifier of the customer subnet against which private endpoint is created.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Identifier of the VCN in which subnet exists.
VcnId *string `mandatory:"true" json:"vcnId"`
// Private endpoint display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The time the the private endpoint was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the private endpoint was last updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Lifecycle state of private endpoint.
LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// PrivateEndpoint description.
Description *string `mandatory:"false" json:"description"`
// The OCIDs of the network security groups that the private endpoint belongs to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Detailed message for the lifecycle state.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// 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"`
// 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"`
// 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"`
}
func (m PrivateEndpointSummary) String() string
func (m PrivateEndpointSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShardableCloudAutonomousVmClusterSummary Shardable cloud autonomous vm cluster summary.
type ShardableCloudAutonomousVmClusterSummary struct {
// Cloud autonomous vmcluster identifier
Id *string `mandatory:"true" json:"id"`
// Cloud autonomous vmcluster compartment id
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Lifecycle states for shardable Cloud autonomous vm cluster.
LifecycleState ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Cloud autonomous vmcluster displayName
DisplayName *string `mandatory:"true" json:"displayName"`
// Detailed message for the lifecycle state.
LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`
// The compute model of the Cloud Autonomous VM Cluster.
ComputeModel *string `mandatory:"false" json:"computeModel"`
// The number of Autonomous Container Databases that can be created with the currently available local storage.
AvailableContainerDatabases *int `mandatory:"false" json:"availableContainerDatabases"`
// CPU cores available for allocation to Autonomous Databases.
AvailableCpus *float32 `mandatory:"false" json:"availableCpus"`
// The name of the availability domain that the cloud Autonomous VM cluster is located in.
// The format of the availability domain is the same as returned by Cloud Autonomous VM Cluster API.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The data disk group size allocated for Autonomous Databases, in TBs.
AutonomousDataStorageSizeInTBs *float32 `mandatory:"false" json:"autonomousDataStorageSizeInTBs"`
// The data disk group size available for Autonomous Databases, in TBs.
AvailableAutonomousDataStorageSizeInTBs *float32 `mandatory:"false" json:"availableAutonomousDataStorageSizeInTBs"`
// Cloud Exadata Infrastructure Identifier.
CloudExadataInfrastructureId *string `mandatory:"false" json:"cloudExadataInfrastructureId"`
// The time zone of the Cloud Autonomous VM Cluster.
ClusterTimeZone *string `mandatory:"false" json:"clusterTimeZone"`
// The total number of Autonomous Container Databases that can be created with the allocated local storage.
TotalContainerDatabases *int `mandatory:"false" json:"totalContainerDatabases"`
// Cloud autonomous vmcluster subnet id
SubnetId *string `mandatory:"false" json:"subnetId"`
// Cloud autonomous vmcluster shape
Shape *string `mandatory:"false" json:"shape"`
// Cloud autonomous vmcluster node count
NodeCount *int `mandatory:"false" json:"nodeCount"`
// The Oracle license model that applies to the Oracle Autonomous Database.
LicenseModel *string `mandatory:"false" json:"licenseModel"`
// The memory allocated in GBs.
MemorySizeInGBs *int `mandatory:"false" json:"memorySizeInGBs"`
// The amount of memory (in GBs) enabled per OCPU or ECPU.
MemoryPerOracleComputeUnitInGBs *int `mandatory:"false" json:"memoryPerOracleComputeUnitInGBs"`
// The number of CPU cores on the cloud Autonomous VM cluster.
CpuCoreCount *int `mandatory:"false" json:"cpuCoreCount"`
// The number of CPU cores enabled per VM cluster node.
CpuCoreCountPerNode *int `mandatory:"false" json:"cpuCoreCountPerNode"`
// The number of CPU cores on the cloud Autonomous VM cluster.
OcpuCount *float32 `mandatory:"false" json:"ocpuCount"`
// The CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database.
ReclaimableCpus *float32 `mandatory:"false" json:"reclaimableCpus"`
// Number of Autonomous Container Databases that can be created in the Autonomous VM Cluster
ProvisionableAutonomousContainerDatabases *int `mandatory:"false" json:"provisionableAutonomousContainerDatabases"`
// 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"`
// 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"`
}
func (m ShardableCloudAutonomousVmClusterSummary) String() string
func (m ShardableCloudAutonomousVmClusterSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum Enum with underlying type: string
type ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum
const (
ShardableCloudAutonomousVmClusterSummaryLifecycleStateActive ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "ACTIVE"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateFailed ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "FAILED"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateNeedsAttention ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "NEEDS_ATTENTION"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateInactive ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "INACTIVE"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateDeleting ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "DELETING"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateDeleted ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "DELETED"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateUpdating ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "UPDATING"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateCreating ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "CREATING"
ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum = "UNAVAILABLE"
)
func GetMappingShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum(val string) (ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum, bool)
GetMappingShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetShardableCloudAutonomousVmClusterSummaryLifecycleStateEnumValues() []ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum
GetShardableCloudAutonomousVmClusterSummaryLifecycleStateEnumValues Enumerates the set of values for ShardableCloudAutonomousVmClusterSummaryLifecycleStateEnum
ShardableCloudAutonomousVmClusters Collection of shardable cloud autonomous vm clusters.
type ShardableCloudAutonomousVmClusters struct {
// Array of shardable cloud autonomous vm clusters summaries.
Items []ShardableCloudAutonomousVmClusterSummary `mandatory:"true" json:"items"`
}
func (m ShardableCloudAutonomousVmClusters) String() string
func (m ShardableCloudAutonomousVmClusters) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShardedDatabase Sharded Database resource.
type ShardedDatabase interface {
// Sharded Database identifier
GetId() *string
// Identifier of the compartment in which sharded database exists.
GetCompartmentId() *string
// Oracle sharded database display name.
GetDisplayName() *string
// The time the the Sharded Database was created. An RFC3339 formatted datetime string
GetTimeCreated() *common.SDKTime
// The time the Sharded Database was last updated. An RFC3339 formatted datetime string
GetTimeUpdated() *common.SDKTime
// Lifecycle states for sharded databases.
GetLifecycleState() ShardedDatabaseLifecycleStateEnum
// Detailed message for the lifecycle state.
GetLifecycleStateDetails() *string
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
GetSystemTags() map[string]map[string]interface{}
}
ShardedDatabaseCollection Collection of sharded databases.
type ShardedDatabaseCollection struct {
// Array of sharded databases summaries.
Items []ShardedDatabaseSummary `mandatory:"true" json:"items"`
}
func (m ShardedDatabaseCollection) String() string
func (m *ShardedDatabaseCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ShardedDatabaseCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShardedDatabaseDbDeploymentTypeEnum Enum with underlying type: string
type ShardedDatabaseDbDeploymentTypeEnum string
Set of constants representing the allowable values for ShardedDatabaseDbDeploymentTypeEnum
const (
ShardedDatabaseDbDeploymentTypeDedicated ShardedDatabaseDbDeploymentTypeEnum = "DEDICATED"
)
func GetMappingShardedDatabaseDbDeploymentTypeEnum(val string) (ShardedDatabaseDbDeploymentTypeEnum, bool)
GetMappingShardedDatabaseDbDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetShardedDatabaseDbDeploymentTypeEnumValues() []ShardedDatabaseDbDeploymentTypeEnum
GetShardedDatabaseDbDeploymentTypeEnumValues Enumerates the set of values for ShardedDatabaseDbDeploymentTypeEnum
ShardedDatabaseLifecycleStateEnum Enum with underlying type: string
type ShardedDatabaseLifecycleStateEnum string
Set of constants representing the allowable values for ShardedDatabaseLifecycleStateEnum
const (
ShardedDatabaseLifecycleStateActive ShardedDatabaseLifecycleStateEnum = "ACTIVE"
ShardedDatabaseLifecycleStateFailed ShardedDatabaseLifecycleStateEnum = "FAILED"
ShardedDatabaseLifecycleStateNeedsAttention ShardedDatabaseLifecycleStateEnum = "NEEDS_ATTENTION"
ShardedDatabaseLifecycleStateInactive ShardedDatabaseLifecycleStateEnum = "INACTIVE"
ShardedDatabaseLifecycleStateDeleting ShardedDatabaseLifecycleStateEnum = "DELETING"
ShardedDatabaseLifecycleStateDeleted ShardedDatabaseLifecycleStateEnum = "DELETED"
ShardedDatabaseLifecycleStateUpdating ShardedDatabaseLifecycleStateEnum = "UPDATING"
ShardedDatabaseLifecycleStateCreating ShardedDatabaseLifecycleStateEnum = "CREATING"
ShardedDatabaseLifecycleStateEnum = "UNAVAILABLE"
)
func GetMappingShardedDatabaseLifecycleStateEnum(val string) (ShardedDatabaseLifecycleStateEnum, bool)
GetMappingShardedDatabaseLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetShardedDatabaseLifecycleStateEnumValues() []ShardedDatabaseLifecycleStateEnum
GetShardedDatabaseLifecycleStateEnumValues Enumerates the set of values for ShardedDatabaseLifecycleStateEnum
ShardedDatabaseServiceClient a client for ShardedDatabaseService
type ShardedDatabaseServiceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewShardedDatabaseServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ShardedDatabaseServiceClient, err error)
NewShardedDatabaseServiceClientWithConfigurationProvider Creates a new default ShardedDatabaseService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewShardedDatabaseServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ShardedDatabaseServiceClient, err error)
NewShardedDatabaseServiceClientWithOboToken Creates a new default ShardedDatabaseService client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client ShardedDatabaseServiceClient) ChangePrivateEndpointCompartment(ctx context.Context, request ChangePrivateEndpointCompartmentRequest) (response ChangePrivateEndpointCompartmentResponse, err error)
ChangePrivateEndpointCompartment Move the private endpoint to the specified compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ChangePrivateEndpointCompartment.go.html to see an example of how to use ChangePrivateEndpointCompartment API. A default retry strategy applies to this operation ChangePrivateEndpointCompartment()
func (client ShardedDatabaseServiceClient) ChangeShardedDatabaseCompartment(ctx context.Context, request ChangeShardedDatabaseCompartmentRequest) (response ChangeShardedDatabaseCompartmentResponse, err error)
ChangeShardedDatabaseCompartment Move the sharded database database and its dependent resources to the specified compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ChangeShardedDatabaseCompartment.go.html to see an example of how to use ChangeShardedDatabaseCompartment API. A default retry strategy applies to this operation ChangeShardedDatabaseCompartment()
func (client *ShardedDatabaseServiceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ShardedDatabaseServiceClient) ConfigureShardedDatabaseGsms(ctx context.Context, request ConfigureShardedDatabaseGsmsRequest) (response ConfigureShardedDatabaseGsmsResponse, err error)
ConfigureShardedDatabaseGsms Configure new Global Service Manager(GSM aka shard manager) instances for the sharded database. Specify the names of old GSM instances that need to be replaced via parameter oldGsmNames in the request payload. Also specify whether rotated GSM instances shall be provisioned with latest image of GSM software or the image used by existing GSM instances shall be used.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ConfigureShardedDatabaseGsms.go.html to see an example of how to use ConfigureShardedDatabaseGsms API. A default retry strategy applies to this operation ConfigureShardedDatabaseGsms()
func (client ShardedDatabaseServiceClient) ConfigureSharding(ctx context.Context, request ConfigureShardingRequest) (response ConfigureShardingResponse, err error)
ConfigureSharding Once all components of sharded database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the sharded database. Note that this 'ConfigureSharding' API also needs to be invoked after successfully adding a new shard to the sharded database using PATCH api. If this API is not invoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology of the sharded database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ConfigureSharding.go.html to see an example of how to use ConfigureSharding API. A default retry strategy applies to this operation ConfigureSharding()
func (client ShardedDatabaseServiceClient) CreatePrivateEndpoint(ctx context.Context, request CreatePrivateEndpointRequest) (response CreatePrivateEndpointResponse, err error)
CreatePrivateEndpoint Creates a PrivateEndpoint.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/CreatePrivateEndpoint.go.html to see an example of how to use CreatePrivateEndpoint API. A default retry strategy applies to this operation CreatePrivateEndpoint()
func (client ShardedDatabaseServiceClient) CreateShardedDatabase(ctx context.Context, request CreateShardedDatabaseRequest) (response CreateShardedDatabaseResponse, err error)
CreateShardedDatabase Creates a Sharded Database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/CreateShardedDatabase.go.html to see an example of how to use CreateShardedDatabase API. A default retry strategy applies to this operation CreateShardedDatabase()
func (client ShardedDatabaseServiceClient) DeletePrivateEndpoint(ctx context.Context, request DeletePrivateEndpointRequest) (response DeletePrivateEndpointResponse, err error)
DeletePrivateEndpoint Delete the given private endpoint.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/DeletePrivateEndpoint.go.html to see an example of how to use DeletePrivateEndpoint API. A default retry strategy applies to this operation DeletePrivateEndpoint()
func (client ShardedDatabaseServiceClient) DeleteShardedDatabase(ctx context.Context, request DeleteShardedDatabaseRequest) (response DeleteShardedDatabaseResponse, err error)
DeleteShardedDatabase Terminate the given sharded databases.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/DeleteShardedDatabase.go.html to see an example of how to use DeleteShardedDatabase API. A default retry strategy applies to this operation DeleteShardedDatabase()
func (client ShardedDatabaseServiceClient) DownloadGsmCertificateSigningRequest(ctx context.Context, request DownloadGsmCertificateSigningRequestRequest) (response DownloadGsmCertificateSigningRequestResponse, err error)
DownloadGsmCertificateSigningRequest Generate the common certificate signing request for GSMs. Download the <sdb-prefix>.csr file from API response. Users can use this .csr file to generate the CA signed certificate, and as a next step use 'uploadSignedCertificateAndGenerateWallet' API to upload the CA signed certificate to GSM, and generate wallets for the GSM instances of the sharded database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/DownloadGsmCertificateSigningRequest.go.html to see an example of how to use DownloadGsmCertificateSigningRequest API. A default retry strategy applies to this operation DownloadGsmCertificateSigningRequest()
func (client ShardedDatabaseServiceClient) FetchConnectionString(ctx context.Context, request FetchConnectionStringRequest) (response FetchConnectionStringResponse, err error)
FetchConnectionString Gets the Sharded Database Connection Strings.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/FetchConnectionString.go.html to see an example of how to use FetchConnectionString API. A default retry strategy applies to this operation FetchConnectionString()
func (client ShardedDatabaseServiceClient) FetchShardableCloudAutonomousVmClusters(ctx context.Context, request FetchShardableCloudAutonomousVmClustersRequest) (response FetchShardableCloudAutonomousVmClustersResponse, err error)
FetchShardableCloudAutonomousVmClusters List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/FetchShardableCloudAutonomousVmClusters.go.html to see an example of how to use FetchShardableCloudAutonomousVmClusters API. A default retry strategy applies to this operation FetchShardableCloudAutonomousVmClusters()
func (client ShardedDatabaseServiceClient) GenerateGsmCertificateSigningRequest(ctx context.Context, request GenerateGsmCertificateSigningRequestRequest) (response GenerateGsmCertificateSigningRequestResponse, err error)
GenerateGsmCertificateSigningRequest Generate the certificate signing request for GSM instances of the sharded database. Once certificate signing request is generated, then customers can download the certificate signing request using 'downloadGsmCertificateSigningRequest' api call.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GenerateGsmCertificateSigningRequest.go.html to see an example of how to use GenerateGsmCertificateSigningRequest API. A default retry strategy applies to this operation GenerateGsmCertificateSigningRequest()
func (client ShardedDatabaseServiceClient) GenerateWallet(ctx context.Context, request GenerateWalletRequest) (response GenerateWalletResponse, err error)
GenerateWallet Generate the wallet associated with sharded database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GenerateWallet.go.html to see an example of how to use GenerateWallet API. A default retry strategy applies to this operation GenerateWallet()
func (client ShardedDatabaseServiceClient) GetPrivateEndpoint(ctx context.Context, request GetPrivateEndpointRequest) (response GetPrivateEndpointResponse, err error)
GetPrivateEndpoint Get the PrivateEndpoint resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GetPrivateEndpoint.go.html to see an example of how to use GetPrivateEndpoint API. A default retry strategy applies to this operation GetPrivateEndpoint()
func (client ShardedDatabaseServiceClient) GetShardedDatabase(ctx context.Context, request GetShardedDatabaseRequest) (response GetShardedDatabaseResponse, err error)
GetShardedDatabase Gets the details of the Sharded database identified by given id.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GetShardedDatabase.go.html to see an example of how to use GetShardedDatabase API. A default retry strategy applies to this operation GetShardedDatabase()
func (client ShardedDatabaseServiceClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets details of the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client ShardedDatabaseServiceClient) ListPrivateEndpoints(ctx context.Context, request ListPrivateEndpointsRequest) (response ListPrivateEndpointsResponse, err error)
ListPrivateEndpoints List of PrivateEndpoints.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListPrivateEndpoints.go.html to see an example of how to use ListPrivateEndpoints API. A default retry strategy applies to this operation ListPrivateEndpoints()
func (client ShardedDatabaseServiceClient) ListShardedDatabases(ctx context.Context, request ListShardedDatabasesRequest) (response ListShardedDatabasesResponse, err error)
ListShardedDatabases List of Sharded databases.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListShardedDatabases.go.html to see an example of how to use ListShardedDatabases API. A default retry strategy applies to this operation ListShardedDatabases()
func (client ShardedDatabaseServiceClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client ShardedDatabaseServiceClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client ShardedDatabaseServiceClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client ShardedDatabaseServiceClient) PatchShardedDatabase(ctx context.Context, request PatchShardedDatabaseRequest) (response PatchShardedDatabaseResponse, err error)
PatchShardedDatabase Patch operation to add, remove or update shards to the sharded database topology. In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/PatchShardedDatabase.go.html to see an example of how to use PatchShardedDatabase API. A default retry strategy applies to this operation PatchShardedDatabase()
func (client ShardedDatabaseServiceClient) PrevalidateShardedDatabase(ctx context.Context, request PrevalidateShardedDatabaseRequest) (response PrevalidateShardedDatabaseResponse, err error)
PrevalidateShardedDatabase Sharded database pre-validation request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/PrevalidateShardedDatabase.go.html to see an example of how to use PrevalidateShardedDatabase API. A default retry strategy applies to this operation PrevalidateShardedDatabase()
func (client *ShardedDatabaseServiceClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ShardedDatabaseServiceClient) StartShardedDatabase(ctx context.Context, request StartShardedDatabaseRequest) (response StartShardedDatabaseResponse, err error)
StartShardedDatabase Start the shards, catalog and GSMs of Sharded Database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/StartShardedDatabase.go.html to see an example of how to use StartShardedDatabase API. A default retry strategy applies to this operation StartShardedDatabase()
func (client ShardedDatabaseServiceClient) StopShardedDatabase(ctx context.Context, request StopShardedDatabaseRequest) (response StopShardedDatabaseResponse, err error)
StopShardedDatabase Stop the shards, catalog and GSM instances for the sharded database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/StopShardedDatabase.go.html to see an example of how to use StopShardedDatabase API. A default retry strategy applies to this operation StopShardedDatabase()
func (client ShardedDatabaseServiceClient) UpdatePrivateEndpoint(ctx context.Context, request UpdatePrivateEndpointRequest) (response UpdatePrivateEndpointResponse, err error)
UpdatePrivateEndpoint Updates the configuration of privateendpoint.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/UpdatePrivateEndpoint.go.html to see an example of how to use UpdatePrivateEndpoint API. A default retry strategy applies to this operation UpdatePrivateEndpoint()
func (client ShardedDatabaseServiceClient) UpdateShardedDatabase(ctx context.Context, request UpdateShardedDatabaseRequest) (response UpdateShardedDatabaseResponse, err error)
UpdateShardedDatabase Updates the configuration of sharded database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/UpdateShardedDatabase.go.html to see an example of how to use UpdateShardedDatabase API. A default retry strategy applies to this operation UpdateShardedDatabase()
func (client ShardedDatabaseServiceClient) UploadSignedCertificateAndGenerateWallet(ctx context.Context, request UploadSignedCertificateAndGenerateWalletRequest) (response UploadSignedCertificateAndGenerateWalletResponse, err error)
UploadSignedCertificateAndGenerateWallet Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the sharded database. Customer shall provide the CA signed certificate key details by adding the certificate in request body.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/UploadSignedCertificateAndGenerateWallet.go.html to see an example of how to use UploadSignedCertificateAndGenerateWallet API. A default retry strategy applies to this operation UploadSignedCertificateAndGenerateWallet()
func (client ShardedDatabaseServiceClient) ValidateNetwork(ctx context.Context, request ValidateNetworkRequest) (response ValidateNetworkResponse, err error)
ValidateNetwork Validate the network connectivity between components of sharded database.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ValidateNetwork.go.html to see an example of how to use ValidateNetwork API. A default retry strategy applies to this operation ValidateNetwork()
ShardedDatabaseSummary Sharded Database resource summary.
type ShardedDatabaseSummary interface {
// Sharded Database identifier
GetId() *string
// Identifier of the compartment where sharded database exists.
GetCompartmentId() *string
// Oracle sharded database display name.
GetDisplayName() *string
// The time the the Sharded Database was created. An RFC3339 formatted datetime string
GetTimeCreated() *common.SDKTime
// The time the Sharded Database was last updated. An RFC3339 formatted datetime string
GetTimeUpdated() *common.SDKTime
// Lifecycle state of sharded database.
GetLifecycleState() ShardedDatabaseLifecycleStateEnum
// Detailed message for the lifecycle state.
GetLifecycleStateDetails() *string
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
GetSystemTags() map[string]map[string]interface{}
}
ShardedDatabaseSummaryDbDeploymentTypeEnum Enum with underlying type: string
type ShardedDatabaseSummaryDbDeploymentTypeEnum string
Set of constants representing the allowable values for ShardedDatabaseSummaryDbDeploymentTypeEnum
const (
ShardedDatabaseSummaryDbDeploymentTypeDedicated ShardedDatabaseSummaryDbDeploymentTypeEnum = "DEDICATED"
)
func GetMappingShardedDatabaseSummaryDbDeploymentTypeEnum(val string) (ShardedDatabaseSummaryDbDeploymentTypeEnum, bool)
GetMappingShardedDatabaseSummaryDbDeploymentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetShardedDatabaseSummaryDbDeploymentTypeEnumValues() []ShardedDatabaseSummaryDbDeploymentTypeEnum
GetShardedDatabaseSummaryDbDeploymentTypeEnumValues Enumerates the set of values for ShardedDatabaseSummaryDbDeploymentTypeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StartShardedDatabaseRequest wrapper for the StartShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/StartShardedDatabase.go.html to see an example of how to use StartShardedDatabaseRequest.
type StartShardedDatabaseRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request StartShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartShardedDatabaseRequest) String() string
func (request StartShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartShardedDatabaseResponse wrapper for the StartShardedDatabase operation
type StartShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response StartShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartShardedDatabaseResponse) String() string
StopShardedDatabaseRequest wrapper for the StopShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/StopShardedDatabase.go.html to see an example of how to use StopShardedDatabaseRequest.
type StopShardedDatabaseRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request StopShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopShardedDatabaseRequest) String() string
func (request StopShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopShardedDatabaseResponse wrapper for the StopShardedDatabase operation
type StopShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response StopShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopShardedDatabaseResponse) String() string
UpdatePrivateEndpointDetails The details of private endpoint to be updated.
type UpdatePrivateEndpointDetails struct {
// Display name for PrivateEndpoint
DisplayName *string `mandatory:"false" json:"displayName"`
// PrivateEndpoint description.
Description *string `mandatory:"false" json:"description"`
// The OCIDs of the network security groups that the private endpoint belongs to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// 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"`
// 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"`
}
func (m UpdatePrivateEndpointDetails) String() string
func (m UpdatePrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePrivateEndpointRequest wrapper for the UpdatePrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/UpdatePrivateEndpoint.go.html to see an example of how to use UpdatePrivateEndpointRequest.
type UpdatePrivateEndpointRequest struct {
// Oracle Sharded Database PrivateEndpoint identifier
PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`
// The configuration of private endpoint to be updated.
UpdatePrivateEndpointDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request UpdatePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePrivateEndpointRequest) String() string
func (request UpdatePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePrivateEndpointResponse wrapper for the UpdatePrivateEndpoint operation
type UpdatePrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivateEndpoint instance
PrivateEndpoint `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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdatePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePrivateEndpointResponse) String() string
UpdateShardedDatabaseDetails The details of sharded database to be updated.
type UpdateShardedDatabaseDetails struct {
// Display name of the sharded database.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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"`
// 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"`
}
func (m UpdateShardedDatabaseDetails) String() string
func (m UpdateShardedDatabaseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateShardedDatabaseRequest wrapper for the UpdateShardedDatabase operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/UpdateShardedDatabase.go.html to see an example of how to use UpdateShardedDatabaseRequest.
type UpdateShardedDatabaseRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// The configuration of Sharded database to be updated.
UpdateShardedDatabaseDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
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
}
func (request UpdateShardedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateShardedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateShardedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateShardedDatabaseRequest) String() string
func (request UpdateShardedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateShardedDatabaseResponse wrapper for the UpdateShardedDatabase operation
type UpdateShardedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The ShardedDatabase instance
ShardedDatabase `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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateShardedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateShardedDatabaseResponse) String() string
UploadSignedCertificateAndGenerateWalletDetails Details of the request to upload the CA signed certificates to GSMs and generate wallets for GSMs of the sharded database.
type UploadSignedCertificateAndGenerateWalletDetails struct {
// The CA signed certificate key..
CaSignedCertificate *string `mandatory:"true" json:"caSignedCertificate"`
}
func (m UploadSignedCertificateAndGenerateWalletDetails) String() string
func (m UploadSignedCertificateAndGenerateWalletDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UploadSignedCertificateAndGenerateWalletRequest wrapper for the UploadSignedCertificateAndGenerateWallet operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/UploadSignedCertificateAndGenerateWallet.go.html to see an example of how to use UploadSignedCertificateAndGenerateWalletRequest.
type UploadSignedCertificateAndGenerateWalletRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// Details required to upload the CA signed certificates to GSM instances of sharded database and generate
// the wallets.
UploadSignedCertificateAndGenerateWalletDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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.
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
}
func (request UploadSignedCertificateAndGenerateWalletRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UploadSignedCertificateAndGenerateWalletRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UploadSignedCertificateAndGenerateWalletRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UploadSignedCertificateAndGenerateWalletRequest) String() string
func (request UploadSignedCertificateAndGenerateWalletRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UploadSignedCertificateAndGenerateWalletResponse wrapper for the UploadSignedCertificateAndGenerateWallet operation
type UploadSignedCertificateAndGenerateWalletResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response UploadSignedCertificateAndGenerateWalletResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UploadSignedCertificateAndGenerateWalletResponse) String() string
ValidateNetworkRequest wrapper for the ValidateNetwork operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/globallydistributeddatabase/ValidateNetwork.go.html to see an example of how to use ValidateNetworkRequest.
type ValidateNetworkRequest struct {
// Sharded Database identifier
ShardedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"shardedDatabaseId"`
// Determines the surrogates check. Default is true.
IsSurrogate *bool `mandatory:"false" contributesTo:"query" name:"isSurrogate"`
// Specify the name of shard or catalog.
ResourceName *string `mandatory:"false" contributesTo:"query" name:"resourceName"`
// Determines if the given resource name is for primary or not.
IsPrimary *bool `mandatory:"false" contributesTo:"query" name:"isPrimary"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
}
func (request ValidateNetworkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ValidateNetworkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ValidateNetworkRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ValidateNetworkRequest) String() string
func (request ValidateNetworkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ValidateNetworkResponse wrapper for the ValidateNetwork operation
type ValidateNetworkResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ValidateNetworkResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ValidateNetworkResponse) String() string
WorkRequest A description of workrequest status
type WorkRequest struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata
EntityUri *string `mandatory:"false" json:"entityUri"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly