Class ObjectStorageClient

Aborts an in-progress multipart upload and deletes all parts that have been uploaded.

Cancels a work request.

Close the client once it is no longer needed

Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.

Creates a request to copy an object within a region or to another region.

See [Object Names](https://docs.cloud.oracle.com/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.

Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.

Starts a new multipart upload to a specific object in the given bucket in the given namespace.

See [Object Names](https://docs.cloud.oracle.com/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.

Creates a pre-authenticated request specific to the bucket.

Creates a replication policy for the specified bucket.

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.

Creates a new ObjectStorageWaiter for resources for this service.

Deletes a bucket if the bucket is already empty. If the bucket is not empty, use {@link #deleteObject(DeleteObjectRequest) 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.

Deletes an object.

Deletes the object lifecycle policy for the bucket.

Deletes the pre-authenticated request for the bucket. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

Deletes the replication policy associated with the source bucket.

Deletes the specified rule. The deletion takes effect typically within 30 seconds. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

Gets the current representation of the given bucket in the given Object Storage namespace.

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.

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

Gets the metadata and body of an object.

Gets the object lifecycle policy for the bucket.

Gets the pre-authenticated request for the bucket. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

Get the replication policy.

Get the specified retention rule. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

Gets the waiters available for resources for this service.

Gets the status of the work request for the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.

Gets the user-defined metadata and entity tag (ETag) for an object.

NOTE: This function is deprecated in favor of listBucketsRecordIterator function. Creates a new async iterator which will iterate over the models.BucketSummary objects contained in responses from the listBuckets operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listBucketsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listBuckets operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listMultipartUploadPartsRecordIterator function. Creates a new async iterator which will iterate over the models.MultipartUploadPartSummary objects contained in responses from the listMultipartUploadParts operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listMultipartUploadPartsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMultipartUploadParts operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listMultipartUploadsRecordIterator function. Creates a new async iterator which will iterate over the models.MultipartUpload objects contained in responses from the listMultipartUploads operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listMultipartUploadsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMultipartUploads operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listObjectsRecordIterator function. Creates a new async iterator which will iterate over the models.ObjectSummary objects contained in responses from the listObjects operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listObjectsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listObjects operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listPreauthenticatedRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.PreauthenticatedRequestSummary objects contained in responses from the listPreauthenticatedRequests operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listPreauthenticatedRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPreauthenticatedRequests operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listReplicationPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.ReplicationPolicySummary objects contained in responses from the listReplicationPolicies operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listReplicationPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listReplicationPolicies operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listReplicationSourcesRecordIterator function. Creates a new async iterator which will iterate over the models.ReplicationSource objects contained in responses from the listReplicationSources operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listReplicationSourcesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listReplicationSources operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket and does not contain fields like the user-defined metadata.

ListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned `opc-next-page` value with the `page` request parameter.

To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Creates a new async iterator which will iterate over the models.BucketSummary objects contained in responses from the listBuckets operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listBuckets operation. This iterator will fetch more data from the server as needed.

Lists the parts of an in-progress multipart upload.

Creates a new async iterator which will iterate over the models.MultipartUploadPartSummary objects contained in responses from the listMultipartUploadParts operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listMultipartUploadParts operation. This iterator will fetch more data from the server as needed.

Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.

Creates a new async iterator which will iterate over the models.MultipartUpload objects contained in responses from the listMultipartUploads operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listMultipartUploads operation. This iterator will fetch more data from the server as needed.

Lists the object versions in a bucket.

ListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through more object versions, use the returned `opc-next-page` value with the `page` request parameter.

To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Lists the objects in a bucket. By default, ListObjects returns object names only. See the fields parameter for other fields that you can optionally include in ListObjects response.

ListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith' value with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end' parameters.

To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Creates a new async iterator which will iterate over the models.ObjectSummary objects contained in responses from the listObjects operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listObjects operation. This iterator will fetch more data from the server as needed.

Lists pre-authenticated requests for the bucket.

Creates a new async iterator which will iterate over the models.PreauthenticatedRequestSummary objects contained in responses from the listPreauthenticatedRequests operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listPreauthenticatedRequests operation. This iterator will fetch more data from the server as needed.

List the replication policies associated with a bucket.

Creates a new async iterator which will iterate over the models.ReplicationPolicySummary objects contained in responses from the listReplicationPolicies operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listReplicationPolicies operation. This iterator will fetch more data from the server as needed.

List the replication sources of a destination bucket.

Creates a new async iterator which will iterate over the models.ReplicationSource objects contained in responses from the listReplicationSources operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listReplicationSources operation. This iterator will fetch more data from the server as needed.

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.

Lists the errors of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

Lists the logs of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

Lists the work requests in a compartment.

Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

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.

Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by PutObject is 50 GiB.

See [Object Names](https://docs.cloud.oracle.com/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.

See [Special Instructions for Object Storage PUT](https://docs.cloud.oracle.com/Content/API/Concepts/signingrequests.htm#ObjectStoragePut) for request signature requirements.

Creates or replaces the object lifecycle policy for the bucket.

Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent version of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master encryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign a key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property of the bucket determines which master encryption key is assigned to the bucket. If you assigned a different Key Management master encryption key to the bucket, you can call this API to re-encrypt all data encryption keys with the newly assigned key. Similarly, you might want to re-encrypt all data encryption keys if the assigned key has been rotated to a new key version since objects were last added to the bucket. If you call this API and there is no kmsKeyId associated with the bucket, the call will fail.

Calling this API starts a work request task to re-encrypt the data encryption key of all objects in the bucket. Only objects created before the time of the API call will be re-encrypted. The call can take a long time, depending on how many objects are in the bucket and how big they are. This API returns a work request ID that you can use to retrieve the status of the work request task. All the versions of objects will be re-encrypted whether versioning is enabled or suspended at the bucket.

Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage service manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for the bucket applies to the objects it contains.

You can alternatively employ one of these encryption strategies for an object:

- You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service.

- You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C).

Rename an object in the given Object Storage namespace.

See [Object Names](https://docs.cloud.oracle.com/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.

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.

Shutdown the circuit breaker used by the client when it is no longer needed

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

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.

Changes the storage tier of the object specified by the objectName parameter.

Updates the specified retention rule. Rule changes take effect typically within 30 seconds.

Uploads a single part of a multipart upload.