oci-go-sdk: github.com/oracle/oci-go-sdk/objectstorage Index | Files | Directories

package objectstorage

import "github.com/oracle/oci-go-sdk/objectstorage"

Index

Package Files

abort_multipart_upload_request_response.go bucket.go bucket_summary.go cancel_work_request_request_response.go commit_multipart_upload_details.go commit_multipart_upload_part_details.go commit_multipart_upload_request_response.go copy_object_details.go copy_object_request_response.go create_bucket_details.go create_bucket_request_response.go create_multipart_upload_details.go create_multipart_upload_request_response.go create_preauthenticated_request_details.go create_preauthenticated_request_request_response.go create_replication_policy_details.go create_replication_policy_request_response.go create_retention_rule_details.go create_retention_rule_request_response.go delete_bucket_request_response.go delete_object_lifecycle_policy_request_response.go delete_object_request_response.go delete_preauthenticated_request_request_response.go delete_replication_policy_request_response.go delete_retention_rule_request_response.go duration.go get_bucket_request_response.go get_namespace_metadata_request_response.go get_namespace_request_response.go get_object_lifecycle_policy_request_response.go get_object_request_response.go get_preauthenticated_request_request_response.go get_replication_policy_request_response.go get_retention_rule_request_response.go get_work_request_request_response.go head_bucket_request_response.go head_object_request_response.go list_buckets_request_response.go list_multipart_upload_parts_request_response.go list_multipart_uploads_request_response.go list_objects.go list_objects_request_response.go list_preauthenticated_requests_request_response.go list_replication_policies_request_response.go list_replication_sources_request_response.go list_retention_rules_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go make_bucket_writable_request_response.go multipart_upload.go multipart_upload_part_summary.go namespace_metadata.go object_lifecycle_policy.go object_lifecycle_rule.go object_name_filter.go object_summary.go objectstorage_client.go pattern_details.go preauthenticated_request.go preauthenticated_request_summary.go put_object_lifecycle_policy_details.go put_object_lifecycle_policy_request_response.go put_object_request_response.go reencrypt_bucket_request_response.go rename_object_details.go rename_object_request_response.go replication_policy.go replication_policy_summary.go replication_source.go restore_objects_details.go restore_objects_request_response.go retention_rule.go retention_rule_collection.go retention_rule_details.go retention_rule_summary.go update_bucket_details.go update_bucket_request_response.go update_namespace_metadata_details.go update_namespace_metadata_request_response.go update_retention_rule_details.go update_retention_rule_request_response.go upload_part_request_response.go work_request.go work_request_error.go work_request_log_entry.go work_request_resource.go work_request_resource_metadata_key.go work_request_summary.go

type AbortMultipartUploadRequest Uses

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
}

AbortMultipartUploadRequest wrapper for the AbortMultipartUpload operation

func (AbortMultipartUploadRequest) HTTPRequest Uses

func (request AbortMultipartUploadRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AbortMultipartUploadRequest) RetryPolicy Uses

func (request AbortMultipartUploadRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AbortMultipartUploadRequest) String Uses

func (request AbortMultipartUploadRequest) String() string

type AbortMultipartUploadResponse Uses

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"`
}

AbortMultipartUploadResponse wrapper for the AbortMultipartUpload operation

func (AbortMultipartUploadResponse) HTTPResponse Uses

func (response AbortMultipartUploadResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AbortMultipartUploadResponse) String Uses

func (response AbortMultipartUploadResponse) String() string

type Bucket Uses

type Bucket 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"`

    // Arbitrary string keys and values for user-defined metadata.
    Metadata map[string]string `mandatory:"true" json:"metadata"`

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the bucket.
    Id  *string `mandatory:"false" json:"id"`
}

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.cloud.oracle.com/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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (Bucket) String Uses

func (m Bucket) String() string

type BucketPublicAccessTypeEnum Uses

type BucketPublicAccessTypeEnum string

BucketPublicAccessTypeEnum Enum with underlying type: string

const (
    BucketPublicAccessTypeNopublicaccess        BucketPublicAccessTypeEnum = "NoPublicAccess"
    BucketPublicAccessTypeObjectread            BucketPublicAccessTypeEnum = "ObjectRead"
    BucketPublicAccessTypeObjectreadwithoutlist BucketPublicAccessTypeEnum = "ObjectReadWithoutList"
)

Set of constants representing the allowable values for BucketPublicAccessTypeEnum

func GetBucketPublicAccessTypeEnumValues Uses

func GetBucketPublicAccessTypeEnumValues() []BucketPublicAccessTypeEnum

GetBucketPublicAccessTypeEnumValues Enumerates the set of values for BucketPublicAccessTypeEnum

type BucketStorageTierEnum Uses

type BucketStorageTierEnum string

BucketStorageTierEnum Enum with underlying type: string

const (
    BucketStorageTierStandard BucketStorageTierEnum = "Standard"
    BucketStorageTierArchive  BucketStorageTierEnum = "Archive"
)

Set of constants representing the allowable values for BucketStorageTierEnum

func GetBucketStorageTierEnumValues Uses

func GetBucketStorageTierEnumValues() []BucketStorageTierEnum

GetBucketStorageTierEnumValues Enumerates the set of values for BucketStorageTierEnum

type BucketSummary Uses

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.cloud.oracle.com/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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (BucketSummary) String Uses

func (m BucketSummary) String() string

type CancelWorkRequestRequest Uses

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
}

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

func (CancelWorkRequestRequest) HTTPRequest Uses

func (request CancelWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy Uses

func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelWorkRequestRequest) String Uses

func (request CancelWorkRequestRequest) String() string

type CancelWorkRequestResponse Uses

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"`
}

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse Uses

func (response CancelWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String Uses

func (response CancelWorkRequestResponse) String() string

type CommitMultipartUploadDetails Uses

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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (CommitMultipartUploadDetails) String Uses

func (m CommitMultipartUploadDetails) String() string

type CommitMultipartUploadPartDetails Uses

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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (CommitMultipartUploadPartDetails) String Uses

func (m CommitMultipartUploadPartDetails) String() string

type CommitMultipartUploadRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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
}

CommitMultipartUploadRequest wrapper for the CommitMultipartUpload operation

func (CommitMultipartUploadRequest) HTTPRequest Uses

func (request CommitMultipartUploadRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CommitMultipartUploadRequest) RetryPolicy Uses

func (request CommitMultipartUploadRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CommitMultipartUploadRequest) String Uses

func (request CommitMultipartUploadRequest) String() string

type CommitMultipartUploadResponse Uses

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 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 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"`
}

CommitMultipartUploadResponse wrapper for the CommitMultipartUpload operation

func (CommitMultipartUploadResponse) HTTPResponse Uses

func (response CommitMultipartUploadResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CommitMultipartUploadResponse) String Uses

func (response CommitMultipartUploadResponse) String() string

type CopyObjectDetails Uses

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.
    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"`

    // 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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (CopyObjectDetails) String Uses

func (m CopyObjectDetails) String() string

type CopyObjectRequest Uses

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"`

    // 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
}

CopyObjectRequest wrapper for the CopyObject operation

func (CopyObjectRequest) HTTPRequest Uses

func (request CopyObjectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CopyObjectRequest) RetryPolicy Uses

func (request CopyObjectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CopyObjectRequest) String Uses

func (request CopyObjectRequest) String() string

type CopyObjectResponse Uses

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"`
}

CopyObjectResponse wrapper for the CopyObject operation

func (CopyObjectResponse) HTTPResponse Uses

func (response CopyObjectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CopyObjectResponse) String Uses

func (response CopyObjectResponse) String() string

type CreateBucketDetails Uses

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.cloud.oracle.com/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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (CreateBucketDetails) String Uses

func (m CreateBucketDetails) String() string

type CreateBucketDetailsPublicAccessTypeEnum Uses

type CreateBucketDetailsPublicAccessTypeEnum string

CreateBucketDetailsPublicAccessTypeEnum Enum with underlying type: string

const (
    CreateBucketDetailsPublicAccessTypeNopublicaccess        CreateBucketDetailsPublicAccessTypeEnum = "NoPublicAccess"
    CreateBucketDetailsPublicAccessTypeObjectread            CreateBucketDetailsPublicAccessTypeEnum = "ObjectRead"
    CreateBucketDetailsPublicAccessTypeObjectreadwithoutlist CreateBucketDetailsPublicAccessTypeEnum = "ObjectReadWithoutList"
)

Set of constants representing the allowable values for CreateBucketDetailsPublicAccessTypeEnum

func GetCreateBucketDetailsPublicAccessTypeEnumValues Uses

func GetCreateBucketDetailsPublicAccessTypeEnumValues() []CreateBucketDetailsPublicAccessTypeEnum

GetCreateBucketDetailsPublicAccessTypeEnumValues Enumerates the set of values for CreateBucketDetailsPublicAccessTypeEnum

type CreateBucketDetailsStorageTierEnum Uses

type CreateBucketDetailsStorageTierEnum string

CreateBucketDetailsStorageTierEnum Enum with underlying type: string

const (
    CreateBucketDetailsStorageTierStandard CreateBucketDetailsStorageTierEnum = "Standard"
    CreateBucketDetailsStorageTierArchive  CreateBucketDetailsStorageTierEnum = "Archive"
)

Set of constants representing the allowable values for CreateBucketDetailsStorageTierEnum

func GetCreateBucketDetailsStorageTierEnumValues Uses

func GetCreateBucketDetailsStorageTierEnumValues() []CreateBucketDetailsStorageTierEnum

GetCreateBucketDetailsStorageTierEnumValues Enumerates the set of values for CreateBucketDetailsStorageTierEnum

type CreateBucketRequest Uses

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
}

CreateBucketRequest wrapper for the CreateBucket operation

func (CreateBucketRequest) HTTPRequest Uses

func (request CreateBucketRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBucketRequest) RetryPolicy Uses

func (request CreateBucketRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBucketRequest) String Uses

func (request CreateBucketRequest) String() string

type CreateBucketResponse Uses

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"`
}

CreateBucketResponse wrapper for the CreateBucket operation

func (CreateBucketResponse) HTTPResponse Uses

func (response CreateBucketResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBucketResponse) String Uses

func (response CreateBucketResponse) String() string

type CreateMultipartUploadDetails Uses

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"`

    // 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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (CreateMultipartUploadDetails) String Uses

func (m CreateMultipartUploadDetails) String() string

type CreateMultipartUploadRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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
}

CreateMultipartUploadRequest wrapper for the CreateMultipartUpload operation

func (CreateMultipartUploadRequest) HTTPRequest Uses

func (request CreateMultipartUploadRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateMultipartUploadRequest) RetryPolicy Uses

func (request CreateMultipartUploadRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateMultipartUploadRequest) String Uses

func (request CreateMultipartUploadRequest) String() string

type CreateMultipartUploadResponse Uses

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"`
}

CreateMultipartUploadResponse wrapper for the CreateMultipartUpload operation

func (CreateMultipartUploadResponse) HTTPResponse Uses

func (response CreateMultipartUploadResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateMultipartUploadResponse) String Uses

func (response CreateMultipartUploadResponse) String() string

type CreatePreauthenticatedRequestDetails Uses

type CreatePreauthenticatedRequestDetails struct {

    // A user-specified name for the pre-authenticated request. Names can be helpful in managing pre-authenticated requests.
    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"`

    // 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.
    ObjectName *string `mandatory:"false" json:"objectName"`
}

CreatePreauthenticatedRequestDetails The representation of CreatePreauthenticatedRequestDetails

func (CreatePreauthenticatedRequestDetails) String Uses

func (m CreatePreauthenticatedRequestDetails) String() string

type CreatePreauthenticatedRequestDetailsAccessTypeEnum Uses

type CreatePreauthenticatedRequestDetailsAccessTypeEnum string

CreatePreauthenticatedRequestDetailsAccessTypeEnum Enum with underlying type: string

const (
    CreatePreauthenticatedRequestDetailsAccessTypeObjectread      CreatePreauthenticatedRequestDetailsAccessTypeEnum = "ObjectRead"
    CreatePreauthenticatedRequestDetailsAccessTypeObjectwrite     CreatePreauthenticatedRequestDetailsAccessTypeEnum = "ObjectWrite"
    CreatePreauthenticatedRequestDetailsAccessTypeObjectreadwrite CreatePreauthenticatedRequestDetailsAccessTypeEnum = "ObjectReadWrite"
    CreatePreauthenticatedRequestDetailsAccessTypeAnyobjectwrite  CreatePreauthenticatedRequestDetailsAccessTypeEnum = "AnyObjectWrite"
)

Set of constants representing the allowable values for CreatePreauthenticatedRequestDetailsAccessTypeEnum

func GetCreatePreauthenticatedRequestDetailsAccessTypeEnumValues Uses

func GetCreatePreauthenticatedRequestDetailsAccessTypeEnumValues() []CreatePreauthenticatedRequestDetailsAccessTypeEnum

GetCreatePreauthenticatedRequestDetailsAccessTypeEnumValues Enumerates the set of values for CreatePreauthenticatedRequestDetailsAccessTypeEnum

type CreatePreauthenticatedRequestRequest Uses

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
}

CreatePreauthenticatedRequestRequest wrapper for the CreatePreauthenticatedRequest operation

func (CreatePreauthenticatedRequestRequest) HTTPRequest Uses

func (request CreatePreauthenticatedRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreatePreauthenticatedRequestRequest) RetryPolicy Uses

func (request CreatePreauthenticatedRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreatePreauthenticatedRequestRequest) String Uses

func (request CreatePreauthenticatedRequestRequest) String() string

type CreatePreauthenticatedRequestResponse Uses

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"`
}

CreatePreauthenticatedRequestResponse wrapper for the CreatePreauthenticatedRequest operation

func (CreatePreauthenticatedRequestResponse) HTTPResponse Uses

func (response CreatePreauthenticatedRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreatePreauthenticatedRequestResponse) String Uses

func (response CreatePreauthenticatedRequestResponse) String() string

type CreateReplicationPolicyDetails Uses

type CreateReplicationPolicyDetails struct {

    // 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"`
}

CreateReplicationPolicyDetails The details to create a replication policy.

func (CreateReplicationPolicyDetails) String Uses

func (m CreateReplicationPolicyDetails) String() string

type CreateReplicationPolicyRequest Uses

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
}

CreateReplicationPolicyRequest wrapper for the CreateReplicationPolicy operation

func (CreateReplicationPolicyRequest) HTTPRequest Uses

func (request CreateReplicationPolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateReplicationPolicyRequest) RetryPolicy Uses

func (request CreateReplicationPolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateReplicationPolicyRequest) String Uses

func (request CreateReplicationPolicyRequest) String() string

type CreateReplicationPolicyResponse Uses

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"`
}

CreateReplicationPolicyResponse wrapper for the CreateReplicationPolicy operation

func (CreateReplicationPolicyResponse) HTTPResponse Uses

func (response CreateReplicationPolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateReplicationPolicyResponse) String Uses

func (response CreateReplicationPolicyResponse) String() string

type CreateRetentionRuleDetails Uses

type CreateRetentionRuleDetails struct {

    // A user-specified name for the retention rule. Names can be helpful in identifying retention rules.
    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"`
}

CreateRetentionRuleDetails The details to create a retention rule.

func (CreateRetentionRuleDetails) String Uses

func (m CreateRetentionRuleDetails) String() string

type CreateRetentionRuleRequest Uses

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
}

CreateRetentionRuleRequest wrapper for the CreateRetentionRule operation

func (CreateRetentionRuleRequest) HTTPRequest Uses

func (request CreateRetentionRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateRetentionRuleRequest) RetryPolicy Uses

func (request CreateRetentionRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateRetentionRuleRequest) String Uses

func (request CreateRetentionRuleRequest) String() string

type CreateRetentionRuleResponse Uses

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"`
}

CreateRetentionRuleResponse wrapper for the CreateRetentionRule operation

func (CreateRetentionRuleResponse) HTTPResponse Uses

func (response CreateRetentionRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateRetentionRuleResponse) String Uses

func (response CreateRetentionRuleResponse) String() string

type DeleteBucketRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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
}

DeleteBucketRequest wrapper for the DeleteBucket operation

func (DeleteBucketRequest) HTTPRequest Uses

func (request DeleteBucketRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBucketRequest) RetryPolicy Uses

func (request DeleteBucketRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBucketRequest) String Uses

func (request DeleteBucketRequest) String() string

type DeleteBucketResponse Uses

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"`
}

DeleteBucketResponse wrapper for the DeleteBucket operation

func (DeleteBucketResponse) HTTPResponse Uses

func (response DeleteBucketResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBucketResponse) String Uses

func (response DeleteBucketResponse) String() string

type DeleteObjectLifecyclePolicyRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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
}

DeleteObjectLifecyclePolicyRequest wrapper for the DeleteObjectLifecyclePolicy operation

func (DeleteObjectLifecyclePolicyRequest) HTTPRequest Uses

func (request DeleteObjectLifecyclePolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteObjectLifecyclePolicyRequest) RetryPolicy Uses

func (request DeleteObjectLifecyclePolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteObjectLifecyclePolicyRequest) String Uses

func (request DeleteObjectLifecyclePolicyRequest) String() string

type DeleteObjectLifecyclePolicyResponse Uses

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"`
}

DeleteObjectLifecyclePolicyResponse wrapper for the DeleteObjectLifecyclePolicy operation

func (DeleteObjectLifecyclePolicyResponse) HTTPResponse Uses

func (response DeleteObjectLifecyclePolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteObjectLifecyclePolicyResponse) String Uses

func (response DeleteObjectLifecyclePolicyResponse) String() string

type DeleteObjectRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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
}

DeleteObjectRequest wrapper for the DeleteObject operation

func (DeleteObjectRequest) HTTPRequest Uses

func (request DeleteObjectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteObjectRequest) RetryPolicy Uses

func (request DeleteObjectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteObjectRequest) String Uses

func (request DeleteObjectRequest) String() string

type DeleteObjectResponse Uses

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"`
}

DeleteObjectResponse wrapper for the DeleteObject operation

func (DeleteObjectResponse) HTTPResponse Uses

func (response DeleteObjectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteObjectResponse) String Uses

func (response DeleteObjectResponse) String() string

type DeletePreauthenticatedRequestRequest Uses

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
}

DeletePreauthenticatedRequestRequest wrapper for the DeletePreauthenticatedRequest operation

func (DeletePreauthenticatedRequestRequest) HTTPRequest Uses

func (request DeletePreauthenticatedRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeletePreauthenticatedRequestRequest) RetryPolicy Uses

func (request DeletePreauthenticatedRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeletePreauthenticatedRequestRequest) String Uses

func (request DeletePreauthenticatedRequestRequest) String() string

type DeletePreauthenticatedRequestResponse Uses

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"`
}

DeletePreauthenticatedRequestResponse wrapper for the DeletePreauthenticatedRequest operation

func (DeletePreauthenticatedRequestResponse) HTTPResponse Uses

func (response DeletePreauthenticatedRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeletePreauthenticatedRequestResponse) String Uses

func (response DeletePreauthenticatedRequestResponse) String() string

type DeleteReplicationPolicyRequest Uses

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
}

DeleteReplicationPolicyRequest wrapper for the DeleteReplicationPolicy operation

func (DeleteReplicationPolicyRequest) HTTPRequest Uses

func (request DeleteReplicationPolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteReplicationPolicyRequest) RetryPolicy Uses

func (request DeleteReplicationPolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteReplicationPolicyRequest) String Uses

func (request DeleteReplicationPolicyRequest) String() string

type DeleteReplicationPolicyResponse Uses

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"`
}

DeleteReplicationPolicyResponse wrapper for the DeleteReplicationPolicy operation

func (DeleteReplicationPolicyResponse) HTTPResponse Uses

func (response DeleteReplicationPolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteReplicationPolicyResponse) String Uses

func (response DeleteReplicationPolicyResponse) String() string

type DeleteRetentionRuleRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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
}

DeleteRetentionRuleRequest wrapper for the DeleteRetentionRule operation

func (DeleteRetentionRuleRequest) HTTPRequest Uses

func (request DeleteRetentionRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteRetentionRuleRequest) RetryPolicy Uses

func (request DeleteRetentionRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteRetentionRuleRequest) String Uses

func (request DeleteRetentionRuleRequest) String() string

type DeleteRetentionRuleResponse Uses

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"`
}

DeleteRetentionRuleResponse wrapper for the DeleteRetentionRule operation

func (DeleteRetentionRuleResponse) HTTPResponse Uses

func (response DeleteRetentionRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteRetentionRuleResponse) String Uses

func (response DeleteRetentionRuleResponse) String() string

type Duration Uses

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"`
}

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.

func (Duration) String Uses

func (m Duration) String() string

type DurationTimeUnitEnum Uses

type DurationTimeUnitEnum string

DurationTimeUnitEnum Enum with underlying type: string

const (
    DurationTimeUnitYears DurationTimeUnitEnum = "YEARS"
    DurationTimeUnitDays  DurationTimeUnitEnum = "DAYS"
)

Set of constants representing the allowable values for DurationTimeUnitEnum

func GetDurationTimeUnitEnumValues Uses

func GetDurationTimeUnitEnumValues() []DurationTimeUnitEnum

GetDurationTimeUnitEnumValues Enumerates the set of values for DurationTimeUnitEnum

type GetBucketFieldsEnum Uses

type GetBucketFieldsEnum string

GetBucketFieldsEnum Enum with underlying type: string

const (
    GetBucketFieldsApproximatecount GetBucketFieldsEnum = "approximateCount"
    GetBucketFieldsApproximatesize  GetBucketFieldsEnum = "approximateSize"
)

Set of constants representing the allowable values for GetBucketFieldsEnum

func GetGetBucketFieldsEnumValues Uses

func GetGetBucketFieldsEnumValues() []GetBucketFieldsEnum

GetGetBucketFieldsEnumValues Enumerates the set of values for GetBucketFieldsEnum

type GetBucketRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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) and 'approximateSize'
    // (total approximate size in bytes of all objects). For example 'approximateCount,approximateSize'.
    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
}

GetBucketRequest wrapper for the GetBucket operation

func (GetBucketRequest) HTTPRequest Uses

func (request GetBucketRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBucketRequest) RetryPolicy Uses

func (request GetBucketRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBucketRequest) String Uses

func (request GetBucketRequest) String() string

type GetBucketResponse Uses

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
}

GetBucketResponse wrapper for the GetBucket operation

func (GetBucketResponse) HTTPResponse Uses

func (response GetBucketResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBucketResponse) String Uses

func (response GetBucketResponse) String() string

type GetNamespaceMetadataRequest Uses

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
}

GetNamespaceMetadataRequest wrapper for the GetNamespaceMetadata operation

func (GetNamespaceMetadataRequest) HTTPRequest Uses

func (request GetNamespaceMetadataRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetNamespaceMetadataRequest) RetryPolicy Uses

func (request GetNamespaceMetadataRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetNamespaceMetadataRequest) String Uses

func (request GetNamespaceMetadataRequest) String() string

type GetNamespaceMetadataResponse Uses

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"`
}

GetNamespaceMetadataResponse wrapper for the GetNamespaceMetadata operation

func (GetNamespaceMetadataResponse) HTTPResponse Uses

func (response GetNamespaceMetadataResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetNamespaceMetadataResponse) String Uses

func (response GetNamespaceMetadataResponse) String() string

type GetNamespaceRequest Uses

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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) or the compartment
    // OCID (https://docs.cloud.oracle.com/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
}

GetNamespaceRequest wrapper for the GetNamespace operation

func (GetNamespaceRequest) HTTPRequest Uses

func (request GetNamespaceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetNamespaceRequest) RetryPolicy Uses

func (request GetNamespaceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetNamespaceRequest) String Uses

func (request GetNamespaceRequest) String() string

type GetNamespaceResponse Uses

type GetNamespaceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The string instance
    Value *string `presentIn:"body"`
}

GetNamespaceResponse wrapper for the GetNamespace operation

func (GetNamespaceResponse) HTTPResponse Uses

func (response GetNamespaceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetNamespaceResponse) String Uses

func (response GetNamespaceResponse) String() string

type GetObjectArchivalStateEnum Uses

type GetObjectArchivalStateEnum string

GetObjectArchivalStateEnum Enum with underlying type: string

const (
    GetObjectArchivalStateAvailable GetObjectArchivalStateEnum = "AVAILABLE"
    GetObjectArchivalStateArchived  GetObjectArchivalStateEnum = "ARCHIVED"
    GetObjectArchivalStateRestoring GetObjectArchivalStateEnum = "RESTORING"
    GetObjectArchivalStateRestored  GetObjectArchivalStateEnum = "RESTORED"
)

Set of constants representing the allowable values for GetObjectArchivalStateEnum

func GetGetObjectArchivalStateEnumValues Uses

func GetGetObjectArchivalStateEnumValues() []GetObjectArchivalStateEnum

GetGetObjectArchivalStateEnumValues Enumerates the set of values for GetObjectArchivalStateEnum

type GetObjectLifecyclePolicyRequest Uses

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
}

GetObjectLifecyclePolicyRequest wrapper for the GetObjectLifecyclePolicy operation

func (GetObjectLifecyclePolicyRequest) HTTPRequest Uses

func (request GetObjectLifecyclePolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetObjectLifecyclePolicyRequest) RetryPolicy Uses

func (request GetObjectLifecyclePolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetObjectLifecyclePolicyRequest) String Uses

func (request GetObjectLifecyclePolicyRequest) String() string

type GetObjectLifecyclePolicyResponse Uses

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"`
}

GetObjectLifecyclePolicyResponse wrapper for the GetObjectLifecyclePolicy operation

func (GetObjectLifecyclePolicyResponse) HTTPResponse Uses

func (response GetObjectLifecyclePolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetObjectLifecyclePolicyResponse) String Uses

func (response GetObjectLifecyclePolicyResponse) String() string

type GetObjectRequest Uses

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"`

    // The entity tag (ETag) to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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"`

    // 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
}

GetObjectRequest wrapper for the GetObject operation

func (GetObjectRequest) HTTPRequest Uses

func (request GetObjectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetObjectRequest) RetryPolicy Uses

func (request GetObjectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetObjectRequest) String Uses

func (request GetObjectRequest) String() string

type GetObjectResponse Uses

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"`

    // 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 current state of the object.
    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"`

    // 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
}

GetObjectResponse wrapper for the GetObject operation

func (GetObjectResponse) HTTPResponse Uses

func (response GetObjectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetObjectResponse) String Uses

func (response GetObjectResponse) String() string

type GetPreauthenticatedRequestRequest Uses

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
}

GetPreauthenticatedRequestRequest wrapper for the GetPreauthenticatedRequest operation

func (GetPreauthenticatedRequestRequest) HTTPRequest Uses

func (request GetPreauthenticatedRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPreauthenticatedRequestRequest) RetryPolicy Uses

func (request GetPreauthenticatedRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPreauthenticatedRequestRequest) String Uses

func (request GetPreauthenticatedRequestRequest) String() string

type GetPreauthenticatedRequestResponse Uses

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"`
}

GetPreauthenticatedRequestResponse wrapper for the GetPreauthenticatedRequest operation

func (GetPreauthenticatedRequestResponse) HTTPResponse Uses

func (response GetPreauthenticatedRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPreauthenticatedRequestResponse) String Uses

func (response GetPreauthenticatedRequestResponse) String() string

type GetReplicationPolicyRequest Uses

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
}

GetReplicationPolicyRequest wrapper for the GetReplicationPolicy operation

func (GetReplicationPolicyRequest) HTTPRequest Uses

func (request GetReplicationPolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetReplicationPolicyRequest) RetryPolicy Uses

func (request GetReplicationPolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetReplicationPolicyRequest) String Uses

func (request GetReplicationPolicyRequest) String() string

type GetReplicationPolicyResponse Uses

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"`
}

GetReplicationPolicyResponse wrapper for the GetReplicationPolicy operation

func (GetReplicationPolicyResponse) HTTPResponse Uses

func (response GetReplicationPolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetReplicationPolicyResponse) String Uses

func (response GetReplicationPolicyResponse) String() string

type GetRetentionRuleRequest Uses

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
}

GetRetentionRuleRequest wrapper for the GetRetentionRule operation

func (GetRetentionRuleRequest) HTTPRequest Uses

func (request GetRetentionRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRetentionRuleRequest) RetryPolicy Uses

func (request GetRetentionRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRetentionRuleRequest) String Uses

func (request GetRetentionRuleRequest) String() string

type GetRetentionRuleResponse Uses

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"`
}

GetRetentionRuleResponse wrapper for the GetRetentionRule operation

func (GetRetentionRuleResponse) HTTPResponse Uses

func (response GetRetentionRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRetentionRuleResponse) String Uses

func (response GetRetentionRuleResponse) String() string

type GetWorkRequestRequest Uses

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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest Uses

func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy Uses

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String Uses

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse Uses

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"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse Uses

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String Uses

func (response GetWorkRequestResponse) String() string

type HeadBucketRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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
}

HeadBucketRequest wrapper for the HeadBucket operation

func (HeadBucketRequest) HTTPRequest Uses

func (request HeadBucketRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (HeadBucketRequest) RetryPolicy Uses

func (request HeadBucketRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (HeadBucketRequest) String Uses

func (request HeadBucketRequest) String() string

type HeadBucketResponse Uses

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
}

HeadBucketResponse wrapper for the HeadBucket operation

func (HeadBucketResponse) HTTPResponse Uses

func (response HeadBucketResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (HeadBucketResponse) String Uses

func (response HeadBucketResponse) String() string

type HeadObjectArchivalStateEnum Uses

type HeadObjectArchivalStateEnum string

HeadObjectArchivalStateEnum Enum with underlying type: string

const (
    HeadObjectArchivalStateAvailable HeadObjectArchivalStateEnum = "AVAILABLE"
    HeadObjectArchivalStateArchived  HeadObjectArchivalStateEnum = "ARCHIVED"
    HeadObjectArchivalStateRestoring HeadObjectArchivalStateEnum = "RESTORING"
    HeadObjectArchivalStateRestored  HeadObjectArchivalStateEnum = "RESTORED"
)

Set of constants representing the allowable values for HeadObjectArchivalStateEnum

func GetHeadObjectArchivalStateEnumValues Uses

func GetHeadObjectArchivalStateEnumValues() []HeadObjectArchivalStateEnum

GetHeadObjectArchivalStateEnumValues Enumerates the set of values for HeadObjectArchivalStateEnum

type HeadObjectRequest Uses

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"`

    // The entity tag (ETag) to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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
}

HeadObjectRequest wrapper for the HeadObject operation

func (HeadObjectRequest) HTTPRequest Uses

func (request HeadObjectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (HeadObjectRequest) RetryPolicy Uses

func (request HeadObjectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (HeadObjectRequest) String Uses

func (request HeadObjectRequest) String() string

type HeadObjectResponse Uses

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"`

    // 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 current state of the object.
    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"`

    // 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
}

HeadObjectResponse wrapper for the HeadObject operation

func (HeadObjectResponse) HTTPResponse Uses

func (response HeadObjectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (HeadObjectResponse) String Uses

func (response HeadObjectResponse) String() string

type ListBucketsFieldsEnum Uses

type ListBucketsFieldsEnum string

ListBucketsFieldsEnum Enum with underlying type: string

const (
    ListBucketsFieldsTags ListBucketsFieldsEnum = "tags"
)

Set of constants representing the allowable values for ListBucketsFieldsEnum

func GetListBucketsFieldsEnumValues Uses

func GetListBucketsFieldsEnumValues() []ListBucketsFieldsEnum

GetListBucketsFieldsEnumValues Enumerates the set of values for ListBucketsFieldsEnum

type ListBucketsRequest Uses

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"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page at which to start retrieving results.
    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
}

ListBucketsRequest wrapper for the ListBuckets operation

func (ListBucketsRequest) HTTPRequest Uses

func (request ListBucketsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBucketsRequest) RetryPolicy Uses

func (request ListBucketsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBucketsRequest) String Uses

func (request ListBucketsRequest) String() string

type ListBucketsResponse Uses

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"`

    // 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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBucketsResponse wrapper for the ListBuckets operation

func (ListBucketsResponse) HTTPResponse Uses

func (response ListBucketsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBucketsResponse) String Uses

func (response ListBucketsResponse) String() string

type ListMultipartUploadPartsRequest Uses

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"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page at which to start retrieving results.
    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
}

ListMultipartUploadPartsRequest wrapper for the ListMultipartUploadParts operation

func (ListMultipartUploadPartsRequest) HTTPRequest Uses

func (request ListMultipartUploadPartsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListMultipartUploadPartsRequest) RetryPolicy Uses

func (request ListMultipartUploadPartsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListMultipartUploadPartsRequest) String Uses

func (request ListMultipartUploadPartsRequest) String() string

type ListMultipartUploadPartsResponse Uses

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"`

    // 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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListMultipartUploadPartsResponse wrapper for the ListMultipartUploadParts operation

func (ListMultipartUploadPartsResponse) HTTPResponse Uses

func (response ListMultipartUploadPartsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListMultipartUploadPartsResponse) String Uses

func (response ListMultipartUploadPartsResponse) String() string

type ListMultipartUploadsRequest Uses

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"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page at which to start retrieving results.
    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
}

ListMultipartUploadsRequest wrapper for the ListMultipartUploads operation

func (ListMultipartUploadsRequest) HTTPRequest Uses

func (request ListMultipartUploadsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListMultipartUploadsRequest) RetryPolicy Uses

func (request ListMultipartUploadsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListMultipartUploadsRequest) String Uses

func (request ListMultipartUploadsRequest) String() string

type ListMultipartUploadsResponse Uses

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"`

    // 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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListMultipartUploadsResponse wrapper for the ListMultipartUploads operation

func (ListMultipartUploadsResponse) HTTPResponse Uses

func (response ListMultipartUploadsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListMultipartUploadsResponse) String Uses

func (response ListMultipartUploadsResponse) String() string

type ListObjects Uses

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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (ListObjects) String Uses

func (m ListObjects) String() string

type ListObjectsRequest Uses

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"`

    // Object names returned by a list query must be greater or equal to this parameter.
    Start *string `mandatory:"false" contributesTo:"query" name:"start"`

    // Object names returned by a list query must be strictly less than this parameter.
    End *string `mandatory:"false" contributesTo:"query" name:"end"`

    // The maximum number of items to return.
    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 in list of objects includes the 'name' field. This parameter can also include 'size'
    // (object size in bytes), 'etag', 'md5', and 'timeCreated' (object creation date and time) fields.
    // Value of this parameter should be a comma-separated, case-insensitive list of those field names.
    // For example 'name,etag,timeCreated,md5'.
    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"`

    // 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
}

ListObjectsRequest wrapper for the ListObjects operation

func (ListObjectsRequest) HTTPRequest Uses

func (request ListObjectsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListObjectsRequest) RetryPolicy Uses

func (request ListObjectsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListObjectsRequest) String Uses

func (request ListObjectsRequest) String() string

type ListObjectsResponse Uses

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"`
}

ListObjectsResponse wrapper for the ListObjects operation

func (ListObjectsResponse) HTTPResponse Uses

func (response ListObjectsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListObjectsResponse) String Uses

func (response ListObjectsResponse) String() string

type ListPreauthenticatedRequestsRequest Uses

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"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page at which to start retrieving results.
    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
}

ListPreauthenticatedRequestsRequest wrapper for the ListPreauthenticatedRequests operation

func (ListPreauthenticatedRequestsRequest) HTTPRequest Uses

func (request ListPreauthenticatedRequestsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListPreauthenticatedRequestsRequest) RetryPolicy Uses

func (request ListPreauthenticatedRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListPreauthenticatedRequestsRequest) String Uses

func (request ListPreauthenticatedRequestsRequest) String() string

type ListPreauthenticatedRequestsResponse Uses

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"`

    // 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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListPreauthenticatedRequestsResponse wrapper for the ListPreauthenticatedRequests operation

func (ListPreauthenticatedRequestsResponse) HTTPResponse Uses

func (response ListPreauthenticatedRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListPreauthenticatedRequestsResponse) String Uses

func (response ListPreauthenticatedRequestsResponse) String() string

type ListReplicationPoliciesRequest Uses

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"`

    // The page at which to start retrieving results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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
}

ListReplicationPoliciesRequest wrapper for the ListReplicationPolicies operation

func (ListReplicationPoliciesRequest) HTTPRequest Uses

func (request ListReplicationPoliciesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListReplicationPoliciesRequest) RetryPolicy Uses

func (request ListReplicationPoliciesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListReplicationPoliciesRequest) String Uses

func (request ListReplicationPoliciesRequest) String() string

type ListReplicationPoliciesResponse Uses

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"`

    // 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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListReplicationPoliciesResponse wrapper for the ListReplicationPolicies operation

func (ListReplicationPoliciesResponse) HTTPResponse Uses

func (response ListReplicationPoliciesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListReplicationPoliciesResponse) String Uses

func (response ListReplicationPoliciesResponse) String() string

type ListReplicationSourcesRequest Uses

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"`

    // The page at which to start retrieving results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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
}

ListReplicationSourcesRequest wrapper for the ListReplicationSources operation

func (ListReplicationSourcesRequest) HTTPRequest Uses

func (request ListReplicationSourcesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListReplicationSourcesRequest) RetryPolicy Uses

func (request ListReplicationSourcesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListReplicationSourcesRequest) String Uses

func (request ListReplicationSourcesRequest) String() string

type ListReplicationSourcesResponse Uses

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"`

    // 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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListReplicationSourcesResponse wrapper for the ListReplicationSources operation

func (ListReplicationSourcesResponse) HTTPResponse Uses

func (response ListReplicationSourcesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListReplicationSourcesResponse) String Uses

func (response ListReplicationSourcesResponse) String() string

type ListRetentionRulesRequest Uses

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"`

    // The page at which to start retrieving results.
    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
}

ListRetentionRulesRequest wrapper for the ListRetentionRules operation

func (ListRetentionRulesRequest) HTTPRequest Uses

func (request ListRetentionRulesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRetentionRulesRequest) RetryPolicy Uses

func (request ListRetentionRulesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRetentionRulesRequest) String Uses

func (request ListRetentionRulesRequest) String() string

type ListRetentionRulesResponse Uses

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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListRetentionRulesResponse wrapper for the ListRetentionRules operation

func (ListRetentionRulesResponse) HTTPResponse Uses

func (response ListRetentionRulesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRetentionRulesResponse) String Uses

func (response ListRetentionRulesResponse) String() string

type ListWorkRequestErrorsRequest Uses

type ListWorkRequestErrorsRequest struct {

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

    // The page at which to start retrieving results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsRequest) HTTPRequest Uses

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy Uses

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String Uses

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse Uses

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"`

    // 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.
    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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse Uses

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String Uses

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestLogsRequest Uses

type ListWorkRequestLogsRequest struct {

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

    // The page at which to start retrieving results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsRequest) HTTPRequest Uses

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy Uses

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String Uses

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse Uses

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"`

    // 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.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse Uses

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String Uses

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestsRequest Uses

type ListWorkRequestsRequest struct {

    // The ID of the compartment in which to list buckets.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

    // The page at which to start retrieving results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

func (ListWorkRequestsRequest) HTTPRequest Uses

func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy Uses

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String Uses

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse Uses

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"`

    // 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.
    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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse Uses

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String Uses

func (response ListWorkRequestsResponse) String() string

type MakeBucketWritableRequest Uses

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
}

MakeBucketWritableRequest wrapper for the MakeBucketWritable operation

func (MakeBucketWritableRequest) HTTPRequest Uses

func (request MakeBucketWritableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (MakeBucketWritableRequest) RetryPolicy Uses

func (request MakeBucketWritableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (MakeBucketWritableRequest) String Uses

func (request MakeBucketWritableRequest) String() string

type MakeBucketWritableResponse Uses

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"`
}

MakeBucketWritableResponse wrapper for the MakeBucketWritable operation

func (MakeBucketWritableResponse) HTTPResponse Uses

func (response MakeBucketWritableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (MakeBucketWritableResponse) String Uses

func (response MakeBucketWritableResponse) String() string

type MultipartUpload Uses

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"`
}

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.cloud.oracle.com/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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (MultipartUpload) String Uses

func (m MultipartUpload) String() string

type MultipartUploadPartSummary Uses

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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (MultipartUploadPartSummary) String Uses

func (m MultipartUploadPartSummary) String() string

type NamespaceMetadata Uses

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"`
}

NamespaceMetadata NamespaceMetadata maps a namespace string to defaultS3CompartmentId and defaultSwiftCompartmentId values.

func (NamespaceMetadata) String Uses

func (m NamespaceMetadata) String() string

type ObjectLifecyclePolicy Uses

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.cloud.oracle.com/iaas/api/#/en/objectstorage/20160918/ObjectLifecyclePolicy/PutObjectLifecyclePolicy).
    Items []ObjectLifecycleRule `mandatory:"false" json:"items"`
}

ObjectLifecyclePolicy The collection of lifecycle policy rules that together form the object lifecycle policy of a given bucket.

func (ObjectLifecyclePolicy) String Uses

func (m ObjectLifecyclePolicy) String() string

type ObjectLifecycleRule Uses

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 into the
    // Archive Storage tier (https://docs.cloud.oracle.com/Content/Archive/Concepts/archivestorageoverview.htm). Rules using the action
    // 'DELETE' permanently delete objects from buckets. 'ARCHIVE' and 'DELETE' are the only two supported
    // actions at this time.
    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"`

    ObjectNameFilter *ObjectNameFilter `mandatory:"false" json:"objectNameFilter"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (ObjectLifecycleRule) String Uses

func (m ObjectLifecycleRule) String() string

type ObjectLifecycleRuleTimeUnitEnum Uses

type ObjectLifecycleRuleTimeUnitEnum string

ObjectLifecycleRuleTimeUnitEnum Enum with underlying type: string

const (
    ObjectLifecycleRuleTimeUnitDays  ObjectLifecycleRuleTimeUnitEnum = "DAYS"
    ObjectLifecycleRuleTimeUnitYears ObjectLifecycleRuleTimeUnitEnum = "YEARS"
)

Set of constants representing the allowable values for ObjectLifecycleRuleTimeUnitEnum

func GetObjectLifecycleRuleTimeUnitEnumValues Uses

func GetObjectLifecycleRuleTimeUnitEnumValues() []ObjectLifecycleRuleTimeUnitEnum

GetObjectLifecycleRuleTimeUnitEnumValues Enumerates the set of values for ObjectLifecycleRuleTimeUnitEnum

type ObjectNameFilter Uses

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"`
}

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.

func (ObjectNameFilter) String Uses

func (m ObjectNameFilter) String() string

type ObjectStorageClient Uses

type ObjectStorageClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

ObjectStorageClient a client for ObjectStorage

func NewObjectStorageClientWithConfigurationProvider Uses

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 Uses

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 (ObjectStorageClient) AbortMultipartUpload Uses

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.

func (ObjectStorageClient) CancelWorkRequest Uses

func (client ObjectStorageClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancels a work request.

func (ObjectStorageClient) CommitMultipartUpload Uses

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.

func (*ObjectStorageClient) ConfigurationProvider Uses

func (client *ObjectStorageClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ObjectStorageClient) CopyObject Uses

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.

func (ObjectStorageClient) CreateBucket Uses

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.

func (ObjectStorageClient) CreateMultipartUpload Uses

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.

func (ObjectStorageClient) CreatePreauthenticatedRequest Uses

func (client ObjectStorageClient) CreatePreauthenticatedRequest(ctx context.Context, request CreatePreauthenticatedRequestRequest) (response CreatePreauthenticatedRequestResponse, err error)

CreatePreauthenticatedRequest Creates a pre-authenticated request specific to the bucket.

func (ObjectStorageClient) CreateReplicationPolicy Uses

func (client ObjectStorageClient) CreateReplicationPolicy(ctx context.Context, request CreateReplicationPolicyRequest) (response CreateReplicationPolicyResponse, err error)

CreateReplicationPolicy Creates a replication policy for the specified bucket.

func (ObjectStorageClient) CreateRetentionRule Uses

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.

func (ObjectStorageClient) DeleteBucket Uses

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.

func (ObjectStorageClient) DeleteObject Uses

func (client ObjectStorageClient) DeleteObject(ctx context.Context, request DeleteObjectRequest) (response DeleteObjectResponse, err error)

DeleteObject Deletes an object.

func (ObjectStorageClient) DeleteObjectLifecyclePolicy Uses

func (client ObjectStorageClient) DeleteObjectLifecyclePolicy(ctx context.Context, request DeleteObjectLifecyclePolicyRequest) (response DeleteObjectLifecyclePolicyResponse, err error)

DeleteObjectLifecyclePolicy Deletes the object lifecycle policy for the bucket.

func (ObjectStorageClient) DeletePreauthenticatedRequest Uses

func (client ObjectStorageClient) DeletePreauthenticatedRequest(ctx context.Context, request DeletePreauthenticatedRequestRequest) (response DeletePreauthenticatedRequestResponse, err error)

DeletePreauthenticatedRequest Deletes the pre-authenticated request for the bucket.

func (ObjectStorageClient) DeleteReplicationPolicy Uses

func (client ObjectStorageClient) DeleteReplicationPolicy(ctx context.Context, request DeleteReplicationPolicyRequest) (response DeleteReplicationPolicyResponse, err error)

DeleteReplicationPolicy Deletes the replication policy associated with the source bucket.

func (ObjectStorageClient) DeleteRetentionRule Uses

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.

func (ObjectStorageClient) GetBucket Uses

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.

func (ObjectStorageClient) GetNamespace Uses

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.

func (ObjectStorageClient) GetNamespaceMetadata Uses

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (ObjectStorageClient) GetObject Uses

func (client ObjectStorageClient) GetObject(ctx context.Context, request GetObjectRequest) (response GetObjectResponse, err error)

GetObject Gets the metadata and body of an object.

func (ObjectStorageClient) GetObjectLifecyclePolicy Uses

func (client ObjectStorageClient) GetObjectLifecyclePolicy(ctx context.Context, request GetObjectLifecyclePolicyRequest) (response GetObjectLifecyclePolicyResponse, err error)

GetObjectLifecyclePolicy Gets the object lifecycle policy for the bucket.

func (ObjectStorageClient) GetPreauthenticatedRequest Uses

func (client ObjectStorageClient) GetPreauthenticatedRequest(ctx context.Context, request GetPreauthenticatedRequestRequest) (response GetPreauthenticatedRequestResponse, err error)

GetPreauthenticatedRequest Gets the pre-authenticated request for the bucket.

func (ObjectStorageClient) GetReplicationPolicy Uses

func (client ObjectStorageClient) GetReplicationPolicy(ctx context.Context, request GetReplicationPolicyRequest) (response GetReplicationPolicyResponse, err error)

GetReplicationPolicy Get the replication policy.

func (ObjectStorageClient) GetRetentionRule Uses

func (client ObjectStorageClient) GetRetentionRule(ctx context.Context, request GetRetentionRuleRequest) (response GetRetentionRuleResponse, err error)

GetRetentionRule Get the specified retention rule.

func (ObjectStorageClient) GetWorkRequest Uses

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.

func (ObjectStorageClient) HeadBucket Uses

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.

func (ObjectStorageClient) HeadObject Uses

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.

func (ObjectStorageClient) ListBuckets Uses

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. 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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (ObjectStorageClient) ListMultipartUploadParts Uses

func (client ObjectStorageClient) ListMultipartUploadParts(ctx context.Context, request ListMultipartUploadPartsRequest) (response ListMultipartUploadPartsResponse, err error)

ListMultipartUploadParts Lists the parts of an in-progress multipart upload.

func (ObjectStorageClient) ListMultipartUploads Uses

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.

func (ObjectStorageClient) ListObjects Uses

func (client ObjectStorageClient) ListObjects(ctx context.Context, request ListObjectsRequest) (response ListObjectsResponse, err error)

ListObjects Lists the objects in a bucket. 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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (ObjectStorageClient) ListPreauthenticatedRequests Uses

func (client ObjectStorageClient) ListPreauthenticatedRequests(ctx context.Context, request ListPreauthenticatedRequestsRequest) (response ListPreauthenticatedRequestsResponse, err error)

ListPreauthenticatedRequests Lists pre-authenticated requests for the bucket.

func (ObjectStorageClient) ListReplicationPolicies Uses

func (client ObjectStorageClient) ListReplicationPolicies(ctx context.Context, request ListReplicationPoliciesRequest) (response ListReplicationPoliciesResponse, err error)

ListReplicationPolicies List the replication policies associated with a bucket.

func (ObjectStorageClient) ListReplicationSources Uses

func (client ObjectStorageClient) ListReplicationSources(ctx context.Context, request ListReplicationSourcesRequest) (response ListReplicationSourcesResponse, err error)

ListReplicationSources List the replication sources of a destination bucket.

func (ObjectStorageClient) ListRetentionRules Uses

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.

func (ObjectStorageClient) ListWorkRequestErrors Uses

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.

func (ObjectStorageClient) ListWorkRequestLogs Uses

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.

func (ObjectStorageClient) ListWorkRequests Uses

func (client ObjectStorageClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in a compartment.

func (ObjectStorageClient) MakeBucketWritable Uses

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.

func (ObjectStorageClient) PutObject Uses

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 Special Instructions for Object Storage PUT (https://docs.cloud.oracle.com/Content/API/Concepts/signingrequests.htm#ObjectStoragePut) for request signature requirements.

func (ObjectStorageClient) PutObjectLifecyclePolicy Uses

func (client ObjectStorageClient) PutObjectLifecyclePolicy(ctx context.Context, request PutObjectLifecyclePolicyRequest) (response PutObjectLifecyclePolicyResponse, err error)

PutObjectLifecyclePolicy Creates or replaces the object lifecycle policy for the bucket.

func (ObjectStorageClient) ReencryptBucket Uses

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.

func (ObjectStorageClient) RenameObject Uses

func (client ObjectStorageClient) RenameObject(ctx context.Context, request RenameObjectRequest) (response RenameObjectResponse, err error)

RenameObject Rename an object in the given Object Storage namespace.

func (ObjectStorageClient) RestoreObjects Uses

func (client ObjectStorageClient) RestoreObjects(ctx context.Context, request RestoreObjectsRequest) (response RestoreObjectsResponse, err error)

RestoreObjects Restores one or more objects specified by the objectName parameter. By default objects will be restored for 24 hours. Duration can be configured using the hours parameter.

func (*ObjectStorageClient) SetRegion Uses

func (client *ObjectStorageClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ObjectStorageClient) UpdateBucket Uses

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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

func (ObjectStorageClient) UpdateNamespaceMetadata Uses

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.

func (ObjectStorageClient) UpdateRetentionRule Uses

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.

func (ObjectStorageClient) UploadPart Uses

func (client ObjectStorageClient) UploadPart(ctx context.Context, request UploadPartRequest) (response UploadPartResponse, err error)

UploadPart Uploads a single part of a multipart upload.

type ObjectSummary Uses

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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (ObjectSummary) String Uses

func (m ObjectSummary) String() string

type PatternDetails Uses

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"`
}

PatternDetails Specifying inclusion and exclusion patterns.

func (PatternDetails) String Uses

func (m PatternDetails) String() string

type PreauthenticatedRequest Uses

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"`
}

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.cloud.oracle.com/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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (PreauthenticatedRequest) String Uses

func (m PreauthenticatedRequest) String() string

type PreauthenticatedRequestAccessTypeEnum Uses

type PreauthenticatedRequestAccessTypeEnum string

PreauthenticatedRequestAccessTypeEnum Enum with underlying type: string

const (
    PreauthenticatedRequestAccessTypeObjectread      PreauthenticatedRequestAccessTypeEnum = "ObjectRead"
    PreauthenticatedRequestAccessTypeObjectwrite     PreauthenticatedRequestAccessTypeEnum = "ObjectWrite"
    PreauthenticatedRequestAccessTypeObjectreadwrite PreauthenticatedRequestAccessTypeEnum = "ObjectReadWrite"
    PreauthenticatedRequestAccessTypeAnyobjectwrite  PreauthenticatedRequestAccessTypeEnum = "AnyObjectWrite"
)

Set of constants representing the allowable values for PreauthenticatedRequestAccessTypeEnum

func GetPreauthenticatedRequestAccessTypeEnumValues Uses

func GetPreauthenticatedRequestAccessTypeEnumValues() []PreauthenticatedRequestAccessTypeEnum

GetPreauthenticatedRequestAccessTypeEnumValues Enumerates the set of values for PreauthenticatedRequestAccessTypeEnum

type PreauthenticatedRequestSummary Uses

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"`
}

PreauthenticatedRequestSummary Get summary information about pre-authenticated requests.

func (PreauthenticatedRequestSummary) String Uses

func (m PreauthenticatedRequestSummary) String() string

type PreauthenticatedRequestSummaryAccessTypeEnum Uses

type PreauthenticatedRequestSummaryAccessTypeEnum string

PreauthenticatedRequestSummaryAccessTypeEnum Enum with underlying type: string

const (
    PreauthenticatedRequestSummaryAccessTypeObjectread      PreauthenticatedRequestSummaryAccessTypeEnum = "ObjectRead"
    PreauthenticatedRequestSummaryAccessTypeObjectwrite     PreauthenticatedRequestSummaryAccessTypeEnum = "ObjectWrite"
    PreauthenticatedRequestSummaryAccessTypeObjectreadwrite PreauthenticatedRequestSummaryAccessTypeEnum = "ObjectReadWrite"
    PreauthenticatedRequestSummaryAccessTypeAnyobjectwrite  PreauthenticatedRequestSummaryAccessTypeEnum = "AnyObjectWrite"
)

Set of constants representing the allowable values for PreauthenticatedRequestSummaryAccessTypeEnum

func GetPreauthenticatedRequestSummaryAccessTypeEnumValues Uses

func GetPreauthenticatedRequestSummaryAccessTypeEnumValues() []PreauthenticatedRequestSummaryAccessTypeEnum

GetPreauthenticatedRequestSummaryAccessTypeEnumValues Enumerates the set of values for PreauthenticatedRequestSummaryAccessTypeEnum

type PutObjectLifecyclePolicyDetails Uses

type PutObjectLifecyclePolicyDetails struct {

    // The bucket's set of lifecycle policy rules.
    Items []ObjectLifecycleRule `mandatory:"false" json:"items"`
}

PutObjectLifecyclePolicyDetails Creates a new object lifecycle policy for a bucket.

func (PutObjectLifecyclePolicyDetails) String Uses

func (m PutObjectLifecyclePolicyDetails) String() string

type PutObjectLifecyclePolicyRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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
}

PutObjectLifecyclePolicyRequest wrapper for the PutObjectLifecyclePolicy operation

func (PutObjectLifecyclePolicyRequest) HTTPRequest Uses

func (request PutObjectLifecyclePolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PutObjectLifecyclePolicyRequest) RetryPolicy Uses

func (request PutObjectLifecyclePolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PutObjectLifecyclePolicyRequest) String Uses

func (request PutObjectLifecyclePolicyRequest) String() string

type PutObjectLifecyclePolicyResponse Uses

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"`
}

PutObjectLifecyclePolicyResponse wrapper for the PutObjectLifecyclePolicy operation

func (PutObjectLifecyclePolicyResponse) HTTPResponse Uses

func (response PutObjectLifecyclePolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PutObjectLifecyclePolicyResponse) String Uses

func (response PutObjectLifecyclePolicyResponse) String() string

type PutObjectRequest Uses

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:"true" 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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    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"`

    // 100-continue
    Expect *string `mandatory:"false" contributesTo:"header" name:"Expect"`

    // The optional base-64 header that defines the 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 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"`

    // 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
}

PutObjectRequest wrapper for the PutObject operation

func (PutObjectRequest) HTTPRequest Uses

func (request PutObjectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PutObjectRequest) RetryPolicy Uses

func (request PutObjectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PutObjectRequest) String Uses

func (request PutObjectRequest) String() string

type PutObjectResponse Uses

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 base-64 encoded MD5 hash of the request body as computed by the server.
    OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"`

    // 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"`
}

PutObjectResponse wrapper for the PutObject operation

func (PutObjectResponse) HTTPResponse Uses

func (response PutObjectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PutObjectResponse) String Uses

func (response PutObjectResponse) String() string

type ReencryptBucketRequest Uses

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
}

ReencryptBucketRequest wrapper for the ReencryptBucket operation

func (ReencryptBucketRequest) HTTPRequest Uses

func (request ReencryptBucketRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ReencryptBucketRequest) RetryPolicy Uses

func (request ReencryptBucketRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ReencryptBucketRequest) String Uses

func (request ReencryptBucketRequest) String() string

type ReencryptBucketResponse Uses

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"`
}

ReencryptBucketResponse wrapper for the ReencryptBucket operation

func (ReencryptBucketResponse) HTTPResponse Uses

func (response ReencryptBucketResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ReencryptBucketResponse) String Uses

func (response ReencryptBucketResponse) String() string

type RenameObjectDetails Uses

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.
    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.
    NewObjIfNoneMatchETag *string `mandatory:"false" json:"newObjIfNoneMatchETag"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (RenameObjectDetails) String Uses

func (m RenameObjectDetails) String() string

type RenameObjectRequest Uses

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.
    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
}

RenameObjectRequest wrapper for the RenameObject operation

func (RenameObjectRequest) HTTPRequest Uses

func (request RenameObjectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RenameObjectRequest) RetryPolicy Uses

func (request RenameObjectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RenameObjectRequest) String Uses

func (request RenameObjectRequest) String() string

type RenameObjectResponse Uses

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"`
}

RenameObjectResponse wrapper for the RenameObject operation

func (RenameObjectResponse) HTTPResponse Uses

func (response RenameObjectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RenameObjectResponse) String Uses

func (response RenameObjectResponse) String() string

type ReplicationPolicy Uses

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"`
}

ReplicationPolicy The details of a replication policy.

func (ReplicationPolicy) String Uses

func (m ReplicationPolicy) String() string

type ReplicationPolicyStatusEnum Uses

type ReplicationPolicyStatusEnum string

ReplicationPolicyStatusEnum Enum with underlying type: string

const (
    ReplicationPolicyStatusActive      ReplicationPolicyStatusEnum = "ACTIVE"
    ReplicationPolicyStatusClientError ReplicationPolicyStatusEnum = "CLIENT_ERROR"
)

Set of constants representing the allowable values for ReplicationPolicyStatusEnum

func GetReplicationPolicyStatusEnumValues Uses

func GetReplicationPolicyStatusEnumValues() []ReplicationPolicyStatusEnum

GetReplicationPolicyStatusEnumValues Enumerates the set of values for ReplicationPolicyStatusEnum

type ReplicationPolicySummary Uses

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"`
}

ReplicationPolicySummary The summary of a replication policy.

func (ReplicationPolicySummary) String Uses

func (m ReplicationPolicySummary) String() string

type ReplicationPolicySummaryStatusEnum Uses

type ReplicationPolicySummaryStatusEnum string

ReplicationPolicySummaryStatusEnum Enum with underlying type: string

const (
    ReplicationPolicySummaryStatusActive      ReplicationPolicySummaryStatusEnum = "ACTIVE"
    ReplicationPolicySummaryStatusClientError ReplicationPolicySummaryStatusEnum = "CLIENT_ERROR"
)

Set of constants representing the allowable values for ReplicationPolicySummaryStatusEnum

func GetReplicationPolicySummaryStatusEnumValues Uses

func GetReplicationPolicySummaryStatusEnumValues() []ReplicationPolicySummaryStatusEnum

GetReplicationPolicySummaryStatusEnumValues Enumerates the set of values for ReplicationPolicySummaryStatusEnum

type ReplicationSource Uses

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"`
}

ReplicationSource The details of a replication source bucket that replicates to a target destination bucket.

func (ReplicationSource) String Uses

func (m ReplicationSource) String() string

type RestoreObjectsDetails Uses

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"`
}

RestoreObjectsDetails The representation of RestoreObjectsDetails

func (RestoreObjectsDetails) String Uses

func (m RestoreObjectsDetails) String() string

type RestoreObjectsRequest Uses

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 objects.
    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
}

RestoreObjectsRequest wrapper for the RestoreObjects operation

func (RestoreObjectsRequest) HTTPRequest Uses

func (request RestoreObjectsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreObjectsRequest) RetryPolicy Uses

func (request RestoreObjectsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestoreObjectsRequest) String Uses

func (request RestoreObjectsRequest) String() string

type RestoreObjectsResponse Uses

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"`
}

RestoreObjectsResponse wrapper for the RestoreObjects operation

func (RestoreObjectsResponse) HTTPResponse Uses

func (response RestoreObjectsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestoreObjectsResponse) String Uses

func (response RestoreObjectsResponse) String() string

type RetentionRule Uses

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"`
}

RetentionRule The details of a retention rule.

func (RetentionRule) String Uses

func (m RetentionRule) String() string

type RetentionRuleCollection Uses

type RetentionRuleCollection struct {

    // An array of retention rule summaries.
    Items []RetentionRuleSummary `mandatory:"true" json:"items"`
}

RetentionRuleCollection Retention rule collection.

func (RetentionRuleCollection) String Uses

func (m RetentionRuleCollection) String() string

type RetentionRuleDetails Uses

type RetentionRuleDetails struct {

    // A user-specified name for the retention rule. Names can be helpful in identifying retention rules.
    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"`
}

RetentionRuleDetails The details to create or update a retention rule.

func (RetentionRuleDetails) String Uses

func (m RetentionRuleDetails) String() string

type RetentionRuleSummary Uses

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"`
}

RetentionRuleSummary The summary of a retention rule.

func (RetentionRuleSummary) String Uses

func (m RetentionRuleSummary) String() string

type UpdateBucketDetails Uses

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.cloud.oracle.com/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.cloud.oracle.com/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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The OCID (https://docs.cloud.oracle.com/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"`
}

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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

func (UpdateBucketDetails) String Uses

func (m UpdateBucketDetails) String() string

type UpdateBucketDetailsPublicAccessTypeEnum Uses

type UpdateBucketDetailsPublicAccessTypeEnum string

UpdateBucketDetailsPublicAccessTypeEnum Enum with underlying type: string

const (
    UpdateBucketDetailsPublicAccessTypeNopublicaccess        UpdateBucketDetailsPublicAccessTypeEnum = "NoPublicAccess"
    UpdateBucketDetailsPublicAccessTypeObjectread            UpdateBucketDetailsPublicAccessTypeEnum = "ObjectRead"
    UpdateBucketDetailsPublicAccessTypeObjectreadwithoutlist UpdateBucketDetailsPublicAccessTypeEnum = "ObjectReadWithoutList"
)

Set of constants representing the allowable values for UpdateBucketDetailsPublicAccessTypeEnum

func GetUpdateBucketDetailsPublicAccessTypeEnumValues Uses

func GetUpdateBucketDetailsPublicAccessTypeEnumValues() []UpdateBucketDetailsPublicAccessTypeEnum

GetUpdateBucketDetailsPublicAccessTypeEnumValues Enumerates the set of values for UpdateBucketDetailsPublicAccessTypeEnum

type UpdateBucketRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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
}

UpdateBucketRequest wrapper for the UpdateBucket operation

func (UpdateBucketRequest) HTTPRequest Uses

func (request UpdateBucketRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBucketRequest) RetryPolicy Uses

func (request UpdateBucketRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBucketRequest) String Uses

func (request UpdateBucketRequest) String() string

type UpdateBucketResponse Uses

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"`
}

UpdateBucketResponse wrapper for the UpdateBucket operation

func (UpdateBucketResponse) HTTPResponse Uses

func (response UpdateBucketResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBucketResponse) String Uses

func (response UpdateBucketResponse) String() string

type UpdateNamespaceMetadataDetails Uses

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"`
}

UpdateNamespaceMetadataDetails UpdateNamespaceMetadataDetails is used to update the NamespaceMetadata. To update NamespaceMetadata, a user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission.

func (UpdateNamespaceMetadataDetails) String Uses

func (m UpdateNamespaceMetadataDetails) String() string

type UpdateNamespaceMetadataRequest Uses

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
}

UpdateNamespaceMetadataRequest wrapper for the UpdateNamespaceMetadata operation

func (UpdateNamespaceMetadataRequest) HTTPRequest Uses

func (request UpdateNamespaceMetadataRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateNamespaceMetadataRequest) RetryPolicy Uses

func (request UpdateNamespaceMetadataRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateNamespaceMetadataRequest) String Uses

func (request UpdateNamespaceMetadataRequest) String() string

type UpdateNamespaceMetadataResponse Uses

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"`
}

UpdateNamespaceMetadataResponse wrapper for the UpdateNamespaceMetadata operation

func (UpdateNamespaceMetadataResponse) HTTPResponse Uses

func (response UpdateNamespaceMetadataResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateNamespaceMetadataResponse) String Uses

func (response UpdateNamespaceMetadataResponse) String() string

type UpdateRetentionRuleDetails Uses

type UpdateRetentionRuleDetails struct {

    // A user-specified name for the retention rule. Names can be helpful in identifying retention rules.
    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"`
}

UpdateRetentionRuleDetails The details to update a retention rule.

func (UpdateRetentionRuleDetails) String Uses

func (m UpdateRetentionRuleDetails) String() string

type UpdateRetentionRuleRequest Uses

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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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
}

UpdateRetentionRuleRequest wrapper for the UpdateRetentionRule operation

func (UpdateRetentionRuleRequest) HTTPRequest Uses

func (request UpdateRetentionRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRetentionRuleRequest) RetryPolicy Uses

func (request UpdateRetentionRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateRetentionRuleRequest) String Uses

func (request UpdateRetentionRuleRequest) String() string

type UpdateRetentionRuleResponse Uses

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"`
}

UpdateRetentionRuleResponse wrapper for the UpdateRetentionRule operation

func (UpdateRetentionRuleResponse) HTTPResponse Uses

func (response UpdateRetentionRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateRetentionRuleResponse) String Uses

func (response UpdateRetentionRuleResponse) String() string

type UploadPartRequest Uses

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:"true" 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. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
    // For uploading a part, this is the entity tag of the target part.
    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 object
    // already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
    // part, this is the entity tag of the target part.
    IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`

    // 100-continue
    Expect *string `mandatory:"false" contributesTo:"header" name:"Expect"`

    // The optional base-64 header that defines the 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"`

    // 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
}

UploadPartRequest wrapper for the UploadPart operation

func (UploadPartRequest) HTTPRequest Uses

func (request UploadPartRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UploadPartRequest) RetryPolicy Uses

func (request UploadPartRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UploadPartRequest) String Uses

func (request UploadPartRequest) String() string

type UploadPartResponse Uses

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 entity tag (ETag) for the object.
    ETag *string `presentIn:"header" name:"etag"`
}

UploadPartResponse wrapper for the UploadPart operation

func (UploadPartResponse) HTTPResponse Uses

func (response UploadPartResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UploadPartResponse) String Uses

func (response UploadPartResponse) String() string

type WorkRequest Uses

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.cloud.oracle.com/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"`
}

WorkRequest A description of workRequest status.

func (WorkRequest) String Uses

func (m WorkRequest) String() string

type WorkRequestError Uses

type WorkRequestError struct {

    // A machine-usable code for the error that occurred. For the list of error codes,
    // see API Errors (https://docs.cloud.oracle.com/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"`
}

WorkRequestError The representation of WorkRequestError

func (WorkRequestError) String Uses

func (m WorkRequestError) String() string

type WorkRequestLogEntry Uses

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"`
}

WorkRequestLogEntry The representation of WorkRequestLogEntry

func (WorkRequestLogEntry) String Uses

func (m WorkRequestLogEntry) String() string

type WorkRequestOperationTypeEnum Uses

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string

const (
    WorkRequestOperationTypeCopyObject WorkRequestOperationTypeEnum = "COPY_OBJECT"
    WorkRequestOperationTypeReencrypt  WorkRequestOperationTypeEnum = "REENCRYPT"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetWorkRequestOperationTypeEnumValues Uses

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource Uses

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"`
}

WorkRequestResource The representation of WorkRequestResource

func (WorkRequestResource) String Uses

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum Uses

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string

const (
    WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
    WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
    WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
    WorkRequestResourceActionTypeRelated    WorkRequestResourceActionTypeEnum = "RELATED"
    WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
    WorkRequestResourceActionTypeRead       WorkRequestResourceActionTypeEnum = "READ"
    WorkRequestResourceActionTypeWritten    WorkRequestResourceActionTypeEnum = "WRITTEN"
)

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetWorkRequestResourceActionTypeEnumValues Uses

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestResourceMetadataKeyEnum Uses

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
    WorkRequestResourceMetadataKeyRegion    WorkRequestResourceMetadataKeyEnum = "REGION"
    WorkRequestResourceMetadataKeyNamespace WorkRequestResourceMetadataKeyEnum = "NAMESPACE"
    WorkRequestResourceMetadataKeyBucket    WorkRequestResourceMetadataKeyEnum = "BUCKET"
    WorkRequestResourceMetadataKeyObject    WorkRequestResourceMetadataKeyEnum = "OBJECT"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetWorkRequestResourceMetadataKeyEnumValues Uses

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestStatusEnum Uses

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string

const (
    WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
    WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
    WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
    WorkRequestStatusCompleted  WorkRequestStatusEnum = "COMPLETED"
    WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
    WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetWorkRequestStatusEnumValues Uses

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary Uses

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.cloud.oracle.com/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"`
}

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String Uses

func (m WorkRequestSummary) String() string

type WorkRequestSummaryOperationTypeEnum Uses

type WorkRequestSummaryOperationTypeEnum string

WorkRequestSummaryOperationTypeEnum Enum with underlying type: string

const (
    WorkRequestSummaryOperationTypeCopyObject WorkRequestSummaryOperationTypeEnum = "COPY_OBJECT"
    WorkRequestSummaryOperationTypeReencrypt  WorkRequestSummaryOperationTypeEnum = "REENCRYPT"
)

Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum

func GetWorkRequestSummaryOperationTypeEnumValues Uses

func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum

GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum

type WorkRequestSummaryStatusEnum Uses

type WorkRequestSummaryStatusEnum string

WorkRequestSummaryStatusEnum Enum with underlying type: string

const (
    WorkRequestSummaryStatusAccepted   WorkRequestSummaryStatusEnum = "ACCEPTED"
    WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
    WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
    WorkRequestSummaryStatusCompleted  WorkRequestSummaryStatusEnum = "COMPLETED"
    WorkRequestSummaryStatusCanceling  WorkRequestSummaryStatusEnum = "CANCELING"
    WorkRequestSummaryStatusCanceled   WorkRequestSummaryStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestSummaryStatusEnum

func GetWorkRequestSummaryStatusEnumValues Uses

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum

Directories

PathSynopsis
transferPackage transfer simplifies interaction with the Object Storage service by abstracting away the method used to upload objects.

Package objectstorage imports 5 packages (graph) and is imported by 8 packages. Updated 2020-04-01. Refresh now. Tools for package owners.