@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface ObjectStorageAsync extends AutoCloseable
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.void setRegion(Region region)
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.
region
- The region of the service.void setRegion(String regionId)
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
.
regionId
- The public region ID.Future<AbortMultipartUploadResponse> abortMultipartUpload(AbortMultipartUploadRequest request, AsyncHandler<AbortMultipartUploadRequest,AbortMultipartUploadResponse> handler)
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
Cancels a work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CommitMultipartUploadResponse> commitMultipartUpload(CommitMultipartUploadRequest request, AsyncHandler<CommitMultipartUploadRequest,CommitMultipartUploadResponse> handler)
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CopyObjectResponse> copyObject(CopyObjectRequest request, AsyncHandler<CopyObjectRequest,CopyObjectResponse> handler)
Creates a request to copy an object within a region or to another region.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateBucketResponse> createBucket(CreateBucketRequest request, AsyncHandler<CreateBucketRequest,CreateBucketResponse> handler)
Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateMultipartUploadResponse> createMultipartUpload(CreateMultipartUploadRequest request, AsyncHandler<CreateMultipartUploadRequest,CreateMultipartUploadResponse> handler)
Starts a new multipart upload to a specific object in the given bucket in the given namespace.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreatePreauthenticatedRequestResponse> createPreauthenticatedRequest(CreatePreauthenticatedRequestRequest request, AsyncHandler<CreatePreauthenticatedRequestRequest,CreatePreauthenticatedRequestResponse> handler)
Creates a pre-authenticated request specific to the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteBucketResponse> deleteBucket(DeleteBucketRequest request, AsyncHandler<DeleteBucketRequest,DeleteBucketResponse> handler)
Deletes a bucket if the bucket is already empty. If the bucket is not empty, use deleteObject
first. You also cannot delete a bucket that has a pre-authenticated request associated with that bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteObjectResponse> deleteObject(DeleteObjectRequest request, AsyncHandler<DeleteObjectRequest,DeleteObjectResponse> handler)
Deletes an object.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteObjectLifecyclePolicyResponse> deleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest request, AsyncHandler<DeleteObjectLifecyclePolicyRequest,DeleteObjectLifecyclePolicyResponse> handler)
Deletes the object lifecycle policy for the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeletePreauthenticatedRequestResponse> deletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest request, AsyncHandler<DeletePreauthenticatedRequestRequest,DeletePreauthenticatedRequestResponse> handler)
Deletes the pre-authenticated request for the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetBucketResponse> getBucket(GetBucketRequest request, AsyncHandler<GetBucketRequest,GetBucketResponse> handler)
Gets the current representation of the given bucket in the given Object Storage namespace.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetNamespaceResponse> getNamespace(GetNamespaceRequest request, AsyncHandler<GetNamespaceRequest,GetNamespaceResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetNamespaceMetadataResponse> getNamespaceMetadata(GetNamespaceMetadataRequest request, AsyncHandler<GetNamespaceMetadataRequest,GetNamespaceMetadataResponse> handler)
Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId.
Any user with the 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetObjectResponse> getObject(GetObjectRequest request, AsyncHandler<GetObjectRequest,GetObjectResponse> handler)
Gets the metadata and body of an object.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetObjectLifecyclePolicyResponse> getObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest request, AsyncHandler<GetObjectLifecyclePolicyRequest,GetObjectLifecyclePolicyResponse> handler)
Gets the object lifecycle policy for the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetPreauthenticatedRequestResponse> getPreauthenticatedRequest(GetPreauthenticatedRequestRequest request, AsyncHandler<GetPreauthenticatedRequestRequest,GetPreauthenticatedRequestResponse> handler)
Gets the pre-authenticated request for the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the status of the work request for the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<HeadBucketResponse> headBucket(HeadBucketRequest request, AsyncHandler<HeadBucketRequest,HeadBucketResponse> handler)
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<HeadObjectResponse> headObject(HeadObjectRequest request, AsyncHandler<HeadObjectRequest,HeadObjectResponse> handler)
Gets the user-defined metadata and entity tag (ETag) for an object.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListBucketsResponse> listBuckets(ListBucketsRequest request, AsyncHandler<ListBucketsRequest,ListBucketsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListMultipartUploadPartsResponse> listMultipartUploadParts(ListMultipartUploadPartsRequest request, AsyncHandler<ListMultipartUploadPartsRequest,ListMultipartUploadPartsResponse> handler)
Lists the parts of an in-progress multipart upload.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListMultipartUploadsResponse> listMultipartUploads(ListMultipartUploadsRequest request, AsyncHandler<ListMultipartUploadsRequest,ListMultipartUploadsResponse> handler)
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListObjectsResponse> listObjects(ListObjectsRequest request, AsyncHandler<ListObjectsRequest,ListObjectsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListPreauthenticatedRequestsResponse> listPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request, AsyncHandler<ListPreauthenticatedRequestsRequest,ListPreauthenticatedRequestsResponse> handler)
Lists pre-authenticated requests for the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Lists the errors of the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Lists the logs of the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<PutObjectResponse> putObject(PutObjectRequest request, AsyncHandler<PutObjectRequest,PutObjectResponse> handler)
Creates a new object or overwrites an existing one. See Special Instructions for Object Storage PUT for request signature requirements.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<PutObjectLifecyclePolicyResponse> putObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request, AsyncHandler<PutObjectLifecyclePolicyRequest,PutObjectLifecyclePolicyResponse> handler)
Creates or replaces the object lifecycle policy for the bucket.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RenameObjectResponse> renameObject(RenameObjectRequest request, AsyncHandler<RenameObjectRequest,RenameObjectResponse> handler)
Rename an object in the given Object Storage namespace.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RestoreObjectsResponse> restoreObjects(RestoreObjectsRequest request, AsyncHandler<RestoreObjectsRequest,RestoreObjectsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateBucketResponse> updateBucket(UpdateBucketRequest request, AsyncHandler<UpdateBucketRequest,UpdateBucketResponse> handler)
Performs a partial or full update of a bucket’s user-defined metadata.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateNamespaceMetadataResponse> updateNamespaceMetadata(UpdateNamespaceMetadataRequest request, AsyncHandler<UpdateNamespaceMetadataRequest,UpdateNamespaceMetadataResponse> handler)
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 NAMESPACE_UPDATE permission to make changes to the default compartments for Amazon S3 and Swift.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UploadPartResponse> uploadPart(UploadPartRequest request, AsyncHandler<UploadPartRequest,UploadPartResponse> handler)
Uploads a single part of a multipart upload.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2019. All rights reserved.