@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ObjectStorageClient extends BaseSyncClient implements ObjectStorage
Modifier and Type | Class and Description |
---|---|
static class |
ObjectStorageClient.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 |
---|
ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and Description |
---|---|
AbortMultipartUploadResponse |
abortMultipartUpload(AbortMultipartUploadRequest request)
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
|
static ObjectStorageClient.Builder |
builder()
Create a builder for this client.
|
CancelWorkRequestResponse |
cancelWorkRequest(CancelWorkRequestRequest request)
Cancels a work request.
|
void |
close() |
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.
|
CreatePrivateEndpointResponse |
createPrivateEndpoint(CreatePrivateEndpointRequest request)
Create a PrivateEndpoint.
|
CreateReplicationPolicyResponse |
createReplicationPolicy(CreateReplicationPolicyRequest request)
Creates a replication policy for the specified bucket.
|
CreateRetentionRuleResponse |
createRetentionRule(CreateRetentionRuleRequest request)
Creates a new retention rule in the specified 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.
|
DeletePrivateEndpointResponse |
deletePrivateEndpoint(DeletePrivateEndpointRequest request)
Deletes a Private Endpoint if it exists in the given namespace.
|
DeleteReplicationPolicyResponse |
deleteReplicationPolicy(DeleteReplicationPolicyRequest request)
Deletes the replication policy associated with the source bucket.
|
DeleteRetentionRuleResponse |
deleteRetentionRule(DeleteRetentionRuleRequest request)
Deletes the specified rule.
|
GetBucketResponse |
getBucket(GetBucketRequest request)
Gets the current representation of the given bucket in the given Object Storage namespace.
|
String |
getClientCommonLibraryVersion() |
protected ClientConfigurator |
getDefaultConfigurator() |
String |
getEndpoint() |
Optional<String> |
getMinimumClientCommonLibraryVersionFromClient() |
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.
|
GetPrivateEndpointResponse |
getPrivateEndpoint(GetPrivateEndpointRequest request)
Gets the current representation of the given Private Endpoint in the given Object Storage
namespace.
|
GetReplicationPolicyResponse |
getReplicationPolicy(GetReplicationPolicyRequest request)
Get the replication policy.
|
GetRetentionRuleResponse |
getRetentionRule(GetRetentionRuleRequest request)
Get the specified retention rule.
|
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.
|
ListObjectVersionsResponse |
listObjectVersions(ListObjectVersionsRequest request)
Lists the object versions in a bucket.
|
ListPreauthenticatedRequestsResponse |
listPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request)
Lists pre-authenticated requests for the bucket.
|
ListPrivateEndpointsResponse |
listPrivateEndpoints(ListPrivateEndpointsRequest request)
Gets a list of all PrivateEndpointSummary in a compartment associated with a namespace.
|
ListReplicationPoliciesResponse |
listReplicationPolicies(ListReplicationPoliciesRequest request)
List the replication policies associated with a bucket.
|
ListReplicationSourcesResponse |
listReplicationSources(ListReplicationSourcesRequest request)
List the replication sources of a destination bucket.
|
ListRetentionRulesResponse |
listRetentionRules(ListRetentionRulesRequest request)
List the retention rules for a 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.
|
MakeBucketWritableResponse |
makeBucketWritable(MakeBucketWritableRequest request)
Stops replication to the destination bucket and removes the replication policy.
|
void |
populateServiceParametersInEndpoint(String endpoint,
Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base
endpoint.
|
PutObjectResponse |
putObject(PutObjectRequest request)
Creates a new object or overwrites an existing object with the same name.
|
PutObjectLifecyclePolicyResponse |
putObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request)
Creates or replaces the object lifecycle policy for the bucket.
|
ReencryptBucketResponse |
reencryptBucket(ReencryptBucketRequest request)
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.
|
ReencryptObjectResponse |
reencryptObject(ReencryptObjectRequest request)
Re-encrypts the data encryption keys that encrypt the object and its chunks.
|
void |
refreshClient()
Rebuild the backing
HttpClient . |
RenameObjectResponse |
renameObject(RenameObjectRequest request)
Rename an object in the given Object Storage namespace.
|
RestoreObjectsResponse |
restoreObjects(RestoreObjectsRequest request)
Restores the object specified by the objectName parameter.
|
void |
setEndpoint(String endpoint) |
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’).
|
void |
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.
|
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.
|
UpdateObjectStorageTierResponse |
updateObjectStorageTier(UpdateObjectStorageTierRequest request)
Changes the storage tier of the object specified by the objectName parameter.
|
UpdatePrivateEndpointResponse |
updatePrivateEndpoint(UpdatePrivateEndpointRequest request)
Performs a partial or full update of a user-defined data associated with the Private
Endpoint.
|
UpdateRetentionRuleResponse |
updateRetentionRule(UpdateRetentionRuleRequest request)
Updates the specified retention rule.
|
UploadPartResponse |
uploadPart(UploadPartRequest request)
Uploads a single part of a multipart upload.
|
void |
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.
|
clientCall
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 ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageClient.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 ObjectStorageClient(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 ObjectStorageClient.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 ObjectStorageClient(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 ObjectStorageClient.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
@Deprecated public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ObjectStorageClient.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
executorService
- ObjectStorageClient.Builder.executorService
protected ClientConfigurator getDefaultConfigurator()
public static ObjectStorageClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
ObjectStorage
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 ObjectStorage
region
- The region of the service.public void setRegion(String regionId)
ObjectStorage
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 ObjectStorage
regionId
- The public region ID.public AbortMultipartUploadResponse abortMultipartUpload(AbortMultipartUploadRequest request)
ObjectStorage
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
abortMultipartUpload
in interface ObjectStorage
request
- The request object containing the details to sendpublic CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
ObjectStorage
Cancels a work request.
cancelWorkRequest
in interface ObjectStorage
request
- The request object containing the details to sendpublic CommitMultipartUploadResponse commitMultipartUpload(CommitMultipartUploadRequest request)
ObjectStorage
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
commitMultipartUpload
in interface ObjectStorage
request
- The request object containing the details to sendpublic CopyObjectResponse copyObject(CopyObjectRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic CreateBucketResponse createBucket(CreateBucketRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUploadRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic CreatePreauthenticatedRequestResponse createPreauthenticatedRequest(CreatePreauthenticatedRequestRequest request)
ObjectStorage
Creates a pre-authenticated request specific to the bucket.
createPreauthenticatedRequest
in interface ObjectStorage
request
- The request object containing the details to sendpublic CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)
ObjectStorage
Create a PrivateEndpoint.
createPrivateEndpoint
in interface ObjectStorage
request
- The request object containing the details to sendpublic CreateReplicationPolicyResponse createReplicationPolicy(CreateReplicationPolicyRequest request)
ObjectStorage
Creates a replication policy for the specified bucket.
createReplicationPolicy
in interface ObjectStorage
request
- The request object containing the details to sendpublic CreateRetentionRuleResponse createRetentionRule(CreateRetentionRuleRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic DeleteBucketResponse deleteBucket(DeleteBucketRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic DeleteObjectResponse deleteObject(DeleteObjectRequest request)
ObjectStorage
Deletes an object.
deleteObject
in interface ObjectStorage
request
- The request object containing the details to sendpublic DeleteObjectLifecyclePolicyResponse deleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest request)
ObjectStorage
Deletes the object lifecycle policy for the bucket.
deleteObjectLifecyclePolicy
in interface ObjectStorage
request
- The request object containing the details to sendpublic DeletePreauthenticatedRequestResponse deletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest request)
ObjectStorage
Deletes the pre-authenticated request for the bucket.
deletePreauthenticatedRequest
in interface ObjectStorage
request
- The request object containing the details to sendpublic DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)
ObjectStorage
Deletes a Private Endpoint if it exists in the given namespace.
deletePrivateEndpoint
in interface ObjectStorage
request
- The request object containing the details to sendpublic DeleteReplicationPolicyResponse deleteReplicationPolicy(DeleteReplicationPolicyRequest request)
ObjectStorage
Deletes the replication policy associated with the source bucket.
deleteReplicationPolicy
in interface ObjectStorage
request
- The request object containing the details to sendpublic DeleteRetentionRuleResponse deleteRetentionRule(DeleteRetentionRuleRequest request)
ObjectStorage
Deletes the specified rule. The deletion takes effect typically within 30 seconds.
deleteRetentionRule
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetBucketResponse getBucket(GetBucketRequest request)
ObjectStorage
Gets the current representation of the given bucket in the given Object Storage namespace.
getBucket
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetNamespaceResponse getNamespace(GetNamespaceRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic GetNamespaceMetadataResponse getNamespaceMetadata(GetNamespaceMetadataRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic GetObjectResponse getObject(GetObjectRequest request)
ObjectStorage
Gets the metadata and body of an object.
getObject
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetObjectLifecyclePolicyResponse getObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest request)
ObjectStorage
Gets the object lifecycle policy for the bucket.
getObjectLifecyclePolicy
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetPreauthenticatedRequestResponse getPreauthenticatedRequest(GetPreauthenticatedRequestRequest request)
ObjectStorage
Gets the pre-authenticated request for the bucket.
getPreauthenticatedRequest
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)
ObjectStorage
Gets the current representation of the given Private Endpoint in the given Object Storage namespace.
getPrivateEndpoint
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetReplicationPolicyResponse getReplicationPolicy(GetReplicationPolicyRequest request)
ObjectStorage
Get the replication policy.
getReplicationPolicy
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetRetentionRuleResponse getRetentionRule(GetRetentionRuleRequest request)
ObjectStorage
Get the specified retention rule.
getRetentionRule
in interface ObjectStorage
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
ObjectStorage
Gets the status of the work request for the given ID.
getWorkRequest
in interface ObjectStorage
request
- The request object containing the details to sendpublic HeadBucketResponse headBucket(HeadBucketRequest request)
ObjectStorage
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
headBucket
in interface ObjectStorage
request
- The request object containing the details to sendpublic HeadObjectResponse headObject(HeadObjectRequest request)
ObjectStorage
Gets the user-defined metadata and entity tag (ETag) for an object.
headObject
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListBucketsResponse listBuckets(ListBucketsRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic ListMultipartUploadPartsResponse listMultipartUploadParts(ListMultipartUploadPartsRequest request)
ObjectStorage
Lists the parts of an in-progress multipart upload.
listMultipartUploadParts
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListMultipartUploadsResponse listMultipartUploads(ListMultipartUploadsRequest request)
ObjectStorage
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
listMultipartUploads
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListObjectVersionsResponse listObjectVersions(ListObjectVersionsRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic ListObjectsResponse listObjects(ListObjectsRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic ListPreauthenticatedRequestsResponse listPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request)
ObjectStorage
Lists pre-authenticated requests for the bucket.
listPreauthenticatedRequests
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic ListReplicationPoliciesResponse listReplicationPolicies(ListReplicationPoliciesRequest request)
ObjectStorage
List the replication policies associated with a bucket.
listReplicationPolicies
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListReplicationSourcesResponse listReplicationSources(ListReplicationSourcesRequest request)
ObjectStorage
List the replication sources of a destination bucket.
listReplicationSources
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListRetentionRulesResponse listRetentionRules(ListRetentionRulesRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
ObjectStorage
Lists the errors of the work request with the given ID.
listWorkRequestErrors
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
ObjectStorage
Lists the logs of the work request with the given ID.
listWorkRequestLogs
in interface ObjectStorage
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
ObjectStorage
Lists the work requests in a compartment.
listWorkRequests
in interface ObjectStorage
request
- The request object containing the details to sendpublic MakeBucketWritableResponse makeBucketWritable(MakeBucketWritableRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic PutObjectResponse putObject(PutObjectRequest request)
ObjectStorage
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.
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int)
and InputStream.reset()
, when a retry is necessary, the stream is reset so it starts at
the beginning (or whatever the stream's position was at the time this operation is called}.
Note this means that if the caller has used InputStream.mark(int)
before,
then the mark will not be the same anymore after this operation, and a subsequent call to
InputStream.reset()
by the caller will reset the stream not to the caller's
mark, but to the position the stream was in when this operation was called.
If the stream is a FileInputStream
, and the stream's FileChannel
position can be changed (like for a regular file), the stream
will be wrapped in such a way that it does provide support for InputStream.mark(int)
and InputStream.reset()
. Then the same
procedure as above is followed. If the stream's FileChannel
position cannot be changed (like for a named pipe), then the stream's contents will be
buffered in memory, as described below.
If the stream does not support InputStream.mark(int)
and InputStream.reset()
, then the stream is wrapped in a BufferedInputStream
, which means the entire contents may be buffered in memory. Then
the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream
whose FileChannel
position can be changed, should be less than 2
GiB in size if retries are used. This is because streams 2 GiB in size or larger do no
guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in
retries and manage retries yourself.
putObject
in interface ObjectStorage
request
- The request object containing the details to sendpublic PutObjectLifecyclePolicyResponse putObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request)
ObjectStorage
Creates or replaces the object lifecycle policy for the bucket.
putObjectLifecyclePolicy
in interface ObjectStorage
request
- The request object containing the details to sendpublic ReencryptBucketResponse reencryptBucket(ReencryptBucketRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic ReencryptObjectResponse reencryptObject(ReencryptObjectRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic RenameObjectResponse renameObject(RenameObjectRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic RestoreObjectsResponse restoreObjects(RestoreObjectsRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic UpdateBucketResponse updateBucket(UpdateBucketRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic UpdateNamespaceMetadataResponse updateNamespaceMetadata(UpdateNamespaceMetadataRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic UpdateObjectStorageTierResponse updateObjectStorageTier(UpdateObjectStorageTierRequest request)
ObjectStorage
Changes the storage tier of the object specified by the objectName parameter.
updateObjectStorageTier
in interface ObjectStorage
request
- The request object containing the details to sendpublic UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)
ObjectStorage
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 ObjectStorage
request
- The request object containing the details to sendpublic UpdateRetentionRuleResponse updateRetentionRule(UpdateRetentionRuleRequest request)
ObjectStorage
Updates the specified retention rule. Rule changes take effect typically within 30 seconds.
updateRetentionRule
in interface ObjectStorage
request
- The request object containing the details to sendpublic UploadPartResponse uploadPart(UploadPartRequest request)
ObjectStorage
Uploads a single part of a multipart upload.
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int)
and InputStream.reset()
, when a retry is necessary, the stream is reset so it starts at
the beginning (or whatever the stream's position was at the time this operation is called}.
Note this means that if the caller has used InputStream.mark(int)
before,
then the mark will not be the same anymore after this operation, and a subsequent call to
InputStream.reset()
by the caller will reset the stream not to the caller's
mark, but to the position the stream was in when this operation was called.
If the stream is a FileInputStream
, and the stream's FileChannel
position can be changed (like for a regular file), the stream
will be wrapped in such a way that it does provide support for InputStream.mark(int)
and InputStream.reset()
. Then the same
procedure as above is followed. If the stream's FileChannel
position cannot be changed (like for a named pipe), then the stream's contents will be
buffered in memory, as described below.
If the stream does not support InputStream.mark(int)
and InputStream.reset()
, then the stream is wrapped in a BufferedInputStream
, which means the entire contents may be buffered in memory. Then
the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream
whose FileChannel
position can be changed, should be less than 2
GiB in size if retries are used. This is because streams 2 GiB in size or larger do no
guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in
retries and manage retries yourself.
uploadPart
in interface ObjectStorage
request
- The request object containing the details to sendpublic ObjectStorageWaiters getWaiters()
ObjectStorage
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ObjectStorage
public ObjectStoragePaginators getPaginators()
ObjectStorage
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.
getPaginators
in interface ObjectStorage
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()
Copyright © 2016–2024. All rights reserved.