@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ObjectStorageAsyncClient extends BaseAsyncClient implements ObjectStorageAsync
Async client implementation for ObjectStorage service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response
to the call is an InputStream
, like getObject Api in object storage service,
developers need to process the stream in AsyncHandler, and not anywhere else, because the stream
will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done
with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or
the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the
AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine
whether or not the request was completed via Future.isDone/isCancelled.
Please refer to
https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
Modifier and Type | Class and Description |
---|---|
static class |
ObjectStorageAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for ObjectStorage.
|
Constructor and Description |
---|
ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ObjectStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
ObjectStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
ObjectStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for ObjectStorage.
public final String clientCommonLibraryVersion
@Deprecated public ObjectStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public ObjectStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public ObjectStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public ObjectStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
protected ClientConfigurator getDefaultConfigurator()
public static ObjectStorageAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
ObjectStorageAsync
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
setRegion
in interface ObjectStorageAsync
region
- The region of the service.public void setRegion(String regionId)
ObjectStorageAsync
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
setRegion
in interface ObjectStorageAsync
regionId
- The public region ID.public Future<AbortMultipartUploadResponse> abortMultipartUpload(AbortMultipartUploadRequest request, AsyncHandler<AbortMultipartUploadRequest,AbortMultipartUploadResponse> handler)
ObjectStorageAsync
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
abortMultipartUpload
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
ObjectStorageAsync
Cancels a work request.
cancelWorkRequest
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CommitMultipartUploadResponse> commitMultipartUpload(CommitMultipartUploadRequest request, AsyncHandler<CommitMultipartUploadRequest,CommitMultipartUploadResponse> handler)
ObjectStorageAsync
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
commitMultipartUpload
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CopyObjectResponse> copyObject(CopyObjectRequest request, AsyncHandler<CopyObjectRequest,CopyObjectResponse> handler)
ObjectStorageAsync
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.
copyObject
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateBucketResponse> createBucket(CreateBucketRequest request, AsyncHandler<CreateBucketRequest,CreateBucketResponse> handler)
ObjectStorageAsync
Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.
createBucket
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateMultipartUploadResponse> createMultipartUpload(CreateMultipartUploadRequest request, AsyncHandler<CreateMultipartUploadRequest,CreateMultipartUploadResponse> handler)
ObjectStorageAsync
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.
createMultipartUpload
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreatePreauthenticatedRequestResponse> createPreauthenticatedRequest(CreatePreauthenticatedRequestRequest request, AsyncHandler<CreatePreauthenticatedRequestRequest,CreatePreauthenticatedRequestResponse> handler)
ObjectStorageAsync
Creates a pre-authenticated request specific to the bucket.
createPreauthenticatedRequest
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreatePrivateEndpointResponse> createPrivateEndpoint(CreatePrivateEndpointRequest request, AsyncHandler<CreatePrivateEndpointRequest,CreatePrivateEndpointResponse> handler)
ObjectStorageAsync
Create a PrivateEndpoint.
createPrivateEndpoint
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateReplicationPolicyResponse> createReplicationPolicy(CreateReplicationPolicyRequest request, AsyncHandler<CreateReplicationPolicyRequest,CreateReplicationPolicyResponse> handler)
ObjectStorageAsync
Creates a replication policy for the specified bucket.
createReplicationPolicy
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateRetentionRuleResponse> createRetentionRule(CreateRetentionRuleRequest request, AsyncHandler<CreateRetentionRuleRequest,CreateRetentionRuleResponse> handler)
ObjectStorageAsync
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.
createRetentionRule
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteBucketResponse> deleteBucket(DeleteBucketRequest request, AsyncHandler<DeleteBucketRequest,DeleteBucketResponse> handler)
ObjectStorageAsync
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.
deleteBucket
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteObjectResponse> deleteObject(DeleteObjectRequest request, AsyncHandler<DeleteObjectRequest,DeleteObjectResponse> handler)
ObjectStorageAsync
Deletes an object.
deleteObject
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteObjectLifecyclePolicyResponse> deleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest request, AsyncHandler<DeleteObjectLifecyclePolicyRequest,DeleteObjectLifecyclePolicyResponse> handler)
ObjectStorageAsync
Deletes the object lifecycle policy for the bucket.
deleteObjectLifecyclePolicy
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeletePreauthenticatedRequestResponse> deletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest request, AsyncHandler<DeletePreauthenticatedRequestRequest,DeletePreauthenticatedRequestResponse> handler)
ObjectStorageAsync
Deletes the pre-authenticated request for the bucket.
deletePreauthenticatedRequest
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeletePrivateEndpointResponse> deletePrivateEndpoint(DeletePrivateEndpointRequest request, AsyncHandler<DeletePrivateEndpointRequest,DeletePrivateEndpointResponse> handler)
ObjectStorageAsync
Deletes a Private Endpoint if it exists in the given namespace.
deletePrivateEndpoint
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteReplicationPolicyResponse> deleteReplicationPolicy(DeleteReplicationPolicyRequest request, AsyncHandler<DeleteReplicationPolicyRequest,DeleteReplicationPolicyResponse> handler)
ObjectStorageAsync
Deletes the replication policy associated with the source bucket.
deleteReplicationPolicy
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteRetentionRuleResponse> deleteRetentionRule(DeleteRetentionRuleRequest request, AsyncHandler<DeleteRetentionRuleRequest,DeleteRetentionRuleResponse> handler)
ObjectStorageAsync
Deletes the specified rule. The deletion takes effect typically within 30 seconds.
deleteRetentionRule
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetBucketResponse> getBucket(GetBucketRequest request, AsyncHandler<GetBucketRequest,GetBucketResponse> handler)
ObjectStorageAsync
Gets the current representation of the given bucket in the given Object Storage namespace.
getBucket
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetNamespaceResponse> getNamespace(GetNamespaceRequest request, AsyncHandler<GetNamespaceRequest,GetNamespaceResponse> handler)
ObjectStorageAsync
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.
getNamespace
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetNamespaceMetadataResponse> getNamespaceMetadata(GetNamespaceMetadataRequest request, AsyncHandler<GetNamespaceMetadataRequest,GetNamespaceMetadataResponse> handler)
ObjectStorageAsync
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).
getNamespaceMetadata
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetObjectResponse> getObject(GetObjectRequest request, AsyncHandler<GetObjectRequest,GetObjectResponse> handler)
ObjectStorageAsync
Gets the metadata and body of an object.
getObject
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetObjectLifecyclePolicyResponse> getObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest request, AsyncHandler<GetObjectLifecyclePolicyRequest,GetObjectLifecyclePolicyResponse> handler)
ObjectStorageAsync
Gets the object lifecycle policy for the bucket.
getObjectLifecyclePolicy
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetPreauthenticatedRequestResponse> getPreauthenticatedRequest(GetPreauthenticatedRequestRequest request, AsyncHandler<GetPreauthenticatedRequestRequest,GetPreauthenticatedRequestResponse> handler)
ObjectStorageAsync
Gets the pre-authenticated request for the bucket.
getPreauthenticatedRequest
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetPrivateEndpointResponse> getPrivateEndpoint(GetPrivateEndpointRequest request, AsyncHandler<GetPrivateEndpointRequest,GetPrivateEndpointResponse> handler)
ObjectStorageAsync
Gets the current representation of the given Private Endpoint in the given Object Storage namespace.
getPrivateEndpoint
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetReplicationPolicyResponse> getReplicationPolicy(GetReplicationPolicyRequest request, AsyncHandler<GetReplicationPolicyRequest,GetReplicationPolicyResponse> handler)
ObjectStorageAsync
Get the replication policy.
getReplicationPolicy
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetRetentionRuleResponse> getRetentionRule(GetRetentionRuleRequest request, AsyncHandler<GetRetentionRuleRequest,GetRetentionRuleResponse> handler)
ObjectStorageAsync
Get the specified retention rule.
getRetentionRule
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
ObjectStorageAsync
Gets the status of the work request for the given ID.
getWorkRequest
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<HeadBucketResponse> headBucket(HeadBucketRequest request, AsyncHandler<HeadBucketRequest,HeadBucketResponse> handler)
ObjectStorageAsync
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
headBucket
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<HeadObjectResponse> headObject(HeadObjectRequest request, AsyncHandler<HeadObjectRequest,HeadObjectResponse> handler)
ObjectStorageAsync
Gets the user-defined metadata and entity tag (ETag) for an object.
headObject
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBucketsResponse> listBuckets(ListBucketsRequest request, AsyncHandler<ListBucketsRequest,ListBucketsResponse> handler)
ObjectStorageAsync
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).
listBuckets
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListMultipartUploadPartsResponse> listMultipartUploadParts(ListMultipartUploadPartsRequest request, AsyncHandler<ListMultipartUploadPartsRequest,ListMultipartUploadPartsResponse> handler)
ObjectStorageAsync
Lists the parts of an in-progress multipart upload.
listMultipartUploadParts
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListMultipartUploadsResponse> listMultipartUploads(ListMultipartUploadsRequest request, AsyncHandler<ListMultipartUploadsRequest,ListMultipartUploadsResponse> handler)
ObjectStorageAsync
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
listMultipartUploads
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListObjectVersionsResponse> listObjectVersions(ListObjectVersionsRequest request, AsyncHandler<ListObjectVersionsRequest,ListObjectVersionsResponse> handler)
ObjectStorageAsync
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).
listObjectVersions
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListObjectsResponse> listObjects(ListObjectsRequest request, AsyncHandler<ListObjectsRequest,ListObjectsResponse> handler)
ObjectStorageAsync
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).
listObjects
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListPreauthenticatedRequestsResponse> listPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request, AsyncHandler<ListPreauthenticatedRequestsRequest,ListPreauthenticatedRequestsResponse> handler)
ObjectStorageAsync
Lists pre-authenticated requests for the bucket.
listPreauthenticatedRequests
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListPrivateEndpointsResponse> listPrivateEndpoints(ListPrivateEndpointsRequest request, AsyncHandler<ListPrivateEndpointsRequest,ListPrivateEndpointsResponse> handler)
ObjectStorageAsync
Gets a list of all PrivateEndpointSummary in a compartment associated with a namespace. To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
listPrivateEndpoints
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListReplicationPoliciesResponse> listReplicationPolicies(ListReplicationPoliciesRequest request, AsyncHandler<ListReplicationPoliciesRequest,ListReplicationPoliciesResponse> handler)
ObjectStorageAsync
List the replication policies associated with a bucket.
listReplicationPolicies
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListReplicationSourcesResponse> listReplicationSources(ListReplicationSourcesRequest request, AsyncHandler<ListReplicationSourcesRequest,ListReplicationSourcesResponse> handler)
ObjectStorageAsync
List the replication sources of a destination bucket.
listReplicationSources
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListRetentionRulesResponse> listRetentionRules(ListRetentionRulesRequest request, AsyncHandler<ListRetentionRulesRequest,ListRetentionRulesResponse> handler)
ObjectStorageAsync
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.
listRetentionRules
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
ObjectStorageAsync
Lists the errors of the work request with the given ID.
listWorkRequestErrors
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
ObjectStorageAsync
Lists the logs of the work request with the given ID.
listWorkRequestLogs
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
ObjectStorageAsync
Lists the work requests in a compartment.
listWorkRequests
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<MakeBucketWritableResponse> makeBucketWritable(MakeBucketWritableRequest request, AsyncHandler<MakeBucketWritableRequest,MakeBucketWritableResponse> handler)
ObjectStorageAsync
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.
makeBucketWritable
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<PutObjectResponse> putObject(PutObjectRequest request, AsyncHandler<PutObjectRequest,PutObjectResponse> handler)
ObjectStorageAsync
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.
putObject
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<PutObjectLifecyclePolicyResponse> putObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request, AsyncHandler<PutObjectLifecyclePolicyRequest,PutObjectLifecyclePolicyResponse> handler)
ObjectStorageAsync
Creates or replaces the object lifecycle policy for the bucket.
putObjectLifecyclePolicy
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ReencryptBucketResponse> reencryptBucket(ReencryptBucketRequest request, AsyncHandler<ReencryptBucketRequest,ReencryptBucketResponse> handler)
ObjectStorageAsync
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.
reencryptBucket
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ReencryptObjectResponse> reencryptObject(ReencryptObjectRequest request, AsyncHandler<ReencryptObjectRequest,ReencryptObjectResponse> handler)
ObjectStorageAsync
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).
reencryptObject
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RenameObjectResponse> renameObject(RenameObjectRequest request, AsyncHandler<RenameObjectRequest,RenameObjectResponse> handler)
ObjectStorageAsync
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.
renameObject
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RestoreObjectsResponse> restoreObjects(RestoreObjectsRequest request, AsyncHandler<RestoreObjectsRequest,RestoreObjectsResponse> handler)
ObjectStorageAsync
Restores the object specified by the objectName parameter. By default object will be restored for 24 hours. Duration can be configured using the hours parameter.
restoreObjects
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateBucketResponse> updateBucket(UpdateBucketRequest request, AsyncHandler<UpdateBucketRequest,UpdateBucketResponse> handler)
ObjectStorageAsync
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).
updateBucket
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateNamespaceMetadataResponse> updateNamespaceMetadata(UpdateNamespaceMetadataRequest request, AsyncHandler<UpdateNamespaceMetadataRequest,UpdateNamespaceMetadataResponse> handler)
ObjectStorageAsync
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.
updateNamespaceMetadata
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateObjectStorageTierResponse> updateObjectStorageTier(UpdateObjectStorageTierRequest request, AsyncHandler<UpdateObjectStorageTierRequest,UpdateObjectStorageTierResponse> handler)
ObjectStorageAsync
Changes the storage tier of the object specified by the objectName parameter.
updateObjectStorageTier
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdatePrivateEndpointResponse> updatePrivateEndpoint(UpdatePrivateEndpointRequest request, AsyncHandler<UpdatePrivateEndpointRequest,UpdatePrivateEndpointResponse> handler)
ObjectStorageAsync
Performs a partial or full update of a user-defined data associated with the Private Endpoint.
Use UpdatePrivateEndpoint to move a Private Endpoint from one compartment to another within the same tenancy. Supply the compartmentID of the compartment that you want to move the Private Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp or accessTargets of the Private Endpoint. For more information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
This API follows replace semantics (rather than merge semantics). That means if the body provides values for parameters and the resource has exisiting ones, this operation will replace those existing values.
updatePrivateEndpoint
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateRetentionRuleResponse> updateRetentionRule(UpdateRetentionRuleRequest request, AsyncHandler<UpdateRetentionRuleRequest,UpdateRetentionRuleResponse> handler)
ObjectStorageAsync
Updates the specified retention rule. Rule changes take effect typically within 30 seconds.
updateRetentionRule
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UploadPartResponse> uploadPart(UploadPartRequest request, AsyncHandler<UploadPartRequest,UploadPartResponse> handler)
ObjectStorageAsync
Uploads a single part of a multipart upload.
uploadPart
in interface ObjectStorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
Copyright © 2016–2024. All rights reserved.