@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface ObjectStorage extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
AbortMultipartUploadResponse |
abortMultipartUpload(AbortMultipartUploadRequest request)
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
|
CancelWorkRequestResponse |
cancelWorkRequest(CancelWorkRequestRequest request)
Cancels a work request.
|
CommitMultipartUploadResponse |
commitMultipartUpload(CommitMultipartUploadRequest request)
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
|
CopyObjectResponse |
copyObject(CopyObjectRequest request)
Creates a request to copy an object within a region or to another region.
|
CreateBucketResponse |
createBucket(CreateBucketRequest request)
Creates a bucket in the given namespace with a bucket name and optional user-defined metadata.
|
CreateMultipartUploadResponse |
createMultipartUpload(CreateMultipartUploadRequest request)
Starts a new multipart upload to a specific object in the given bucket in the given namespace.
|
CreatePreauthenticatedRequestResponse |
createPreauthenticatedRequest(CreatePreauthenticatedRequestRequest request)
Creates a pre-authenticated request specific to the bucket.
|
DeleteBucketResponse |
deleteBucket(DeleteBucketRequest request)
Deletes a bucket if the bucket is already empty.
|
DeleteObjectResponse |
deleteObject(DeleteObjectRequest request)
Deletes an object.
|
DeleteObjectLifecyclePolicyResponse |
deleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest request)
Deletes the object lifecycle policy for the bucket.
|
DeletePreauthenticatedRequestResponse |
deletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest request)
Deletes the pre-authenticated request for the bucket.
|
GetBucketResponse |
getBucket(GetBucketRequest request)
Gets the current representation of the given bucket in the given Object Storage namespace.
|
GetNamespaceResponse |
getNamespace(GetNamespaceRequest request)
Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace.
|
GetNamespaceMetadataResponse |
getNamespaceMetadata(GetNamespaceMetadataRequest request)
Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId.
|
GetObjectResponse |
getObject(GetObjectRequest request)
Gets the metadata and body of an object.
|
GetObjectLifecyclePolicyResponse |
getObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest request)
Gets the object lifecycle policy for the bucket.
|
ObjectStoragePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
GetPreauthenticatedRequestResponse |
getPreauthenticatedRequest(GetPreauthenticatedRequestRequest request)
Gets the pre-authenticated request for the bucket.
|
ObjectStorageWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request for the given ID.
|
HeadBucketResponse |
headBucket(HeadBucketRequest request)
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
|
HeadObjectResponse |
headObject(HeadObjectRequest request)
Gets the user-defined metadata and entity tag (ETag) for an object.
|
ListBucketsResponse |
listBuckets(ListBucketsRequest request)
Gets a list of all BucketSummary items in a compartment.
|
ListMultipartUploadPartsResponse |
listMultipartUploadParts(ListMultipartUploadPartsRequest request)
Lists the parts of an in-progress multipart upload.
|
ListMultipartUploadsResponse |
listMultipartUploads(ListMultipartUploadsRequest request)
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
|
ListObjectsResponse |
listObjects(ListObjectsRequest request)
Lists the objects in a bucket.
|
ListPreauthenticatedRequestsResponse |
listPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request)
Lists pre-authenticated requests for the bucket.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Lists the errors of the work request with the given ID.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Lists the logs of the work request with the given ID.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
|
PutObjectResponse |
putObject(PutObjectRequest request)
Creates a new object or overwrites an existing one.
|
PutObjectLifecyclePolicyResponse |
putObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request)
Creates or replaces the object lifecycle policy for the bucket.
|
RenameObjectResponse |
renameObject(RenameObjectRequest request)
Rename an object in the given Object Storage namespace.
|
RestoreObjectsResponse |
restoreObjects(RestoreObjectsRequest request)
Restores one or more objects specified by the objectName parameter.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateBucketResponse |
updateBucket(UpdateBucketRequest request)
Performs a partial or full update of a bucket’s user-defined metadata.
|
UpdateNamespaceMetadataResponse |
updateNamespaceMetadata(UpdateNamespaceMetadataRequest request)
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.
|
UploadPartResponse |
uploadPart(UploadPartRequest request)
Uploads a single part of a multipart upload.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.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.AbortMultipartUploadResponse abortMultipartUpload(AbortMultipartUploadRequest request)
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
request
- The request object containing the details to sendBmcException
- when an error occurs.CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Cancels a work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.CommitMultipartUploadResponse commitMultipartUpload(CommitMultipartUploadRequest request)
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 sendBmcException
- when an error occurs.CopyObjectResponse copyObject(CopyObjectRequest request)
Creates a request to copy an object within a region or to another region.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateBucketResponse createBucket(CreateBucketRequest request)
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 sendBmcException
- when an error occurs.CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUploadRequest request)
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 sendBmcException
- when an error occurs.CreatePreauthenticatedRequestResponse createPreauthenticatedRequest(CreatePreauthenticatedRequestRequest request)
Creates a pre-authenticated request specific to the bucket.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteBucketResponse deleteBucket(DeleteBucketRequest request)
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 sendBmcException
- when an error occurs.DeleteObjectResponse deleteObject(DeleteObjectRequest request)
Deletes an object.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteObjectLifecyclePolicyResponse deleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest request)
Deletes the object lifecycle policy for the bucket.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeletePreauthenticatedRequestResponse deletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest request)
Deletes the pre-authenticated request for the bucket.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBucketResponse getBucket(GetBucketRequest request)
Gets the current representation of the given bucket in the given Object Storage namespace.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetNamespaceResponse getNamespace(GetNamespaceRequest request)
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 sendBmcException
- when an error occurs.GetNamespaceMetadataResponse getNamespaceMetadata(GetNamespaceMetadataRequest request)
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 sendBmcException
- when an error occurs.GetObjectResponse getObject(GetObjectRequest request)
Gets the metadata and body of an object.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetObjectLifecyclePolicyResponse getObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest request)
Gets the object lifecycle policy for the bucket.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetPreauthenticatedRequestResponse getPreauthenticatedRequest(GetPreauthenticatedRequestRequest request)
Gets the pre-authenticated request for the bucket.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request for the given ID.
request
- The request object containing the details to sendBmcException
- when an error occurs.HeadBucketResponse headBucket(HeadBucketRequest request)
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 sendBmcException
- when an error occurs.HeadObjectResponse headObject(HeadObjectRequest request)
Gets the user-defined metadata and entity tag (ETag) for an object.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListBucketsResponse listBuckets(ListBucketsRequest request)
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 sendBmcException
- when an error occurs.ListMultipartUploadPartsResponse listMultipartUploadParts(ListMultipartUploadPartsRequest request)
Lists the parts of an in-progress multipart upload.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListMultipartUploadsResponse listMultipartUploads(ListMultipartUploadsRequest request)
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 sendBmcException
- when an error occurs.ListObjectsResponse listObjects(ListObjectsRequest request)
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 sendBmcException
- when an error occurs.ListPreauthenticatedRequestsResponse listPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request)
Lists pre-authenticated requests for the bucket.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Lists the errors of the work request with the given ID.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Lists the logs of the work request with the given ID.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.PutObjectResponse putObject(PutObjectRequest request)
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 sendBmcException
- when an error occurs.PutObjectLifecyclePolicyResponse putObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request)
Creates or replaces the object lifecycle policy for the bucket.
request
- The request object containing the details to sendBmcException
- when an error occurs.RenameObjectResponse renameObject(RenameObjectRequest request)
Rename an object in the given Object Storage namespace.
request
- The request object containing the details to sendBmcException
- when an error occurs.RestoreObjectsResponse restoreObjects(RestoreObjectsRequest request)
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 sendBmcException
- when an error occurs.UpdateBucketResponse updateBucket(UpdateBucketRequest request)
Performs a partial or full update of a bucket’s user-defined metadata.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateNamespaceMetadataResponse updateNamespaceMetadata(UpdateNamespaceMetadataRequest request)
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 sendBmcException
- when an error occurs.UploadPartResponse uploadPart(UploadPartRequest request)
Uploads a single part of a multipart upload.
request
- The request object containing the details to sendBmcException
- when an error occurs.ObjectStorageWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
ObjectStoragePaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2019. All rights reserved.