func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAutoTieringEnumStringValues() []string
GetAutoTieringEnumStringValues Enumerates the set of values in String for AutoTieringEnum
func GetClusterTypeEnumStringValues() []string
GetClusterTypeEnumStringValues Enumerates the set of values in String for ClusterTypeEnum
func GetDbWorkloadEnumStringValues() []string
GetDbWorkloadEnumStringValues Enumerates the set of values in String for DbWorkloadEnum
func GetListStacksSortByEnumStringValues() []string
GetListStacksSortByEnumStringValues Enumerates the set of values in String for ListStacksSortByEnum
func GetListStacksSortOrderEnumStringValues() []string
GetListStacksSortOrderEnumStringValues Enumerates the set of values in String for ListStacksSortOrderEnum
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 GetObjectVersioningEnumStringValues() []string
GetObjectVersioningEnumStringValues Enumerates the set of values in String for ObjectVersioningEnum
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 GetServiceEnumStringValues() []string
GetServiceEnumStringValues Enumerates the set of values in String for ServiceEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetStackLifecycleStateEnumStringValues() []string
GetStackLifecycleStateEnumStringValues Enumerates the set of values in String for StackLifecycleStateEnum
func GetStackTemplateEnumStringValues() []string
GetStackTemplateEnumStringValues Enumerates the set of values in String for StackTemplateEnum
func GetStorageTierEnumStringValues() []string
GetStorageTierEnumStringValues Enumerates the set of values in String for StorageTierEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
func GetWorkflowActionEnumStringValues() []string
GetWorkflowActionEnumStringValues Enumerates the set of values in String for WorkflowActionEnum
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
AdbArtifactsDetail ADW details to upload artifacts.
type AdbArtifactsDetail struct {
// Instance id of the existing ADB instance.
InstanceId *string `mandatory:"true" json:"instanceId"`
// Object storage path for the artifacts.
ArtifactObjectStoragePath *string `mandatory:"true" json:"artifactObjectStoragePath"`
// DB credential details.
DbCredentials []DbCredentialsDetail `mandatory:"false" json:"dbCredentials"`
}
func (m AdbArtifactsDetail) String() string
func (m AdbArtifactsDetail) 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
AdbDetail Details to create an Oracle Autonomous Database.
type AdbDetail struct {
// Id for the adw instance.
InstanceId *string `mandatory:"true" json:"instanceId"`
// DB Workload to be used with ADB. Accepted values are OLTP, DW.
DbWorkload DbWorkloadEnum `mandatory:"true" json:"dbWorkload"`
// The compute amount (ECPUs) available to the database.
Ecpu *int `mandatory:"true" json:"ecpu"`
// The size, in terabytes, of the data volume that will be created and attached to the database.
DataStorageSizeInTBs *int `mandatory:"true" json:"dataStorageSizeInTBs"`
// The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID for admin password.
AdminPasswordId *string `mandatory:"true" json:"adminPasswordId"`
// A valid Oracle Database version for Autonomous Database.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// Specifies if the Autonomous Database requires mTLS connections.
IsMtlsConnectionRequired *bool `mandatory:"false" json:"isMtlsConnectionRequired"`
// The OCID of the subnet the Autonomous Database is associated with.
SubnetId *string `mandatory:"false" json:"subnetId"`
// This is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Allowed only when subnetId is provided (private ADB).
ToolsPublicAccess *string `mandatory:"false" json:"toolsPublicAccess"`
// If true then subnetId should not be provided.
IsPublic *bool `mandatory:"false" json:"isPublic"`
}
func (m AdbDetail) String() string
func (m AdbDetail) 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
AdbUpdateDetail Details to update an Oracle Autonomous Database.
type AdbUpdateDetail struct {
// Id of the existing ADB instance.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The compute amount (ECPUs) available to the database.
Ecpu *int `mandatory:"false" json:"ecpu"`
// The size, in terabytes, of the data volume that will be created and attached to the database.
DataStorageSizeInTBs *int `mandatory:"false" json:"dataStorageSizeInTBs"`
// Specifies if the Autonomous Database requires mTLS connections.
IsMtlsConnectionRequired *bool `mandatory:"false" json:"isMtlsConnectionRequired"`
}
func (m AdbUpdateDetail) String() string
func (m AdbUpdateDetail) 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
AddServiceDetails The configuration details for adding new services to the existing Stack.
type AddServiceDetails struct {
// List of templates to be added for the stack.
StackTemplates []StackTemplateEnum `mandatory:"true" json:"stackTemplates"`
// List of services to be added for the stack.
Services []ServiceEnum `mandatory:"true" json:"services"`
// ADB details if adb is included in the services to be added.
Adb []AdbDetail `mandatory:"false" json:"adb"`
// GGCS details if ggcs is included in the services to be added.
Ggcs []GgcsDetail `mandatory:"false" json:"ggcs"`
// DATAFLOW details if dataflow is included in the services to be added.
Dataflow []DataflowDetail `mandatory:"false" json:"dataflow"`
// Object Storage Details if object storage is included in services to be added.
Objectstorage []ObjectStorageDetail `mandatory:"false" json:"objectstorage"`
// GenAI Details if genai is included in services to be added.
Genai []GenAiDetail `mandatory:"false" json:"genai"`
}
func (m AddServiceDetails) String() string
func (m AddServiceDetails) 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
AddServiceRequest wrapper for the AddService operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/AddService.go.html to see an example of how to use AddServiceRequest.
type AddServiceRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
StackId *string `mandatory:"true" contributesTo:"path" name:"stackId"`
// The information to be updated.
AddServiceDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 AddServiceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddServiceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddServiceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddServiceRequest) String() string
func (request AddServiceRequest) 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
AddServiceResponse wrapper for the AddService operation
type AddServiceResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 AddServiceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddServiceResponse) String() string
AdditionalDetails Additional details about the provisioned services
type AdditionalDetails struct {
// connections assigned to Golden Gate deployment
AssignedConnections []AssignedConnectionDetails `mandatory:"false" json:"assignedConnections"`
// OCID of model
ModelId *string `mandatory:"false" json:"modelId"`
// version of model
ModelVersion *string `mandatory:"false" json:"modelVersion"`
// region of cluster
OciRegion *string `mandatory:"false" json:"ociRegion"`
// details of all endpoints assigned to cluster
EndpointDetails []EndpointAdditional `mandatory:"false" json:"endpointDetails"`
// OCID of model
PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`
}
func (m AdditionalDetails) String() string
func (m AdditionalDetails) 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
AssignedConnectionDetails Details to about assigned connections.
type AssignedConnectionDetails struct {
// Name of the connection.
ConnectionName *string `mandatory:"false" json:"connectionName"`
// OCID of the connection.
ConnectionId *string `mandatory:"false" json:"connectionId"`
// Specifies who has made this connection.
RequestedBy *string `mandatory:"false" json:"requestedBy"`
}
func (m AssignedConnectionDetails) String() string
func (m AssignedConnectionDetails) 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
AutoTieringEnum Enum with underlying type: string
type AutoTieringEnum string
Set of constants representing the allowable values for AutoTieringEnum
const (
AutoTieringDisabled AutoTieringEnum = "DISABLED"
AutoTieringInfrequentaccess AutoTieringEnum = "INFREQUENTACCESS"
)
func GetAutoTieringEnumValues() []AutoTieringEnum
GetAutoTieringEnumValues Enumerates the set of values for AutoTieringEnum
func GetMappingAutoTieringEnum(val string) (AutoTieringEnum, bool)
GetMappingAutoTieringEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) 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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeStackCompartmentDetails The configuration details for moving stack and associated services in stack to a different compartment.
type ChangeStackCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Stack to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeStackCompartmentDetails) String() string
func (m ChangeStackCompartmentDetails) 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
ChangeStackCompartmentRequest wrapper for the ChangeStackCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ChangeStackCompartment.go.html to see an example of how to use ChangeStackCompartmentRequest.
type ChangeStackCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
StackId *string `mandatory:"true" contributesTo:"path" name:"stackId"`
// The information to be updated.
ChangeStackCompartmentDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ChangeStackCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeStackCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeStackCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeStackCompartmentRequest) String() string
func (request ChangeStackCompartmentRequest) 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
ChangeStackCompartmentResponse wrapper for the ChangeStackCompartment operation
type ChangeStackCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ChangeStackCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeStackCompartmentResponse) String() string
ClusterTypeEnum Enum with underlying type: string
type ClusterTypeEnum string
Set of constants representing the allowable values for ClusterTypeEnum
const (
ClusterTypeHosting ClusterTypeEnum = "HOSTING"
)
func GetClusterTypeEnumValues() []ClusterTypeEnum
GetClusterTypeEnumValues Enumerates the set of values for ClusterTypeEnum
func GetMappingClusterTypeEnum(val string) (ClusterTypeEnum, bool)
GetMappingClusterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateStackDetails Details to create a Stack.
type CreateStackDetails struct {
// A user-friendly name. Should be unique per compartment. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the Stack in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// List of templates to be onboarded for the stack.
StackTemplates []StackTemplateEnum `mandatory:"true" json:"stackTemplates"`
// List of services to be onboarded for the stack.
Services []ServiceEnum `mandatory:"true" json:"services"`
// email id to which the stack notifications would be sent.
NotificationEmail *string `mandatory:"false" json:"notificationEmail"`
// ADB details if adb is included in the services.
Adb []AdbDetail `mandatory:"false" json:"adb"`
// GGCS details if ggcs is included in the services.
Ggcs []GgcsDetail `mandatory:"false" json:"ggcs"`
// DATAFLOW details if dataflow is included in the services.
Dataflow []DataflowDetail `mandatory:"false" json:"dataflow"`
// Object Storage Details if object storage is included in services.
Objectstorage []ObjectStorageDetail `mandatory:"false" json:"objectstorage"`
// GenAi Details if genai is included in services.
Genai []GenAiDetail `mandatory:"false" json:"genai"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateStackDetails) String() string
func (m CreateStackDetails) 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
CreateStackRequest wrapper for the CreateStack operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/CreateStack.go.html to see an example of how to use CreateStackRequest.
type CreateStackRequest struct {
// Details for the new Stack.
CreateStackDetails `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 running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreateStackRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateStackRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateStackRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateStackRequest) String() string
func (request CreateStackRequest) 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
CreateStackResponse wrapper for the CreateStack operation
type CreateStackResponse struct {
// The underlying http response
RawResponse *http.Response
// The Stack instance
Stack `presentIn:"body"`
// URL for the created Stack. The Stack OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 CreateStackResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateStackResponse) String() string
DataflowArtifactsDetail Detail to deploy Artifacts for Dataflow service.
type DataflowArtifactsDetail struct {
// Instance id of the existing Dataflow Instance for artifact deployment.
InstanceId *string `mandatory:"true" json:"instanceId"`
// Contains the main file (py/jar) along with parameters & configuration to be passed to the DataFlow run.
Execute *string `mandatory:"true" json:"execute"`
// Contains the archive from object storage bucket which can be added as dependency to data flow application.
ArchiveUri *string `mandatory:"false" json:"archiveUri"`
}
func (m DataflowArtifactsDetail) String() string
func (m DataflowArtifactsDetail) 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
DataflowConnectionDetails Details of services to create private endpoint.
type DataflowConnectionDetails struct {
// List of DIF Service Dependency Details to create private endpoint.
DifDependencies []DifDependencyDetails `mandatory:"false" json:"difDependencies"`
// An array of DNS zone names.
DomainNames []string `mandatory:"false" json:"domainNames"`
}
func (m DataflowConnectionDetails) String() string
func (m DataflowConnectionDetails) 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
DataflowConnections Details for connections to other services from Dataflow.
type DataflowConnections struct {
// OCID of the private subnet
SubnetId *string `mandatory:"true" json:"subnetId"`
ConnectionDetails *DataflowConnectionDetails `mandatory:"true" json:"connectionDetails"`
}
func (m DataflowConnections) String() string
func (m DataflowConnections) 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
DataflowDetail Details to create an OCI Dataflow resources.
type DataflowDetail struct {
// Id for dataflow instance
InstanceId *string `mandatory:"true" json:"instanceId"`
// The Spark version utilized to run the application.
SparkVersion *string `mandatory:"true" json:"sparkVersion"`
// The VM shape for the driver. Sets the driver cores and memory.
DriverShape *string `mandatory:"true" json:"driverShape"`
// The VM shape for the executors. Sets the executor cores and memory.
ExecutorShape *string `mandatory:"true" json:"executorShape"`
// The number of executor VMs requested.
NumExecutors *int `mandatory:"true" json:"numExecutors"`
// InstanceId of log bucket created as part of objectstorage service in stack. Used for storing application run logs.
LogBucketInstanceId *string `mandatory:"true" json:"logBucketInstanceId"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// OCID of the already provisioned dataflow private endpoint.
PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`
Connections *DataflowConnections `mandatory:"false" json:"connections"`
// InstanceId of warehouse bucket created as part of objectstorage service in stack. Mandatory for SQL applications.
WarehouseBucketInstanceId *string `mandatory:"false" json:"warehouseBucketInstanceId"`
}
func (m DataflowDetail) String() string
func (m DataflowDetail) 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
DataflowUpdateDetail Details of the existing dataflow instance to be updated.
type DataflowUpdateDetail struct {
// Instance id of the existing dataflow instance to be updated.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The Spark version utilized to run the application.
SparkVersion *string `mandatory:"false" json:"sparkVersion"`
// The VM shape for the driver. Sets the driver cores and memory.
DriverShape *string `mandatory:"false" json:"driverShape"`
// The VM shape for the executors. Sets the executor cores and memory.
ExecutorShape *string `mandatory:"false" json:"executorShape"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// The number of executor VMs requested.
NumExecutors *int `mandatory:"false" json:"numExecutors"`
// OCID of the already provisioned dataflow private endpoint.
PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`
Connections *UpdateDataflowConnections `mandatory:"false" json:"connections"`
// InstanceId of log bucket created as part of objectstorage service in stack. Used for storing application run logs.
LogBucketInstanceId *string `mandatory:"false" json:"logBucketInstanceId"`
// InstanceId of warehouse bucket created as part of objectstorage service in stack. Mandatory for SQL applications.
WarehouseBucketInstanceId *string `mandatory:"false" json:"warehouseBucketInstanceId"`
}
func (m DataflowUpdateDetail) String() string
func (m DataflowUpdateDetail) 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
DbCredentialsDetail DB credentials for ADB connection.
type DbCredentialsDetail struct {
// Username for ADB to be created or updated.
UserName *string `mandatory:"true" json:"userName"`
// Vault secret OCID containing the corresponding user password.
SecretId *string `mandatory:"true" json:"secretId"`
// Type of the user. Allowed values are "ADMIN" or "CUSTOM" or "GGCS".
UserType *string `mandatory:"true" json:"userType"`
}
func (m DbCredentialsDetail) String() string
func (m DbCredentialsDetail) 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
DbWorkloadEnum Enum with underlying type: string
type DbWorkloadEnum string
Set of constants representing the allowable values for DbWorkloadEnum
const (
DbWorkloadOltp DbWorkloadEnum = "OLTP"
DbWorkloadDw DbWorkloadEnum = "DW"
)
func GetDbWorkloadEnumValues() []DbWorkloadEnum
GetDbWorkloadEnumValues Enumerates the set of values for DbWorkloadEnum
func GetMappingDbWorkloadEnum(val string) (DbWorkloadEnum, bool)
GetMappingDbWorkloadEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteStackRequest wrapper for the DeleteStack operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/DeleteStack.go.html to see an example of how to use DeleteStackRequest.
type DeleteStackRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
StackId *string `mandatory:"true" contributesTo:"path" name:"stackId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeleteStackRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteStackRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteStackRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteStackRequest) String() string
func (request DeleteStackRequest) 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
DeleteStackResponse wrapper for the DeleteStack operation
type DeleteStackResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 DeleteStackResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteStackResponse) String() string
DeployArtifactsDetails The data to create a DataIntelligence.
type DeployArtifactsDetails struct {
// List of templates to be onboarded for the stack.
StackTemplates []StackTemplateEnum `mandatory:"true" json:"stackTemplates"`
// List of services to be onboarded for the stack.
Services []ServiceEnum `mandatory:"true" json:"services"`
// Subnet id for the Private Endpoint creation for artifact deployment.
SubnetId *string `mandatory:"false" json:"subnetId"`
// ADB artifact details if adb is included in the services.
Adb []AdbArtifactsDetail `mandatory:"false" json:"adb"`
// GGCS artifact details if ggcs is included in the services.
Ggcs []GgcsArtifactsDetail `mandatory:"false" json:"ggcs"`
// Dataflow artifact details if dataflow is included in the services.
Dataflow []DataflowArtifactsDetail `mandatory:"false" json:"dataflow"`
}
func (m DeployArtifactsDetails) String() string
func (m DeployArtifactsDetails) 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
DeployArtifactsRequest wrapper for the DeployArtifacts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/DeployArtifacts.go.html to see an example of how to use DeployArtifactsRequest.
type DeployArtifactsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
StackId *string `mandatory:"true" contributesTo:"path" name:"stackId"`
// The artifact information to be deployed.
DeployArtifactsDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 running 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 removed 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 DeployArtifactsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeployArtifactsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeployArtifactsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeployArtifactsRequest) String() string
func (request DeployArtifactsRequest) 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
DeployArtifactsResponse wrapper for the DeployArtifacts operation
type DeployArtifactsResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 DeployArtifactsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeployArtifactsResponse) String() string
DifDependencyDetails DIF Service Dependency Details.
type DifDependencyDetails struct {
// Supported service name.
ServiceType *string `mandatory:"true" json:"serviceType"`
// InstanceId of service which is part of the Stack.
ServiceInstanceId *string `mandatory:"true" json:"serviceInstanceId"`
}
func (m DifDependencyDetails) String() string
func (m DifDependencyDetails) 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
EndpointAdditional Details of provisioned endpoint.
type EndpointAdditional struct {
// Identifier for each endpoint.
EndpointName *string `mandatory:"false" json:"endpointName"`
// OCID of the endpoint.
EndpointId *string `mandatory:"false" json:"endpointId"`
}
func (m EndpointAdditional) String() string
func (m EndpointAdditional) 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
EndpointDetails Details to provision Endpoint for the GenAi dedicated cluster.
type EndpointDetails struct {
// Identifier for each endpoint.
EndpointName *string `mandatory:"true" json:"endpointName"`
// Helps remove toxic and biased content from responses.
IsContentModerationEnabled *bool `mandatory:"true" json:"isContentModerationEnabled"`
}
func (m EndpointDetails) String() string
func (m EndpointDetails) 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
GenAiDetail GenAI details required to provision dedicated clusters.
type GenAiDetail struct {
// Id for the GGCS instance to be provisioned.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The dedicated AI cluster type.
ClusterType ClusterTypeEnum `mandatory:"true" json:"clusterType"`
// Name of the base model.
BaseModel *string `mandatory:"true" json:"baseModel"`
// Region on which the cluster end endpoint will be provisioned.
OciRegion *string `mandatory:"true" json:"ociRegion"`
// No of replicas of base model to be used for hosting.
UnitCount *int `mandatory:"true" json:"unitCount"`
// List of endpoints to provision for the GENAI cluster.
Endpoints []EndpointDetails `mandatory:"false" json:"endpoints"`
}
func (m GenAiDetail) String() string
func (m GenAiDetail) 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
GenAiUpdateDetail Details required for existing GenAi instance to be updated.
type GenAiUpdateDetail struct {
// Instance id of the exisitng GenAi instance to be updated.
InstanceId *string `mandatory:"true" json:"instanceId"`
// No of replicas of base model to be used for hosting.
UnitCount *int `mandatory:"false" json:"unitCount"`
// List of endpoints to be provisioned new or updated if existing for the GenAi dedicated cluster.
Endpoints []EndpointDetails `mandatory:"false" json:"endpoints"`
}
func (m GenAiUpdateDetail) String() string
func (m GenAiUpdateDetail) 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
GetStackRequest wrapper for the GetStack operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/GetStack.go.html to see an example of how to use GetStackRequest.
type GetStackRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
StackId *string `mandatory:"true" contributesTo:"path" name:"stackId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetStackRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetStackRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetStackRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetStackRequest) String() string
func (request GetStackRequest) 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
GetStackResponse wrapper for the GetStack operation
type GetStackResponse struct {
// The underlying http response
RawResponse *http.Response
// The Stack instance
Stack `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetStackResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetStackResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// 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
GgcsArtifactsDetail Details required to deploy artifacts in the GGCS deployment.
type GgcsArtifactsDetail struct {
// Instance id of the exisitng GGCS instance.
InstanceId *string `mandatory:"true" json:"instanceId"`
// Object storage root path containing GGCS artifacts.
ArtifactObjectStoragePath *string `mandatory:"false" json:"artifactObjectStoragePath"`
// Ggcs user details to be created or updated.
Users []GgcsUserDetail `mandatory:"false" json:"users"`
// Source Detail to configure existing or new datasource.
Sources []GgcsSourceDetail `mandatory:"false" json:"sources"`
// Target Detail to configure existing or new datasource.
Targets []GgcsTargetDetail `mandatory:"false" json:"targets"`
}
func (m GgcsArtifactsDetail) String() string
func (m GgcsArtifactsDetail) 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
GgcsConnectionDetails Details of GGCS connections to be created.
type GgcsConnectionDetails struct {
// Name of the connection to be created.
ConnectionName *string `mandatory:"true" json:"connectionName"`
// List of Service Dependency Details for connection creation.
DifDependencies []DifDependencyDetails `mandatory:"false" json:"difDependencies"`
// Vault secret OCID containing password that Oracle GoldenGate uses to connect the associated system of the given technology.
GgAdminSecretId *string `mandatory:"false" json:"ggAdminSecretId"`
// OCID of pre-created Oracle GoldenGate connection.
ConnectionId *string `mandatory:"false" json:"connectionId"`
}
func (m GgcsConnectionDetails) String() string
func (m GgcsConnectionDetails) 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
GgcsDetail GGCS details required to provision deployments and connections.
type GgcsDetail struct {
// Id for the GGCS instance to provision.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The Minimum number of OCPUs to be made available for this Deployment.
Ocpu *int `mandatory:"true" json:"ocpu"`
// The OCID of the subnet of the GGCS deployment's private endpoint.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The OCID of the Secret where the deployment password is stored.
PasswordSecretId *string `mandatory:"true" json:"passwordSecretId"`
// The OCID of a public subnet in the customer tenancy. Can be provided only for public GGCS deployments.
PublicSubnetId *string `mandatory:"false" json:"publicSubnetId"`
// Version of OGG.
OggVersion *string `mandatory:"false" json:"oggVersion"`
// Connection details to be associated with the Goldengate deployment.
Connections []GgcsConnectionDetails `mandatory:"false" json:"connections"`
}
func (m GgcsDetail) String() string
func (m GgcsDetail) 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
GgcsSourceDetail GGCS source configuration for creating or updating existing extracts.
type GgcsSourceDetail struct {
// Ggcs source artifact id.
SourceId *string `mandatory:"true" json:"sourceId"`
// Action to be done over the user. Allowed values are "CREATE" or "UPDATE".
Action WorkflowActionEnum `mandatory:"true" json:"action"`
// Boolean value that determines source operations should start or not.
ShouldStartSourceOperations *bool `mandatory:"true" json:"shouldStartSourceOperations"`
// Target uri for the GoldenGate deployment where distribution path needs to be configured.
TargetUri *string `mandatory:"false" json:"targetUri"`
// Name of assigned connection for the source.
TargetConnectionName *string `mandatory:"false" json:"targetConnectionName"`
}
func (m GgcsSourceDetail) String() string
func (m GgcsSourceDetail) 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
GgcsTargetDetail GGCS target configuration for creating or updating existing replicats.
type GgcsTargetDetail struct {
// GGCS target artifact id.
TargetId *string `mandatory:"true" json:"targetId"`
// Action to be done over the user. Allowed values are "CREATE" or "UPDATE".
Action WorkflowActionEnum `mandatory:"true" json:"action"`
// Boolean value that determines target operations should start or not.
ShouldStartTargetOperations *bool `mandatory:"true" json:"shouldStartTargetOperations"`
// Source uri for the GoldenGate deployment from where the collector path needs to be configured.
SourceUri *string `mandatory:"false" json:"sourceUri"`
// Name of assigned connection for the target.
SourceConnectionName *string `mandatory:"false" json:"sourceConnectionName"`
}
func (m GgcsTargetDetail) String() string
func (m GgcsTargetDetail) 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
GgcsUpdateDetail Details required to update the existing GGCS instance.
type GgcsUpdateDetail struct {
// Instance id of the existing GGCS instance to be updated.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The Minimum number of OCPUs to be made available for this Deployment.
Ocpu *int `mandatory:"false" json:"ocpu"`
// The OCID of a public subnet in the customer tenancy. Can be provided only for public GGCS deployments.
PublicSubnetId *string `mandatory:"false" json:"publicSubnetId"`
// Connection details to be associated with the Goldengate deployment.
Connections []GgcsConnectionDetails `mandatory:"false" json:"connections"`
}
func (m GgcsUpdateDetail) String() string
func (m GgcsUpdateDetail) 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
GgcsUserDetail Ggcs user credentials to be created or updated.
type GgcsUserDetail struct {
// username for the user.
UserName *string `mandatory:"true" json:"userName"`
// Vault OCID containing password for existing or new user.
SecretId *string `mandatory:"true" json:"secretId"`
// Type of GoldenGate user. Allowed values are "OPERATOR".
UserType *string `mandatory:"true" json:"userType"`
// Action to be done over the user. Allowed values are "CREATE" or "UPDATE".
Action WorkflowActionEnum `mandatory:"true" json:"action"`
}
func (m GgcsUserDetail) String() string
func (m GgcsUserDetail) 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
ListStacksRequest wrapper for the ListStacks operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListStacks.go.html to see an example of how to use ListStacksRequest.
type ListStacksRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState StackLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListStacksSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListStacksSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListStacksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListStacksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListStacksRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListStacksRequest) String() string
func (request ListStacksRequest) 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
ListStacksResponse wrapper for the ListStacks operation
type ListStacksResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of StackCollection instances
StackCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListStacksResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListStacksResponse) String() string
ListStacksSortByEnum Enum with underlying type: string
type ListStacksSortByEnum string
Set of constants representing the allowable values for ListStacksSortByEnum
const (
ListStacksSortByTimecreated ListStacksSortByEnum = "timeCreated"
ListStacksSortByDisplayname ListStacksSortByEnum = "displayName"
)
func GetListStacksSortByEnumValues() []ListStacksSortByEnum
GetListStacksSortByEnumValues Enumerates the set of values for ListStacksSortByEnum
func GetMappingListStacksSortByEnum(val string) (ListStacksSortByEnum, bool)
GetMappingListStacksSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListStacksSortOrderEnum Enum with underlying type: string
type ListStacksSortOrderEnum string
Set of constants representing the allowable values for ListStacksSortOrderEnum
const (
ListStacksSortOrderAsc ListStacksSortOrderEnum = "ASC"
ListStacksSortOrderDesc ListStacksSortOrderEnum = "DESC"
)
func GetListStacksSortOrderEnumValues() []ListStacksSortOrderEnum
GetListStacksSortOrderEnumValues Enumerates the set of values for ListStacksSortOrderEnum
func GetMappingListStacksSortOrderEnum(val string) (ListStacksSortOrderEnum, bool)
GetMappingListStacksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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 (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
)
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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 (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
)
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only the resources that match the given lifecycle state.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either ascending (`ASC`) or descending (`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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCancelling ListWorkRequestsStatusEnum = "CANCELLING"
ListWorkRequestsStatusCancelled ListWorkRequestsStatusEnum = "CANCELLED"
)
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
ObjectStorageDetail Object Storage Details required to provision buckets.
type ObjectStorageDetail struct {
// Id for Object Storage instance to be provisioned.
InstanceId *string `mandatory:"true" json:"instanceId"`
// Mentions whether the object versioning to be enabled or not,Allowed values are "ENABLED" / "DISABLED"/"SUSPENDED"
ObjectVersioning ObjectVersioningEnum `mandatory:"true" json:"objectVersioning"`
// Mentions which storage tier to use for the bucket,Allowed values are "STANDARD" / "ARCHIVE"
StorageTier StorageTierEnum `mandatory:"true" json:"storageTier"`
// It sets the auto-tiering status on the bucket.Allowed values are "DISABLED" / "INFREQUENTACCESS"
AutoTiering AutoTieringEnum `mandatory:"false" json:"autoTiering,omitempty"`
}
func (m ObjectStorageDetail) String() string
func (m ObjectStorageDetail) 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
ObjectStorageUpdateDetail Details of Object Storage instance to be updated.
type ObjectStorageUpdateDetail struct {
// Instance id of the existing Object Storage instance to be updated.
InstanceId *string `mandatory:"true" json:"instanceId"`
// Mentions which storage tier to use for the bucket,Allowed values are "STANDARD" / "ARCHIVE"
ObjectVersioning ObjectVersioningEnum `mandatory:"false" json:"objectVersioning,omitempty"`
// It sets the auto-tiering status on the bucket.Allowed values are "DISABLED" / "INFREQUENTACCESS"
AutoTiering AutoTieringEnum `mandatory:"false" json:"autoTiering,omitempty"`
}
func (m ObjectStorageUpdateDetail) String() string
func (m ObjectStorageUpdateDetail) 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
ObjectVersioningEnum Enum with underlying type: string
type ObjectVersioningEnum string
Set of constants representing the allowable values for ObjectVersioningEnum
const (
ObjectVersioningEnabled ObjectVersioningEnum = "ENABLED"
ObjectVersioningSuspended ObjectVersioningEnum = "SUSPENDED"
ObjectVersioningDisabled ObjectVersioningEnum = "DISABLED"
)
func GetMappingObjectVersioningEnum(val string) (ObjectVersioningEnum, bool)
GetMappingObjectVersioningEnum performs case Insensitive comparison on enum value and return the desired enum
func GetObjectVersioningEnumValues() []ObjectVersioningEnum
GetObjectVersioningEnumValues Enumerates the set of values for ObjectVersioningEnum
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"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCancelling OperationStatusEnum = "CANCELLING"
OperationStatusCancelled OperationStatusEnum = "CANCELLED"
)
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 (
OperationTypeCreateStack OperationTypeEnum = "CREATE_STACK"
OperationTypeUpdateStack OperationTypeEnum = "UPDATE_STACK"
OperationTypeDeleteStack OperationTypeEnum = "DELETE_STACK"
OperationTypeMoveStack OperationTypeEnum = "MOVE_STACK"
OperationTypeDeployArtifacts OperationTypeEnum = "DEPLOY_ARTIFACTS"
OperationTypeAddServiceInStack OperationTypeEnum = "ADD_SERVICE_IN_STACK"
)
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
ServiceDetailResponse Details of the cloud service.
type ServiceDetailResponse struct {
// ID for the service instance.
InstanceId *string `mandatory:"false" json:"instanceId"`
// ID for the service
ServiceId *string `mandatory:"false" json:"serviceId"`
// name of the service
DisplayName *string `mandatory:"false" json:"displayName"`
// name of the service
CurrentArtifactPath *string `mandatory:"false" json:"currentArtifactPath"`
// name of the cloud service
ServiceType *string `mandatory:"false" json:"serviceType"`
// url for the service
ServiceUrl *string `mandatory:"false" json:"serviceUrl"`
// state of the service
Status *string `mandatory:"false" json:"status"`
AdditionalDetails *AdditionalDetails `mandatory:"false" json:"additionalDetails"`
}
func (m ServiceDetailResponse) String() string
func (m ServiceDetailResponse) 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
ServiceEnum Enum with underlying type: string
type ServiceEnum string
Set of constants representing the allowable values for ServiceEnum
const (
ServiceAdb ServiceEnum = "ADB"
ServiceGgcs ServiceEnum = "GGCS"
ServiceObjectstorage ServiceEnum = "OBJECTSTORAGE"
ServiceGenai ServiceEnum = "GENAI"
ServiceDataflow ServiceEnum = "DATAFLOW"
)
func GetMappingServiceEnum(val string) (ServiceEnum, bool)
GetMappingServiceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetServiceEnumValues() []ServiceEnum
GetServiceEnumValues Enumerates the set of values for ServiceEnum
ShapeConfig This is used to configure the shape of the driver or executor if a flexible shape is used.
type ShapeConfig struct {
// The amount of memory used for the driver or executors.
MemoryInGBs *int `mandatory:"true" json:"memoryInGBs"`
// The total number of OCPUs used for the driver or executors. See here for details.
Ocpus *int `mandatory:"true" json:"ocpus"`
}
func (m ShapeConfig) String() string
func (m ShapeConfig) 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
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
Stack A Stack is a collection of a templates and services. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type Stack struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// List of templates to be onboarded for the stack.
StackTemplates []StackTemplateEnum `mandatory:"true" json:"stackTemplates"`
// List of services to be onboarded for the stack.
Services []ServiceEnum `mandatory:"true" json:"services"`
// The date and time the Stack was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the Stack.
LifecycleState StackLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// email id to which the stack notifications would be sent.
NotificationEmail *string `mandatory:"false" json:"notificationEmail"`
// ADB details if adb is included in the services.
Adb []AdbDetail `mandatory:"false" json:"adb"`
// GGCS details if ggcs is included in the services.
Ggcs []GgcsDetail `mandatory:"false" json:"ggcs"`
// DATAFLOW details if dataflow is included in the services.
Dataflow []DataflowDetail `mandatory:"false" json:"dataflow"`
// Object Storage Details if object storage is included in services.
Objectstorage []ObjectStorageDetail `mandatory:"false" json:"objectstorage"`
// GenAI Details if genai is included in services.
Genai []GenAiDetail `mandatory:"false" json:"genai"`
// Details of the service onboarded for the data intelligence stack.
ServiceDetails []ServiceDetailResponse `mandatory:"false" json:"serviceDetails"`
// The date and time the Stack was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the Stack in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Stack) String() string
func (m Stack) 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
StackClient a client for Stack
type StackClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewStackClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client StackClient, err error)
NewStackClientWithConfigurationProvider Creates a new default Stack client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewStackClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client StackClient, err error)
NewStackClientWithOboToken Creates a new default Stack 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 StackClient) AddService(ctx context.Context, request AddServiceRequest) (response AddServiceResponse, err error)
AddService Add new service or update existing service.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/AddService.go.html to see an example of how to use AddService API. A default retry strategy applies to this operation AddService()
func (client StackClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client StackClient) ChangeStackCompartment(ctx context.Context, request ChangeStackCompartmentRequest) (response ChangeStackCompartmentResponse, err error)
ChangeStackCompartment Moves a Stack into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ChangeStackCompartment.go.html to see an example of how to use ChangeStackCompartment API. A default retry strategy applies to this operation ChangeStackCompartment()
func (client *StackClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client StackClient) CreateStack(ctx context.Context, request CreateStackRequest) (response CreateStackResponse, err error)
CreateStack Creates a Stack.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/CreateStack.go.html to see an example of how to use CreateStack API. A default retry strategy applies to this operation CreateStack()
func (client StackClient) DeleteStack(ctx context.Context, request DeleteStackRequest) (response DeleteStackResponse, err error)
DeleteStack Deletes a Stack.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/DeleteStack.go.html to see an example of how to use DeleteStack API. A default retry strategy applies to this operation DeleteStack()
func (client StackClient) DeployArtifacts(ctx context.Context, request DeployArtifactsRequest) (response DeployArtifactsResponse, err error)
DeployArtifacts DeployArtifacts
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/DeployArtifacts.go.html to see an example of how to use DeployArtifacts API. A default retry strategy applies to this operation DeployArtifacts()
func (client StackClient) GetStack(ctx context.Context, request GetStackRequest) (response GetStackResponse, err error)
GetStack Gets information about a Stack.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/GetStack.go.html to see an example of how to use GetStack API. A default retry strategy applies to this operation GetStack()
func (client StackClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client StackClient) ListStacks(ctx context.Context, request ListStacksRequest) (response ListStacksResponse, err error)
ListStacks Gets a list of Stacks.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListStacks.go.html to see an example of how to use ListStacks API. A default retry strategy applies to this operation ListStacks()
func (client StackClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client StackClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client StackClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *StackClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client StackClient) UpdateStack(ctx context.Context, request UpdateStackRequest) (response UpdateStackResponse, err error)
UpdateStack Updates a Stack.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/UpdateStack.go.html to see an example of how to use UpdateStack API. A default retry strategy applies to this operation UpdateStack()
StackCollection Results of a Stack search. Contains both StackSummary items and other information, such as metadata.
type StackCollection struct {
// List of Stacks.
Items []StackSummary `mandatory:"true" json:"items"`
}
func (m StackCollection) String() string
func (m StackCollection) 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
StackLifecycleStateEnum Enum with underlying type: string
type StackLifecycleStateEnum string
Set of constants representing the allowable values for StackLifecycleStateEnum
const (
StackLifecycleStateCreating StackLifecycleStateEnum = "CREATING"
StackLifecycleStateUpdating StackLifecycleStateEnum = "UPDATING"
StackLifecycleStateActive StackLifecycleStateEnum = "ACTIVE"
StackLifecycleStateDeleting StackLifecycleStateEnum = "DELETING"
StackLifecycleStateDeleted StackLifecycleStateEnum = "DELETED"
StackLifecycleStateFailed StackLifecycleStateEnum = "FAILED"
StackLifecycleStateNeedsAttention StackLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingStackLifecycleStateEnum(val string) (StackLifecycleStateEnum, bool)
GetMappingStackLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStackLifecycleStateEnumValues() []StackLifecycleStateEnum
GetStackLifecycleStateEnumValues Enumerates the set of values for StackLifecycleStateEnum
StackSummary Summary information about a Stack.
type StackSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the Stack was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the Stack.
LifecycleState StackLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// The date and time the Stack was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the Stack in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m StackSummary) String() string
func (m StackSummary) 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
StackTemplateEnum Enum with underlying type: string
type StackTemplateEnum string
Set of constants representing the allowable values for StackTemplateEnum
const (
StackTemplateDatalake StackTemplateEnum = "DATALAKE"
StackTemplateDatapipeline StackTemplateEnum = "DATAPIPELINE"
StackTemplateAiservices StackTemplateEnum = "AISERVICES"
StackTemplateDatatransformation StackTemplateEnum = "DATATRANSFORMATION"
)
func GetMappingStackTemplateEnum(val string) (StackTemplateEnum, bool)
GetMappingStackTemplateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStackTemplateEnumValues() []StackTemplateEnum
GetStackTemplateEnumValues Enumerates the set of values for StackTemplateEnum
StorageTierEnum Enum with underlying type: string
type StorageTierEnum string
Set of constants representing the allowable values for StorageTierEnum
const (
StorageTierStandard StorageTierEnum = "STANDARD"
StorageTierArchive StorageTierEnum = "ARCHIVE"
)
func GetMappingStorageTierEnum(val string) (StorageTierEnum, bool)
GetMappingStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStorageTierEnumValues() []StorageTierEnum
GetStorageTierEnumValues Enumerates the set of values for StorageTierEnum
UpdateDataflowConnections Details for connections to other services from Dataflow.
type UpdateDataflowConnections struct {
ConnectionDetails *DataflowConnectionDetails `mandatory:"true" json:"connectionDetails"`
}
func (m UpdateDataflowConnections) String() string
func (m UpdateDataflowConnections) 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
UpdateStackDetails Details to update a Stack.
type UpdateStackDetails struct {
// email id to which the stack notifications would be sent.
NotificationEmail *string `mandatory:"false" json:"notificationEmail"`
// List of templates to be updated for the stack.
StackTemplates []StackTemplateEnum `mandatory:"false" json:"stackTemplates,omitempty"`
// List of services to be updated for the stack.
Services []ServiceEnum `mandatory:"false" json:"services,omitempty"`
// ADB details if adb is included in the services to be updated.
Adb []AdbUpdateDetail `mandatory:"false" json:"adb"`
// GGCS details if ggcs is included in the services to be updated.
Ggcs []GgcsUpdateDetail `mandatory:"false" json:"ggcs"`
// DATAFLOW details if dataflow is included in the services to be updated.
Dataflow []DataflowUpdateDetail `mandatory:"false" json:"dataflow"`
// Object Storage Details if object storage is included in services to be updated.
Objectstorage []ObjectStorageUpdateDetail `mandatory:"false" json:"objectstorage"`
// GenAI Details if genai is included in services to be updated.
Genai []GenAiUpdateDetail `mandatory:"false" json:"genai"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateStackDetails) String() string
func (m UpdateStackDetails) 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
UpdateStackRequest wrapper for the UpdateStack operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dif/UpdateStack.go.html to see an example of how to use UpdateStackRequest.
type UpdateStackRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack.
StackId *string `mandatory:"true" contributesTo:"path" name:"stackId"`
// The information to be updated.
UpdateStackDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 UpdateStackRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateStackRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateStackRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateStackRequest) String() string
func (request UpdateStackRequest) 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
UpdateStackResponse wrapper for the UpdateStack operation
type UpdateStackResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 UpdateStackResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateStackResponse) String() string
WorkRequest An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
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 performing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error message.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
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 A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
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 performing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
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 A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
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 that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request 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 Summary information about an asynchronous work request.
type WorkRequestSummary struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
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 A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
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
WorkflowActionEnum Enum with underlying type: string
type WorkflowActionEnum string
Set of constants representing the allowable values for WorkflowActionEnum
const (
WorkflowActionCreate WorkflowActionEnum = "CREATE"
WorkflowActionUpdate WorkflowActionEnum = "UPDATE"
)
func GetMappingWorkflowActionEnum(val string) (WorkflowActionEnum, bool)
GetMappingWorkflowActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkflowActionEnumValues() []WorkflowActionEnum
GetWorkflowActionEnumValues Enumerates the set of values for WorkflowActionEnum