func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetBucketDetailsDefinitionBucketTypeEnumStringValues() []string
GetBucketDetailsDefinitionBucketTypeEnumStringValues Enumerates the set of values in String for BucketDetailsDefinitionBucketTypeEnum
func GetGdpOperationTypeEnumStringValues() []string
GetGdpOperationTypeEnumStringValues Enumerates the set of values in String for GdpOperationTypeEnum
func GetGdpPipelineLifecycleStateEnumStringValues() []string
GetGdpPipelineLifecycleStateEnumStringValues Enumerates the set of values in String for GdpPipelineLifecycleStateEnum
func GetGdpPipelinePipelineTypeEnumStringValues() []string
GetGdpPipelinePipelineTypeEnumStringValues Enumerates the set of values in String for GdpPipelinePipelineTypeEnum
func GetListGdpPipelinesSortByEnumStringValues() []string
GetListGdpPipelinesSortByEnumStringValues Enumerates the set of values in String for ListGdpPipelinesSortByEnum
func GetListGdpPipelinesSortOrderEnumStringValues() []string
GetListGdpPipelinesSortOrderEnumStringValues Enumerates the set of values in String for ListGdpPipelinesSortOrderEnum
func GetListGdpWorkRequestErrorsSortByEnumStringValues() []string
GetListGdpWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListGdpWorkRequestErrorsSortByEnum
func GetListGdpWorkRequestErrorsSortOrderEnumStringValues() []string
GetListGdpWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListGdpWorkRequestErrorsSortOrderEnum
func GetListGdpWorkRequestLogsSortByEnumStringValues() []string
GetListGdpWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListGdpWorkRequestLogsSortByEnum
func GetListGdpWorkRequestLogsSortOrderEnumStringValues() []string
GetListGdpWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListGdpWorkRequestLogsSortOrderEnum
func GetListGdpWorkRequestsSortByEnumStringValues() []string
GetListGdpWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListGdpWorkRequestsSortByEnum
func GetListGdpWorkRequestsSortOrderEnumStringValues() []string
GetListGdpWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListGdpWorkRequestsSortOrderEnum
func GetListGdpWorkRequestsStatusEnumStringValues() []string
GetListGdpWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListGdpWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BucketDetailsDefinition Information about a particular bucket.
type BucketDetailsDefinition struct {
// Type of bucket. SENDER pipelines can be SOURCE, TRANSFER, REJECT, or FAILED. RECEIVER pipelines have a DESTINATION bucket.
BucketType BucketDetailsDefinitionBucketTypeEnum `mandatory:"true" json:"bucketType"`
// Namespace of the bucket.
Namespace *string `mandatory:"true" json:"namespace"`
// Name of the bucket.
Name *string `mandatory:"true" json:"name"`
// OCID of the bucket.
Id *string `mandatory:"true" json:"id"`
}
func (m BucketDetailsDefinition) String() string
func (m BucketDetailsDefinition) 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
BucketDetailsDefinitionBucketTypeEnum Enum with underlying type: string
type BucketDetailsDefinitionBucketTypeEnum string
Set of constants representing the allowable values for BucketDetailsDefinitionBucketTypeEnum
const (
BucketDetailsDefinitionBucketTypeSource BucketDetailsDefinitionBucketTypeEnum = "SOURCE"
BucketDetailsDefinitionBucketTypeTransfer BucketDetailsDefinitionBucketTypeEnum = "TRANSFER"
BucketDetailsDefinitionBucketTypeReject BucketDetailsDefinitionBucketTypeEnum = "REJECT"
BucketDetailsDefinitionBucketTypeDestination BucketDetailsDefinitionBucketTypeEnum = "DESTINATION"
)
func GetBucketDetailsDefinitionBucketTypeEnumValues() []BucketDetailsDefinitionBucketTypeEnum
GetBucketDetailsDefinitionBucketTypeEnumValues Enumerates the set of values for BucketDetailsDefinitionBucketTypeEnum
func GetMappingBucketDetailsDefinitionBucketTypeEnum(val string) (BucketDetailsDefinitionBucketTypeEnum, bool)
GetMappingBucketDetailsDefinitionBucketTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeGdpPipelineCompartmentDetails The compartment of the pipeline to be updated.
type ChangeGdpPipelineCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeGdpPipelineCompartmentDetails) String() string
func (m ChangeGdpPipelineCompartmentDetails) 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
ChangeGdpPipelineCompartmentRequest wrapper for the ChangeGdpPipelineCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ChangeGdpPipelineCompartment.go.html to see an example of how to use ChangeGdpPipelineCompartmentRequest.
type ChangeGdpPipelineCompartmentRequest struct {
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// The information to be updated.
ChangeGdpPipelineCompartmentDetails `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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeGdpPipelineCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeGdpPipelineCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeGdpPipelineCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeGdpPipelineCompartmentRequest) String() string
func (request ChangeGdpPipelineCompartmentRequest) 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
ChangeGdpPipelineCompartmentResponse wrapper for the ChangeGdpPipelineCompartment operation
type ChangeGdpPipelineCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeGdpPipelineCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeGdpPipelineCompartmentResponse) String() string
CreateGdpPipelineDetails The information about the new pipeline.
type CreateGdpPipelineDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Pipeline short name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of pipeline. Can be SENDER or RECEIVER.
PipelineType GdpPipelinePipelineTypeEnum `mandatory:"true" json:"pipelineType"`
// Information about the bucket in the pipeline being configured.
BucketDetails []BucketDetailsDefinition `mandatory:"true" json:"bucketDetails"`
// Public region name where the peered pipeline exists.
PeeringRegion *string `mandatory:"true" json:"peeringRegion"`
// Short field input by customer for a description of the data pipeline use-case.
Description *string `mandatory:"false" json:"description"`
// the OCID of the service log group.
ServiceLogGroupId *string `mandatory:"false" json:"serviceLogGroupId"`
// List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc).
FileTypes []string `mandatory:"false" json:"fileTypes"`
// Authorization information about the pipeline being configured.
AuthorizationDetails *string `mandatory:"false" json:"authorizationDetails"`
// Enable file override feature in destination bucket
IsFileOverrideInDestinationEnabled *bool `mandatory:"false" json:"isFileOverrideInDestinationEnabled"`
// Determines whether GDP Scanning should be enabled for the pipeline.
IsScanningEnabled *bool `mandatory:"false" json:"isScanningEnabled"`
// Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.
IsChunkingEnabled *bool `mandatory:"false" json:"isChunkingEnabled"`
// Determines whether file transfers need to go through an approval workflow.
IsApprovalNeeded *bool `mandatory:"false" json:"isApprovalNeeded"`
// The KMS vault OCID for the key to be used for file transfer approvals.
ApprovalKeyVaultId *string `mandatory:"false" json:"approvalKeyVaultId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateGdpPipelineDetails) String() string
func (m CreateGdpPipelineDetails) 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
CreateGdpPipelineRequest wrapper for the CreateGdpPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/CreateGdpPipeline.go.html to see an example of how to use CreateGdpPipelineRequest.
type CreateGdpPipelineRequest struct {
// Details about the new pipeline.
CreateGdpPipelineDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateGdpPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGdpPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGdpPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGdpPipelineRequest) String() string
func (request CreateGdpPipelineRequest) 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
CreateGdpPipelineResponse wrapper for the CreateGdpPipeline operation
type CreateGdpPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateGdpPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGdpPipelineResponse) String() string
DeleteGdpPipelineRequest wrapper for the DeleteGdpPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/DeleteGdpPipeline.go.html to see an example of how to use DeleteGdpPipelineRequest.
type DeleteGdpPipelineRequest struct {
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteGdpPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGdpPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGdpPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGdpPipelineRequest) String() string
func (request DeleteGdpPipelineRequest) 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
DeleteGdpPipelineResponse wrapper for the DeleteGdpPipeline operation
type DeleteGdpPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteGdpPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGdpPipelineResponse) String() string
GdpOperationTypeEnum Enum with underlying type: string
type GdpOperationTypeEnum string
Set of constants representing the allowable values for GdpOperationTypeEnum
const (
GdpOperationTypeCreateGdpPipeline GdpOperationTypeEnum = "CREATE_GDP_PIPELINE"
GdpOperationTypeStartGdpPipeline GdpOperationTypeEnum = "START_GDP_PIPELINE"
GdpOperationTypeStopGdpPipeline GdpOperationTypeEnum = "STOP_GDP_PIPELINE"
GdpOperationTypeUpdateGdpPipeline GdpOperationTypeEnum = "UPDATE_GDP_PIPELINE"
GdpOperationTypeDeleteGdpPipeline GdpOperationTypeEnum = "DELETE_GDP_PIPELINE"
GdpOperationTypePeerGdpPipeline GdpOperationTypeEnum = "PEER_GDP_PIPELINE"
GdpOperationTypeMoveGdpPipeline GdpOperationTypeEnum = "MOVE_GDP_PIPELINE"
GdpOperationTypeRotateGdpPipelineKeys GdpOperationTypeEnum = "ROTATE_GDP_PIPELINE_KEYS"
)
func GetGdpOperationTypeEnumValues() []GdpOperationTypeEnum
GetGdpOperationTypeEnumValues Enumerates the set of values for GdpOperationTypeEnum
func GetMappingGdpOperationTypeEnum(val string) (GdpOperationTypeEnum, bool)
GetMappingGdpOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GdpPipeline Retrieves pipeline configuration information by identifier.
type GdpPipeline struct {
// The OCID of the pipeline.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the pipeline.
LifecycleState GdpPipelineLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Pipeline short name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of pipeline. Can be SENDER or RECEIVER.
PipelineType GdpPipelinePipelineTypeEnum `mandatory:"true" json:"pipelineType"`
// Public region name where the peered pipeline exists.
PeeringRegion *string `mandatory:"true" json:"peeringRegion"`
// The time the the pipeline was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the pipeline was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// Additional details about the current state of the pipeline.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Short field input by customer for a description of the data pipeline use-case.
Description *string `mandatory:"false" json:"description"`
// the OCID of the service log group.
ServiceLogGroupId *string `mandatory:"false" json:"serviceLogGroupId"`
// List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc).
FileTypes []string `mandatory:"false" json:"fileTypes"`
// Authorization information about the pipeline being configured.
AuthorizationDetails *string `mandatory:"false" json:"authorizationDetails"`
// Information about the bucket in the pipeline being configured.
BucketDetails []BucketDetailsDefinition `mandatory:"false" json:"bucketDetails"`
// OCID of the peered pipeline.
PeeredGdpPipelineId *string `mandatory:"false" json:"peeredGdpPipelineId"`
// Enable file override feature in destination bucket
IsFileOverrideInDestinationEnabled *bool `mandatory:"false" json:"isFileOverrideInDestinationEnabled"`
// Determines whether GDP Scanning should be enabled for the pipeline.
IsScanningEnabled *bool `mandatory:"false" json:"isScanningEnabled"`
// Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.
IsChunkingEnabled *bool `mandatory:"false" json:"isChunkingEnabled"`
// Determines whether file transfers need to go through an approval workflow.
IsApprovalNeeded *bool `mandatory:"false" json:"isApprovalNeeded"`
// The KMS vault OCID for the key to be used for file transfer approvals.
ApprovalKeyVaultId *string `mandatory:"false" json:"approvalKeyVaultId"`
// 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 GdpPipeline) String() string
func (m GdpPipeline) 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
GdpPipelineCollection Results of a pipeline search. Contains both summary items and other information, such as metadata.
type GdpPipelineCollection struct {
// List of pipelines within a compartment.
Items []GdpPipelineSummary `mandatory:"true" json:"items"`
}
func (m GdpPipelineCollection) String() string
func (m GdpPipelineCollection) 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
GdpPipelineLifecycleStateEnum Enum with underlying type: string
type GdpPipelineLifecycleStateEnum string
Set of constants representing the allowable values for GdpPipelineLifecycleStateEnum
const (
GdpPipelineLifecycleStateCreating GdpPipelineLifecycleStateEnum = "CREATING"
GdpPipelineLifecycleStateUpdating GdpPipelineLifecycleStateEnum = "UPDATING"
GdpPipelineLifecycleStateActive GdpPipelineLifecycleStateEnum = "ACTIVE"
GdpPipelineLifecycleStateInactive GdpPipelineLifecycleStateEnum = "INACTIVE"
GdpPipelineLifecycleStateDeleting GdpPipelineLifecycleStateEnum = "DELETING"
GdpPipelineLifecycleStateDeleted GdpPipelineLifecycleStateEnum = "DELETED"
GdpPipelineLifecycleStateFailed GdpPipelineLifecycleStateEnum = "FAILED"
GdpPipelineLifecycleStateNeedsAttention GdpPipelineLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetGdpPipelineLifecycleStateEnumValues() []GdpPipelineLifecycleStateEnum
GetGdpPipelineLifecycleStateEnumValues Enumerates the set of values for GdpPipelineLifecycleStateEnum
func GetMappingGdpPipelineLifecycleStateEnum(val string) (GdpPipelineLifecycleStateEnum, bool)
GetMappingGdpPipelineLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
GdpPipelinePipelineTypeEnum Enum with underlying type: string
type GdpPipelinePipelineTypeEnum string
Set of constants representing the allowable values for GdpPipelinePipelineTypeEnum
const (
GdpPipelinePipelineTypeSender GdpPipelinePipelineTypeEnum = "SENDER"
GdpPipelinePipelineTypeReceiver GdpPipelinePipelineTypeEnum = "RECEIVER"
)
func GetGdpPipelinePipelineTypeEnumValues() []GdpPipelinePipelineTypeEnum
GetGdpPipelinePipelineTypeEnumValues Enumerates the set of values for GdpPipelinePipelineTypeEnum
func GetMappingGdpPipelinePipelineTypeEnum(val string) (GdpPipelinePipelineTypeEnum, bool)
GetMappingGdpPipelinePipelineTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GdpPipelineSummary Retrieves summary pipeline configuration information by identifier.
type GdpPipelineSummary struct {
// The OCID of the pipeline.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the pipeline.
LifecycleState GdpPipelineLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Pipeline short name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of pipeline. Can be SENDER or RECEIVER.
PipelineType GdpPipelinePipelineTypeEnum `mandatory:"true" json:"pipelineType"`
// Public region name where the peered pipeline exists.
PeeringRegion *string `mandatory:"true" json:"peeringRegion"`
// The time the pipeline was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the pipeline was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// Short field input by customer for a description of the data pipeline use-case.
Description *string `mandatory:"false" json:"description"`
// the OCID of the service log group.
ServiceLogGroupId *string `mandatory:"false" json:"serviceLogGroupId"`
// Free-text field containing tracking information for approval tracking.
AuthorizationDetails *string `mandatory:"false" json:"authorizationDetails"`
// Enable file override feature in destination bucket
IsFileOverrideInDestinationEnabled *bool `mandatory:"false" json:"isFileOverrideInDestinationEnabled"`
// Determines whether GDP Scanning should be enabled for the pipeline.
IsScanningEnabled *bool `mandatory:"false" json:"isScanningEnabled"`
// Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.
IsChunkingEnabled *bool `mandatory:"false" json:"isChunkingEnabled"`
// Determines whether file transfers need to go through an approval workflow.
IsApprovalNeeded *bool `mandatory:"false" json:"isApprovalNeeded"`
// 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 GdpPipelineSummary) String() string
func (m GdpPipelineSummary) 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
GdpWorkRequest A description of work request status.
type GdpWorkRequest struct {
// Type of work request.
OperationType GdpOperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of the current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m GdpWorkRequest) String() string
func (m GdpWorkRequest) 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
GdpWorkRequestSummary A summary of the status of a work request.
type GdpWorkRequestSummary struct {
// Type of work request.
OperationType GdpOperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of the current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m GdpWorkRequestSummary) String() string
func (m GdpWorkRequestSummary) 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
GdpWorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type GdpWorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []GdpWorkRequestSummary `mandatory:"true" json:"items"`
}
func (m GdpWorkRequestSummaryCollection) String() string
func (m GdpWorkRequestSummaryCollection) 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
GetGdpPipelineRequest wrapper for the GetGdpPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/GetGdpPipeline.go.html to see an example of how to use GetGdpPipelineRequest.
type GetGdpPipelineRequest struct {
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetGdpPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGdpPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGdpPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGdpPipelineRequest) String() string
func (request GetGdpPipelineRequest) 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
GetGdpPipelineResponse wrapper for the GetGdpPipeline operation
type GetGdpPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// The GdpPipeline instance
GdpPipeline `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 GetGdpPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGdpPipelineResponse) String() string
GetGdpWorkRequestRequest wrapper for the GetGdpWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/GetGdpWorkRequest.go.html to see an example of how to use GetGdpWorkRequestRequest.
type GetGdpWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetGdpWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGdpWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGdpWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGdpWorkRequestRequest) String() string
func (request GetGdpWorkRequestRequest) 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
GetGdpWorkRequestResponse wrapper for the GetGdpWorkRequest operation
type GetGdpWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The GdpWorkRequest instance
GdpWorkRequest `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 GetGdpWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGdpWorkRequestResponse) String() string
GuardedDataPipelineClient a client for GuardedDataPipeline
type GuardedDataPipelineClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGuardedDataPipelineClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GuardedDataPipelineClient, err error)
NewGuardedDataPipelineClientWithConfigurationProvider Creates a new default GuardedDataPipeline client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGuardedDataPipelineClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GuardedDataPipelineClient, err error)
NewGuardedDataPipelineClientWithOboToken Creates a new default GuardedDataPipeline 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 GuardedDataPipelineClient) ChangeGdpPipelineCompartment(ctx context.Context, request ChangeGdpPipelineCompartmentRequest) (response ChangeGdpPipelineCompartmentResponse, err error)
ChangeGdpPipelineCompartment Moves a pipeline resource from one compartment to another. When provided, if-match is checked against etag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ChangeGdpPipelineCompartment.go.html to see an example of how to use ChangeGdpPipelineCompartment API. A default retry strategy applies to this operation ChangeGdpPipelineCompartment()
func (client *GuardedDataPipelineClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GuardedDataPipelineClient) CreateGdpPipeline(ctx context.Context, request CreateGdpPipelineRequest) (response CreateGdpPipelineResponse, err error)
CreateGdpPipeline Creates a new pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/CreateGdpPipeline.go.html to see an example of how to use CreateGdpPipeline API. A default retry strategy applies to this operation CreateGdpPipeline()
func (client GuardedDataPipelineClient) DeleteGdpPipeline(ctx context.Context, request DeleteGdpPipelineRequest) (response DeleteGdpPipelineResponse, err error)
DeleteGdpPipeline Deletes a pipeline by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/DeleteGdpPipeline.go.html to see an example of how to use DeleteGdpPipeline API. A default retry strategy applies to this operation DeleteGdpPipeline()
func (client GuardedDataPipelineClient) GetGdpPipeline(ctx context.Context, request GetGdpPipelineRequest) (response GetGdpPipelineResponse, err error)
GetGdpPipeline Retrieves a pipeline by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/GetGdpPipeline.go.html to see an example of how to use GetGdpPipeline API. A default retry strategy applies to this operation GetGdpPipeline()
func (client GuardedDataPipelineClient) GetGdpWorkRequest(ctx context.Context, request GetGdpWorkRequestRequest) (response GetGdpWorkRequestResponse, err error)
GetGdpWorkRequest Gets details of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/GetGdpWorkRequest.go.html to see an example of how to use GetGdpWorkRequest API. A default retry strategy applies to this operation GetGdpWorkRequest()
func (client GuardedDataPipelineClient) ListGdpPipelines(ctx context.Context, request ListGdpPipelinesRequest) (response ListGdpPipelinesResponse, err error)
ListGdpPipelines Returns a list of pipelines.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpPipelines.go.html to see an example of how to use ListGdpPipelines API. A default retry strategy applies to this operation ListGdpPipelines()
func (client GuardedDataPipelineClient) ListGdpWorkRequestErrors(ctx context.Context, request ListGdpWorkRequestErrorsRequest) (response ListGdpWorkRequestErrorsResponse, err error)
ListGdpWorkRequestErrors Returns a (paginated) list of errors for the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpWorkRequestErrors.go.html to see an example of how to use ListGdpWorkRequestErrors API. A default retry strategy applies to this operation ListGdpWorkRequestErrors()
func (client GuardedDataPipelineClient) ListGdpWorkRequestLogs(ctx context.Context, request ListGdpWorkRequestLogsRequest) (response ListGdpWorkRequestLogsResponse, err error)
ListGdpWorkRequestLogs Returns a (paginated) list of logs for the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpWorkRequestLogs.go.html to see an example of how to use ListGdpWorkRequestLogs API. A default retry strategy applies to this operation ListGdpWorkRequestLogs()
func (client GuardedDataPipelineClient) ListGdpWorkRequests(ctx context.Context, request ListGdpWorkRequestsRequest) (response ListGdpWorkRequestsResponse, err error)
ListGdpWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpWorkRequests.go.html to see an example of how to use ListGdpWorkRequests API. A default retry strategy applies to this operation ListGdpWorkRequests()
func (client GuardedDataPipelineClient) PeerGdpPipeline(ctx context.Context, request PeerGdpPipelineRequest) (response PeerGdpPipelineResponse, err error)
PeerGdpPipeline Peers the pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/PeerGdpPipeline.go.html to see an example of how to use PeerGdpPipeline API. A default retry strategy applies to this operation PeerGdpPipeline()
func (client GuardedDataPipelineClient) RotateGdpPipelineKeys(ctx context.Context, request RotateGdpPipelineKeysRequest) (response RotateGdpPipelineKeysResponse, err error)
RotateGdpPipelineKeys Rotates the pipeline keys by resending the control message with a fresh pair of keys.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/RotateGdpPipelineKeys.go.html to see an example of how to use RotateGdpPipelineKeys API. A default retry strategy applies to this operation RotateGdpPipelineKeys()
func (client *GuardedDataPipelineClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GuardedDataPipelineClient) StartGdpPipeline(ctx context.Context, request StartGdpPipelineRequest) (response StartGdpPipelineResponse, err error)
StartGdpPipeline Starts the pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/StartGdpPipeline.go.html to see an example of how to use StartGdpPipeline API. A default retry strategy applies to this operation StartGdpPipeline()
func (client GuardedDataPipelineClient) StopGdpPipeline(ctx context.Context, request StopGdpPipelineRequest) (response StopGdpPipelineResponse, err error)
StopGdpPipeline Stops the pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/StopGdpPipeline.go.html to see an example of how to use StopGdpPipeline API. A default retry strategy applies to this operation StopGdpPipeline()
func (client GuardedDataPipelineClient) UpdateGdpPipeline(ctx context.Context, request UpdateGdpPipelineRequest) (response UpdateGdpPipelineResponse, err error)
UpdateGdpPipeline Updates the pipeline.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/UpdateGdpPipeline.go.html to see an example of how to use UpdateGdpPipeline API. A default retry strategy applies to this operation UpdateGdpPipeline()
ListGdpPipelinesRequest wrapper for the ListGdpPipelines operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpPipelines.go.html to see an example of how to use ListGdpPipelinesRequest.
type ListGdpPipelinesRequest struct {
// The ID 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 entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"false" contributesTo:"query" name:"gdpPipelineId"`
// A filter to return only resources with a lifecycleState that matches the given lifecycleState.
LifecycleState GdpPipelineLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListGdpPipelinesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListGdpPipelinesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListGdpPipelinesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGdpPipelinesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGdpPipelinesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGdpPipelinesRequest) String() string
func (request ListGdpPipelinesRequest) 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
ListGdpPipelinesResponse wrapper for the ListGdpPipelines operation
type ListGdpPipelinesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GdpPipelineCollection instances
GdpPipelineCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListGdpPipelinesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGdpPipelinesResponse) String() string
ListGdpPipelinesSortByEnum Enum with underlying type: string
type ListGdpPipelinesSortByEnum string
Set of constants representing the allowable values for ListGdpPipelinesSortByEnum
const (
ListGdpPipelinesSortByTimecreated ListGdpPipelinesSortByEnum = "timeCreated"
ListGdpPipelinesSortByDisplayname ListGdpPipelinesSortByEnum = "displayName"
)
func GetListGdpPipelinesSortByEnumValues() []ListGdpPipelinesSortByEnum
GetListGdpPipelinesSortByEnumValues Enumerates the set of values for ListGdpPipelinesSortByEnum
func GetMappingListGdpPipelinesSortByEnum(val string) (ListGdpPipelinesSortByEnum, bool)
GetMappingListGdpPipelinesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpPipelinesSortOrderEnum Enum with underlying type: string
type ListGdpPipelinesSortOrderEnum string
Set of constants representing the allowable values for ListGdpPipelinesSortOrderEnum
const (
ListGdpPipelinesSortOrderAsc ListGdpPipelinesSortOrderEnum = "ASC"
ListGdpPipelinesSortOrderDesc ListGdpPipelinesSortOrderEnum = "DESC"
)
func GetListGdpPipelinesSortOrderEnumValues() []ListGdpPipelinesSortOrderEnum
GetListGdpPipelinesSortOrderEnumValues Enumerates the set of values for ListGdpPipelinesSortOrderEnum
func GetMappingListGdpPipelinesSortOrderEnum(val string) (ListGdpPipelinesSortOrderEnum, bool)
GetMappingListGdpPipelinesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpWorkRequestErrorsRequest wrapper for the ListGdpWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpWorkRequestErrors.go.html to see an example of how to use ListGdpWorkRequestErrorsRequest.
type ListGdpWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
SortBy ListGdpWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListGdpWorkRequestErrorsSortOrderEnum `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 ListGdpWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGdpWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGdpWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGdpWorkRequestErrorsRequest) String() string
func (request ListGdpWorkRequestErrorsRequest) 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
ListGdpWorkRequestErrorsResponse wrapper for the ListGdpWorkRequestErrors operation
type ListGdpWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListGdpWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGdpWorkRequestErrorsResponse) String() string
ListGdpWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListGdpWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListGdpWorkRequestErrorsSortByEnum
const (
ListGdpWorkRequestErrorsSortByTimestamp ListGdpWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListGdpWorkRequestErrorsSortByEnumValues() []ListGdpWorkRequestErrorsSortByEnum
GetListGdpWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListGdpWorkRequestErrorsSortByEnum
func GetMappingListGdpWorkRequestErrorsSortByEnum(val string) (ListGdpWorkRequestErrorsSortByEnum, bool)
GetMappingListGdpWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListGdpWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListGdpWorkRequestErrorsSortOrderEnum
const (
ListGdpWorkRequestErrorsSortOrderAsc ListGdpWorkRequestErrorsSortOrderEnum = "ASC"
ListGdpWorkRequestErrorsSortOrderDesc ListGdpWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListGdpWorkRequestErrorsSortOrderEnumValues() []ListGdpWorkRequestErrorsSortOrderEnum
GetListGdpWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListGdpWorkRequestErrorsSortOrderEnum
func GetMappingListGdpWorkRequestErrorsSortOrderEnum(val string) (ListGdpWorkRequestErrorsSortOrderEnum, bool)
GetMappingListGdpWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpWorkRequestLogsRequest wrapper for the ListGdpWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpWorkRequestLogs.go.html to see an example of how to use ListGdpWorkRequestLogsRequest.
type ListGdpWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
SortBy ListGdpWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListGdpWorkRequestLogsSortOrderEnum `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 ListGdpWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGdpWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGdpWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGdpWorkRequestLogsRequest) String() string
func (request ListGdpWorkRequestLogsRequest) 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
ListGdpWorkRequestLogsResponse wrapper for the ListGdpWorkRequestLogs operation
type ListGdpWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListGdpWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGdpWorkRequestLogsResponse) String() string
ListGdpWorkRequestLogsSortByEnum Enum with underlying type: string
type ListGdpWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListGdpWorkRequestLogsSortByEnum
const (
ListGdpWorkRequestLogsSortByTimestamp ListGdpWorkRequestLogsSortByEnum = "timestamp"
)
func GetListGdpWorkRequestLogsSortByEnumValues() []ListGdpWorkRequestLogsSortByEnum
GetListGdpWorkRequestLogsSortByEnumValues Enumerates the set of values for ListGdpWorkRequestLogsSortByEnum
func GetMappingListGdpWorkRequestLogsSortByEnum(val string) (ListGdpWorkRequestLogsSortByEnum, bool)
GetMappingListGdpWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListGdpWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListGdpWorkRequestLogsSortOrderEnum
const (
ListGdpWorkRequestLogsSortOrderAsc ListGdpWorkRequestLogsSortOrderEnum = "ASC"
ListGdpWorkRequestLogsSortOrderDesc ListGdpWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListGdpWorkRequestLogsSortOrderEnumValues() []ListGdpWorkRequestLogsSortOrderEnum
GetListGdpWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListGdpWorkRequestLogsSortOrderEnum
func GetMappingListGdpWorkRequestLogsSortOrderEnum(val string) (ListGdpWorkRequestLogsSortOrderEnum, bool)
GetMappingListGdpWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpWorkRequestsRequest wrapper for the ListGdpWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/ListGdpWorkRequests.go.html to see an example of how to use ListGdpWorkRequestsRequest.
type ListGdpWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources with a lifecycleState that matches the given OperationStatus.
Status ListGdpWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListGdpWorkRequestsSortOrderEnum `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 ListGdpWorkRequestsSortByEnum `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 ListGdpWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGdpWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGdpWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGdpWorkRequestsRequest) String() string
func (request ListGdpWorkRequestsRequest) 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
ListGdpWorkRequestsResponse wrapper for the ListGdpWorkRequests operation
type ListGdpWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GdpWorkRequestSummaryCollection instances
GdpWorkRequestSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListGdpWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGdpWorkRequestsResponse) String() string
ListGdpWorkRequestsSortByEnum Enum with underlying type: string
type ListGdpWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListGdpWorkRequestsSortByEnum
const (
ListGdpWorkRequestsSortByTimeaccepted ListGdpWorkRequestsSortByEnum = "timeAccepted"
)
func GetListGdpWorkRequestsSortByEnumValues() []ListGdpWorkRequestsSortByEnum
GetListGdpWorkRequestsSortByEnumValues Enumerates the set of values for ListGdpWorkRequestsSortByEnum
func GetMappingListGdpWorkRequestsSortByEnum(val string) (ListGdpWorkRequestsSortByEnum, bool)
GetMappingListGdpWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpWorkRequestsSortOrderEnum Enum with underlying type: string
type ListGdpWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListGdpWorkRequestsSortOrderEnum
const (
ListGdpWorkRequestsSortOrderAsc ListGdpWorkRequestsSortOrderEnum = "ASC"
ListGdpWorkRequestsSortOrderDesc ListGdpWorkRequestsSortOrderEnum = "DESC"
)
func GetListGdpWorkRequestsSortOrderEnumValues() []ListGdpWorkRequestsSortOrderEnum
GetListGdpWorkRequestsSortOrderEnumValues Enumerates the set of values for ListGdpWorkRequestsSortOrderEnum
func GetMappingListGdpWorkRequestsSortOrderEnum(val string) (ListGdpWorkRequestsSortOrderEnum, bool)
GetMappingListGdpWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGdpWorkRequestsStatusEnum Enum with underlying type: string
type ListGdpWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListGdpWorkRequestsStatusEnum
const (
ListGdpWorkRequestsStatusAccepted ListGdpWorkRequestsStatusEnum = "ACCEPTED"
ListGdpWorkRequestsStatusInProgress ListGdpWorkRequestsStatusEnum = "IN_PROGRESS"
ListGdpWorkRequestsStatusWaiting ListGdpWorkRequestsStatusEnum = "WAITING"
ListGdpWorkRequestsStatusNeedsAttention ListGdpWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListGdpWorkRequestsStatusFailed ListGdpWorkRequestsStatusEnum = "FAILED"
ListGdpWorkRequestsStatusSucceeded ListGdpWorkRequestsStatusEnum = "SUCCEEDED"
ListGdpWorkRequestsStatusCanceling ListGdpWorkRequestsStatusEnum = "CANCELING"
ListGdpWorkRequestsStatusCanceled ListGdpWorkRequestsStatusEnum = "CANCELED"
)
func GetListGdpWorkRequestsStatusEnumValues() []ListGdpWorkRequestsStatusEnum
GetListGdpWorkRequestsStatusEnumValues Enumerates the set of values for ListGdpWorkRequestsStatusEnum
func GetMappingListGdpWorkRequestsStatusEnum(val string) (ListGdpWorkRequestsStatusEnum, bool)
GetMappingListGdpWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
PeerGdpPipelineDetails Details about the peering pipeline.
type PeerGdpPipelineDetails struct {
// OCID of the peering pipeline.
PeeringGdpPipelineId *string `mandatory:"true" json:"peeringGdpPipelineId"`
// Unique one-time-token generated to validate the identity of the sender and prevent the peer request from being tampered with.
PeerValidationNonce *string `mandatory:"false" json:"peerValidationNonce"`
}
func (m PeerGdpPipelineDetails) String() string
func (m PeerGdpPipelineDetails) 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
PeerGdpPipelineRequest wrapper for the PeerGdpPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/PeerGdpPipeline.go.html to see an example of how to use PeerGdpPipelineRequest.
type PeerGdpPipelineRequest struct {
// Details about the peered pipeline.
PeerGdpPipelineDetails `contributesTo:"body"`
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request PeerGdpPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PeerGdpPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PeerGdpPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PeerGdpPipelineRequest) String() string
func (request PeerGdpPipelineRequest) 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
PeerGdpPipelineResponse wrapper for the PeerGdpPipeline operation
type PeerGdpPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response PeerGdpPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PeerGdpPipelineResponse) String() string
RotateGdpPipelineKeysRequest wrapper for the RotateGdpPipelineKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/RotateGdpPipelineKeys.go.html to see an example of how to use RotateGdpPipelineKeysRequest.
type RotateGdpPipelineKeysRequest struct {
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RotateGdpPipelineKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RotateGdpPipelineKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RotateGdpPipelineKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RotateGdpPipelineKeysRequest) String() string
func (request RotateGdpPipelineKeysRequest) 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
RotateGdpPipelineKeysResponse wrapper for the RotateGdpPipelineKeys operation
type RotateGdpPipelineKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RotateGdpPipelineKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RotateGdpPipelineKeysResponse) String() string
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
StartGdpPipelineRequest wrapper for the StartGdpPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/StartGdpPipeline.go.html to see an example of how to use StartGdpPipelineRequest.
type StartGdpPipelineRequest struct {
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StartGdpPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartGdpPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartGdpPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartGdpPipelineRequest) String() string
func (request StartGdpPipelineRequest) 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
StartGdpPipelineResponse wrapper for the StartGdpPipeline operation
type StartGdpPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StartGdpPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartGdpPipelineResponse) String() string
StopGdpPipelineRequest wrapper for the StopGdpPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/StopGdpPipeline.go.html to see an example of how to use StopGdpPipelineRequest.
type StopGdpPipelineRequest struct {
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StopGdpPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopGdpPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopGdpPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopGdpPipelineRequest) String() string
func (request StopGdpPipelineRequest) 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
StopGdpPipelineResponse wrapper for the StopGdpPipeline operation
type StopGdpPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StopGdpPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopGdpPipelineResponse) String() string
UpdateGdpPipelineDetails The pipeline information to be updated.
type UpdateGdpPipelineDetails struct {
// Pipeline name. Can be renamed later.
DisplayName *string `mandatory:"false" json:"displayName"`
// Short field input by customer for a description of the data pipeline use-case.
Description *string `mandatory:"false" json:"description"`
// the OCID of the service log group.
ServiceLogGroupId *string `mandatory:"false" json:"serviceLogGroupId"`
// List of file types allowed to be transferred in the data pipeline according to the authorization details (e.g. .pdf, .xml, .doc).
FileTypes []string `mandatory:"false" json:"fileTypes"`
// Authorization information about the pipeline being configured.
AuthorizationDetails *string `mandatory:"false" json:"authorizationDetails"`
// Enable file override feature in destination bucket
IsFileOverrideInDestinationEnabled *bool `mandatory:"false" json:"isFileOverrideInDestinationEnabled"`
// Determines whether GDP Scanning should be enabled for the pipeline.
IsScanningEnabled *bool `mandatory:"false" json:"isScanningEnabled"`
// Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.
IsChunkingEnabled *bool `mandatory:"false" json:"isChunkingEnabled"`
// Determines whether file transfers need to go through an approval workflow.
IsApprovalNeeded *bool `mandatory:"false" json:"isApprovalNeeded"`
// The KMS vault OCID for the key to be used for file transfer approvals.
ApprovalKeyVaultId *string `mandatory:"false" json:"approvalKeyVaultId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateGdpPipelineDetails) String() string
func (m UpdateGdpPipelineDetails) 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
UpdateGdpPipelineRequest wrapper for the UpdateGdpPipeline operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/gdp/UpdateGdpPipeline.go.html to see an example of how to use UpdateGdpPipelineRequest.
type UpdateGdpPipelineRequest struct {
// Unique pipeline identifier.
GdpPipelineId *string `mandatory:"true" contributesTo:"path" name:"gdpPipelineId"`
// The information to be updated.
UpdateGdpPipelineDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateGdpPipelineRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGdpPipelineRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGdpPipelineRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGdpPipelineRequest) String() string
func (request UpdateGdpPipelineRequest) 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
UpdateGdpPipelineResponse wrapper for the UpdateGdpPipeline operation
type UpdateGdpPipelineResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateGdpPipelineResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGdpPipelineResponse) String() string
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum