func GetArchivalStateEnumStringValues() []string
GetArchivalStateEnumStringValues Enumerates the set of values in String for ArchivalStateEnum
func GetBucketAutoTieringEnumStringValues() []string
GetBucketAutoTieringEnumStringValues Enumerates the set of values in String for BucketAutoTieringEnum
func GetBucketPublicAccessTypeEnumStringValues() []string
GetBucketPublicAccessTypeEnumStringValues Enumerates the set of values in String for BucketPublicAccessTypeEnum
func GetBucketStorageTierEnumStringValues() []string
GetBucketStorageTierEnumStringValues Enumerates the set of values in String for BucketStorageTierEnum
func GetBucketVersioningEnumStringValues() []string
GetBucketVersioningEnumStringValues Enumerates the set of values in String for BucketVersioningEnum
func GetChecksumAlgorithmEnumStringValues() []string
GetChecksumAlgorithmEnumStringValues Enumerates the set of values in String for ChecksumAlgorithmEnum
func GetCreateBucketDetailsPublicAccessTypeEnumStringValues() []string
GetCreateBucketDetailsPublicAccessTypeEnumStringValues Enumerates the set of values in String for CreateBucketDetailsPublicAccessTypeEnum
func GetCreateBucketDetailsStorageTierEnumStringValues() []string
GetCreateBucketDetailsStorageTierEnumStringValues Enumerates the set of values in String for CreateBucketDetailsStorageTierEnum
func GetCreateBucketDetailsVersioningEnumStringValues() []string
GetCreateBucketDetailsVersioningEnumStringValues Enumerates the set of values in String for CreateBucketDetailsVersioningEnum
func GetCreateMultipartUploadOpcChecksumAlgorithmEnumStringValues() []string
GetCreateMultipartUploadOpcChecksumAlgorithmEnumStringValues Enumerates the set of values in String for CreateMultipartUploadOpcChecksumAlgorithmEnum
func GetCreatePreauthenticatedRequestDetailsAccessTypeEnumStringValues() []string
GetCreatePreauthenticatedRequestDetailsAccessTypeEnumStringValues Enumerates the set of values in String for CreatePreauthenticatedRequestDetailsAccessTypeEnum
func GetDurationTimeUnitEnumStringValues() []string
GetDurationTimeUnitEnumStringValues Enumerates the set of values in String for DurationTimeUnitEnum
func GetGetBucketFieldsEnumStringValues() []string
GetGetBucketFieldsEnumStringValues Enumerates the set of values in String for GetBucketFieldsEnum
func GetGetObjectArchivalStateEnumStringValues() []string
GetGetObjectArchivalStateEnumStringValues Enumerates the set of values in String for GetObjectArchivalStateEnum
func GetGetObjectStorageTierEnumStringValues() []string
GetGetObjectStorageTierEnumStringValues Enumerates the set of values in String for GetObjectStorageTierEnum
func GetHeadObjectArchivalStateEnumStringValues() []string
GetHeadObjectArchivalStateEnumStringValues Enumerates the set of values in String for HeadObjectArchivalStateEnum
func GetHeadObjectStorageTierEnumStringValues() []string
GetHeadObjectStorageTierEnumStringValues Enumerates the set of values in String for HeadObjectStorageTierEnum
func GetListBucketsFieldsEnumStringValues() []string
GetListBucketsFieldsEnumStringValues Enumerates the set of values in String for ListBucketsFieldsEnum
func GetListObjectVersionsFieldsEnumStringValues() []string
GetListObjectVersionsFieldsEnumStringValues Enumerates the set of values in String for ListObjectVersionsFieldsEnum
func GetListPrivateEndpointsFieldsEnumStringValues() []string
GetListPrivateEndpointsFieldsEnumStringValues Enumerates the set of values in String for ListPrivateEndpointsFieldsEnum
func GetObjectLifecycleRuleTimeUnitEnumStringValues() []string
GetObjectLifecycleRuleTimeUnitEnumStringValues Enumerates the set of values in String for ObjectLifecycleRuleTimeUnitEnum
func GetPreauthenticatedRequestAccessTypeEnumStringValues() []string
GetPreauthenticatedRequestAccessTypeEnumStringValues Enumerates the set of values in String for PreauthenticatedRequestAccessTypeEnum
func GetPreauthenticatedRequestBucketListingActionEnumStringValues() []string
GetPreauthenticatedRequestBucketListingActionEnumStringValues Enumerates the set of values in String for PreauthenticatedRequestBucketListingActionEnum
func GetPreauthenticatedRequestSummaryAccessTypeEnumStringValues() []string
GetPreauthenticatedRequestSummaryAccessTypeEnumStringValues Enumerates the set of values in String for PreauthenticatedRequestSummaryAccessTypeEnum
func GetPrivateEndpointLifecycleStateEnumStringValues() []string
GetPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for PrivateEndpointLifecycleStateEnum
func GetPutObjectOpcChecksumAlgorithmEnumStringValues() []string
GetPutObjectOpcChecksumAlgorithmEnumStringValues Enumerates the set of values in String for PutObjectOpcChecksumAlgorithmEnum
func GetPutObjectStorageTierEnumStringValues() []string
GetPutObjectStorageTierEnumStringValues Enumerates the set of values in String for PutObjectStorageTierEnum
func GetReplicationPolicyStatusEnumStringValues() []string
GetReplicationPolicyStatusEnumStringValues Enumerates the set of values in String for ReplicationPolicyStatusEnum
func GetReplicationPolicySummaryStatusEnumStringValues() []string
GetReplicationPolicySummaryStatusEnumStringValues Enumerates the set of values in String for ReplicationPolicySummaryStatusEnum
func GetSseCustomerKeyDetailsAlgorithmEnumStringValues() []string
GetSseCustomerKeyDetailsAlgorithmEnumStringValues Enumerates the set of values in String for SseCustomerKeyDetailsAlgorithmEnum
func GetStorageTierEnumStringValues() []string
GetStorageTierEnumStringValues Enumerates the set of values in String for StorageTierEnum
func GetUpdateBucketDetailsPublicAccessTypeEnumStringValues() []string
GetUpdateBucketDetailsPublicAccessTypeEnumStringValues Enumerates the set of values in String for UpdateBucketDetailsPublicAccessTypeEnum
func GetUpdateBucketDetailsVersioningEnumStringValues() []string
GetUpdateBucketDetailsVersioningEnumStringValues Enumerates the set of values in String for UpdateBucketDetailsVersioningEnum
func GetUploadPartOpcChecksumAlgorithmEnumStringValues() []string
GetUploadPartOpcChecksumAlgorithmEnumStringValues Enumerates the set of values in String for UploadPartOpcChecksumAlgorithmEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
func GetWorkRequestSummaryOperationTypeEnumStringValues() []string
GetWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestSummaryOperationTypeEnum
func GetWorkRequestSummaryStatusEnumStringValues() []string
GetWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for WorkRequestSummaryStatusEnum
AbortMultipartUploadRequest wrapper for the AbortMultipartUpload operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/AbortMultipartUpload.go.html to see an example of how to use AbortMultipartUploadRequest.
type AbortMultipartUploadRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// The upload ID for a multipart upload.
UploadId *string `mandatory:"true" contributesTo:"query" name:"uploadId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 AbortMultipartUploadRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AbortMultipartUploadRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AbortMultipartUploadRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request AbortMultipartUploadRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AbortMultipartUploadRequest) String() string
func (request AbortMultipartUploadRequest) 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
AbortMultipartUploadResponse wrapper for the AbortMultipartUpload operation
type AbortMultipartUploadResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response AbortMultipartUploadResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AbortMultipartUploadResponse) String() string
AccessTargetDetails Details of the targets that can be accessed by the private endpoint.
type AccessTargetDetails struct {
// The Object Storage namespace which the private endpoint can access. Wildcards ('*') are allowed. If value is '*', it means all namespaces can be accessed. It cannot be a regex.
Namespace *string `mandatory:"true" json:"namespace"`
// The compartment ID which the private endpoint can access. Wildcards ('*') are allowed. If value is '*', it means all compartments in the specified namespace can be accessed. It cannot be a regex.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the bucket. Avoid entering confidential information. Wildcards ('*') are allowed. If value is '*', it means all buckets in the specified namespace and compartment can be accessed. It cannot be a regex.
// Example: my-new-bucket1
Bucket *string `mandatory:"true" json:"bucket"`
}
func (m AccessTargetDetails) String() string
func (m AccessTargetDetails) 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
ArchivalStateEnum Enum with underlying type: string
type ArchivalStateEnum string
Set of constants representing the allowable values for ArchivalStateEnum
const (
ArchivalStateArchived ArchivalStateEnum = "Archived"
ArchivalStateRestoring ArchivalStateEnum = "Restoring"
ArchivalStateRestored ArchivalStateEnum = "Restored"
)
func GetArchivalStateEnumValues() []ArchivalStateEnum
GetArchivalStateEnumValues Enumerates the set of values for ArchivalStateEnum
func GetMappingArchivalStateEnum(val string) (ArchivalStateEnum, bool)
GetMappingArchivalStateEnum performs case Insensitive comparison on enum value and return the desired enum
Bucket A bucket is a container for storing objects in a compartment within a namespace. A bucket is associated with a single compartment. The compartment has policies that indicate what actions a user can perform on a bucket and all the objects in the bucket. For more information, see Managing Buckets (https://docs.oracle.com/iaas/Content/Object/Tasks/managingbuckets.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type Bucket struct {
// The Object Storage namespace in which the bucket resides.
Namespace *string `mandatory:"true" json:"namespace"`
// The name of the bucket. Avoid entering confidential information.
// Example: my-new-bucket1
Name *string `mandatory:"true" json:"name"`
// The compartment ID in which the bucket is authorized.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Arbitrary string keys and values for user-defined metadata.
Metadata map[string]string `mandatory:"true" json:"metadata"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the bucket.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The date and time the bucket was created, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The entity tag (ETag) for the bucket.
Etag *string `mandatory:"true" json:"etag"`
// The type of public access enabled on this bucket.
// A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the
// bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the
// `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the
// bucket, public access is allowed for the `GetObject` and `HeadObject` operations.
PublicAccessType BucketPublicAccessTypeEnum `mandatory:"false" json:"publicAccessType,omitempty"`
// The storage tier type assigned to the bucket. A bucket is set to `Standard` tier by default, which means
// objects uploaded or copied to the bucket will be in the standard storage tier. When the `Archive` tier type
// is set explicitly for a bucket, objects uploaded or copied to the bucket will be stored in archive storage.
// The `storageTier` property is immutable after bucket is created.
StorageTier BucketStorageTierEnum `mandatory:"false" json:"storageTier,omitempty"`
// Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is
// set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information
// about events, see Overview of Events (https://docs.oracle.com/iaas/Content/Events/Concepts/eventsoverview.htm).
ObjectEventsEnabled *bool `mandatory:"false" json:"objectEventsEnabled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management
// service to generate a data encryption key or to encrypt or decrypt a data encryption key.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// The entity tag (ETag) for the live object lifecycle policy on the bucket.
ObjectLifecyclePolicyEtag *string `mandatory:"false" json:"objectLifecyclePolicyEtag"`
// The approximate number of objects in the bucket. Count statistics are reported periodically. You will see a
// lag between what is displayed and the actual object count.
ApproximateCount *int64 `mandatory:"false" json:"approximateCount"`
// The approximate total size in bytes of all objects in the bucket. Size statistics are reported periodically. You will
// see a lag between what is displayed and the actual size of the bucket.
ApproximateSize *int64 `mandatory:"false" json:"approximateSize"`
// Whether or not this bucket is a replication source. By default, `replicationEnabled` is set to `false`. This will
// be set to 'true' when you create a replication policy for the bucket.
ReplicationEnabled *bool `mandatory:"false" json:"replicationEnabled"`
// Whether or not this bucket is read only. By default, `isReadOnly` is set to `false`. This will
// be set to 'true' when this bucket is configured as a destination in a replication policy.
IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the bucket.
Id *string `mandatory:"false" json:"id"`
// The versioning status on the bucket. A bucket is created with versioning `Disabled` by default.
// For versioning `Enabled`, objects are protected from overwrites and deletes, by maintaining their version history. When versioning is `Suspended`, the previous versions will still remain but new versions will no longer be created when overwitten or deleted.
Versioning BucketVersioningEnum `mandatory:"false" json:"versioning,omitempty"`
// The auto tiering status on the bucket. A bucket is created with auto tiering `Disabled` by default.
// For auto tiering `InfrequentAccess`, objects are transitioned automatically between the 'Standard'
// and 'InfrequentAccess' tiers based on the access pattern of the objects.
AutoTiering BucketAutoTieringEnum `mandatory:"false" json:"autoTiering,omitempty"`
}
func (m Bucket) String() string
func (m Bucket) 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
BucketAutoTieringEnum Enum with underlying type: string
type BucketAutoTieringEnum string
Set of constants representing the allowable values for BucketAutoTieringEnum
const (
BucketAutoTieringDisabled BucketAutoTieringEnum = "Disabled"
BucketAutoTieringInfrequentaccess BucketAutoTieringEnum = "InfrequentAccess"
)
func GetBucketAutoTieringEnumValues() []BucketAutoTieringEnum
GetBucketAutoTieringEnumValues Enumerates the set of values for BucketAutoTieringEnum
func GetMappingBucketAutoTieringEnum(val string) (BucketAutoTieringEnum, bool)
GetMappingBucketAutoTieringEnum performs case Insensitive comparison on enum value and return the desired enum
BucketPublicAccessTypeEnum Enum with underlying type: string
type BucketPublicAccessTypeEnum string
Set of constants representing the allowable values for BucketPublicAccessTypeEnum
const (
BucketPublicAccessTypeNopublicaccess BucketPublicAccessTypeEnum = "NoPublicAccess"
BucketPublicAccessTypeObjectread BucketPublicAccessTypeEnum = "ObjectRead"
BucketPublicAccessTypeObjectreadwithoutlist BucketPublicAccessTypeEnum = "ObjectReadWithoutList"
)
func GetBucketPublicAccessTypeEnumValues() []BucketPublicAccessTypeEnum
GetBucketPublicAccessTypeEnumValues Enumerates the set of values for BucketPublicAccessTypeEnum
func GetMappingBucketPublicAccessTypeEnum(val string) (BucketPublicAccessTypeEnum, bool)
GetMappingBucketPublicAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BucketStorageTierEnum Enum with underlying type: string
type BucketStorageTierEnum string
Set of constants representing the allowable values for BucketStorageTierEnum
const (
BucketStorageTierStandard BucketStorageTierEnum = "Standard"
BucketStorageTierArchive BucketStorageTierEnum = "Archive"
)
func GetBucketStorageTierEnumValues() []BucketStorageTierEnum
GetBucketStorageTierEnumValues Enumerates the set of values for BucketStorageTierEnum
func GetMappingBucketStorageTierEnum(val string) (BucketStorageTierEnum, bool)
GetMappingBucketStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
BucketSummary To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type BucketSummary struct {
// The Object Storage namespace in which the bucket lives.
Namespace *string `mandatory:"true" json:"namespace"`
// The name of the bucket. Avoid entering confidential information.
// Example: my-new-bucket1
Name *string `mandatory:"true" json:"name"`
// The compartment ID in which the bucket is authorized.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the bucket.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The date and time the bucket was created, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The entity tag (ETag) for the bucket.
Etag *string `mandatory:"true" json:"etag"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m BucketSummary) String() string
func (m BucketSummary) 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
BucketVersioningEnum Enum with underlying type: string
type BucketVersioningEnum string
Set of constants representing the allowable values for BucketVersioningEnum
const (
BucketVersioningEnabled BucketVersioningEnum = "Enabled"
BucketVersioningSuspended BucketVersioningEnum = "Suspended"
BucketVersioningDisabled BucketVersioningEnum = "Disabled"
)
func GetBucketVersioningEnumValues() []BucketVersioningEnum
GetBucketVersioningEnumValues Enumerates the set of values for BucketVersioningEnum
func GetMappingBucketVersioningEnum(val string) (BucketVersioningEnum, bool)
GetMappingBucketVersioningEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChecksumAlgorithmEnum Enum with underlying type: string
type ChecksumAlgorithmEnum string
Set of constants representing the allowable values for ChecksumAlgorithmEnum
const (
ChecksumAlgorithmCrc32C ChecksumAlgorithmEnum = "CRC32C"
ChecksumAlgorithmSha256 ChecksumAlgorithmEnum = "SHA256"
ChecksumAlgorithmSha384 ChecksumAlgorithmEnum = "SHA384"
)
func GetChecksumAlgorithmEnumValues() []ChecksumAlgorithmEnum
GetChecksumAlgorithmEnumValues Enumerates the set of values for ChecksumAlgorithmEnum
func GetMappingChecksumAlgorithmEnum(val string) (ChecksumAlgorithmEnum, bool)
GetMappingChecksumAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
CommitMultipartUploadDetails To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type CommitMultipartUploadDetails struct {
// The part numbers and entity tags (ETags) for the parts to be committed.
PartsToCommit []CommitMultipartUploadPartDetails `mandatory:"true" json:"partsToCommit"`
// The part numbers for the parts to be excluded from the completed object.
// Each part created for this upload must be in either partsToExclude or partsToCommit, but cannot be in both.
PartsToExclude []int `mandatory:"false" json:"partsToExclude"`
}
func (m CommitMultipartUploadDetails) String() string
func (m CommitMultipartUploadDetails) 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
CommitMultipartUploadPartDetails To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type CommitMultipartUploadPartDetails struct {
// The part number for this part.
PartNum *int `mandatory:"true" json:"partNum"`
// The entity tag (ETag) returned when this part was uploaded.
Etag *string `mandatory:"true" json:"etag"`
}
func (m CommitMultipartUploadPartDetails) String() string
func (m CommitMultipartUploadPartDetails) 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
CommitMultipartUploadRequest wrapper for the CommitMultipartUpload operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CommitMultipartUpload.go.html to see an example of how to use CommitMultipartUploadRequest.
type CommitMultipartUploadRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// The upload ID for a multipart upload.
UploadId *string `mandatory:"true" contributesTo:"query" name:"uploadId"`
// The part numbers and entity tags (ETags) for the parts you want to commit.
CommitMultipartUploadDetails `contributesTo:"body"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should
// fail if the resource already exists.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 CommitMultipartUploadRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CommitMultipartUploadRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CommitMultipartUploadRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CommitMultipartUploadRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CommitMultipartUploadRequest) String() string
func (request CommitMultipartUploadRequest) 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
CommitMultipartUploadResponse wrapper for the CommitMultipartUpload operation
type CommitMultipartUploadResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Base-64 representation of the multipart object MD5 hash.
// The multipart object hash is calculated by taking the MD5 hashes of the parts passed to this call,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the MD5 hash of the concatenated values. The multipart object hash is followed
// by a hyphen and the total number of parts (for example, '-6').
OpcMultipartMd5 *string `presentIn:"header" name:"opc-multipart-md5"`
// The base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the object.
// Even for objects uploaded using multipart upload, this header returns the CRC32C (Castagnoli) checksum
// of the complete reconstructed object.
OpcContentCrc32c *string `presentIn:"header" name:"opc-content-crc32c"`
// Base-64 representation of the multipart object SHA256 hash.
// The multipart object hash is calculated by taking the SHA256 hashes of the parts passed to this call,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the SHA256 hash of the concatenated values. The multipart object hash is followed
// by a hyphen and the total number of parts (for example, '-6').
OpcMultipartSha256 *string `presentIn:"header" name:"opc-multipart-sha256"`
// Base-64 representation of the multipart object SHA384 hash.
// The multipart object hash is calculated by taking the SHA384 hashes of the parts passed to this call,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the SHA384 hash of the concatenated values. The multipart object hash is followed
// by a hyphen and the total number of parts (for example, '-6').
OpcMultipartSha384 *string `presentIn:"header" name:"opc-multipart-sha384"`
// The entity tag (ETag) for the object.
ETag *string `presentIn:"header" name:"etag"`
// The time the object was last modified, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
// VersionId of the newly created object
VersionId *string `presentIn:"header" name:"version-id"`
}
func (response CommitMultipartUploadResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CommitMultipartUploadResponse) String() string
CopyObjectDetails The parameters required by Object Storage to process a request to copy an object to another bucket. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type CopyObjectDetails struct {
// The name of the object to be copied.
SourceObjectName *string `mandatory:"true" json:"sourceObjectName"`
// The destination region the object will be copied to, for example "us-ashburn-1".
DestinationRegion *string `mandatory:"true" json:"destinationRegion"`
// The destination Object Storage namespace the object will be copied to.
DestinationNamespace *string `mandatory:"true" json:"destinationNamespace"`
// The destination bucket the object will be copied to.
DestinationBucket *string `mandatory:"true" json:"destinationBucket"`
// The name of the destination object resulting from the copy operation. Avoid entering confidential information.
DestinationObjectName *string `mandatory:"true" json:"destinationObjectName"`
// The entity tag (ETag) to match against that of the source object. Used to confirm that the source object
// with a given name is the version of that object storing a specified ETag.
SourceObjectIfMatchETag *string `mandatory:"false" json:"sourceObjectIfMatchETag"`
// VersionId of the object to copy. If not provided then current version is copied by default.
SourceVersionId *string `mandatory:"false" json:"sourceVersionId"`
// The entity tag (ETag) to match against that of the destination object (an object intended to be overwritten).
// Used to confirm that the destination object stored under a given name is the version of that object
// storing a specified entity tag.
DestinationObjectIfMatchETag *string `mandatory:"false" json:"destinationObjectIfMatchETag"`
// The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail
// if the object already exists in the destination bucket.
DestinationObjectIfNoneMatchETag *string `mandatory:"false" json:"destinationObjectIfNoneMatchETag"`
// Arbitrary string keys and values for the user-defined metadata for the object. Keys must be in
// "opc-meta-*" format. Avoid entering confidential information. Metadata key-value pairs entered
// in this field are assigned to the destination object. If you enter no metadata values, the destination
// object will inherit any existing metadata values associated with the source object.
DestinationObjectMetadata map[string]string `mandatory:"false" json:"destinationObjectMetadata"`
// The storage tier that the object should be stored in. If not specified, the object will be stored in
// the same storage tier as the bucket.
DestinationObjectStorageTier StorageTierEnum `mandatory:"false" json:"destinationObjectStorageTier,omitempty"`
}
func (m CopyObjectDetails) String() string
func (m CopyObjectDetails) 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
CopyObjectRequest wrapper for the CopyObject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CopyObject.go.html to see an example of how to use CopyObjectRequest.
type CopyObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The source and destination of the object to be copied.
CopyObjectDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The optional header that specifies "AES256" as the encryption algorithm. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or
// decrypt the data. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This
// value is used to check the integrity of the encryption key. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key-sha256"`
// The optional header that specifies "AES256" as the encryption algorithm to use to decrypt the source
// object. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSourceSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-source-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to decrypt
// the source object. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSourceSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-source-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key used to
// decrypt the source object. This value is used to check the integrity of the encryption key. For
// more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSourceSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-source-sse-customer-key-sha256"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key
// Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
OpcSseKmsKeyId *string `mandatory:"false" contributesTo:"header" name:"opc-sse-kms-key-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 CopyObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CopyObjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CopyObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CopyObjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CopyObjectRequest) String() string
func (request CopyObjectRequest) 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
CopyObjectResponse wrapper for the CopyObject operation
type CopyObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
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, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response CopyObjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CopyObjectResponse) String() string
CreateBucketDetails To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type CreateBucketDetails struct {
// The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
// Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information.
// example: Example: my-new-bucket1
Name *string `mandatory:"true" json:"name"`
// The ID of the compartment in which to create the bucket.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Arbitrary string, up to 4KB, of keys and values for user-defined metadata.
Metadata map[string]string `mandatory:"false" json:"metadata"`
// The type of public access enabled on this bucket.
// A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the
// bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the
// `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the bucket,
// public access is allowed for the `GetObject` and `HeadObject` operations.
PublicAccessType CreateBucketDetailsPublicAccessTypeEnum `mandatory:"false" json:"publicAccessType,omitempty"`
// The type of storage tier of this bucket.
// A bucket is set to 'Standard' tier by default, which means the bucket will be put in the standard storage tier.
// When 'Archive' tier type is set explicitly, the bucket is put in the Archive Storage tier. The 'storageTier'
// property is immutable after bucket is created.
StorageTier CreateBucketDetailsStorageTierEnum `mandatory:"false" json:"storageTier,omitempty"`
// Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is
// set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information
// about events, see Overview of Events (https://docs.oracle.com/iaas/Content/Events/Concepts/eventsoverview.htm).
ObjectEventsEnabled *bool `mandatory:"false" json:"objectEventsEnabled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key
// Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Set the versioning status on the bucket. By default, a bucket is created with versioning `Disabled`. Use this option to enable versioning during bucket creation. Objects in a version enabled bucket are protected from overwrites and deletions. Previous versions of the same object will be available in the bucket.
Versioning CreateBucketDetailsVersioningEnum `mandatory:"false" json:"versioning,omitempty"`
// Set the auto tiering status on the bucket. By default, a bucket is created with auto tiering `Disabled`.
// Use this option to enable auto tiering during bucket creation. Objects in a bucket with auto tiering set to
// `InfrequentAccess` are transitioned automatically between the 'Standard' and 'InfrequentAccess'
// tiers based on the access pattern of the objects.
AutoTiering BucketAutoTieringEnum `mandatory:"false" json:"autoTiering,omitempty"`
}
func (m CreateBucketDetails) String() string
func (m CreateBucketDetails) 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
CreateBucketDetailsPublicAccessTypeEnum Enum with underlying type: string
type CreateBucketDetailsPublicAccessTypeEnum string
Set of constants representing the allowable values for CreateBucketDetailsPublicAccessTypeEnum
const (
CreateBucketDetailsPublicAccessTypeNopublicaccess CreateBucketDetailsPublicAccessTypeEnum = "NoPublicAccess"
CreateBucketDetailsPublicAccessTypeObjectread CreateBucketDetailsPublicAccessTypeEnum = "ObjectRead"
CreateBucketDetailsPublicAccessTypeObjectreadwithoutlist CreateBucketDetailsPublicAccessTypeEnum = "ObjectReadWithoutList"
)
func GetCreateBucketDetailsPublicAccessTypeEnumValues() []CreateBucketDetailsPublicAccessTypeEnum
GetCreateBucketDetailsPublicAccessTypeEnumValues Enumerates the set of values for CreateBucketDetailsPublicAccessTypeEnum
func GetMappingCreateBucketDetailsPublicAccessTypeEnum(val string) (CreateBucketDetailsPublicAccessTypeEnum, bool)
GetMappingCreateBucketDetailsPublicAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateBucketDetailsStorageTierEnum Enum with underlying type: string
type CreateBucketDetailsStorageTierEnum string
Set of constants representing the allowable values for CreateBucketDetailsStorageTierEnum
const (
CreateBucketDetailsStorageTierStandard CreateBucketDetailsStorageTierEnum = "Standard"
CreateBucketDetailsStorageTierArchive CreateBucketDetailsStorageTierEnum = "Archive"
)
func GetCreateBucketDetailsStorageTierEnumValues() []CreateBucketDetailsStorageTierEnum
GetCreateBucketDetailsStorageTierEnumValues Enumerates the set of values for CreateBucketDetailsStorageTierEnum
func GetMappingCreateBucketDetailsStorageTierEnum(val string) (CreateBucketDetailsStorageTierEnum, bool)
GetMappingCreateBucketDetailsStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
CreateBucketDetailsVersioningEnum Enum with underlying type: string
type CreateBucketDetailsVersioningEnum string
Set of constants representing the allowable values for CreateBucketDetailsVersioningEnum
const (
CreateBucketDetailsVersioningEnabled CreateBucketDetailsVersioningEnum = "Enabled"
CreateBucketDetailsVersioningDisabled CreateBucketDetailsVersioningEnum = "Disabled"
)
func GetCreateBucketDetailsVersioningEnumValues() []CreateBucketDetailsVersioningEnum
GetCreateBucketDetailsVersioningEnumValues Enumerates the set of values for CreateBucketDetailsVersioningEnum
func GetMappingCreateBucketDetailsVersioningEnum(val string) (CreateBucketDetailsVersioningEnum, bool)
GetMappingCreateBucketDetailsVersioningEnum performs case Insensitive comparison on enum value and return the desired enum
CreateBucketRequest wrapper for the CreateBucket operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateBucket.go.html to see an example of how to use CreateBucketRequest.
type CreateBucketRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// Request object for creating a bucket.
CreateBucketDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 CreateBucketRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBucketRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBucketRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CreateBucketRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBucketRequest) String() string
func (request CreateBucketRequest) 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
CreateBucketResponse wrapper for the CreateBucket operation
type CreateBucketResponse struct {
// The underlying http response
RawResponse *http.Response
// The Bucket instance
Bucket `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the bucket that was created.
ETag *string `presentIn:"header" name:"etag"`
// The full path to the bucket that was created.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateBucketResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBucketResponse) String() string
CreateMultipartUploadDetails To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type CreateMultipartUploadDetails struct {
// The name of the object to which this multi-part upload is targeted. Avoid entering confidential information.
// Example: test/object1.log
Object *string `mandatory:"true" json:"object"`
// The optional Content-Type header that defines the standard MIME type format of the object to upload.
// Specifying values for this header has no effect on Object Storage behavior. Programs that read the object
// determine what to do based on the value provided. For example, you could use this header to identify and
// perform special operations on text only objects.
ContentType *string `mandatory:"false" json:"contentType"`
// The optional Content-Language header that defines the content language of the object to upload. Specifying
// values for this header has no effect on Object Storage behavior. Programs that read the object determine what
// to do based on the value provided. For example, you could use this header to identify and differentiate objects
// based on a particular language.
ContentLanguage *string `mandatory:"false" json:"contentLanguage"`
// The optional Content-Encoding header that defines the content encodings that were applied to the object to
// upload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the
// object determine what to do based on the value provided. For example, you could use this header to determine
// what decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of
// the object.
ContentEncoding *string `mandatory:"false" json:"contentEncoding"`
// The optional Content-Disposition header that defines presentational information for the object to be
// returned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object
// Storage behavior. Programs that read the object determine what to do based on the value provided.
// For example, you could use this header to let users download objects with custom filenames in a browser.
ContentDisposition *string `mandatory:"false" json:"contentDisposition"`
// The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and
// HeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs
// that read the object determine what to do based on the value provided.
// For example, you could use this header to identify objects that require caching restrictions.
CacheControl *string `mandatory:"false" json:"cacheControl"`
// The storage tier that the object should be stored in. If not specified, the object will be stored in
// the same storage tier as the bucket.
StorageTier StorageTierEnum `mandatory:"false" json:"storageTier,omitempty"`
// Arbitrary string keys and values for the user-defined metadata for the object.
// Keys must be in "opc-meta-*" format. Avoid entering confidential information.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m CreateMultipartUploadDetails) String() string
func (m CreateMultipartUploadDetails) 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
CreateMultipartUploadOpcChecksumAlgorithmEnum Enum with underlying type: string
type CreateMultipartUploadOpcChecksumAlgorithmEnum string
Set of constants representing the allowable values for CreateMultipartUploadOpcChecksumAlgorithmEnum
const (
CreateMultipartUploadOpcChecksumAlgorithmCrc32c CreateMultipartUploadOpcChecksumAlgorithmEnum = "CRC32C"
CreateMultipartUploadOpcChecksumAlgorithmSha256 CreateMultipartUploadOpcChecksumAlgorithmEnum = "SHA256"
CreateMultipartUploadOpcChecksumAlgorithmSha384 CreateMultipartUploadOpcChecksumAlgorithmEnum = "SHA384"
)
func GetCreateMultipartUploadOpcChecksumAlgorithmEnumValues() []CreateMultipartUploadOpcChecksumAlgorithmEnum
GetCreateMultipartUploadOpcChecksumAlgorithmEnumValues Enumerates the set of values for CreateMultipartUploadOpcChecksumAlgorithmEnum
func GetMappingCreateMultipartUploadOpcChecksumAlgorithmEnum(val string) (CreateMultipartUploadOpcChecksumAlgorithmEnum, bool)
GetMappingCreateMultipartUploadOpcChecksumAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
CreateMultipartUploadRequest wrapper for the CreateMultipartUpload operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateMultipartUpload.go.html to see an example of how to use CreateMultipartUploadRequest.
type CreateMultipartUploadRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// Request object for creating a multipart upload.
CreateMultipartUploadDetails `contributesTo:"body"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should
// fail if the resource already exists.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The optional header that specifies "AES256" as the encryption algorithm. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or
// decrypt the data. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This
// value is used to check the integrity of the encryption key. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key-sha256"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key
// Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
OpcSseKmsKeyId *string `mandatory:"false" contributesTo:"header" name:"opc-sse-kms-key-id"`
// The optional checksum algorithm to use to compute and store the checksum of the body of the HTTP request (or the parts in case of multipart uploads),
// in addition to the default MD5 checksum.
OpcChecksumAlgorithm CreateMultipartUploadOpcChecksumAlgorithmEnum `mandatory:"false" contributesTo:"header" name:"opc-checksum-algorithm"`
// 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 CreateMultipartUploadRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateMultipartUploadRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateMultipartUploadRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CreateMultipartUploadRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateMultipartUploadRequest) String() string
func (request CreateMultipartUploadRequest) 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
CreateMultipartUploadResponse wrapper for the CreateMultipartUpload operation
type CreateMultipartUploadResponse struct {
// The underlying http response
RawResponse *http.Response
// The MultipartUpload instance
MultipartUpload `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The full path to the new upload.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateMultipartUploadResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateMultipartUploadResponse) String() string
CreatePreauthenticatedRequestDetails The representation of CreatePreauthenticatedRequestDetails
type CreatePreauthenticatedRequestDetails struct {
// A user-specified name for the pre-authenticated request. Names can be helpful in managing pre-authenticated requests.
// Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// The operation that can be performed on this resource.
AccessType CreatePreauthenticatedRequestDetailsAccessTypeEnum `mandatory:"true" json:"accessType"`
// The expiration date for the pre-authenticated request as per RFC 3339 (https://tools.ietf.org/html/rfc3339).
// After this date the pre-authenticated request will no longer be valid.
TimeExpires *common.SDKTime `mandatory:"true" json:"timeExpires"`
// Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite".
// Deny: Prevents the user from performing a list operation.
// ListObjects: Authorizes the user to perform a list operation.
BucketListingAction PreauthenticatedRequestBucketListingActionEnum `mandatory:"false" json:"bucketListingAction,omitempty"`
// The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential
// information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket
// if the access type allows that. The object name can be a prefix as well, in that case pre-authenticated request
// grants access to all the objects within the bucket starting with that prefix provided that we have the correct access type.
ObjectName *string `mandatory:"false" json:"objectName"`
}
func (m CreatePreauthenticatedRequestDetails) String() string
func (m CreatePreauthenticatedRequestDetails) 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
CreatePreauthenticatedRequestDetailsAccessTypeEnum Enum with underlying type: string
type CreatePreauthenticatedRequestDetailsAccessTypeEnum string
Set of constants representing the allowable values for CreatePreauthenticatedRequestDetailsAccessTypeEnum
const (
CreatePreauthenticatedRequestDetailsAccessTypeObjectread CreatePreauthenticatedRequestDetailsAccessTypeEnum = "ObjectRead"
CreatePreauthenticatedRequestDetailsAccessTypeObjectwrite CreatePreauthenticatedRequestDetailsAccessTypeEnum = "ObjectWrite"
CreatePreauthenticatedRequestDetailsAccessTypeObjectreadwrite CreatePreauthenticatedRequestDetailsAccessTypeEnum = "ObjectReadWrite"
CreatePreauthenticatedRequestDetailsAccessTypeAnyobjectwrite CreatePreauthenticatedRequestDetailsAccessTypeEnum = "AnyObjectWrite"
CreatePreauthenticatedRequestDetailsAccessTypeAnyobjectread CreatePreauthenticatedRequestDetailsAccessTypeEnum = "AnyObjectRead"
CreatePreauthenticatedRequestDetailsAccessTypeAnyobjectreadwrite CreatePreauthenticatedRequestDetailsAccessTypeEnum = "AnyObjectReadWrite"
)
func GetCreatePreauthenticatedRequestDetailsAccessTypeEnumValues() []CreatePreauthenticatedRequestDetailsAccessTypeEnum
GetCreatePreauthenticatedRequestDetailsAccessTypeEnumValues Enumerates the set of values for CreatePreauthenticatedRequestDetailsAccessTypeEnum
func GetMappingCreatePreauthenticatedRequestDetailsAccessTypeEnum(val string) (CreatePreauthenticatedRequestDetailsAccessTypeEnum, bool)
GetMappingCreatePreauthenticatedRequestDetailsAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreatePreauthenticatedRequestRequest wrapper for the CreatePreauthenticatedRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreatePreauthenticatedRequest.go.html to see an example of how to use CreatePreauthenticatedRequestRequest.
type CreatePreauthenticatedRequestRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// Information needed to create the pre-authenticated request.
CreatePreauthenticatedRequestDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 CreatePreauthenticatedRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePreauthenticatedRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePreauthenticatedRequestRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CreatePreauthenticatedRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePreauthenticatedRequestRequest) String() string
func (request CreatePreauthenticatedRequestRequest) 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
CreatePreauthenticatedRequestResponse wrapper for the CreatePreauthenticatedRequest operation
type CreatePreauthenticatedRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The PreauthenticatedRequest instance
PreauthenticatedRequest `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreatePreauthenticatedRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePreauthenticatedRequestResponse) String() string
CreatePrivateEndpointDetails Details to create a private endpoint
type CreatePrivateEndpointDetails struct {
// This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens,
// underscores, and periods.
// Example: my-new-private-endpoint1
Name *string `mandatory:"true" json:"name"`
// The ID of the compartment in which to create the Private Endpoint.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the customer's subnet where the private endpoint VNIC will reside.
SubnetId *string `mandatory:"true" json:"subnetId"`
// A prefix to use for the private endpoint. The customer VCN's DNS records are
// updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn.
// Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage.<region>.oraclecloud.com'
Prefix *string `mandatory:"true" json:"prefix"`
// A list of targets that can be accessed by the private endpoint.
AccessTargets []AccessTargetDetails `mandatory:"true" json:"accessTargets"`
// A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the
// customer VCN's DNS record.
AdditionalPrefixes []string `mandatory:"false" json:"additionalPrefixes"`
// The private IP address to assign to this private endpoint. If you provide a value,
// it must be an available IP address in the customer's subnet. If it's not available, an error
// is returned.
// If you do not provide a value, an available IP address in the subnet is automatically chosen.
PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`
// A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
// For more information about NSGs, see
// NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreatePrivateEndpointDetails) String() string
func (m CreatePrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePrivateEndpointRequest wrapper for the CreatePrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreatePrivateEndpoint.go.html to see an example of how to use CreatePrivateEndpointRequest.
type CreatePrivateEndpointRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// Details to create a private endpoint.
CreatePrivateEndpointDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreatePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePrivateEndpointRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CreatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePrivateEndpointRequest) String() string
func (request CreatePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePrivateEndpointResponse wrapper for the CreatePrivateEndpoint operation
type CreatePrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
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, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response CreatePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePrivateEndpointResponse) String() string
CreateReplicationPolicyDetails The details to create a replication policy.
type CreateReplicationPolicyDetails struct {
// The name of the policy. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// The destination region to replicate to, for example "us-ashburn-1".
DestinationRegionName *string `mandatory:"true" json:"destinationRegionName"`
// The bucket to replicate to in the destination region. Replication policy creation does not automatically
// create a destination bucket. Create the destination bucket before creating the policy.
DestinationBucketName *string `mandatory:"true" json:"destinationBucketName"`
}
func (m CreateReplicationPolicyDetails) String() string
func (m CreateReplicationPolicyDetails) 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
CreateReplicationPolicyRequest wrapper for the CreateReplicationPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateReplicationPolicy.go.html to see an example of how to use CreateReplicationPolicyRequest.
type CreateReplicationPolicyRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The replication policy.
CreateReplicationPolicyDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 CreateReplicationPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateReplicationPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateReplicationPolicyRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CreateReplicationPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateReplicationPolicyRequest) String() string
func (request CreateReplicationPolicyRequest) 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
CreateReplicationPolicyResponse wrapper for the CreateReplicationPolicy operation
type CreateReplicationPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ReplicationPolicy instance
ReplicationPolicy `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response CreateReplicationPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateReplicationPolicyResponse) String() string
CreateRetentionRuleDetails The details to create a retention rule.
type CreateRetentionRuleDetails struct {
// A user-specified name for the retention rule. Names can be helpful in identifying retention rules.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
Duration *Duration `mandatory:"false" json:"duration"`
// The date and time as per RFC 3339 (https://tools.ietf.org/html/rfc3339) after which this rule is locked
// and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are
// allowed and no other properties can be changed. This property cannot be updated for rules that are in a
// locked state. Specifying it when a duration is not specified is considered an error.
TimeRuleLocked *common.SDKTime `mandatory:"false" json:"timeRuleLocked"`
}
func (m CreateRetentionRuleDetails) String() string
func (m CreateRetentionRuleDetails) 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
CreateRetentionRuleRequest wrapper for the CreateRetentionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateRetentionRule.go.html to see an example of how to use CreateRetentionRuleRequest.
type CreateRetentionRuleRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The retention rule to create for the bucket.
CreateRetentionRuleDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 CreateRetentionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRetentionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRetentionRuleRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request CreateRetentionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRetentionRuleRequest) String() string
func (request CreateRetentionRuleRequest) 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
CreateRetentionRuleResponse wrapper for the CreateRetentionRule operation
type CreateRetentionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The RetentionRule instance
RetentionRule `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// The entity tag (ETag) for the retention rule that was created.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateRetentionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRetentionRuleResponse) String() string
DeleteBucketRequest wrapper for the DeleteBucket operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteBucket.go.html to see an example of how to use DeleteBucketRequest.
type DeleteBucketRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 DeleteBucketRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBucketRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBucketRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request DeleteBucketRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBucketRequest) String() string
func (request DeleteBucketRequest) 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
DeleteBucketResponse wrapper for the DeleteBucket operation
type DeleteBucketResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteBucketResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBucketResponse) String() string
DeleteObjectLifecyclePolicyRequest wrapper for the DeleteObjectLifecyclePolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteObjectLifecyclePolicy.go.html to see an example of how to use DeleteObjectLifecyclePolicyRequest.
type DeleteObjectLifecyclePolicyRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteObjectLifecyclePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteObjectLifecyclePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteObjectLifecyclePolicyRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request DeleteObjectLifecyclePolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteObjectLifecyclePolicyRequest) String() string
func (request DeleteObjectLifecyclePolicyRequest) 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
DeleteObjectLifecyclePolicyResponse wrapper for the DeleteObjectLifecyclePolicy operation
type DeleteObjectLifecyclePolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response DeleteObjectLifecyclePolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteObjectLifecyclePolicyResponse) String() string
DeleteObjectRequest wrapper for the DeleteObject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteObject.go.html to see an example of how to use DeleteObjectRequest.
type DeleteObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// VersionId used to identify a particular version of the object
VersionId *string `mandatory:"false" contributesTo:"query" name:"versionId"`
// 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 DeleteObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteObjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request DeleteObjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteObjectRequest) String() string
func (request DeleteObjectRequest) 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
DeleteObjectResponse wrapper for the DeleteObject operation
type DeleteObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The time the object was deleted, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
// The `versionId` of the delete marker created as a result of the DELETE Object.
// If the request contains a specific `versionId`, then this response header will be the same as the requested `versionId` of the object that was deleted.
VersionId *string `presentIn:"header" name:"version-id"`
// This is `true` if the deleted object is a delete marker, otherwise `false`
IsDeleteMarker *bool `presentIn:"header" name:"is-delete-marker"`
}
func (response DeleteObjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteObjectResponse) String() string
DeletePreauthenticatedRequestRequest wrapper for the DeletePreauthenticatedRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeletePreauthenticatedRequest.go.html to see an example of how to use DeletePreauthenticatedRequestRequest.
type DeletePreauthenticatedRequestRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The unique identifier for the pre-authenticated request. This can be used to manage operations against
// the pre-authenticated request, such as GET or DELETE.
ParId *string `mandatory:"true" contributesTo:"path" name:"parId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 DeletePreauthenticatedRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePreauthenticatedRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePreauthenticatedRequestRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request DeletePreauthenticatedRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePreauthenticatedRequestRequest) String() string
func (request DeletePreauthenticatedRequestRequest) 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
DeletePreauthenticatedRequestResponse wrapper for the DeletePreauthenticatedRequest operation
type DeletePreauthenticatedRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeletePreauthenticatedRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePreauthenticatedRequestResponse) String() string
DeletePrivateEndpointRequest wrapper for the DeletePrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeletePrivateEndpoint.go.html to see an example of how to use DeletePrivateEndpointRequest.
type DeletePrivateEndpointRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the private endpoint. Avoid entering confidential information.
// Example: `my-new-pe-1`
PeName *string `mandatory:"true" contributesTo:"path" name:"peName"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 DeletePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePrivateEndpointRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request DeletePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePrivateEndpointRequest) String() string
func (request DeletePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeletePrivateEndpointResponse wrapper for the DeletePrivateEndpoint operation
type DeletePrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeletePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePrivateEndpointResponse) String() string
DeleteReplicationPolicyRequest wrapper for the DeleteReplicationPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteReplicationPolicy.go.html to see an example of how to use DeleteReplicationPolicyRequest.
type DeleteReplicationPolicyRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The ID of the replication policy.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 DeleteReplicationPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteReplicationPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteReplicationPolicyRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request DeleteReplicationPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteReplicationPolicyRequest) String() string
func (request DeleteReplicationPolicyRequest) 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
DeleteReplicationPolicyResponse wrapper for the DeleteReplicationPolicy operation
type DeleteReplicationPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response DeleteReplicationPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteReplicationPolicyResponse) String() string
DeleteRetentionRuleRequest wrapper for the DeleteRetentionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteRetentionRule.go.html to see an example of how to use DeleteRetentionRuleRequest.
type DeleteRetentionRuleRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The ID of the retention rule.
RetentionRuleId *string `mandatory:"true" contributesTo:"path" name:"retentionRuleId"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 DeleteRetentionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRetentionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRetentionRuleRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request DeleteRetentionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRetentionRuleRequest) String() string
func (request DeleteRetentionRuleRequest) 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
DeleteRetentionRuleResponse wrapper for the DeleteRetentionRule operation
type DeleteRetentionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteRetentionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRetentionRuleResponse) String() string
Duration The amount of time that objects in the bucket should be preserved for and which is calculated in relation to each object's Last-Modified timestamp. If duration is not present, then there is no time limit and the objects in the bucket will be preserved indefinitely.
type Duration struct {
// The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation
// to each object's Last-Modified timestamp.
TimeAmount *int64 `mandatory:"true" json:"timeAmount"`
// The unit that should be used to interpret timeAmount.
TimeUnit DurationTimeUnitEnum `mandatory:"true" json:"timeUnit"`
}
func (m Duration) String() string
func (m Duration) 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
DurationTimeUnitEnum Enum with underlying type: string
type DurationTimeUnitEnum string
Set of constants representing the allowable values for DurationTimeUnitEnum
const (
DurationTimeUnitYears DurationTimeUnitEnum = "YEARS"
DurationTimeUnitDays DurationTimeUnitEnum = "DAYS"
)
func GetDurationTimeUnitEnumValues() []DurationTimeUnitEnum
GetDurationTimeUnitEnumValues Enumerates the set of values for DurationTimeUnitEnum
func GetMappingDurationTimeUnitEnum(val string) (DurationTimeUnitEnum, bool)
GetMappingDurationTimeUnitEnum performs case Insensitive comparison on enum value and return the desired enum
Fqdns The object representing FQDN details formed using prefix and additionalPrefixes.
type Fqdns struct {
PrefixFqdns *PrefixFqdns `mandatory:"false" json:"prefixFqdns"`
// An object containing FQDNs formed using additionalPrefixes.
AdditionalPrefixesFqdns map[string]PrefixFqdns `mandatory:"false" json:"additionalPrefixesFqdns"`
}
func (m Fqdns) String() string
func (m Fqdns) 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
GetBucketFieldsEnum Enum with underlying type: string
type GetBucketFieldsEnum string
Set of constants representing the allowable values for GetBucketFieldsEnum
const (
GetBucketFieldsApproximatecount GetBucketFieldsEnum = "approximateCount"
GetBucketFieldsApproximatesize GetBucketFieldsEnum = "approximateSize"
GetBucketFieldsAutotiering GetBucketFieldsEnum = "autoTiering"
)
func GetGetBucketFieldsEnumValues() []GetBucketFieldsEnum
GetGetBucketFieldsEnumValues Enumerates the set of values for GetBucketFieldsEnum
func GetMappingGetBucketFieldsEnum(val string) (GetBucketFieldsEnum, bool)
GetMappingGetBucketFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetBucketRequest wrapper for the GetBucket operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetBucket.go.html to see an example of how to use GetBucketRequest.
type GetBucketRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not
// match the ETag of the existing resource, the request returns the expected response. If the ETag matches
// the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Bucket summary includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',
// and 'etag' fields. This parameter can also include 'approximateCount' (approximate number of objects), 'approximateSize'
// (total approximate size in bytes of all objects) and 'autoTiering' (state of auto tiering on the bucket).
// For example 'approximateCount,approximateSize,autoTiering'.
Fields []GetBucketFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"csv"`
// 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 GetBucketRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBucketRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBucketRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetBucketRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBucketRequest) String() string
func (request GetBucketRequest) 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
GetBucketResponse wrapper for the GetBucket operation
type GetBucketResponse struct {
// The underlying http response
RawResponse *http.Response
// The Bucket instance
Bucket `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The current entity tag (ETag) for the bucket.
ETag *string `presentIn:"header" name:"etag"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetBucketResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBucketResponse) String() string
GetNamespaceMetadataRequest wrapper for the GetNamespaceMetadata operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetNamespaceMetadata.go.html to see an example of how to use GetNamespaceMetadataRequest.
type GetNamespaceMetadataRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 GetNamespaceMetadataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNamespaceMetadataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNamespaceMetadataRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetNamespaceMetadataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNamespaceMetadataRequest) String() string
func (request GetNamespaceMetadataRequest) 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
GetNamespaceMetadataResponse wrapper for the GetNamespaceMetadata operation
type GetNamespaceMetadataResponse struct {
// The underlying http response
RawResponse *http.Response
// The NamespaceMetadata instance
NamespaceMetadata `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetNamespaceMetadataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNamespaceMetadataResponse) String() string
GetNamespaceRequest wrapper for the GetNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetNamespace.go.html to see an example of how to use GetNamespaceRequest.
type GetNamespaceRequest struct {
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// This is an optional field representing either the tenancy OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or the compartment
// OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) within the tenancy whose Object Storage namespace is to be retrieved.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// 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 GetNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNamespaceRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNamespaceRequest) String() string
func (request GetNamespaceRequest) 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
GetNamespaceResponse wrapper for the GetNamespace operation
type GetNamespaceResponse struct {
// The underlying http response
RawResponse *http.Response
// The string instance
Value *string `presentIn:"body"`
}
func (response GetNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNamespaceResponse) String() string
GetObjectArchivalStateEnum Enum with underlying type: string
type GetObjectArchivalStateEnum string
Set of constants representing the allowable values for GetObjectArchivalStateEnum
const (
GetObjectArchivalStateArchived GetObjectArchivalStateEnum = "Archived"
GetObjectArchivalStateRestoring GetObjectArchivalStateEnum = "Restoring"
GetObjectArchivalStateRestored GetObjectArchivalStateEnum = "Restored"
)
func GetGetObjectArchivalStateEnumValues() []GetObjectArchivalStateEnum
GetGetObjectArchivalStateEnumValues Enumerates the set of values for GetObjectArchivalStateEnum
func GetMappingGetObjectArchivalStateEnum(val string) (GetObjectArchivalStateEnum, bool)
GetMappingGetObjectArchivalStateEnum performs case Insensitive comparison on enum value and return the desired enum
GetObjectLifecyclePolicyRequest wrapper for the GetObjectLifecyclePolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetObjectLifecyclePolicy.go.html to see an example of how to use GetObjectLifecyclePolicyRequest.
type GetObjectLifecyclePolicyRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 GetObjectLifecyclePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetObjectLifecyclePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetObjectLifecyclePolicyRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetObjectLifecyclePolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetObjectLifecyclePolicyRequest) String() string
func (request GetObjectLifecyclePolicyRequest) 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
GetObjectLifecyclePolicyResponse wrapper for the GetObjectLifecyclePolicy operation
type GetObjectLifecyclePolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ObjectLifecyclePolicy instance
ObjectLifecyclePolicy `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// The entity tag (ETag) for the object lifecycle policy.
ETag *string `presentIn:"header" name:"etag"`
}
func (response GetObjectLifecyclePolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetObjectLifecyclePolicyResponse) String() string
GetObjectRequest wrapper for the GetObject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetObject.go.html to see an example of how to use GetObjectRequest.
type GetObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// VersionId used to identify a particular version of the object
VersionId *string `mandatory:"false" contributesTo:"query" name:"versionId"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not
// match the ETag of the existing resource, the request returns the expected response. If the ETag matches
// the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Optional byte range to fetch, as described in RFC 7233 (https://tools.ietf.org/html/rfc7233#section-2.1).
// Note that only a single range of bytes is supported.
Range *string `mandatory:"false" contributesTo:"header" name:"range"`
// The optional header that specifies "AES256" as the encryption algorithm. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or
// decrypt the data. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This
// value is used to check the integrity of the encryption key. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key-sha256"`
// Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response.
HttpResponseContentDisposition *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentDisposition"`
// Specify this query parameter to override the Cache-Control response header in the GetObject response.
HttpResponseCacheControl *string `mandatory:"false" contributesTo:"query" name:"httpResponseCacheControl"`
// Specify this query parameter to override the Content-Type response header in the GetObject response.
HttpResponseContentType *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentType"`
// Specify this query parameter to override the Content-Language response header in the GetObject response.
HttpResponseContentLanguage *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentLanguage"`
// Specify this query parameter to override the Content-Encoding response header in the GetObject response.
HttpResponseContentEncoding *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentEncoding"`
// Specify this query parameter to override the Expires response header in the GetObject response.
HttpResponseExpires *string `mandatory:"false" contributesTo:"query" name:"httpResponseExpires"`
// 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 GetObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetObjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetObjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetObjectRequest) String() string
func (request GetObjectRequest) 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
GetObjectResponse wrapper for the GetObject operation
type GetObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the object.
ETag *string `presentIn:"header" name:"etag"`
// The user-defined metadata for the object.
OpcMeta map[string]string `presentIn:"header-collection" prefix:"opc-meta-"`
// The object size in bytes.
ContentLength *int64 `presentIn:"header" name:"content-length"`
// Content-Range header for range requests, per RFC 7233 (https://tools.ietf.org/html/rfc7233#section-4.2).
ContentRange *string `presentIn:"header" name:"content-range"`
// Content-MD5 header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.15).
// Unavailable for objects uploaded using multipart upload.
ContentMd5 *string `presentIn:"header" name:"content-md5"`
// Only applicable to objects uploaded using multipart upload.
// Base-64 representation of the multipart object hash.
// The multipart object hash is calculated by taking the MD5 hashes of the parts,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the MD5 hash of the concatenated values.
OpcMultipartMd5 *string `presentIn:"header" name:"opc-multipart-md5"`
// The base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the object.
// Even for objects uploaded using multipart upload, this header returns the CRC32C (Castagnoli) checksum
// of the complete reconstructed object.
OpcContentCrc32c *string `presentIn:"header" name:"opc-content-crc32c"`
// Applicable only if SHA256 was specified in the opc-checksum-algorithm request header during upload.
// The base64-encoded SHA256 hash of the object as computed during upload.
// Unavailable for objects uploaded using multipart upload.
OpcContentSha256 *string `presentIn:"header" name:"opc-content-sha256"`
// Only applicable to objects uploaded using multipart upload.
// Applicable only if SHA256 was specified in the opc-checksum-algorithm request header during upload.
// Base-64 representation of the multipart object SHA256 hash.
// The multipart object hash is calculated by taking the SHA256 hashes of the parts,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the SHA256 hash of the concatenated values.
OpcMultipartSha256 *string `presentIn:"header" name:"opc-multipart-sha256"`
// Applicable only if SHA384 was specified in the opc-checksum-algorithm request header during upload.
// The base64-encoded SHA384 hash of the object as computed during upload.
// Unavailable for objects uploaded using multipart upload.
OpcContentSha384 *string `presentIn:"header" name:"opc-content-sha384"`
// Only applicable to objects uploaded using multipart upload.
// Applicable only if SHA384 was specified in the opc-checksum-algorithm request header during upload.
// Base-64 representation of the multipart object SHA384 hash.
// The multipart object hash is calculated by taking the SHA384 hashes of the parts,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the SHA384 hash of the concatenated values.
OpcMultipartSha384 *string `presentIn:"header" name:"opc-multipart-sha384"`
// Content-Type header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.17).
ContentType *string `presentIn:"header" name:"content-type"`
// Content-Language header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.12).
ContentLanguage *string `presentIn:"header" name:"content-language"`
// Content-Encoding header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.11).
ContentEncoding *string `presentIn:"header" name:"content-encoding"`
// Cache-Control header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.9).
CacheControl *string `presentIn:"header" name:"cache-control"`
// Content-Disposition header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-19.5.1).
ContentDisposition *string `presentIn:"header" name:"content-disposition"`
// The object modification time, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
// The storage tier that the object is stored in.
StorageTier GetObjectStorageTierEnum `presentIn:"header" name:"storage-tier"`
// Archival state of an object. This field is set only for objects in Archive tier.
ArchivalState GetObjectArchivalStateEnum `presentIn:"header" name:"archival-state"`
// Time that the object is returned to the archived state. This field is only present for restored objects.
TimeOfArchival *common.SDKTime `presentIn:"header" name:"time-of-archival"`
// VersionId of the object
VersionId *string `presentIn:"header" name:"version-id"`
// The date and time after which the object is no longer cached by a browser, proxy, or other caching entity. See
// RFC 2616 (https://tools.ietf.org/rfc/rfc2616#section-14.21).
Expires *common.SDKTime `presentIn:"header" name:"expires"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetObjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetObjectResponse) String() string
GetObjectStorageTierEnum Enum with underlying type: string
type GetObjectStorageTierEnum string
Set of constants representing the allowable values for GetObjectStorageTierEnum
const (
GetObjectStorageTierStandard GetObjectStorageTierEnum = "Standard"
GetObjectStorageTierInfrequentaccess GetObjectStorageTierEnum = "InfrequentAccess"
GetObjectStorageTierArchive GetObjectStorageTierEnum = "Archive"
)
func GetGetObjectStorageTierEnumValues() []GetObjectStorageTierEnum
GetGetObjectStorageTierEnumValues Enumerates the set of values for GetObjectStorageTierEnum
func GetMappingGetObjectStorageTierEnum(val string) (GetObjectStorageTierEnum, bool)
GetMappingGetObjectStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
GetPreauthenticatedRequestRequest wrapper for the GetPreauthenticatedRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetPreauthenticatedRequest.go.html to see an example of how to use GetPreauthenticatedRequestRequest.
type GetPreauthenticatedRequestRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The unique identifier for the pre-authenticated request. This can be used to manage operations against
// the pre-authenticated request, such as GET or DELETE.
ParId *string `mandatory:"true" contributesTo:"path" name:"parId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 GetPreauthenticatedRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPreauthenticatedRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPreauthenticatedRequestRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetPreauthenticatedRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPreauthenticatedRequestRequest) String() string
func (request GetPreauthenticatedRequestRequest) 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
GetPreauthenticatedRequestResponse wrapper for the GetPreauthenticatedRequest operation
type GetPreauthenticatedRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The PreauthenticatedRequestSummary instance
PreauthenticatedRequestSummary `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetPreauthenticatedRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPreauthenticatedRequestResponse) String() string
GetPrivateEndpointRequest wrapper for the GetPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetPrivateEndpoint.go.html to see an example of how to use GetPrivateEndpointRequest.
type GetPrivateEndpointRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the private endpoint. Avoid entering confidential information.
// Example: `my-new-pe-1`
PeName *string `mandatory:"true" contributesTo:"path" name:"peName"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not
// match the ETag of the existing resource, the request returns the expected response. If the ETag matches
// the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPrivateEndpointRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPrivateEndpointRequest) String() string
func (request GetPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPrivateEndpointResponse wrapper for the GetPrivateEndpoint operation
type GetPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrivateEndpoint instance
PrivateEndpoint `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the Private Endpoint.
ETag *string `presentIn:"header" name:"etag"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPrivateEndpointResponse) String() string
GetReplicationPolicyRequest wrapper for the GetReplicationPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetReplicationPolicy.go.html to see an example of how to use GetReplicationPolicyRequest.
type GetReplicationPolicyRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The ID of the replication policy.
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 GetReplicationPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetReplicationPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetReplicationPolicyRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetReplicationPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetReplicationPolicyRequest) String() string
func (request GetReplicationPolicyRequest) 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
GetReplicationPolicyResponse wrapper for the GetReplicationPolicy operation
type GetReplicationPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ReplicationPolicy instance
ReplicationPolicy `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response GetReplicationPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetReplicationPolicyResponse) String() string
GetRetentionRuleRequest wrapper for the GetRetentionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetRetentionRule.go.html to see an example of how to use GetRetentionRuleRequest.
type GetRetentionRuleRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The ID of the retention rule.
RetentionRuleId *string `mandatory:"true" contributesTo:"path" name:"retentionRuleId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 GetRetentionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRetentionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRetentionRuleRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetRetentionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRetentionRuleRequest) String() string
func (request GetRetentionRuleRequest) 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
GetRetentionRuleResponse wrapper for the GetRetentionRule operation
type GetRetentionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The RetentionRule instance
RetentionRule `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the retention rule.
Etag *string `presentIn:"header" name:"etag"`
// The time the retention rule was last modified, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29)
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
}
func (response GetRetentionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRetentionRuleResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HeadBucketRequest wrapper for the HeadBucket operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/HeadBucket.go.html to see an example of how to use HeadBucketRequest.
type HeadBucketRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not
// match the ETag of the existing resource, the request returns the expected response. If the ETag matches
// the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 HeadBucketRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request HeadBucketRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request HeadBucketRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request HeadBucketRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request HeadBucketRequest) String() string
func (request HeadBucketRequest) 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
HeadBucketResponse wrapper for the HeadBucket operation
type HeadBucketResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The current entity tag (ETag) for the bucket.
ETag *string `presentIn:"header" name:"etag"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response HeadBucketResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response HeadBucketResponse) String() string
HeadObjectArchivalStateEnum Enum with underlying type: string
type HeadObjectArchivalStateEnum string
Set of constants representing the allowable values for HeadObjectArchivalStateEnum
const (
HeadObjectArchivalStateArchived HeadObjectArchivalStateEnum = "Archived"
HeadObjectArchivalStateRestoring HeadObjectArchivalStateEnum = "Restoring"
HeadObjectArchivalStateRestored HeadObjectArchivalStateEnum = "Restored"
)
func GetHeadObjectArchivalStateEnumValues() []HeadObjectArchivalStateEnum
GetHeadObjectArchivalStateEnumValues Enumerates the set of values for HeadObjectArchivalStateEnum
func GetMappingHeadObjectArchivalStateEnum(val string) (HeadObjectArchivalStateEnum, bool)
GetMappingHeadObjectArchivalStateEnum performs case Insensitive comparison on enum value and return the desired enum
HeadObjectRequest wrapper for the HeadObject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/HeadObject.go.html to see an example of how to use HeadObjectRequest.
type HeadObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// VersionId used to identify a particular version of the object
VersionId *string `mandatory:"false" contributesTo:"query" name:"versionId"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not
// match the ETag of the existing resource, the request returns the expected response. If the ETag matches
// the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The optional header that specifies "AES256" as the encryption algorithm. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or
// decrypt the data. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This
// value is used to check the integrity of the encryption key. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key-sha256"`
// 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 HeadObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request HeadObjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request HeadObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request HeadObjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request HeadObjectRequest) String() string
func (request HeadObjectRequest) 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
HeadObjectResponse wrapper for the HeadObject operation
type HeadObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the object.
ETag *string `presentIn:"header" name:"etag"`
// The user-defined metadata for the object.
OpcMeta map[string]string `presentIn:"header-collection" prefix:"opc-meta-"`
// The object size in bytes.
ContentLength *int64 `presentIn:"header" name:"content-length"`
// Content-MD5 header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.15).
// Unavailable for objects uploaded using multipart upload.
ContentMd5 *string `presentIn:"header" name:"content-md5"`
// Only applicable to objects uploaded using multipart upload.
// Base-64 representation of the multipart object hash.
// The multipart object hash is calculated by taking the MD5 hashes of the parts,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the MD5 hash of the concatenated values.
OpcMultipartMd5 *string `presentIn:"header" name:"opc-multipart-md5"`
// The base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the object.
// Even for objects uploaded using multipart upload, this header returns the CRC32C (Castagnoli) checksum
// of the complete reconstructed object.
OpcContentCrc32c *string `presentIn:"header" name:"opc-content-crc32c"`
// Applicable only if SHA256 was specified in the opc-checksum-algorithm request header during upload.
// The base64-encoded SHA256 hash of the object as computed during upload.
// Unavailable for objects uploaded using multipart upload.
OpcContentSha256 *string `presentIn:"header" name:"opc-content-sha256"`
// Only applicable to objects uploaded using multipart upload.
// Applicable only if SHA256 was specified in the opc-checksum-algorithm request header during upload.
// Base-64 representation of the multipart object SHA256 hash.
// The multipart object hash is calculated by taking the SHA256 hashes of the parts,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the SHA256 hash of the concatenated values.
OpcMultipartSha256 *string `presentIn:"header" name:"opc-multipart-sha256"`
// Applicable only if SHA384 was specified in the opc-checksum-algorithm request header during upload.
// The base64-encoded SHA384 hash of the object as computed during upload.
// Unavailable for objects uploaded using multipart upload.
OpcContentSha384 *string `presentIn:"header" name:"opc-content-sha384"`
// Only applicable to objects uploaded using multipart upload.
// Applicable only if SHA384 was specified in the opc-checksum-algorithm request header during upload.
// Base-64 representation of the multipart object SHA384 hash.
// The multipart object hash is calculated by taking the SHA384 hashes of the parts,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the SHA384 hash of the concatenated values.
OpcMultipartSha384 *string `presentIn:"header" name:"opc-multipart-sha384"`
// Content-Type header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.17).
ContentType *string `presentIn:"header" name:"content-type"`
// Content-Language header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.12).
ContentLanguage *string `presentIn:"header" name:"content-language"`
// Content-Encoding header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.11).
ContentEncoding *string `presentIn:"header" name:"content-encoding"`
// Cache-Control header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.9).
CacheControl *string `presentIn:"header" name:"cache-control"`
// Content-Disposition header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-19.5.1).
ContentDisposition *string `presentIn:"header" name:"content-disposition"`
// The object modification time, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
// The storage tier that the object is stored in.
StorageTier HeadObjectStorageTierEnum `presentIn:"header" name:"storage-tier"`
// Archival state of an object. This field is set only for objects in Archive tier.
ArchivalState HeadObjectArchivalStateEnum `presentIn:"header" name:"archival-state"`
// Time that the object is returned to the archived state. This field is only present for restored objects.
TimeOfArchival *common.SDKTime `presentIn:"header" name:"time-of-archival"`
// VersionId of the object requested
VersionId *string `presentIn:"header" name:"version-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response HeadObjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response HeadObjectResponse) String() string
HeadObjectStorageTierEnum Enum with underlying type: string
type HeadObjectStorageTierEnum string
Set of constants representing the allowable values for HeadObjectStorageTierEnum
const (
HeadObjectStorageTierStandard HeadObjectStorageTierEnum = "Standard"
HeadObjectStorageTierInfrequentaccess HeadObjectStorageTierEnum = "InfrequentAccess"
HeadObjectStorageTierArchive HeadObjectStorageTierEnum = "Archive"
)
func GetHeadObjectStorageTierEnumValues() []HeadObjectStorageTierEnum
GetHeadObjectStorageTierEnumValues Enumerates the set of values for HeadObjectStorageTierEnum
func GetMappingHeadObjectStorageTierEnum(val string) (HeadObjectStorageTierEnum, bool)
GetMappingHeadObjectStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
ListBucketsFieldsEnum Enum with underlying type: string
type ListBucketsFieldsEnum string
Set of constants representing the allowable values for ListBucketsFieldsEnum
const (
ListBucketsFieldsTags ListBucketsFieldsEnum = "tags"
)
func GetListBucketsFieldsEnumValues() []ListBucketsFieldsEnum
GetListBucketsFieldsEnumValues Enumerates the set of values for ListBucketsFieldsEnum
func GetMappingListBucketsFieldsEnum(val string) (ListBucketsFieldsEnum, bool)
GetMappingListBucketsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListBucketsRequest wrapper for the ListBuckets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListBuckets.go.html to see an example of how to use ListBucketsRequest.
type ListBucketsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The ID of the compartment in which to list buckets.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Bucket summary in list of buckets includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',
// and 'etag' fields. This parameter can also include 'tags' (freeformTags and definedTags). The only supported value of this parameter is 'tags' for now. Example 'tags'.
Fields []ListBucketsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"csv"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ListBucketsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBucketsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBucketsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListBucketsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBucketsRequest) String() string
func (request ListBucketsRequest) 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
ListBucketsResponse wrapper for the ListBuckets operation
type ListBucketsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []BucketSummary instances
Items []BucketSummary `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of buckets.
// In the GET request, set the limit to the number of buckets items that you want returned in the response.
// If the `opc-next-page` header appears in the response, then this is a partial list and there are additional
// buckets to get. Include the header's value as the `page` parameter in the subsequent GET request to get the
// next batch of buckets. Repeat this process to retrieve the entire list of buckets.
// By default, the page limit is set to 25 buckets per page, but you can specify a value from 1 to 1000.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListBucketsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBucketsResponse) String() string
ListMultipartUploadPartsRequest wrapper for the ListMultipartUploadParts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListMultipartUploadParts.go.html to see an example of how to use ListMultipartUploadPartsRequest.
type ListMultipartUploadPartsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// The upload ID for a multipart upload.
UploadId *string `mandatory:"true" contributesTo:"query" name:"uploadId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ListMultipartUploadPartsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMultipartUploadPartsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMultipartUploadPartsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListMultipartUploadPartsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMultipartUploadPartsRequest) String() string
func (request ListMultipartUploadPartsRequest) 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
ListMultipartUploadPartsResponse wrapper for the ListMultipartUploadParts operation
type ListMultipartUploadPartsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []MultipartUploadPartSummary instances
Items []MultipartUploadPartSummary `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of multipart upload parts.
// In the GET request, set the limit to the number of multipart upload parts that you want returned in the
// response. If the `opc-next-page` header appears in the response, then this is a partial list and there are
// additional multipart upload parts to get. Include the header's value as the `page` parameter in the subsequent
// GET request to get the next batch of multipart upload parts. Repeat this process to retrieve the entire list
// of multipart upload parts.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListMultipartUploadPartsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMultipartUploadPartsResponse) String() string
ListMultipartUploadsRequest wrapper for the ListMultipartUploads operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListMultipartUploads.go.html to see an example of how to use ListMultipartUploadsRequest.
type ListMultipartUploadsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ListMultipartUploadsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMultipartUploadsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMultipartUploadsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListMultipartUploadsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMultipartUploadsRequest) String() string
func (request ListMultipartUploadsRequest) 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
ListMultipartUploadsResponse wrapper for the ListMultipartUploads operation
type ListMultipartUploadsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []MultipartUpload instances
Items []MultipartUpload `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of multipart uploads.
// In the GET request, set the limit to the number of multipart uploads that you want returned in the response.
// If the `opc-next-page` header appears in the response, then this is a partial list and there are
// additional multipart uploads to get. Include the header's value as the `page` parameter in the subsequent
// GET request to get the next batch of objects. Repeat this process to retrieve the entire list of
// multipart uploads.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListMultipartUploadsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMultipartUploadsResponse) String() string
ListObjectVersionsFieldsEnum Enum with underlying type: string
type ListObjectVersionsFieldsEnum string
Set of constants representing the allowable values for ListObjectVersionsFieldsEnum
const (
ListObjectVersionsFieldsName ListObjectVersionsFieldsEnum = "name"
ListObjectVersionsFieldsSize ListObjectVersionsFieldsEnum = "size"
ListObjectVersionsFieldsEtag ListObjectVersionsFieldsEnum = "etag"
ListObjectVersionsFieldsTimecreated ListObjectVersionsFieldsEnum = "timeCreated"
ListObjectVersionsFieldsMd5 ListObjectVersionsFieldsEnum = "md5"
ListObjectVersionsFieldsTimemodified ListObjectVersionsFieldsEnum = "timeModified"
ListObjectVersionsFieldsStoragetier ListObjectVersionsFieldsEnum = "storageTier"
ListObjectVersionsFieldsArchivalstate ListObjectVersionsFieldsEnum = "archivalState"
)
func GetListObjectVersionsFieldsEnumValues() []ListObjectVersionsFieldsEnum
GetListObjectVersionsFieldsEnumValues Enumerates the set of values for ListObjectVersionsFieldsEnum
func GetMappingListObjectVersionsFieldsEnum(val string) (ListObjectVersionsFieldsEnum, bool)
GetMappingListObjectVersionsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListObjectVersionsRequest wrapper for the ListObjectVersions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListObjectVersions.go.html to see an example of how to use ListObjectVersionsRequest.
type ListObjectVersionsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The string to use for matching against the start of object names in a list query.
Prefix *string `mandatory:"false" contributesTo:"query" name:"prefix"`
// Returns object names which are lexicographically greater than or equal to this parameter.
Start *string `mandatory:"false" contributesTo:"query" name:"start"`
// Returns object names which are lexicographically strictly less than this parameter.
End *string `mandatory:"false" contributesTo:"query" name:"end"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// When this parameter is set, only objects whose names do not contain the delimiter character
// (after an optionally specified prefix) are returned in the objects key of the response body.
// Scanned objects whose names contain the delimiter have the part of their name up to the first
// occurrence of the delimiter (including the optional prefix) returned as a set of prefixes.
// Note that only '/' is a supported delimiter character at this time.
Delimiter *string `mandatory:"false" contributesTo:"query" name:"delimiter"`
// Object summary by default includes only the 'name' field. Use this parameter to also
// include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time),
// 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields.
// Specify the value of this parameter as a comma-separated, case-insensitive list of those field names.
// For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
Fields ListObjectVersionsFieldsEnum `mandatory:"false" contributesTo:"query" name:"fields" omitEmpty:"true"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Returns object names which are lexicographically strictly greater than this parameter.
StartAfter *string `mandatory:"false" contributesTo:"query" name:"startAfter"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListObjectVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListObjectVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListObjectVersionsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListObjectVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListObjectVersionsRequest) String() string
func (request ListObjectVersionsRequest) 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
ListObjectVersionsResponse wrapper for the ListObjectVersions operation
type ListObjectVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ObjectVersionCollection instances
ObjectVersionCollection `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of object versions.
// In the GET request, set the limit to the number of object versions that you want returned in the response.
// If the `opc-next-page` header appears in the response, then this is a partial list and there are
// additional object versions to get. Include the header's value as the `page` parameter in the subsequent
// GET request to get the next batch of object versions and prefixes. Repeat this process to retrieve the entire list of
// object versions and prefixes.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListObjectVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListObjectVersionsResponse) String() string
ListObjects To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type ListObjects struct {
// An array of object summaries.
Objects []ObjectSummary `mandatory:"true" json:"objects"`
// Prefixes that are common to the results returned by the request if the request specified a delimiter.
Prefixes []string `mandatory:"false" json:"prefixes"`
// The name of the object to use in the `start` parameter to obtain the next page of
// a truncated ListObjects response. Avoid entering confidential information.
// Example: test/object1.log
NextStartWith *string `mandatory:"false" json:"nextStartWith"`
}
func (m ListObjects) String() string
func (m ListObjects) 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
ListObjectsRequest wrapper for the ListObjects operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListObjects.go.html to see an example of how to use ListObjectsRequest.
type ListObjectsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The string to use for matching against the start of object names in a list query.
Prefix *string `mandatory:"false" contributesTo:"query" name:"prefix"`
// Returns object names which are lexicographically greater than or equal to this parameter.
Start *string `mandatory:"false" contributesTo:"query" name:"start"`
// Returns object names which are lexicographically strictly less than this parameter.
End *string `mandatory:"false" contributesTo:"query" name:"end"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// When this parameter is set, only objects whose names do not contain the delimiter character
// (after an optionally specified prefix) are returned in the objects key of the response body.
// Scanned objects whose names contain the delimiter have the part of their name up to the first
// occurrence of the delimiter (including the optional prefix) returned as a set of prefixes.
// Note that only '/' is a supported delimiter character at this time.
Delimiter *string `mandatory:"false" contributesTo:"query" name:"delimiter"`
// Object summary by default includes only the 'name' field. Use this parameter to also
// include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time),
// 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields.
// Specify the value of this parameter as a comma-separated, case-insensitive list of those field names.
// For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
Fields *string `mandatory:"false" contributesTo:"query" name:"fields" omitEmpty:"true"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Returns object names which are lexicographically strictly greater than this parameter.
StartAfter *string `mandatory:"false" contributesTo:"query" name:"startAfter"`
// 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 ListObjectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListObjectsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListObjectsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListObjectsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListObjectsRequest) String() string
func (request ListObjectsRequest) 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
ListObjectsResponse wrapper for the ListObjects operation
type ListObjectsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ListObjects instance
ListObjects `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListObjectsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListObjectsResponse) String() string
ListPreauthenticatedRequestsRequest wrapper for the ListPreauthenticatedRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListPreauthenticatedRequests.go.html to see an example of how to use ListPreauthenticatedRequestsRequest.
type ListPreauthenticatedRequestsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// User-specified object name prefixes can be used to query and return a list of pre-authenticated requests.
ObjectNamePrefix *string `mandatory:"false" contributesTo:"query" name:"objectNamePrefix"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ListPreauthenticatedRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPreauthenticatedRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPreauthenticatedRequestsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListPreauthenticatedRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPreauthenticatedRequestsRequest) String() string
func (request ListPreauthenticatedRequestsRequest) 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
ListPreauthenticatedRequestsResponse wrapper for the ListPreauthenticatedRequests operation
type ListPreauthenticatedRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PreauthenticatedRequestSummary instances
Items []PreauthenticatedRequestSummary `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of pre-authenticated requests.
// In the GET request, set the limit to the number of pre-authenticated requests that you want returned in
// the response. If the `opc-next-page` header appears in the response, then this is a partial list and there
// are additional pre-authenticated requests to get. Include the header's value as the `page` parameter in
// the subsequent GET request to get the next batch of pre-authenticated requests. Repeat this process to
// retrieve the entire list of pre-authenticated requests.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPreauthenticatedRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPreauthenticatedRequestsResponse) String() string
ListPrivateEndpointsFieldsEnum Enum with underlying type: string
type ListPrivateEndpointsFieldsEnum string
Set of constants representing the allowable values for ListPrivateEndpointsFieldsEnum
const (
ListPrivateEndpointsFieldsTags ListPrivateEndpointsFieldsEnum = "tags"
)
func GetListPrivateEndpointsFieldsEnumValues() []ListPrivateEndpointsFieldsEnum
GetListPrivateEndpointsFieldsEnumValues Enumerates the set of values for ListPrivateEndpointsFieldsEnum
func GetMappingListPrivateEndpointsFieldsEnum(val string) (ListPrivateEndpointsFieldsEnum, bool)
GetMappingListPrivateEndpointsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivateEndpointsRequest wrapper for the ListPrivateEndpoints operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListPrivateEndpoints.go.html to see an example of how to use ListPrivateEndpointsRequest.
type ListPrivateEndpointsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The ID of the compartment in which to list buckets.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// PrivateEndpoint summary in list of PrivateEndpoints includes the 'namespace', 'name', 'compartmentId',
// 'createdBy', 'timeCreated', 'timeModified' and 'etag' fields.
// This parameter can also include 'tags' (freeformTags and definedTags).
// The only supported value of this parameter is 'tags' for now. Example 'tags'.
Fields []ListPrivateEndpointsFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"csv"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The lifecycle state of the Private Endpoint
LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" 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 ListPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPrivateEndpointsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPrivateEndpointsRequest) String() string
func (request ListPrivateEndpointsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPrivateEndpointsResponse wrapper for the ListPrivateEndpoints operation
type ListPrivateEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PrivateEndpointSummary instances
Items []PrivateEndpointSummary `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of PEs.
// In the GET request, set the limit to the number of Private Endpoint items that you want returned in the response.
// If the `opc-next-page` header appears in the response, then this is a partial list and there are additional
// Private Endpoint's to get. Include the header's value as the `page` parameter in the subsequent GET request to get the
// next batch of PEs. Repeat this process to retrieve the entire list of Private Endpoint's.
// By default, the page limit is set to 25 Private Endpoint's per page, but you can specify a value from 1 to 1000.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPrivateEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPrivateEndpointsResponse) String() string
ListReplicationPoliciesRequest wrapper for the ListReplicationPolicies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListReplicationPolicies.go.html to see an example of how to use ListReplicationPoliciesRequest.
type ListReplicationPoliciesRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListReplicationPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListReplicationPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListReplicationPoliciesRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListReplicationPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListReplicationPoliciesRequest) String() string
func (request ListReplicationPoliciesRequest) 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
ListReplicationPoliciesResponse wrapper for the ListReplicationPolicies operation
type ListReplicationPoliciesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ReplicationPolicySummary instances
Items []ReplicationPolicySummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// For paginating a list of replication policies.
// In the GET request, set the limit to the number of buckets items that you want returned in the response.
// If the `opc-next-page` header appears in the response, then this is a partial list and there are additional
// policies to get. Include the header's value as the `page` parameter in the subsequent GET request to get the
// next batch of policies. Repeat this process to retrieve the entire list of policies.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListReplicationPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListReplicationPoliciesResponse) String() string
ListReplicationSourcesRequest wrapper for the ListReplicationSources operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListReplicationSources.go.html to see an example of how to use ListReplicationSourcesRequest.
type ListReplicationSourcesRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListReplicationSourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListReplicationSourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListReplicationSourcesRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListReplicationSourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListReplicationSourcesRequest) String() string
func (request ListReplicationSourcesRequest) 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
ListReplicationSourcesResponse wrapper for the ListReplicationSources operation
type ListReplicationSourcesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ReplicationSource instances
Items []ReplicationSource `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// For paginating a list of replication sources.
// In the GET request, set the limit to the number of items that you want returned in the response.
// If the `opc-next-page` header appears in the response, then this is a partial list and there are additional
// policies to get. Include the header's value as the `page` parameter in the subsequent GET request to get the
// next batch of policies. Repeat this process to retrieve the entire list of sources.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListReplicationSourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListReplicationSourcesResponse) String() string
ListRetentionRulesRequest wrapper for the ListRetentionRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListRetentionRules.go.html to see an example of how to use ListRetentionRulesRequest.
type ListRetentionRulesRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
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 ListRetentionRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRetentionRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRetentionRulesRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListRetentionRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRetentionRulesRequest) String() string
func (request ListRetentionRulesRequest) 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
ListRetentionRulesResponse wrapper for the ListRetentionRules operation
type ListRetentionRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RetentionRuleCollection instances
RetentionRuleCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Paginating a list of retention rules.
// If the `opc-next-page` header appears in the response, it indicates that this is a partial list
// of retention rules and there are additional rules to get. Include the value of this header as
// the `page` parameter in a subsequent GET request to get the next set of retention rules.
// Repeat this process to retrieve the entire list of retention rules.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRetentionRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRetentionRulesResponse) String() string
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestError instances
Items []WorkRequestError `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of work request errors.
// In the GET request, set the limit to the number of work request errors that you want returned in the
// response. If the `opc-next-page` header appears in the response, then this is a partial list and there are
// additional work request errors to get. Include the header's value as the `page` parameter in the subsequent
// GET request to get the next batch of work request errors. Repeat this process to retrieve the entire list of work
// request errors.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// For paginating a list of work request logs.
// In the GET request, set the limit to the number of compartment work requests that you want returned in the
// response. If the `opc-next-page` header appears in the response, then this is a partial list and there are
// additional work requests to get. Include the header's value as the `page` parameter in the subsequent
// GET request to get the next batch of work requests. Repeat this process to retrieve the entire list of work
// requests.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list buckets.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the privateEndpoint for which to list work requests.
PrivateEndpointName *string `mandatory:"false" contributesTo:"query" name:"privateEndpointName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important
// details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestSummary instances
Items []WorkRequestSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For paginating a list of work requests.
// In the GET request, set the limit to the number of compartment work requests that you want returned in the
// response. If the `opc-next-page` header appears in the response, then this is a partial list and there are
// additional work requests to get. Include the header's value as the `page` parameter in the subsequent
// GET request to get the next batch of work requests. Repeat this process to retrieve the entire list of work
// requests.
// For more details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
MakeBucketWritableRequest wrapper for the MakeBucketWritable operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/MakeBucketWritable.go.html to see an example of how to use MakeBucketWritableRequest.
type MakeBucketWritableRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 MakeBucketWritableRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request MakeBucketWritableRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request MakeBucketWritableRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request MakeBucketWritableRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request MakeBucketWritableRequest) String() string
func (request MakeBucketWritableRequest) 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
MakeBucketWritableResponse wrapper for the MakeBucketWritable operation
type MakeBucketWritableResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response MakeBucketWritableResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response MakeBucketWritableResponse) String() string
MultipartUpload Multipart uploads provide efficient and resilient uploads, especially for large objects. Multipart uploads also accommodate objects that are too large for a single upload operation. With multipart uploads, individual parts of an object can be uploaded in parallel to reduce the amount of time you spend uploading. Multipart uploads can also minimize the impact of network failures by letting you retry a failed part upload instead of requiring you to retry an entire object upload. See Using Multipart Uploads (https://docs.oracle.com/iaas/Content/Object/Tasks/usingmultipartuploads.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type MultipartUpload struct {
// The Object Storage namespace in which the in-progress multipart upload is stored.
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket in which the in-progress multipart upload is stored.
Bucket *string `mandatory:"true" json:"bucket"`
// The object name of the in-progress multipart upload.
Object *string `mandatory:"true" json:"object"`
// The unique identifier for the in-progress multipart upload.
UploadId *string `mandatory:"true" json:"uploadId"`
// The date and time the upload was created, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The storage tier that the object is stored in.
StorageTier StorageTierEnum `mandatory:"false" json:"storageTier,omitempty"`
}
func (m MultipartUpload) String() string
func (m MultipartUpload) 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
MultipartUploadPartSummary Gets summary information about multipart uploads. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type MultipartUploadPartSummary struct {
// The current entity tag (ETag) for the part.
Etag *string `mandatory:"true" json:"etag"`
// The MD5 hash of the bytes of the part.
Md5 *string `mandatory:"true" json:"md5"`
// The size of the part in bytes.
Size *int64 `mandatory:"true" json:"size"`
// The part number for this part.
PartNumber *int `mandatory:"true" json:"partNumber"`
}
func (m MultipartUploadPartSummary) String() string
func (m MultipartUploadPartSummary) 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
NamespaceMetadata NamespaceMetadata maps a namespace string to defaultS3CompartmentId and defaultSwiftCompartmentId values.
type NamespaceMetadata struct {
// The Object Storage namespace to which the metadata belongs.
Namespace *string `mandatory:"true" json:"namespace"`
// If the field is set, specifies the default compartment assignment for the Amazon S3 Compatibility API.
DefaultS3CompartmentId *string `mandatory:"true" json:"defaultS3CompartmentId"`
// If the field is set, specifies the default compartment assignment for the Swift API.
DefaultSwiftCompartmentId *string `mandatory:"true" json:"defaultSwiftCompartmentId"`
}
func (m NamespaceMetadata) String() string
func (m NamespaceMetadata) 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
ObjectLifecyclePolicy The collection of lifecycle policy rules that together form the object lifecycle policy of a given bucket.
type ObjectLifecyclePolicy struct {
// The date and time the object lifecycle policy was created, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The live lifecycle policy on the bucket.
// For an example of this value, see the
// PutObjectLifecyclePolicy API documentation (https://docs.oracle.com/iaas/api/#/en/objectstorage/20160918/ObjectLifecyclePolicy/PutObjectLifecyclePolicy).
Items []ObjectLifecycleRule `mandatory:"false" json:"items"`
}
func (m ObjectLifecyclePolicy) String() string
func (m ObjectLifecyclePolicy) 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
ObjectLifecycleRule To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type ObjectLifecycleRule struct {
// The name of the lifecycle rule to be applied.
Name *string `mandatory:"true" json:"name"`
// The action of the object lifecycle policy rule.
// Rules using the action 'ARCHIVE' move objects from Standard and InfrequentAccess storage tiers
// into the Archive storage tier (https://docs.oracle.com/iaas/Content/Archive/Concepts/archivestorageoverview.htm).
// Rules using the action 'INFREQUENT_ACCESS' move objects from Standard storage tier into the
// Infrequent Access Storage tier. Objects that are already in InfrequentAccess tier or in Archive
// tier are left untouched.
// Rules using the action 'DELETE' permanently delete objects from buckets.
// Rules using 'ABORT' abort the uncommitted multipart-uploads and permanently delete their parts from buckets.
Action *string `mandatory:"true" json:"action"`
// Specifies the age of objects to apply the rule to. The timeAmount is interpreted in units defined by the
// timeUnit parameter, and is calculated in relation to each object's Last-Modified time.
TimeAmount *int64 `mandatory:"true" json:"timeAmount"`
// The unit that should be used to interpret timeAmount. Days are defined as starting and ending at midnight UTC.
// Years are defined as 365.2425 days long and likewise round up to the next midnight UTC.
TimeUnit ObjectLifecycleRuleTimeUnitEnum `mandatory:"true" json:"timeUnit"`
// A Boolean that determines whether this rule is currently enabled.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The target of the object lifecycle policy rule. The values of target can be either "objects",
// "multipart-uploads" or "previous-object-versions".
// This field when declared as "objects" is used to specify ARCHIVE, INFREQUENT_ACCESS
// or DELETE rule for objects.
// This field when declared as "previous-object-versions" is used to specify ARCHIVE,
// INFREQUENT_ACCESS or DELETE rule for previous versions of existing objects.
// This field when declared as "multipart-uploads" is used to specify the ABORT (only) rule for
// uncommitted multipart-uploads.
Target *string `mandatory:"false" json:"target"`
ObjectNameFilter *ObjectNameFilter `mandatory:"false" json:"objectNameFilter"`
}
func (m ObjectLifecycleRule) String() string
func (m ObjectLifecycleRule) 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
ObjectLifecycleRuleTimeUnitEnum Enum with underlying type: string
type ObjectLifecycleRuleTimeUnitEnum string
Set of constants representing the allowable values for ObjectLifecycleRuleTimeUnitEnum
const (
ObjectLifecycleRuleTimeUnitDays ObjectLifecycleRuleTimeUnitEnum = "DAYS"
ObjectLifecycleRuleTimeUnitYears ObjectLifecycleRuleTimeUnitEnum = "YEARS"
)
func GetMappingObjectLifecycleRuleTimeUnitEnum(val string) (ObjectLifecycleRuleTimeUnitEnum, bool)
GetMappingObjectLifecycleRuleTimeUnitEnum performs case Insensitive comparison on enum value and return the desired enum
func GetObjectLifecycleRuleTimeUnitEnumValues() []ObjectLifecycleRuleTimeUnitEnum
GetObjectLifecycleRuleTimeUnitEnumValues Enumerates the set of values for ObjectLifecycleRuleTimeUnitEnum
ObjectNameFilter A filter that compares object names to a set of prefixes or patterns to determine if a rule applies to a given object. The filter can contain include glob patterns, exclude glob patterns and inclusion prefixes. The inclusion prefixes property is kept for backward compatibility. It is recommended to use inclusion patterns instead of prefixes. Exclusions take precedence over inclusions.
type ObjectNameFilter struct {
// An array of glob patterns to match the object names to include. An empty array includes all objects in the
// bucket. Exclusion patterns take precedence over inclusion patterns.
// A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other
// than the special pattern characters described below, matches itself.
// Glob patterns must be between 1 and 1024 characters.
// The special pattern characters have the following meanings:
// \ Escapes the following character
// * Matches any string of characters.
// ? Matches any single character .
// [...] Matches a group of characters. A group of characters can be:
// A set of characters, for example: [Zafg9@]. This matches any character in the brackets.
// A range of characters, for example: [a-z]. This matches any character in the range.
// [a-f] is equivalent to [abcdef].
// For character ranges only the CHARACTER-CHARACTER pattern is supported.
// [ab-yz] is not valid
// [a-mn-z] is not valid
// Character ranges can not start with ^ or :
// To include a '-' in the range, make it the first or last character.
InclusionPatterns []string `mandatory:"false" json:"inclusionPatterns"`
// An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion
// patterns take precedence over inclusion patterns.
// A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other
// than the special pattern characters described below, matches itself.
// Glob patterns must be between 1 and 1024 characters.
// The special pattern characters have the following meanings:
// \ Escapes the following character
// * Matches any string of characters.
// ? Matches any single character .
// [...] Matches a group of characters. A group of characters can be:
// A set of characters, for example: [Zafg9@]. This matches any character in the brackets.
// A range of characters, for example: [a-z]. This matches any character in the range.
// [a-f] is equivalent to [abcdef].
// For character ranges only the CHARACTER-CHARACTER pattern is supported.
// [ab-yz] is not valid
// [a-mn-z] is not valid
// Character ranges can not start with ^ or :
// To include a '-' in the range, make it the first or last character.
ExclusionPatterns []string `mandatory:"false" json:"exclusionPatterns"`
// An array of object name prefixes that the rule will apply to. An empty array means to include all objects.
InclusionPrefixes []string `mandatory:"false" json:"inclusionPrefixes"`
}
func (m ObjectNameFilter) String() string
func (m ObjectNameFilter) 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
ObjectStorageClient a client for ObjectStorage
type ObjectStorageClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewObjectStorageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ObjectStorageClient, err error)
NewObjectStorageClientWithConfigurationProvider Creates a new default ObjectStorage client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewObjectStorageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ObjectStorageClient, err error)
NewObjectStorageClientWithOboToken Creates a new default ObjectStorage 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 ObjectStorageClient) AbortMultipartUpload(ctx context.Context, request AbortMultipartUploadRequest) (response AbortMultipartUploadResponse, err error)
AbortMultipartUpload Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/AbortMultipartUpload.go.html to see an example of how to use AbortMultipartUpload API. A default retry strategy applies to this operation AbortMultipartUpload()
func (client ObjectStorageClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client ObjectStorageClient) CommitMultipartUpload(ctx context.Context, request CommitMultipartUploadRequest) (response CommitMultipartUploadResponse, err error)
CommitMultipartUpload Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CommitMultipartUpload.go.html to see an example of how to use CommitMultipartUpload API. A default retry strategy applies to this operation CommitMultipartUpload()
func (client *ObjectStorageClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ObjectStorageClient) CopyObject(ctx context.Context, request CopyObjectRequest) (response CopyObjectResponse, err error)
CopyObject Creates a request to copy an object within a region or to another region. See Object Names (https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CopyObject.go.html to see an example of how to use CopyObject API. A default retry strategy applies to this operation CopyObject()
func (client ObjectStorageClient) CreateBucket(ctx context.Context, request CreateBucketRequest) (response CreateBucketResponse, err error)
CreateBucket Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateBucket.go.html to see an example of how to use CreateBucket API. A default retry strategy applies to this operation CreateBucket()
func (client ObjectStorageClient) CreateMultipartUpload(ctx context.Context, request CreateMultipartUploadRequest) (response CreateMultipartUploadResponse, err error)
CreateMultipartUpload Starts a new multipart upload to a specific object in the given bucket in the given namespace. See Object Names (https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateMultipartUpload.go.html to see an example of how to use CreateMultipartUpload API. A default retry strategy applies to this operation CreateMultipartUpload()
func (client ObjectStorageClient) CreatePreauthenticatedRequest(ctx context.Context, request CreatePreauthenticatedRequestRequest) (response CreatePreauthenticatedRequestResponse, err error)
CreatePreauthenticatedRequest Creates a pre-authenticated request specific to the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreatePreauthenticatedRequest.go.html to see an example of how to use CreatePreauthenticatedRequest API. A default retry strategy applies to this operation CreatePreauthenticatedRequest()
func (client ObjectStorageClient) CreatePrivateEndpoint(ctx context.Context, request CreatePrivateEndpointRequest) (response CreatePrivateEndpointResponse, err error)
CreatePrivateEndpoint Create a PrivateEndpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreatePrivateEndpoint.go.html to see an example of how to use CreatePrivateEndpoint API. A default retry strategy applies to this operation CreatePrivateEndpoint()
func (client ObjectStorageClient) CreateReplicationPolicy(ctx context.Context, request CreateReplicationPolicyRequest) (response CreateReplicationPolicyResponse, err error)
CreateReplicationPolicy Creates a replication policy for the specified bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateReplicationPolicy.go.html to see an example of how to use CreateReplicationPolicy API. A default retry strategy applies to this operation CreateReplicationPolicy()
func (client ObjectStorageClient) CreateRetentionRule(ctx context.Context, request CreateRetentionRuleRequest) (response CreateRetentionRuleResponse, err error)
CreateRetentionRule Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds. Note that a maximum of 100 rules are supported on a bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/CreateRetentionRule.go.html to see an example of how to use CreateRetentionRule API. A default retry strategy applies to this operation CreateRetentionRule()
func (client ObjectStorageClient) DeleteBucket(ctx context.Context, request DeleteBucketRequest) (response DeleteBucketResponse, err error)
DeleteBucket Deletes a bucket if the bucket is already empty. If the bucket is not empty, use DeleteObject first. In addition, you cannot delete a bucket that has a multipart upload in progress or a pre-authenticated request associated with that bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteBucket.go.html to see an example of how to use DeleteBucket API. A default retry strategy applies to this operation DeleteBucket()
func (client ObjectStorageClient) DeleteObject(ctx context.Context, request DeleteObjectRequest) (response DeleteObjectResponse, err error)
DeleteObject Deletes an object.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteObject.go.html to see an example of how to use DeleteObject API. A default retry strategy applies to this operation DeleteObject()
func (client ObjectStorageClient) DeleteObjectLifecyclePolicy(ctx context.Context, request DeleteObjectLifecyclePolicyRequest) (response DeleteObjectLifecyclePolicyResponse, err error)
DeleteObjectLifecyclePolicy Deletes the object lifecycle policy for the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteObjectLifecyclePolicy.go.html to see an example of how to use DeleteObjectLifecyclePolicy API. A default retry strategy applies to this operation DeleteObjectLifecyclePolicy()
func (client ObjectStorageClient) DeletePreauthenticatedRequest(ctx context.Context, request DeletePreauthenticatedRequestRequest) (response DeletePreauthenticatedRequestResponse, err error)
DeletePreauthenticatedRequest Deletes the pre-authenticated request for the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeletePreauthenticatedRequest.go.html to see an example of how to use DeletePreauthenticatedRequest API. A default retry strategy applies to this operation DeletePreauthenticatedRequest()
func (client ObjectStorageClient) DeletePrivateEndpoint(ctx context.Context, request DeletePrivateEndpointRequest) (response DeletePrivateEndpointResponse, err error)
DeletePrivateEndpoint Deletes a Private Endpoint if it exists in the given namespace.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeletePrivateEndpoint.go.html to see an example of how to use DeletePrivateEndpoint API. A default retry strategy applies to this operation DeletePrivateEndpoint()
func (client ObjectStorageClient) DeleteReplicationPolicy(ctx context.Context, request DeleteReplicationPolicyRequest) (response DeleteReplicationPolicyResponse, err error)
DeleteReplicationPolicy Deletes the replication policy associated with the source bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteReplicationPolicy.go.html to see an example of how to use DeleteReplicationPolicy API. A default retry strategy applies to this operation DeleteReplicationPolicy()
func (client ObjectStorageClient) DeleteRetentionRule(ctx context.Context, request DeleteRetentionRuleRequest) (response DeleteRetentionRuleResponse, err error)
DeleteRetentionRule Deletes the specified rule. The deletion takes effect typically within 30 seconds.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/DeleteRetentionRule.go.html to see an example of how to use DeleteRetentionRule API. A default retry strategy applies to this operation DeleteRetentionRule()
func (client ObjectStorageClient) GetBucket(ctx context.Context, request GetBucketRequest) (response GetBucketResponse, err error)
GetBucket Gets the current representation of the given bucket in the given Object Storage namespace.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetBucket.go.html to see an example of how to use GetBucket API. A default retry strategy applies to this operation GetBucket()
func (client ObjectStorageClient) GetNamespace(ctx context.Context, request GetNamespaceRequest) (response GetNamespaceResponse, err error)
GetNamespace Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace is a system-generated string assigned during account creation. For some older tenancies, the namespace string may be the tenancy name in all lower-case letters. You cannot edit a namespace. GetNamespace returns the name of the Object Storage namespace for the user making the request. If an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding tenancy, provided the user has access to it.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetNamespace.go.html to see an example of how to use GetNamespace API. A default retry strategy applies to this operation GetNamespace()
func (client ObjectStorageClient) GetNamespaceMetadata(ctx context.Context, request GetNamespaceMetadataRequest) (response GetNamespaceMetadataResponse, err error)
GetNamespaceMetadata Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId. Any user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetNamespaceMetadata.go.html to see an example of how to use GetNamespaceMetadata API. A default retry strategy applies to this operation GetNamespaceMetadata()
func (client ObjectStorageClient) GetObject(ctx context.Context, request GetObjectRequest) (response GetObjectResponse, err error)
GetObject Gets the metadata and body of an object.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetObject.go.html to see an example of how to use GetObject API. A default retry strategy applies to this operation GetObject()
func (client ObjectStorageClient) GetObjectLifecyclePolicy(ctx context.Context, request GetObjectLifecyclePolicyRequest) (response GetObjectLifecyclePolicyResponse, err error)
GetObjectLifecyclePolicy Gets the object lifecycle policy for the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetObjectLifecyclePolicy.go.html to see an example of how to use GetObjectLifecyclePolicy API. A default retry strategy applies to this operation GetObjectLifecyclePolicy()
func (client ObjectStorageClient) GetPreauthenticatedRequest(ctx context.Context, request GetPreauthenticatedRequestRequest) (response GetPreauthenticatedRequestResponse, err error)
GetPreauthenticatedRequest Gets the pre-authenticated request for the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetPreauthenticatedRequest.go.html to see an example of how to use GetPreauthenticatedRequest API. A default retry strategy applies to this operation GetPreauthenticatedRequest()
func (client ObjectStorageClient) GetPrivateEndpoint(ctx context.Context, request GetPrivateEndpointRequest) (response GetPrivateEndpointResponse, err error)
GetPrivateEndpoint Gets the current representation of the given Private Endpoint in the given Object Storage namespace.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetPrivateEndpoint.go.html to see an example of how to use GetPrivateEndpoint API. A default retry strategy applies to this operation GetPrivateEndpoint()
func (client ObjectStorageClient) GetReplicationPolicy(ctx context.Context, request GetReplicationPolicyRequest) (response GetReplicationPolicyResponse, err error)
GetReplicationPolicy Get the replication policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetReplicationPolicy.go.html to see an example of how to use GetReplicationPolicy API. A default retry strategy applies to this operation GetReplicationPolicy()
func (client ObjectStorageClient) GetRetentionRule(ctx context.Context, request GetRetentionRuleRequest) (response GetRetentionRuleResponse, err error)
GetRetentionRule Get the specified retention rule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetRetentionRule.go.html to see an example of how to use GetRetentionRule API. A default retry strategy applies to this operation GetRetentionRule()
func (client ObjectStorageClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request for the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client ObjectStorageClient) HeadBucket(ctx context.Context, request HeadBucketRequest) (response HeadBucketResponse, err error)
HeadBucket Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/HeadBucket.go.html to see an example of how to use HeadBucket API. A default retry strategy applies to this operation HeadBucket()
func (client ObjectStorageClient) HeadObject(ctx context.Context, request HeadObjectRequest) (response HeadObjectResponse, err error)
HeadObject Gets the user-defined metadata and entity tag (ETag) for an object.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/HeadObject.go.html to see an example of how to use HeadObject API. A default retry strategy applies to this operation HeadObject()
func (client ObjectStorageClient) ListBuckets(ctx context.Context, request ListBucketsRequest) (response ListBucketsResponse, err error)
ListBuckets Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket and does not contain fields like the user-defined metadata. ListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned `opc-next-page` value with the `page` request parameter. To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListBuckets.go.html to see an example of how to use ListBuckets API. A default retry strategy applies to this operation ListBuckets()
func (client ObjectStorageClient) ListMultipartUploadParts(ctx context.Context, request ListMultipartUploadPartsRequest) (response ListMultipartUploadPartsResponse, err error)
ListMultipartUploadParts Lists the parts of an in-progress multipart upload.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListMultipartUploadParts.go.html to see an example of how to use ListMultipartUploadParts API. A default retry strategy applies to this operation ListMultipartUploadParts()
func (client ObjectStorageClient) ListMultipartUploads(ctx context.Context, request ListMultipartUploadsRequest) (response ListMultipartUploadsResponse, err error)
ListMultipartUploads Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListMultipartUploads.go.html to see an example of how to use ListMultipartUploads API. A default retry strategy applies to this operation ListMultipartUploads()
func (client ObjectStorageClient) ListObjectVersions(ctx context.Context, request ListObjectVersionsRequest) (response ListObjectVersionsResponse, err error)
ListObjectVersions Lists the object versions in a bucket. ListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through more object versions, use the returned `opc-next-page` value with the `page` request parameter. To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListObjectVersions.go.html to see an example of how to use ListObjectVersions API. A default retry strategy applies to this operation ListObjectVersions()
func (client ObjectStorageClient) ListObjects(ctx context.Context, request ListObjectsRequest) (response ListObjectsResponse, err error)
ListObjects Lists the objects in a bucket. By default, ListObjects returns object names only. See the `fields` parameter for other fields that you can optionally include in ListObjects response. ListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith' value with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end' parameters. To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListObjects.go.html to see an example of how to use ListObjects API. A default retry strategy applies to this operation ListObjects()
func (client ObjectStorageClient) ListPreauthenticatedRequests(ctx context.Context, request ListPreauthenticatedRequestsRequest) (response ListPreauthenticatedRequestsResponse, err error)
ListPreauthenticatedRequests Lists pre-authenticated requests for the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListPreauthenticatedRequests.go.html to see an example of how to use ListPreauthenticatedRequests API. A default retry strategy applies to this operation ListPreauthenticatedRequests()
func (client ObjectStorageClient) ListPrivateEndpoints(ctx context.Context, request ListPrivateEndpointsRequest) (response ListPrivateEndpointsResponse, err error)
ListPrivateEndpoints Gets a list of all PrivateEndpointSummary in a compartment associated with a namespace. To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListPrivateEndpoints.go.html to see an example of how to use ListPrivateEndpoints API. A default retry strategy applies to this operation ListPrivateEndpoints()
func (client ObjectStorageClient) ListReplicationPolicies(ctx context.Context, request ListReplicationPoliciesRequest) (response ListReplicationPoliciesResponse, err error)
ListReplicationPolicies List the replication policies associated with a bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListReplicationPolicies.go.html to see an example of how to use ListReplicationPolicies API. A default retry strategy applies to this operation ListReplicationPolicies()
func (client ObjectStorageClient) ListReplicationSources(ctx context.Context, request ListReplicationSourcesRequest) (response ListReplicationSourcesResponse, err error)
ListReplicationSources List the replication sources of a destination bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListReplicationSources.go.html to see an example of how to use ListReplicationSources API. A default retry strategy applies to this operation ListReplicationSources()
func (client ObjectStorageClient) ListRetentionRules(ctx context.Context, request ListRetentionRulesRequest) (response ListRetentionRulesResponse, err error)
ListRetentionRules List the retention rules for a bucket. The retention rules are sorted based on creation time, with the most recently created retention rule returned first.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListRetentionRules.go.html to see an example of how to use ListRetentionRules API. A default retry strategy applies to this operation ListRetentionRules()
func (client ObjectStorageClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client ObjectStorageClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client ObjectStorageClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client ObjectStorageClient) MakeBucketWritable(ctx context.Context, request MakeBucketWritableRequest) (response MakeBucketWritableResponse, err error)
MakeBucketWritable Stops replication to the destination bucket and removes the replication policy. When the replication policy was created, this destination bucket became read-only except for new and changed objects replicated automatically from the source bucket. MakeBucketWritable removes the replication policy. This bucket is no longer the target for replication and is now writable, allowing users to make changes to bucket contents.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/MakeBucketWritable.go.html to see an example of how to use MakeBucketWritable API. A default retry strategy applies to this operation MakeBucketWritable()
func (client ObjectStorageClient) PutObject(ctx context.Context, request PutObjectRequest) (response PutObjectResponse, err error)
PutObject Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by PutObject is 50 GiB. See Object Names (https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements. See Special Instructions for Object Storage PUT (https://docs.oracle.com/iaas/Content/API/Concepts/signingrequests.htm#ObjectStoragePut) for request signature requirements.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/PutObject.go.html to see an example of how to use PutObject API. A default retry strategy applies to this operation PutObject()
func (client ObjectStorageClient) PutObjectLifecyclePolicy(ctx context.Context, request PutObjectLifecyclePolicyRequest) (response PutObjectLifecyclePolicyResponse, err error)
PutObjectLifecyclePolicy Creates or replaces the object lifecycle policy for the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/PutObjectLifecyclePolicy.go.html to see an example of how to use PutObjectLifecyclePolicy API. A default retry strategy applies to this operation PutObjectLifecyclePolicy()
func (client ObjectStorageClient) ReencryptBucket(ctx context.Context, request ReencryptBucketRequest) (response ReencryptBucketResponse, err error)
ReencryptBucket Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent version of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master encryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign a key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property of the bucket determines which master encryption key is assigned to the bucket. If you assigned a different Key Management master encryption key to the bucket, you can call this API to re-encrypt all data encryption keys with the newly assigned key. Similarly, you might want to re-encrypt all data encryption keys if the assigned key has been rotated to a new key version since objects were last added to the bucket. If you call this API and there is no kmsKeyId associated with the bucket, the call will fail. Calling this API starts a work request task to re-encrypt the data encryption key of all objects in the bucket. Only objects created before the time of the API call will be re-encrypted. The call can take a long time, depending on how many objects are in the bucket and how big they are. This API returns a work request ID that you can use to retrieve the status of the work request task. All the versions of objects will be re-encrypted whether versioning is enabled or suspended at the bucket.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ReencryptBucket.go.html to see an example of how to use ReencryptBucket API. A default retry strategy applies to this operation ReencryptBucket()
func (client ObjectStorageClient) ReencryptObject(ctx context.Context, request ReencryptObjectRequest) (response ReencryptObjectResponse, err error)
ReencryptObject Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage service manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for the bucket applies to the objects it contains. You can alternatively employ one of these encryption strategies for an object: - You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service. - You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ReencryptObject.go.html to see an example of how to use ReencryptObject API. A default retry strategy applies to this operation ReencryptObject()
func (client ObjectStorageClient) RenameObject(ctx context.Context, request RenameObjectRequest) (response RenameObjectResponse, err error)
RenameObject Rename an object in the given Object Storage namespace. See Object Names (https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/RenameObject.go.html to see an example of how to use RenameObject API. A default retry strategy applies to this operation RenameObject()
func (client ObjectStorageClient) RestoreObjects(ctx context.Context, request RestoreObjectsRequest) (response RestoreObjectsResponse, err error)
RestoreObjects Restores the object specified by the objectName parameter. By default object will be restored for 24 hours. Duration can be configured using the hours parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/RestoreObjects.go.html to see an example of how to use RestoreObjects API. A default retry strategy applies to this operation RestoreObjects()
func (client *ObjectStorageClient) SetCustomClientConfiguration(config common.CustomClientConfiguration)
SetCustomClientConfiguration sets client with retry and other custom configurations
func (client *ObjectStorageClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ObjectStorageClient) UpdateBucket(ctx context.Context, request UpdateBucketRequest) (response UpdateBucketResponse, err error)
UpdateBucket Performs a partial or full update of a bucket's user-defined metadata. Use UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID of the compartment that you want to move the bucket to. For more information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateBucket.go.html to see an example of how to use UpdateBucket API. A default retry strategy applies to this operation UpdateBucket()
func (client ObjectStorageClient) UpdateNamespaceMetadata(ctx context.Context, request UpdateNamespaceMetadataRequest) (response UpdateNamespaceMetadataResponse, err error)
UpdateNamespaceMetadata By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root compartment of the Oracle Cloud Infrastructure tenancy. You can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All subsequent bucket creations will use the new default compartment, but no previously created buckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default compartments for Amazon S3 and Swift.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateNamespaceMetadata.go.html to see an example of how to use UpdateNamespaceMetadata API. A default retry strategy applies to this operation UpdateNamespaceMetadata()
func (client ObjectStorageClient) UpdateObjectStorageTier(ctx context.Context, request UpdateObjectStorageTierRequest) (response UpdateObjectStorageTierResponse, err error)
UpdateObjectStorageTier Changes the storage tier of the object specified by the objectName parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateObjectStorageTier.go.html to see an example of how to use UpdateObjectStorageTier API. A default retry strategy applies to this operation UpdateObjectStorageTier()
func (client ObjectStorageClient) UpdatePrivateEndpoint(ctx context.Context, request UpdatePrivateEndpointRequest) (response UpdatePrivateEndpointResponse, err error)
UpdatePrivateEndpoint Performs a partial or full update of a user-defined data associated with the Private Endpoint. Use UpdatePrivateEndpoint to move a Private Endpoint from one compartment to another within the same tenancy. Supply the compartmentID of the compartment that you want to move the Private Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp or accessTargets of the Private Endpoint. For more information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). This API follows replace semantics (rather than merge semantics). That means if the body provides values for parameters and the resource has exisiting ones, this operation will replace those existing values.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdatePrivateEndpoint.go.html to see an example of how to use UpdatePrivateEndpoint API. A default retry strategy applies to this operation UpdatePrivateEndpoint()
func (client ObjectStorageClient) UpdateRetentionRule(ctx context.Context, request UpdateRetentionRuleRequest) (response UpdateRetentionRuleResponse, err error)
UpdateRetentionRule Updates the specified retention rule. Rule changes take effect typically within 30 seconds.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateRetentionRule.go.html to see an example of how to use UpdateRetentionRule API. A default retry strategy applies to this operation UpdateRetentionRule()
func (client ObjectStorageClient) UploadPart(ctx context.Context, request UploadPartRequest) (response UploadPartResponse, err error)
UploadPart Uploads a single part of a multipart upload.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UploadPart.go.html to see an example of how to use UploadPart API. A default retry strategy applies to this operation UploadPart()
ObjectSummary To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type ObjectSummary struct {
// The name of the object. Avoid entering confidential information.
// Example: test/object1.log
Name *string `mandatory:"true" json:"name"`
// Size of the object in bytes.
Size *int64 `mandatory:"false" json:"size"`
// Base64-encoded MD5 hash of the object data.
Md5 *string `mandatory:"false" json:"md5"`
// The date and time the object was created, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The current entity tag (ETag) for the object.
Etag *string `mandatory:"false" json:"etag"`
// The storage tier that the object is stored in.
StorageTier StorageTierEnum `mandatory:"false" json:"storageTier,omitempty"`
// Archival state of an object. This field is set only for objects in Archive tier.
ArchivalState ArchivalStateEnum `mandatory:"false" json:"archivalState,omitempty"`
// The date and time the object was modified, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.29.
TimeModified *common.SDKTime `mandatory:"false" json:"timeModified"`
}
func (m ObjectSummary) String() string
func (m ObjectSummary) 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
ObjectVersionCollection To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type ObjectVersionCollection struct {
// An array of object version summaries.
Items []ObjectVersionSummary `mandatory:"true" json:"items"`
// Prefixes that are common to the results returned by the request if the request specified a delimiter.
Prefixes []string `mandatory:"false" json:"prefixes"`
}
func (m ObjectVersionCollection) String() string
func (m ObjectVersionCollection) 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
ObjectVersionSummary To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type ObjectVersionSummary struct {
// The name of the object. Avoid entering confidential information.
// Example: test/object1.log
Name *string `mandatory:"true" json:"name"`
// The date and time the object was modified, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616#section-14.29).
TimeModified *common.SDKTime `mandatory:"true" json:"timeModified"`
// VersionId of the object.
VersionId *string `mandatory:"true" json:"versionId"`
// This flag will indicate if the version is deleted or not.
IsDeleteMarker *bool `mandatory:"true" json:"isDeleteMarker"`
// Size of the object in bytes.
Size *int64 `mandatory:"false" json:"size"`
// Base64-encoded MD5 hash of the object data.
Md5 *string `mandatory:"false" json:"md5"`
// The date and time the object was created, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The current entity tag (ETag) for the object.
Etag *string `mandatory:"false" json:"etag"`
// The storage tier that the object is stored in.
StorageTier StorageTierEnum `mandatory:"false" json:"storageTier,omitempty"`
// Archival state of an object. This field is set only for objects in Archive tier.
ArchivalState ArchivalStateEnum `mandatory:"false" json:"archivalState,omitempty"`
}
func (m ObjectVersionSummary) String() string
func (m ObjectVersionSummary) 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
PatternDetails Specifying inclusion and exclusion patterns.
type PatternDetails struct {
// An array of glob patterns to match the object names to include. An empty array includes all objects in the
// bucket. Exclusion patterns take precedence over inclusion patterns.
// A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other
// than the special pattern characters described below, matches itself.
// Glob patterns must be between 1 and 1024 characters.
// The special pattern characters have the following meanings:
// \ Escapes the following character
// * Matches any string of characters.
// ? Matches any single character .
// [...] Matches a group of characters. A group of characters can be:
// A set of characters, for example: [Zafg9@]. This matches any character in the brackets.
// A range of characters, for example: [a-z]. This matches any character in the range.
// [a-f] is equivalent to [abcdef].
// For character ranges only the CHARACTER-CHARACTER pattern is supported.
// [ab-yz] is not valid
// [a-mn-z] is not valid
// Character ranges can not start with ^ or :
// To include a '-' in the range, make it the first or last character.
InclusionPatterns []string `mandatory:"false" json:"inclusionPatterns"`
// An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion
// patterns take precedence over inclusion patterns.
// A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other
// than the special pattern characters described below, matches itself.
// Glob patterns must be between 1 and 1024 characters.
// The special pattern characters have the following meanings:
// \ Escapes the following character
// * Matches any string of characters.
// ? Matches any single character .
// [...] Matches a group of characters. A group of characters can be:
// A set of characters, for example: [Zafg9@]. This matches any character in the brackets.
// A range of characters, for example: [a-z]. This matches any character in the range.
// [a-f] is equivalent to [abcdef].
// For character ranges only the CHARACTER-CHARACTER pattern is supported.
// [ab-yz] is not valid
// [a-mn-z] is not valid
// Character ranges can not start with ^ or :
// To include a '-' in the range, make it the first or last character.
ExclusionPatterns []string `mandatory:"false" json:"exclusionPatterns"`
}
func (m PatternDetails) String() string
func (m PatternDetails) 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
PreauthenticatedRequest Pre-authenticated requests provide a way to let users access a bucket or an object without having their own credentials. When you create a pre-authenticated request, a unique URL is generated. Users in your organization, partners, or third parties can use this URL to access the targets identified in the pre-authenticated request. See Using Pre-Authenticated Requests (https://docs.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type PreauthenticatedRequest struct {
// The unique identifier to use when directly addressing the pre-authenticated request.
Id *string `mandatory:"true" json:"id"`
// The user-provided name of the pre-authenticated request.
Name *string `mandatory:"true" json:"name"`
// The URI to embed in the URL when using the pre-authenticated request.
AccessUri *string `mandatory:"true" json:"accessUri"`
// The operation that can be performed on this resource.
AccessType PreauthenticatedRequestAccessTypeEnum `mandatory:"true" json:"accessType"`
// The expiration date for the pre-authenticated request as per RFC 3339 (https://tools.ietf.org/html/rfc3339). After
// this date the pre-authenticated request will no longer be valid.
TimeExpires *common.SDKTime `mandatory:"true" json:"timeExpires"`
// The date when the pre-authenticated request was created as per specification
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential
// information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket.
// Example: test/object1.log
ObjectName *string `mandatory:"false" json:"objectName"`
// Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite".
// Deny: Prevents the user from performing a list operation.
// ListObjects: Authorizes the user to perform a list operation.
BucketListingAction PreauthenticatedRequestBucketListingActionEnum `mandatory:"false" json:"bucketListingAction,omitempty"`
// The full Path for the object.
FullPath *string `mandatory:"false" json:"fullPath"`
}
func (m PreauthenticatedRequest) String() string
func (m PreauthenticatedRequest) 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
PreauthenticatedRequestAccessTypeEnum Enum with underlying type: string
type PreauthenticatedRequestAccessTypeEnum string
Set of constants representing the allowable values for PreauthenticatedRequestAccessTypeEnum
const (
PreauthenticatedRequestAccessTypeObjectread PreauthenticatedRequestAccessTypeEnum = "ObjectRead"
PreauthenticatedRequestAccessTypeObjectwrite PreauthenticatedRequestAccessTypeEnum = "ObjectWrite"
PreauthenticatedRequestAccessTypeObjectreadwrite PreauthenticatedRequestAccessTypeEnum = "ObjectReadWrite"
PreauthenticatedRequestAccessTypeAnyobjectwrite PreauthenticatedRequestAccessTypeEnum = "AnyObjectWrite"
PreauthenticatedRequestAccessTypeAnyobjectread PreauthenticatedRequestAccessTypeEnum = "AnyObjectRead"
PreauthenticatedRequestAccessTypeAnyobjectreadwrite PreauthenticatedRequestAccessTypeEnum = "AnyObjectReadWrite"
)
func GetMappingPreauthenticatedRequestAccessTypeEnum(val string) (PreauthenticatedRequestAccessTypeEnum, bool)
GetMappingPreauthenticatedRequestAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPreauthenticatedRequestAccessTypeEnumValues() []PreauthenticatedRequestAccessTypeEnum
GetPreauthenticatedRequestAccessTypeEnumValues Enumerates the set of values for PreauthenticatedRequestAccessTypeEnum
PreauthenticatedRequestBucketListingActionEnum Enum with underlying type: string
type PreauthenticatedRequestBucketListingActionEnum string
Set of constants representing the allowable values for PreauthenticatedRequestBucketListingActionEnum
const (
PreauthenticatedRequestBucketListingActionDeny PreauthenticatedRequestBucketListingActionEnum = "Deny"
PreauthenticatedRequestBucketListingActionListobjects PreauthenticatedRequestBucketListingActionEnum = "ListObjects"
)
func GetMappingPreauthenticatedRequestBucketListingActionEnum(val string) (PreauthenticatedRequestBucketListingActionEnum, bool)
GetMappingPreauthenticatedRequestBucketListingActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPreauthenticatedRequestBucketListingActionEnumValues() []PreauthenticatedRequestBucketListingActionEnum
GetPreauthenticatedRequestBucketListingActionEnumValues Enumerates the set of values for PreauthenticatedRequestBucketListingActionEnum
PreauthenticatedRequestSummary Get summary information about pre-authenticated requests.
type PreauthenticatedRequestSummary struct {
// The unique identifier to use when directly addressing the pre-authenticated request.
Id *string `mandatory:"true" json:"id"`
// The user-provided name of the pre-authenticated request.
Name *string `mandatory:"true" json:"name"`
// The operation that can be performed on this resource.
AccessType PreauthenticatedRequestSummaryAccessTypeEnum `mandatory:"true" json:"accessType"`
// The expiration date for the pre-authenticated request as per RFC 3339 (https://tools.ietf.org/html/rfc3339). After this date the pre-authenticated request will no longer be valid.
TimeExpires *common.SDKTime `mandatory:"true" json:"timeExpires"`
// The date when the pre-authenticated request was created as per RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The name of object that is being granted access to by the pre-authenticated request. This can be null and if it is,
// the pre-authenticated request grants access to the entire bucket.
ObjectName *string `mandatory:"false" json:"objectName"`
// Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite".
// Deny: Prevents the user from performing a list operation.
// ListObjects: Authorizes the user to perform a list operation.
BucketListingAction PreauthenticatedRequestBucketListingActionEnum `mandatory:"false" json:"bucketListingAction,omitempty"`
}
func (m PreauthenticatedRequestSummary) String() string
func (m PreauthenticatedRequestSummary) 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
PreauthenticatedRequestSummaryAccessTypeEnum Enum with underlying type: string
type PreauthenticatedRequestSummaryAccessTypeEnum string
Set of constants representing the allowable values for PreauthenticatedRequestSummaryAccessTypeEnum
const (
PreauthenticatedRequestSummaryAccessTypeObjectread PreauthenticatedRequestSummaryAccessTypeEnum = "ObjectRead"
PreauthenticatedRequestSummaryAccessTypeObjectwrite PreauthenticatedRequestSummaryAccessTypeEnum = "ObjectWrite"
PreauthenticatedRequestSummaryAccessTypeObjectreadwrite PreauthenticatedRequestSummaryAccessTypeEnum = "ObjectReadWrite"
PreauthenticatedRequestSummaryAccessTypeAnyobjectwrite PreauthenticatedRequestSummaryAccessTypeEnum = "AnyObjectWrite"
PreauthenticatedRequestSummaryAccessTypeAnyobjectread PreauthenticatedRequestSummaryAccessTypeEnum = "AnyObjectRead"
PreauthenticatedRequestSummaryAccessTypeAnyobjectreadwrite PreauthenticatedRequestSummaryAccessTypeEnum = "AnyObjectReadWrite"
)
func GetMappingPreauthenticatedRequestSummaryAccessTypeEnum(val string) (PreauthenticatedRequestSummaryAccessTypeEnum, bool)
GetMappingPreauthenticatedRequestSummaryAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPreauthenticatedRequestSummaryAccessTypeEnumValues() []PreauthenticatedRequestSummaryAccessTypeEnum
GetPreauthenticatedRequestSummaryAccessTypeEnumValues Enumerates the set of values for PreauthenticatedRequestSummaryAccessTypeEnum
PrefixFqdns An object containing FQDNs
type PrefixFqdns struct {
// ObjectStorage API FQDN
ObjectStorageApiFqdn *string `mandatory:"false" json:"objectStorageApiFqdn"`
// S3 Compatibility API FQDN
S3CompatibilityApiFqdn *string `mandatory:"false" json:"s3CompatibilityApiFqdn"`
// Swift API FQDN
SwiftApiFqdn *string `mandatory:"false" json:"swiftApiFqdn"`
}
func (m PrefixFqdns) String() string
func (m PrefixFqdns) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpoint A private endpoint makes your service accessible through a private IP in the customer's private network. A private endpoint has a name and is associated with a namespace and a single compartment.
type PrivateEndpoint struct {
// This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens,
// underscores, and periods.
// Example: my-new-private-endpoint1
Name *string `mandatory:"true" json:"name"`
// The Object Storage namespace associated with the private enpoint.
Namespace *string `mandatory:"true" json:"namespace"`
// The compartment which is associated with the Private Endpoint.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the Private Endpoint.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The date and time the Private Endpoint was created, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the Private Endpoint was updated, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeModified *common.SDKTime `mandatory:"true" json:"timeModified"`
// The OCID of the customer's subnet where the private endpoint VNIC will reside.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The private IP address to assign to this private endpoint. If you provide a value,
// it must be an available IP address in the customer's subnet. If it's not available, an error
// is returned.
// If you do not provide a value, an available IP address in the subnet is automatically chosen.
PrivateEndpointIp *string `mandatory:"true" json:"privateEndpointIp"`
// A prefix to use for the private endpoint. The customer VCN's DNS records are
// updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn.
// Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage.<region>.oraclecloud.com'
Prefix *string `mandatory:"true" json:"prefix"`
Fqdns *Fqdns `mandatory:"true" json:"fqdns"`
// The entity tag (ETag) for the Private Endpoint.
Etag *string `mandatory:"true" json:"etag"`
// A list of targets that can be accessed by the private endpoint. At least one or more access targets is required for a private endpoint.
AccessTargets []AccessTargetDetails `mandatory:"true" json:"accessTargets"`
// A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the
// customer VCN's DNS record.
AdditionalPrefixes []string `mandatory:"false" json:"additionalPrefixes"`
// A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
// For more information about NSGs, see
// NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The Private Endpoint's lifecycle state.
LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivateEndpoint.
Id *string `mandatory:"false" json:"id"`
}
func (m PrivateEndpoint) String() string
func (m PrivateEndpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpointLifecycleStateEnum Enum with underlying type: string
type PrivateEndpointLifecycleStateEnum string
Set of constants representing the allowable values for PrivateEndpointLifecycleStateEnum
const (
PrivateEndpointLifecycleStateCreating PrivateEndpointLifecycleStateEnum = "CREATING"
PrivateEndpointLifecycleStateActive PrivateEndpointLifecycleStateEnum = "ACTIVE"
PrivateEndpointLifecycleStateInactive PrivateEndpointLifecycleStateEnum = "INACTIVE"
PrivateEndpointLifecycleStateUpdating PrivateEndpointLifecycleStateEnum = "UPDATING"
PrivateEndpointLifecycleStateDeleting PrivateEndpointLifecycleStateEnum = "DELETING"
PrivateEndpointLifecycleStateDeleted PrivateEndpointLifecycleStateEnum = "DELETED"
PrivateEndpointLifecycleStateFailed PrivateEndpointLifecycleStateEnum = "FAILED"
)
func GetMappingPrivateEndpointLifecycleStateEnum(val string) (PrivateEndpointLifecycleStateEnum, bool)
GetMappingPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrivateEndpointLifecycleStateEnumValues() []PrivateEndpointLifecycleStateEnum
GetPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for PrivateEndpointLifecycleStateEnum
PrivateEndpointSummary To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type PrivateEndpointSummary struct {
// The name given to the Private Endpoint. Avoid entering confidential information.
// Example: my-new-pe1
Name *string `mandatory:"true" json:"name"`
// The Object Storage namespace with which the Private Endpoint is associated.
Namespace *string `mandatory:"true" json:"namespace"`
// The compartment ID in which the Private Endpoint is authorized.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the Private Endpoint.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The date and time the Private Endpoint was created, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the Private Endpoint was updated, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
TimeModified *common.SDKTime `mandatory:"true" json:"timeModified"`
// A prefix to use for the private endpoint. The customer VCN's DNS records are
// updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn.
// Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage.<region>.oraclecloud.com'
Prefix *string `mandatory:"true" json:"prefix"`
Fqdns *Fqdns `mandatory:"true" json:"fqdns"`
// The entity tag for the Private Endpoint.
Etag *string `mandatory:"true" json:"etag"`
// The summaries of Private Endpoints' lifecycle state.
LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m PrivateEndpointSummary) String() string
func (m PrivateEndpointSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PutObjectLifecyclePolicyDetails Creates a new object lifecycle policy for a bucket.
type PutObjectLifecyclePolicyDetails struct {
// The bucket's set of lifecycle policy rules.
Items []ObjectLifecycleRule `mandatory:"false" json:"items"`
}
func (m PutObjectLifecyclePolicyDetails) String() string
func (m PutObjectLifecyclePolicyDetails) 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
PutObjectLifecyclePolicyRequest wrapper for the PutObjectLifecyclePolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/PutObjectLifecyclePolicy.go.html to see an example of how to use PutObjectLifecyclePolicyRequest.
type PutObjectLifecyclePolicyRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The lifecycle policy to apply to the bucket.
PutObjectLifecyclePolicyDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should
// fail if the resource already exists.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request PutObjectLifecyclePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PutObjectLifecyclePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PutObjectLifecyclePolicyRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request PutObjectLifecyclePolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PutObjectLifecyclePolicyRequest) String() string
func (request PutObjectLifecyclePolicyRequest) 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
PutObjectLifecyclePolicyResponse wrapper for the PutObjectLifecyclePolicy operation
type PutObjectLifecyclePolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ObjectLifecyclePolicy instance
ObjectLifecyclePolicy `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// The entity tag (ETag) for the object lifecycle policy.
ETag *string `presentIn:"header" name:"etag"`
}
func (response PutObjectLifecyclePolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PutObjectLifecyclePolicyResponse) String() string
PutObjectOpcChecksumAlgorithmEnum Enum with underlying type: string
type PutObjectOpcChecksumAlgorithmEnum string
Set of constants representing the allowable values for PutObjectOpcChecksumAlgorithmEnum
const (
PutObjectOpcChecksumAlgorithmCrc32c PutObjectOpcChecksumAlgorithmEnum = "CRC32C"
PutObjectOpcChecksumAlgorithmSha256 PutObjectOpcChecksumAlgorithmEnum = "SHA256"
PutObjectOpcChecksumAlgorithmSha384 PutObjectOpcChecksumAlgorithmEnum = "SHA384"
)
func GetMappingPutObjectOpcChecksumAlgorithmEnum(val string) (PutObjectOpcChecksumAlgorithmEnum, bool)
GetMappingPutObjectOpcChecksumAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPutObjectOpcChecksumAlgorithmEnumValues() []PutObjectOpcChecksumAlgorithmEnum
GetPutObjectOpcChecksumAlgorithmEnumValues Enumerates the set of values for PutObjectOpcChecksumAlgorithmEnum
PutObjectRequest wrapper for the PutObject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/PutObject.go.html to see an example of how to use PutObjectRequest.
type PutObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// The content length of the body.
ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"Content-Length"`
// The object to upload to the object store.
PutObjectBody io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should
// fail if the resource already exists.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.
// If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.
// The only allowed value for this parameter is "100-Continue" (case-insensitive).
Expect *string `mandatory:"false" contributesTo:"header" name:"Expect"`
// The optional header that defines the base64-encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object
// Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the
// MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error
// is returned with the message:
// "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"
ContentMD5 *string `mandatory:"false" contributesTo:"header" name:"Content-MD5"`
// The optional checksum algorithm to use to compute and store the checksum of the body of the HTTP request (or the parts in case of multipart uploads),
// in addition to the default MD5 checksum.
OpcChecksumAlgorithm PutObjectOpcChecksumAlgorithmEnum `mandatory:"false" contributesTo:"header" name:"opc-checksum-algorithm"`
// Applicable only if CRC32C is specified in the opc-checksum-algorithm request header.
// The optional header that defines the base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the body. If the optional opc-content-crc32c header
// is present, Object Storage performs an integrity check on the body of the HTTP request by computing the CRC32C checksum for the body and comparing
// it to the CRC32C checksum supplied in the header. If the two checksums do not match, the object is rejected and an HTTP-400 Unmatched Content CRC32C error
// is returned with the message:
// "The computed CRC32C of the request body (ACTUAL_CRC32C) does not match the opc-content-crc32c header (HEADER_CRC32C)"
OpcContentCrc32c *string `mandatory:"false" contributesTo:"header" name:"opc-content-crc32c"`
// Applicable only if SHA256 is specified in the opc-checksum-algorithm request header.
// The optional header that defines the base64-encoded SHA256 hash of the body. If the optional opc-content-sha256 header is present, Object
// Storage performs an integrity check on the body of the HTTP request by computing the SHA256 hash for the body and comparing it to the
// SHA256 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content SHA256 error
// is returned with the message:
// "The computed SHA256 of the request body (ACTUAL_SHA256) does not match the opc-content-sha256 header (HEADER_SHA256)"
OpcContentSha256 *string `mandatory:"false" contributesTo:"header" name:"opc-content-sha256"`
// Applicable only if SHA384 is specified in the opc-checksum-algorithm request header.
// The optional header that defines the base64-encoded SHA384 hash of the body. If the optional opc-content-sha384 header is present, Object
// Storage performs an integrity check on the body of the HTTP request by computing the SHA384 hash for the body and comparing it to the
// SHA384 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content SHA384 error
// is returned with the message:
// "The computed SHA384 of the request body (ACTUAL_SHA384) does not match the opc-content-sha384 header (HEADER_SHA384)"
OpcContentSha384 *string `mandatory:"false" contributesTo:"header" name:"opc-content-sha384"`
// The optional Content-Type header that defines the standard MIME type format of the object. Content type defaults to
// 'application/octet-stream' if not specified in the PutObject call. Specifying values for this header has no effect
// on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example,
// you could use this header to identify and perform special operations on text only objects.
ContentType *string `mandatory:"false" contributesTo:"header" name:"Content-Type"`
// The optional Content-Language header that defines the content language of the object to upload. Specifying
// values for this header has no effect on Object Storage behavior. Programs that read the object determine what
// to do based on the value provided. For example, you could use this header to identify and differentiate objects
// based on a particular language.
ContentLanguage *string `mandatory:"false" contributesTo:"header" name:"Content-Language"`
// The optional Content-Encoding header that defines the content encodings that were applied to the object to
// upload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the
// object determine what to do based on the value provided. For example, you could use this header to determine
// what decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of
// the object.
ContentEncoding *string `mandatory:"false" contributesTo:"header" name:"Content-Encoding"`
// The optional Content-Disposition header that defines presentational information for the object to be
// returned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object
// Storage behavior. Programs that read the object determine what to do based on the value provided.
// For example, you could use this header to let users download objects with custom filenames in a browser.
ContentDisposition *string `mandatory:"false" contributesTo:"header" name:"Content-Disposition"`
// The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and
// HeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs
// that read the object determine what to do based on the value provided.
// For example, you could use this header to identify objects that require caching restrictions.
CacheControl *string `mandatory:"false" contributesTo:"header" name:"Cache-Control"`
// The optional header that specifies "AES256" as the encryption algorithm. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or
// decrypt the data. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This
// value is used to check the integrity of the encryption key. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key-sha256"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key
// Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
OpcSseKmsKeyId *string `mandatory:"false" contributesTo:"header" name:"opc-sse-kms-key-id"`
// The storage tier that the object should be stored in. If not specified, the object will be stored in
// the same storage tier as the bucket.
StorageTier PutObjectStorageTierEnum `mandatory:"false" contributesTo:"header" name:"storage-tier"`
// Optional user-defined metadata key and value.
OpcMeta map[string]string `mandatory:"false" contributesTo:"header-collection" prefix:"opc-meta-"`
// 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 PutObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PutObjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PutObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request PutObjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PutObjectRequest) String() string
func (request PutObjectRequest) 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
PutObjectResponse wrapper for the PutObject operation
type PutObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The base64-encoded MD5 hash of the request body as computed by the server.
OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"`
// The base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the request body as computed by the server. Applicable only if CRC32C was specified in opc-checksum-algorithm request header during upload.
OpcContentCrc32c *string `presentIn:"header" name:"opc-content-crc32c"`
// The base64-encoded SHA256 hash of the request body as computed by the server. Applicable only if SHA256 was specified in opc-checksum-algorithm request header during upload.
OpcContentSha256 *string `presentIn:"header" name:"opc-content-sha256"`
// The base64-encoded SHA384 hash of the request body as computed by the server. Applicable only if SHA384 was specified in opc-checksum-algorithm request header during upload.
OpcContentSha384 *string `presentIn:"header" name:"opc-content-sha384"`
// The entity tag (ETag) for the object.
ETag *string `presentIn:"header" name:"etag"`
// The time the object was modified, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
// VersionId of the newly created object
VersionId *string `presentIn:"header" name:"version-id"`
}
func (response PutObjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PutObjectResponse) String() string
PutObjectStorageTierEnum Enum with underlying type: string
type PutObjectStorageTierEnum string
Set of constants representing the allowable values for PutObjectStorageTierEnum
const (
PutObjectStorageTierStandard PutObjectStorageTierEnum = "Standard"
PutObjectStorageTierInfrequentaccess PutObjectStorageTierEnum = "InfrequentAccess"
PutObjectStorageTierArchive PutObjectStorageTierEnum = "Archive"
)
func GetMappingPutObjectStorageTierEnum(val string) (PutObjectStorageTierEnum, bool)
GetMappingPutObjectStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPutObjectStorageTierEnumValues() []PutObjectStorageTierEnum
GetPutObjectStorageTierEnumValues Enumerates the set of values for PutObjectStorageTierEnum
ReencryptBucketRequest wrapper for the ReencryptBucket operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ReencryptBucket.go.html to see an example of how to use ReencryptBucketRequest.
type ReencryptBucketRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ReencryptBucketRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ReencryptBucketRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ReencryptBucketRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ReencryptBucketRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ReencryptBucketRequest) String() string
func (request ReencryptBucketRequest) 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
ReencryptBucketResponse wrapper for the ReencryptBucket operation
type ReencryptBucketResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ReencryptBucketResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ReencryptBucketResponse) String() string
ReencryptObjectDetails The details used to re-encrypt the data encryption keys associated with an object. You can only specify either a kmsKeyId or an sseCustomerKey in the request payload, not both. If the request payload is empty, the object is encrypted using the encryption key assigned to the bucket. The bucket encryption mechanism can either be a master encryption key managed by Oracle or the Vault service.
type ReencryptObjectDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the master encryption key used to call the Vault
// service to re-encrypt the data encryption keys associated with the object and its chunks. If the kmsKeyId value is
// empty, whether null or an empty string, the API will perform re-encryption by using the kmsKeyId associated with the
// bucket or the master encryption key managed by Oracle, depending on the bucket encryption mechanism.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
SseCustomerKey *SseCustomerKeyDetails `mandatory:"false" json:"sseCustomerKey"`
SourceSseCustomerKey *SseCustomerKeyDetails `mandatory:"false" json:"sourceSseCustomerKey"`
}
func (m ReencryptObjectDetails) String() string
func (m ReencryptObjectDetails) 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
ReencryptObjectRequest wrapper for the ReencryptObject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ReencryptObject.go.html to see an example of how to use ReencryptObjectRequest.
type ReencryptObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// Request object for re-encrypting the data encryption key associated with an object.
ReencryptObjectDetails `contributesTo:"body"`
// VersionId used to identify a particular version of the object
VersionId *string `mandatory:"false" contributesTo:"query" name:"versionId"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 ReencryptObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ReencryptObjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ReencryptObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request ReencryptObjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ReencryptObjectRequest) String() string
func (request ReencryptObjectRequest) 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
ReencryptObjectResponse wrapper for the ReencryptObject operation
type ReencryptObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ReencryptObjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ReencryptObjectResponse) String() string
RenameObjectDetails To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type RenameObjectDetails struct {
// The name of the source object to be renamed.
SourceName *string `mandatory:"true" json:"sourceName"`
// The new name of the source object. Avoid entering confidential information.
NewName *string `mandatory:"true" json:"newName"`
// The if-match entity tag (ETag) of the source object.
SrcObjIfMatchETag *string `mandatory:"false" json:"srcObjIfMatchETag"`
// The if-match entity tag (ETag) of the new object.
NewObjIfMatchETag *string `mandatory:"false" json:"newObjIfMatchETag"`
// The if-none-match entity tag (ETag) of the new object. The only valid value is '*', which indicates
// request should fail if the new object already exists.
NewObjIfNoneMatchETag *string `mandatory:"false" json:"newObjIfNoneMatchETag"`
}
func (m RenameObjectDetails) String() string
func (m RenameObjectDetails) 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
RenameObjectRequest wrapper for the RenameObject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/RenameObject.go.html to see an example of how to use RenameObjectRequest.
type RenameObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The sourceName and newName of rename operation. Avoid entering confidential information.
RenameObjectDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 RenameObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RenameObjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RenameObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request RenameObjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RenameObjectRequest) String() string
func (request RenameObjectRequest) 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
RenameObjectResponse wrapper for the RenameObject operation
type RenameObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the object.
ETag *string `presentIn:"header" name:"etag"`
// The time the object was modified, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
// VersionId of the renamed object
VersionId *string `presentIn:"header" name:"version-id"`
}
func (response RenameObjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RenameObjectResponse) String() string
ReplicationPolicy The details of a replication policy.
type ReplicationPolicy struct {
// The id of the replication policy.
Id *string `mandatory:"true" json:"id"`
// The name of the policy.
Name *string `mandatory:"true" json:"name"`
// The destination region to replicate to, for example "us-ashburn-1".
DestinationRegionName *string `mandatory:"true" json:"destinationRegionName"`
// The bucket to replicate to in the destination region. Replication policy creation does not automatically
// create a destination bucket. Create the destination bucket before creating the policy.
DestinationBucketName *string `mandatory:"true" json:"destinationBucketName"`
// The date when the replication policy was created as per RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Changes made to the source bucket before this time has been replicated.
TimeLastSync *common.SDKTime `mandatory:"true" json:"timeLastSync"`
// The replication status of the policy. If the status is CLIENT_ERROR, once the user fixes the issue
// described in the status message, the status will become ACTIVE.
Status ReplicationPolicyStatusEnum `mandatory:"true" json:"status"`
// A human-readable description of the status.
StatusMessage *string `mandatory:"true" json:"statusMessage"`
}
func (m ReplicationPolicy) String() string
func (m ReplicationPolicy) 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
ReplicationPolicyStatusEnum Enum with underlying type: string
type ReplicationPolicyStatusEnum string
Set of constants representing the allowable values for ReplicationPolicyStatusEnum
const (
ReplicationPolicyStatusActive ReplicationPolicyStatusEnum = "ACTIVE"
ReplicationPolicyStatusClientError ReplicationPolicyStatusEnum = "CLIENT_ERROR"
)
func GetMappingReplicationPolicyStatusEnum(val string) (ReplicationPolicyStatusEnum, bool)
GetMappingReplicationPolicyStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationPolicyStatusEnumValues() []ReplicationPolicyStatusEnum
GetReplicationPolicyStatusEnumValues Enumerates the set of values for ReplicationPolicyStatusEnum
ReplicationPolicySummary The summary of a replication policy.
type ReplicationPolicySummary struct {
// The id of the replication policy.
Id *string `mandatory:"true" json:"id"`
// The name of the policy.
Name *string `mandatory:"true" json:"name"`
// The destination region to replicate to, for example "us-ashburn-1".
DestinationRegionName *string `mandatory:"true" json:"destinationRegionName"`
// The bucket to replicate to in the destination region. Replication policy creation does not automatically
// create a destination bucket. Create the destination bucket before creating the policy.
DestinationBucketName *string `mandatory:"true" json:"destinationBucketName"`
// The date when the replication policy was created as per RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Changes made to the source bucket before this time has been replicated.
TimeLastSync *common.SDKTime `mandatory:"true" json:"timeLastSync"`
// The replication status of the policy. If the status is CLIENT_ERROR, once the user fixes the issue
// described in the status message, the status will become ACTIVE.
Status ReplicationPolicySummaryStatusEnum `mandatory:"true" json:"status"`
// A human-readable description of the status.
StatusMessage *string `mandatory:"true" json:"statusMessage"`
}
func (m ReplicationPolicySummary) String() string
func (m ReplicationPolicySummary) 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
ReplicationPolicySummaryStatusEnum Enum with underlying type: string
type ReplicationPolicySummaryStatusEnum string
Set of constants representing the allowable values for ReplicationPolicySummaryStatusEnum
const (
ReplicationPolicySummaryStatusActive ReplicationPolicySummaryStatusEnum = "ACTIVE"
ReplicationPolicySummaryStatusClientError ReplicationPolicySummaryStatusEnum = "CLIENT_ERROR"
)
func GetMappingReplicationPolicySummaryStatusEnum(val string) (ReplicationPolicySummaryStatusEnum, bool)
GetMappingReplicationPolicySummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicationPolicySummaryStatusEnumValues() []ReplicationPolicySummaryStatusEnum
GetReplicationPolicySummaryStatusEnumValues Enumerates the set of values for ReplicationPolicySummaryStatusEnum
ReplicationSource The details of a replication source bucket that replicates to a target destination bucket.
type ReplicationSource struct {
// The name of the policy.
PolicyName *string `mandatory:"true" json:"policyName"`
// The source region replicating data from, for example "us-ashburn-1".
SourceRegionName *string `mandatory:"true" json:"sourceRegionName"`
// The source bucket replicating data from.
SourceBucketName *string `mandatory:"true" json:"sourceBucketName"`
}
func (m ReplicationSource) String() string
func (m ReplicationSource) 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
RestoreObjectsDetails The representation of RestoreObjectsDetails
type RestoreObjectsDetails struct {
// An object that is in an archive storage tier and needs to be restored.
ObjectName *string `mandatory:"true" json:"objectName"`
// The number of hours for which this object will be restored.
// By default objects will be restored for 24 hours. You can instead configure the duration using the hours parameter.
Hours *int `mandatory:"false" json:"hours"`
// The versionId of the object to restore. Current object version is used by default.
VersionId *string `mandatory:"false" json:"versionId"`
}
func (m RestoreObjectsDetails) String() string
func (m RestoreObjectsDetails) 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
RestoreObjectsRequest wrapper for the RestoreObjects operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/RestoreObjects.go.html to see an example of how to use RestoreObjectsRequest.
type RestoreObjectsRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// Request to restore object.
RestoreObjectsDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 RestoreObjectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreObjectsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreObjectsRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request RestoreObjectsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreObjectsRequest) String() string
func (request RestoreObjectsRequest) 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
RestoreObjectsResponse wrapper for the RestoreObjects operation
type RestoreObjectsResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RestoreObjectsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreObjectsResponse) String() string
RetentionRule The details of a retention rule.
type RetentionRule struct {
// Unique identifier for the retention rule.
Id *string `mandatory:"true" json:"id"`
// User specified name for the retention rule.
DisplayName *string `mandatory:"true" json:"displayName"`
// The entity tag (ETag) for the retention rule.
Etag *string `mandatory:"true" json:"etag"`
// The date and time that the retention rule was created as per RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that the retention rule was modified as per RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeModified *common.SDKTime `mandatory:"true" json:"timeModified"`
Duration *Duration `mandatory:"false" json:"duration"`
// The date and time as per RFC 3339 (https://tools.ietf.org/html/rfc3339) after which this rule becomes locked.
// and can only be deleted by deleting the bucket.
TimeRuleLocked *common.SDKTime `mandatory:"false" json:"timeRuleLocked"`
}
func (m RetentionRule) String() string
func (m RetentionRule) 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
RetentionRuleCollection Retention rule collection.
type RetentionRuleCollection struct {
// An array of retention rule summaries.
Items []RetentionRuleSummary `mandatory:"true" json:"items"`
}
func (m RetentionRuleCollection) String() string
func (m RetentionRuleCollection) 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
RetentionRuleDetails The details to create or update a retention rule.
type RetentionRuleDetails struct {
// A user-specified name for the retention rule. Names can be helpful in identifying retention rules.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
Duration *Duration `mandatory:"false" json:"duration"`
// The date and time as per RFC 3339 (https://tools.ietf.org/html/rfc3339) after which this rule is locked
// and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are
// allowed and no other properties can be changed. This property cannot be updated for rules that are in a
// locked state. Specifying it when a duration is not specified is considered an error.
TimeRuleLocked *common.SDKTime `mandatory:"false" json:"timeRuleLocked"`
}
func (m RetentionRuleDetails) String() string
func (m RetentionRuleDetails) 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
RetentionRuleSummary The summary of a retention rule.
type RetentionRuleSummary struct {
// Unique identifier for the retention rule.
Id *string `mandatory:"true" json:"id"`
// User specified name for the retention rule.
DisplayName *string `mandatory:"true" json:"displayName"`
// The entity tag (ETag) for the retention rule.
Etag *string `mandatory:"true" json:"etag"`
// The date and time that the retention rule was created as per RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that the retention rule was modified as per RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeModified *common.SDKTime `mandatory:"true" json:"timeModified"`
Duration *Duration `mandatory:"false" json:"duration"`
// The date and time as per RFC 3339 (https://tools.ietf.org/html/rfc3339) after which this rule becomes locked.
// and can only be deleted by deleting the bucket.
TimeRuleLocked *common.SDKTime `mandatory:"false" json:"timeRuleLocked"`
}
func (m RetentionRuleSummary) String() string
func (m RetentionRuleSummary) 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
SseCustomerKeyDetails Specifies the details of the customer-provided encryption key (SSE-C) associated with an object.
type SseCustomerKeyDetails struct {
// Specifies the encryption algorithm. The only supported value is "AES256".
Algorithm SseCustomerKeyDetailsAlgorithmEnum `mandatory:"true" json:"algorithm"`
// Specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the object data.
Key *string `mandatory:"true" json:"key"`
// Specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity
// of the encryption key.
KeySha256 *string `mandatory:"true" json:"keySha256"`
}
func (m SseCustomerKeyDetails) String() string
func (m SseCustomerKeyDetails) 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
SseCustomerKeyDetailsAlgorithmEnum Enum with underlying type: string
type SseCustomerKeyDetailsAlgorithmEnum string
Set of constants representing the allowable values for SseCustomerKeyDetailsAlgorithmEnum
const (
SseCustomerKeyDetailsAlgorithmAes256 SseCustomerKeyDetailsAlgorithmEnum = "AES256"
)
func GetMappingSseCustomerKeyDetailsAlgorithmEnum(val string) (SseCustomerKeyDetailsAlgorithmEnum, bool)
GetMappingSseCustomerKeyDetailsAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSseCustomerKeyDetailsAlgorithmEnumValues() []SseCustomerKeyDetailsAlgorithmEnum
GetSseCustomerKeyDetailsAlgorithmEnumValues Enumerates the set of values for SseCustomerKeyDetailsAlgorithmEnum
StorageTierEnum Enum with underlying type: string
type StorageTierEnum string
Set of constants representing the allowable values for StorageTierEnum
const (
StorageTierStandard StorageTierEnum = "Standard"
StorageTierInfrequentAccess StorageTierEnum = "InfrequentAccess"
StorageTierArchive StorageTierEnum = "Archive"
)
func GetMappingStorageTierEnum(val string) (StorageTierEnum, bool)
GetMappingStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStorageTierEnumValues() []StorageTierEnum
GetStorageTierEnumValues Enumerates the set of values for StorageTierEnum
UpdateBucketDetails To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type UpdateBucketDetails struct {
// The Object Storage namespace in which the bucket lives.
Namespace *string `mandatory:"false" json:"namespace"`
// The compartmentId for the compartment to move the bucket to.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
// Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information.
// Example: my-new-bucket1
Name *string `mandatory:"false" json:"name"`
// Arbitrary string, up to 4KB, of keys and values for user-defined metadata.
Metadata map[string]string `mandatory:"false" json:"metadata"`
// The type of public access enabled on this bucket. A bucket is set to `NoPublicAccess` by default, which only allows an
// authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access
// is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled
// on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations.
PublicAccessType UpdateBucketDetailsPublicAccessTypeEnum `mandatory:"false" json:"publicAccessType,omitempty"`
// Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is
// set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information
// about events, see Overview of Events (https://docs.oracle.com/iaas/Content/Events/Concepts/eventsoverview.htm).
ObjectEventsEnabled *bool `mandatory:"false" json:"objectEventsEnabled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Key Management master encryption key to associate
// with the specified bucket. If this value is empty, the Update operation will remove the associated key, if
// there is one, from the bucket. (The bucket will continue to be encrypted, but with an encryption key managed
// by Oracle.)
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// The versioning status on the bucket. If in state `Enabled`, multiple versions of the same object can be kept in the bucket.
// When the object is overwritten or deleted, previous versions will still be available. When versioning is `Suspended`, the previous versions will still remain but new versions will no longer be created when overwitten or deleted.
// Versioning cannot be disabled on a bucket once enabled.
Versioning UpdateBucketDetailsVersioningEnum `mandatory:"false" json:"versioning,omitempty"`
// The auto tiering status on the bucket. If in state `InfrequentAccess`, objects are transitioned
// automatically between the 'Standard' and 'InfrequentAccess' tiers based on the access pattern of the objects.
// When auto tiering is `Disabled`, there will be no automatic transitions between storage tiers.
AutoTiering BucketAutoTieringEnum `mandatory:"false" json:"autoTiering,omitempty"`
}
func (m UpdateBucketDetails) String() string
func (m UpdateBucketDetails) 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
UpdateBucketDetailsPublicAccessTypeEnum Enum with underlying type: string
type UpdateBucketDetailsPublicAccessTypeEnum string
Set of constants representing the allowable values for UpdateBucketDetailsPublicAccessTypeEnum
const (
UpdateBucketDetailsPublicAccessTypeNopublicaccess UpdateBucketDetailsPublicAccessTypeEnum = "NoPublicAccess"
UpdateBucketDetailsPublicAccessTypeObjectread UpdateBucketDetailsPublicAccessTypeEnum = "ObjectRead"
UpdateBucketDetailsPublicAccessTypeObjectreadwithoutlist UpdateBucketDetailsPublicAccessTypeEnum = "ObjectReadWithoutList"
)
func GetMappingUpdateBucketDetailsPublicAccessTypeEnum(val string) (UpdateBucketDetailsPublicAccessTypeEnum, bool)
GetMappingUpdateBucketDetailsPublicAccessTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateBucketDetailsPublicAccessTypeEnumValues() []UpdateBucketDetailsPublicAccessTypeEnum
GetUpdateBucketDetailsPublicAccessTypeEnumValues Enumerates the set of values for UpdateBucketDetailsPublicAccessTypeEnum
UpdateBucketDetailsVersioningEnum Enum with underlying type: string
type UpdateBucketDetailsVersioningEnum string
Set of constants representing the allowable values for UpdateBucketDetailsVersioningEnum
const (
UpdateBucketDetailsVersioningEnabled UpdateBucketDetailsVersioningEnum = "Enabled"
UpdateBucketDetailsVersioningSuspended UpdateBucketDetailsVersioningEnum = "Suspended"
)
func GetMappingUpdateBucketDetailsVersioningEnum(val string) (UpdateBucketDetailsVersioningEnum, bool)
GetMappingUpdateBucketDetailsVersioningEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateBucketDetailsVersioningEnumValues() []UpdateBucketDetailsVersioningEnum
GetUpdateBucketDetailsVersioningEnumValues Enumerates the set of values for UpdateBucketDetailsVersioningEnum
UpdateBucketRequest wrapper for the UpdateBucket operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateBucket.go.html to see an example of how to use UpdateBucketRequest.
type UpdateBucketRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// Request object for updating a bucket.
UpdateBucketDetails `contributesTo:"body"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 UpdateBucketRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBucketRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBucketRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request UpdateBucketRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBucketRequest) String() string
func (request UpdateBucketRequest) 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
UpdateBucketResponse wrapper for the UpdateBucket operation
type UpdateBucketResponse struct {
// The underlying http response
RawResponse *http.Response
// The Bucket instance
Bucket `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the updated bucket.
ETag *string `presentIn:"header" name:"etag"`
}
func (response UpdateBucketResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBucketResponse) String() string
UpdateNamespaceMetadataDetails UpdateNamespaceMetadataDetails is used to update the NamespaceMetadata. To update NamespaceMetadata, a user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission.
type UpdateNamespaceMetadataDetails struct {
// The updated compartment id for use by an S3 client, if this field is set.
DefaultS3CompartmentId *string `mandatory:"false" json:"defaultS3CompartmentId"`
// The updated compartment id for use by a Swift client, if this field is set.
DefaultSwiftCompartmentId *string `mandatory:"false" json:"defaultSwiftCompartmentId"`
}
func (m UpdateNamespaceMetadataDetails) String() string
func (m UpdateNamespaceMetadataDetails) 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
UpdateNamespaceMetadataRequest wrapper for the UpdateNamespaceMetadata operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateNamespaceMetadata.go.html to see an example of how to use UpdateNamespaceMetadataRequest.
type UpdateNamespaceMetadataRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// Request object for update NamespaceMetadata.
UpdateNamespaceMetadataDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 UpdateNamespaceMetadataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNamespaceMetadataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNamespaceMetadataRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request UpdateNamespaceMetadataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNamespaceMetadataRequest) String() string
func (request UpdateNamespaceMetadataRequest) 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
UpdateNamespaceMetadataResponse wrapper for the UpdateNamespaceMetadata operation
type UpdateNamespaceMetadataResponse struct {
// The underlying http response
RawResponse *http.Response
// The NamespaceMetadata instance
NamespaceMetadata `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateNamespaceMetadataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNamespaceMetadataResponse) String() string
UpdateObjectStorageTierDetails To change the storage tier of an object, we specify the object name and the desired storage tier in the body. Objects can be moved between Standard and InfrequentAccess tiers and from Standard or InfrequentAccess tier to Archive tier. If a version id is specified, only the specified version of the object is moved to a different storage tier, else the current version is used.
type UpdateObjectStorageTierDetails struct {
// An object for which the storage tier needs to be changed.
ObjectName *string `mandatory:"true" json:"objectName"`
// The storage tier that the object should be moved to.
StorageTier StorageTierEnum `mandatory:"true" json:"storageTier"`
// The versionId of the object. Current object version is used by default.
VersionId *string `mandatory:"false" json:"versionId"`
}
func (m UpdateObjectStorageTierDetails) String() string
func (m UpdateObjectStorageTierDetails) 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
UpdateObjectStorageTierRequest wrapper for the UpdateObjectStorageTier operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateObjectStorageTier.go.html to see an example of how to use UpdateObjectStorageTierRequest.
type UpdateObjectStorageTierRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The object name and the desired storage tier.
UpdateObjectStorageTierDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 UpdateObjectStorageTierRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateObjectStorageTierRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateObjectStorageTierRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request UpdateObjectStorageTierRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateObjectStorageTierRequest) String() string
func (request UpdateObjectStorageTierRequest) 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
UpdateObjectStorageTierResponse wrapper for the UpdateObjectStorageTier operation
type UpdateObjectStorageTierResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateObjectStorageTierResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateObjectStorageTierResponse) String() string
UpdatePrivateEndpointDetails Information that can be updated for a private endpoint.
type UpdatePrivateEndpointDetails struct {
// This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens,
// underscores, and periods.
// Example: my-new-private-endpoint1
Name *string `mandatory:"false" json:"name"`
// The Object Storage namespace which will associated with the private endpoint.
Namespace *string `mandatory:"false" json:"namespace"`
// A list of targets that can be accessed by the private endpoint.
AccessTargets []AccessTargetDetails `mandatory:"false" json:"accessTargets"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdatePrivateEndpointDetails) String() string
func (m UpdatePrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePrivateEndpointRequest wrapper for the UpdatePrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdatePrivateEndpoint.go.html to see an example of how to use UpdatePrivateEndpointRequest.
type UpdatePrivateEndpointRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the private endpoint. Avoid entering confidential information.
// Example: `my-new-pe-1`
PeName *string `mandatory:"true" contributesTo:"path" name:"peName"`
// Request object for updating the Private Endpoint.
UpdatePrivateEndpointDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdatePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePrivateEndpointRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request UpdatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePrivateEndpointRequest) String() string
func (request UpdatePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePrivateEndpointResponse wrapper for the UpdatePrivateEndpoint operation
type UpdatePrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a
// particular request, provide this request ID.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdatePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePrivateEndpointResponse) String() string
UpdateRetentionRuleDetails The details to update a retention rule.
type UpdateRetentionRuleDetails struct {
// A user-specified name for the retention rule. Names can be helpful in identifying retention rules.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
Duration *Duration `mandatory:"false" json:"duration"`
// The date and time as per RFC 3339 (https://tools.ietf.org/html/rfc3339) after which this rule is locked
// and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are
// allowed and no other properties can be changed. This property cannot be updated for rules that are in a
// locked state. Specifying it when a duration is not specified is considered an error.
TimeRuleLocked *common.SDKTime `mandatory:"false" json:"timeRuleLocked"`
}
func (m UpdateRetentionRuleDetails) String() string
func (m UpdateRetentionRuleDetails) 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
UpdateRetentionRuleRequest wrapper for the UpdateRetentionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UpdateRetentionRule.go.html to see an example of how to use UpdateRetentionRuleRequest.
type UpdateRetentionRuleRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The ID of the retention rule.
RetentionRuleId *string `mandatory:"true" contributesTo:"path" name:"retentionRuleId"`
// Request object for updating the retention rule.
UpdateRetentionRuleDetails `contributesTo:"body"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-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 UpdateRetentionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRetentionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRetentionRuleRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request UpdateRetentionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRetentionRuleRequest) String() string
func (request UpdateRetentionRuleRequest) 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
UpdateRetentionRuleResponse wrapper for the UpdateRetentionRule operation
type UpdateRetentionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The RetentionRule instance
RetentionRule `presentIn:"body"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the retention rule that was updated.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateRetentionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRetentionRuleResponse) String() string
UploadPartOpcChecksumAlgorithmEnum Enum with underlying type: string
type UploadPartOpcChecksumAlgorithmEnum string
Set of constants representing the allowable values for UploadPartOpcChecksumAlgorithmEnum
const (
UploadPartOpcChecksumAlgorithmCrc32c UploadPartOpcChecksumAlgorithmEnum = "CRC32C"
UploadPartOpcChecksumAlgorithmSha256 UploadPartOpcChecksumAlgorithmEnum = "SHA256"
UploadPartOpcChecksumAlgorithmSha384 UploadPartOpcChecksumAlgorithmEnum = "SHA384"
)
func GetMappingUploadPartOpcChecksumAlgorithmEnum(val string) (UploadPartOpcChecksumAlgorithmEnum, bool)
GetMappingUploadPartOpcChecksumAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUploadPartOpcChecksumAlgorithmEnumValues() []UploadPartOpcChecksumAlgorithmEnum
GetUploadPartOpcChecksumAlgorithmEnumValues Enumerates the set of values for UploadPartOpcChecksumAlgorithmEnum
UploadPartRequest wrapper for the UploadPart operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/UploadPart.go.html to see an example of how to use UploadPartRequest.
type UploadPartRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// The upload ID for a multipart upload.
UploadId *string `mandatory:"true" contributesTo:"query" name:"uploadId"`
// The part number that identifies the object part currently being uploaded.
UploadPartNum *int `mandatory:"true" contributesTo:"query" name:"uploadPartNum"`
// The content length of the body.
ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"Content-Length"`
// The part being uploaded to the Object Storage service.
UploadPartBody io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should
// fail if the resource already exists.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.
// If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.
// The only allowed value for this parameter is "100-Continue" (case-insensitive).
Expect *string `mandatory:"false" contributesTo:"header" name:"Expect"`
// The optional header that defines the base64-encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object
// Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the
// MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error
// is returned with the message:
// "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"
ContentMD5 *string `mandatory:"false" contributesTo:"header" name:"Content-MD5"`
// The optional checksum algorithm to use to compute and store the checksum of the body of the HTTP request (or the parts in case of multipart uploads),
// in addition to the default MD5 checksum.
OpcChecksumAlgorithm UploadPartOpcChecksumAlgorithmEnum `mandatory:"false" contributesTo:"header" name:"opc-checksum-algorithm"`
// Applicable only if CRC32C is specified in the opc-checksum-algorithm request header.
// The optional header that defines the base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the body. If the optional opc-content-crc32c header
// is present, Object Storage performs an integrity check on the body of the HTTP request by computing the CRC32C checksum for the body and comparing
// it to the CRC32C checksum supplied in the header. If the two checksums do not match, the object is rejected and an HTTP-400 Unmatched Content CRC32C error
// is returned with the message:
// "The computed CRC32C of the request body (ACTUAL_CRC32C) does not match the opc-content-crc32c header (HEADER_CRC32C)"
OpcContentCrc32c *string `mandatory:"false" contributesTo:"header" name:"opc-content-crc32c"`
// Applicable only if SHA256 is specified in the opc-checksum-algorithm request header.
// The optional header that defines the base64-encoded SHA256 hash of the body. If the optional opc-content-sha256 header is present, Object
// Storage performs an integrity check on the body of the HTTP request by computing the SHA256 hash for the body and comparing it to the
// SHA256 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content SHA256 error
// is returned with the message:
// "The computed SHA256 of the request body (ACTUAL_SHA256) does not match the opc-content-sha256 header (HEADER_SHA256)"
OpcContentSha256 *string `mandatory:"false" contributesTo:"header" name:"opc-content-sha256"`
// Applicable only if SHA384 is specified in the opc-checksum-algorithm request header.
// The optional header that defines the base64-encoded SHA384 hash of the body. If the optional opc-content-sha384 header is present, Object
// Storage performs an integrity check on the body of the HTTP request by computing the SHA384 hash for the body and comparing it to the
// SHA384 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content SHA384 error
// is returned with the message:
// "The computed SHA384 of the request body (ACTUAL_SHA384) does not match the opc-content-sha384 header (HEADER_SHA384)"
OpcContentSha384 *string `mandatory:"false" contributesTo:"header" name:"opc-content-sha384"`
// The optional header that specifies "AES256" as the encryption algorithm. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or
// decrypt the data. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This
// value is used to check the integrity of the encryption key. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key-sha256"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key
// Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
OpcSseKmsKeyId *string `mandatory:"false" contributesTo:"header" name:"opc-sse-kms-key-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 UploadPartRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UploadPartRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UploadPartRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint)
ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided. Not all services are supporting this feature and this method will be a no-op for those services.
func (request UploadPartRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UploadPartRequest) String() string
func (request UploadPartRequest) 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
UploadPartResponse wrapper for the UploadPart operation
type UploadPartResponse struct {
// The underlying http response
RawResponse *http.Response
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The base64-encoded MD5 hash of the request body, as computed by the server.
OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"`
// The base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the request body as computed by the server. Applicable only if CRC32C was specified in opc-checksum-algorithm request header during upload.
OpcContentCrc32c *string `presentIn:"header" name:"opc-content-crc32c"`
// The base64-encoded SHA256 hash of the request body as computed by the server. Applicable only if SHA256 was specified in opc-checksum-algorithm request header during upload.
OpcContentSha256 *string `presentIn:"header" name:"opc-content-sha256"`
// The base64-encoded SHA384 hash of the request body as computed by the server. Applicable only if SHA384 was specified in opc-checksum-algorithm request header during upload.
OpcContentSha384 *string `presentIn:"header" name:"opc-content-sha384"`
// The entity tag (ETag) for the object.
ETag *string `presentIn:"header" name:"etag"`
}
func (response UploadPartResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UploadPartResponse) String() string
WorkRequest A description of workRequest status.
type WorkRequest struct {
// The type of work request.
OperationType WorkRequestOperationTypeEnum `mandatory:"false" json:"operationType,omitempty"`
// The status of the specified work request.
Status WorkRequestStatusEnum `mandatory:"false" json:"status,omitempty"`
// The id of the work request.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work
// requests are 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, the OCID of
// the primary resource is used. For example, you can copy an object in a bucket in one compartment to a bucket in
// another compartment. In this case, the OCID of the source compartment is used.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// Percentage of the work request completed.
PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
// The date and time the work request was created, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// The date and time the work request was started, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError The representation of WorkRequestError
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For the list of error codes,
// see API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"false" json:"code"`
// A human-readable description of the issue that produced the error.
Message *string `mandatory:"false" json:"message"`
// The time the error occurred.
Timestamp *common.SDKTime `mandatory:"false" 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
WorkRequestLogEntry The representation of WorkRequestLogEntry
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"false" json:"message"`
// The date and time the log message was written, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"false" 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
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeCopyObject WorkRequestOperationTypeEnum = "COPY_OBJECT"
WorkRequestOperationTypeReencrypt WorkRequestOperationTypeEnum = "REENCRYPT"
WorkRequestOperationTypePrivateEndpointCreate WorkRequestOperationTypeEnum = "PRIVATE_ENDPOINT_CREATE"
WorkRequestOperationTypePrivateEndpointUpdate WorkRequestOperationTypeEnum = "PRIVATE_ENDPOINT_UPDATE"
WorkRequestOperationTypePrivateEndpointDelete WorkRequestOperationTypeEnum = "PRIVATE_ENDPOINT_DELETE"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource The representation of WorkRequestResource
type WorkRequestResource struct {
// The status of the work request.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"false" json:"actionType,omitempty"`
// The resource type the work request affects.
EntityType *string `mandatory:"false" json:"entityType"`
// The resource type identifier.
Identifier *string `mandatory:"false" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
// The metadata of 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
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeRelated WorkRequestResourceActionTypeEnum = "RELATED"
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeRead WorkRequestResourceActionTypeEnum = "READ"
WorkRequestResourceActionTypeWritten WorkRequestResourceActionTypeEnum = "WRITTEN"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyRegion WorkRequestResourceMetadataKeyEnum = "REGION"
WorkRequestResourceMetadataKeyNamespace WorkRequestResourceMetadataKeyEnum = "NAMESPACE"
WorkRequestResourceMetadataKeyBucket WorkRequestResourceMetadataKeyEnum = "BUCKET"
WorkRequestResourceMetadataKeyObject WorkRequestResourceMetadataKeyEnum = "OBJECT"
WorkRequestResourceMetadataKeyPrivateEndpointName WorkRequestResourceMetadataKeyEnum = "PRIVATE_ENDPOINT_NAME"
)
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
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusCompleted WorkRequestStatusEnum = "COMPLETED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// The type of work request.
OperationType WorkRequestSummaryOperationTypeEnum `mandatory:"false" json:"operationType,omitempty"`
// The status of a specified work request.
Status WorkRequestSummaryStatusEnum `mandatory:"false" json:"status,omitempty"`
// The id of the work request.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work
// requests are 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, the OCID of
// the primary resource is used. For example, you can copy an object in a bucket in one compartment to a bucket in
// another compartment. In this case, the OCID of the source compartment is used.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// Percentage of the work request completed.
PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
// The date and time the work request was created, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// The date and time the work request was started, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, as described in
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryOperationTypeEnum Enum with underlying type: string
type WorkRequestSummaryOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum
const (
WorkRequestSummaryOperationTypeCopyObject WorkRequestSummaryOperationTypeEnum = "COPY_OBJECT"
WorkRequestSummaryOperationTypeReencrypt WorkRequestSummaryOperationTypeEnum = "REENCRYPT"
WorkRequestSummaryOperationTypePrivateEndpointCreate WorkRequestSummaryOperationTypeEnum = "PRIVATE_ENDPOINT_CREATE"
WorkRequestSummaryOperationTypePrivateEndpointUpdate WorkRequestSummaryOperationTypeEnum = "PRIVATE_ENDPOINT_UPDATE"
WorkRequestSummaryOperationTypePrivateEndpointDelete WorkRequestSummaryOperationTypeEnum = "PRIVATE_ENDPOINT_DELETE"
)
func GetMappingWorkRequestSummaryOperationTypeEnum(val string) (WorkRequestSummaryOperationTypeEnum, bool)
GetMappingWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum
GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum
WorkRequestSummaryStatusEnum Enum with underlying type: string
type WorkRequestSummaryStatusEnum string
Set of constants representing the allowable values for WorkRequestSummaryStatusEnum
const (
WorkRequestSummaryStatusAccepted WorkRequestSummaryStatusEnum = "ACCEPTED"
WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
WorkRequestSummaryStatusFailed WorkRequestSummaryStatusEnum = "FAILED"
WorkRequestSummaryStatusCompleted WorkRequestSummaryStatusEnum = "COMPLETED"
WorkRequestSummaryStatusCanceling WorkRequestSummaryStatusEnum = "CANCELING"
WorkRequestSummaryStatusCanceled WorkRequestSummaryStatusEnum = "CANCELED"
)
func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)
GetMappingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum