ObjectStorageClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.objectstorage.ObjectStorageClient

All Implemented Interfaces:: ObjectStorage, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class ObjectStorageClient
extends Object
implements ObjectStorage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ObjectStorageClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ObjectStorageClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for ObjectStorage.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for ObjectStorage.

Constructor Summary

Constructors
Constructor and Description
`ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
`ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
`ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
`ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
`ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`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.
`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.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for ObjectStorage.
- Constructor Detail
  - ObjectStorageClient
```
public ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - ObjectStorageClient
```
public ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - ObjectStorageClient
```
public ObjectStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - ObjectStorageClient
```
public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - ObjectStorageClient
```
public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - ObjectStorageClient
```
public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - ObjectStorageClient
```
public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - ObjectStorageClient
```
public ObjectStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint,
                           ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
- Method Detail
  - builder
```
public static ObjectStorageClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: ObjectStorage
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface ObjectStorage
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setRegion in interface ObjectStorage
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setRegion in interface ObjectStorage
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - abortMultipartUpload
```
public AbortMultipartUploadResponse abortMultipartUpload(AbortMultipartUploadRequest request)
```
    Description copied from interface: ObjectStorage
    
    Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
    
    Specified by:
    
    abortMultipartUpload in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - cancelWorkRequest
```
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
```
    Description copied from interface: ObjectStorage
    
    Cancels a work request.
    
    Specified by:
    
    cancelWorkRequest in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - commitMultipartUpload
```
public CommitMultipartUploadResponse commitMultipartUpload(CommitMultipartUploadRequest request)
```
    Description copied from interface: ObjectStorage
    
    Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
    
    Specified by:
    
    commitMultipartUpload in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - copyObject
```
public CopyObjectResponse copyObject(CopyObjectRequest request)
```
    Description copied from interface: ObjectStorage
    
    Creates a request to copy an object within a region or to another region.
    
    Specified by:
    
    copyObject in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBucket
```
public CreateBucketResponse createBucket(CreateBucketRequest request)
```
    Description copied from interface: ObjectStorage
    
    Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.
    
    Specified by:
    
    createBucket in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createMultipartUpload
```
public CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUploadRequest request)
```
    Description copied from interface: ObjectStorage
    
    Starts a new multipart upload to a specific object in the given bucket in the given namespace.
    
    Specified by:
    
    createMultipartUpload in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createPreauthenticatedRequest
```
public CreatePreauthenticatedRequestResponse createPreauthenticatedRequest(CreatePreauthenticatedRequestRequest request)
```
    Description copied from interface: ObjectStorage
    
    Creates a pre-authenticated request specific to the bucket.
    
    Specified by:
    
    createPreauthenticatedRequest in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBucket
```
public DeleteBucketResponse deleteBucket(DeleteBucketRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    deleteBucket in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteObject
```
public DeleteObjectResponse deleteObject(DeleteObjectRequest request)
```
    Description copied from interface: ObjectStorage
    
    Deletes an object.
    
    Specified by:
    
    deleteObject in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteObjectLifecyclePolicy
```
public DeleteObjectLifecyclePolicyResponse deleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest request)
```
    Description copied from interface: ObjectStorage
    
    Deletes the object lifecycle policy for the bucket.
    
    Specified by:
    
    deleteObjectLifecyclePolicy in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deletePreauthenticatedRequest
```
public DeletePreauthenticatedRequestResponse deletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest request)
```
    Description copied from interface: ObjectStorage
    
    Deletes the pre-authenticated request for the bucket.
    
    Specified by:
    
    deletePreauthenticatedRequest in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBucket
```
public GetBucketResponse getBucket(GetBucketRequest request)
```
    Description copied from interface: ObjectStorage
    
    Gets the current representation of the given bucket in the given Object Storage namespace.
    
    Specified by:
    
    getBucket in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getNamespace
```
public GetNamespaceResponse getNamespace(GetNamespaceRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    getNamespace in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getNamespaceMetadata
```
public GetNamespaceMetadataResponse getNamespaceMetadata(GetNamespaceMetadataRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    getNamespaceMetadata in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getObject
```
public GetObjectResponse getObject(GetObjectRequest request)
```
    Description copied from interface: ObjectStorage
    
    Gets the metadata and body of an object.
    
    Specified by:
    
    getObject in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getObjectLifecyclePolicy
```
public GetObjectLifecyclePolicyResponse getObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest request)
```
    Description copied from interface: ObjectStorage
    
    Gets the object lifecycle policy for the bucket.
    
    Specified by:
    
    getObjectLifecyclePolicy in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getPreauthenticatedRequest
```
public GetPreauthenticatedRequestResponse getPreauthenticatedRequest(GetPreauthenticatedRequestRequest request)
```
    Description copied from interface: ObjectStorage
    
    Gets the pre-authenticated request for the bucket.
    
    Specified by:
    
    getPreauthenticatedRequest in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: ObjectStorage
    
    Gets the status of the work request for the given ID.
    
    Specified by:
    
    getWorkRequest in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - headBucket
```
public HeadBucketResponse headBucket(HeadBucketRequest request)
```
    Description copied from interface: ObjectStorage
    
    Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
    
    Specified by:
    
    headBucket in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - headObject
```
public HeadObjectResponse headObject(HeadObjectRequest request)
```
    Description copied from interface: ObjectStorage
    
    Gets the user-defined metadata and entity tag (ETag) for an object.
    
    Specified by:
    
    headObject in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBuckets
```
public ListBucketsResponse listBuckets(ListBucketsRequest request)
```
    Description copied from interface: 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.
    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.
    
    Specified by:
    
    listBuckets in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listMultipartUploadParts
```
public ListMultipartUploadPartsResponse listMultipartUploadParts(ListMultipartUploadPartsRequest request)
```
    Description copied from interface: ObjectStorage
    
    Lists the parts of an in-progress multipart upload.
    
    Specified by:
    
    listMultipartUploadParts in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listMultipartUploads
```
public ListMultipartUploadsResponse listMultipartUploads(ListMultipartUploadsRequest request)
```
    Description copied from interface: ObjectStorage
    
    Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
    
    Specified by:
    
    listMultipartUploads in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listObjects
```
public ListObjectsResponse listObjects(ListObjectsRequest request)
```
    Description copied from interface: ObjectStorage
    
    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.
    
    Specified by:
    
    listObjects in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listPreauthenticatedRequests
```
public ListPreauthenticatedRequestsResponse listPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request)
```
    Description copied from interface: ObjectStorage
    
    Lists pre-authenticated requests for the bucket.
    
    Specified by:
    
    listPreauthenticatedRequests in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: ObjectStorage
    
    Lists the errors of the work request with the given ID.
    
    Specified by:
    
    listWorkRequestErrors in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: ObjectStorage
    
    Lists the logs of the work request with the given ID.
    
    Specified by:
    
    listWorkRequestLogs in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: ObjectStorage
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - putObject
```
public PutObjectResponse putObject(PutObjectRequest request)
```
    Description copied from interface: ObjectStorage
    
    Creates a new object or overwrites an existing one. See Special Instructions for Object Storage PUT for request signature requirements.
    
    Specified by:
    
    putObject in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - putObjectLifecyclePolicy
```
public PutObjectLifecyclePolicyResponse putObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request)
```
    Description copied from interface: ObjectStorage
    
    Creates or replaces the object lifecycle policy for the bucket.
    
    Specified by:
    
    putObjectLifecyclePolicy in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - reencryptBucket
```
public ReencryptBucketResponse reencryptBucket(ReencryptBucketRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    reencryptBucket in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - renameObject
```
public RenameObjectResponse renameObject(RenameObjectRequest request)
```
    Description copied from interface: ObjectStorage
    
    Rename an object in the given Object Storage namespace.
    
    Specified by:
    
    renameObject in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restoreObjects
```
public RestoreObjectsResponse restoreObjects(RestoreObjectsRequest request)
```
    Description copied from interface: ObjectStorage
    
    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.
    
    Specified by:
    
    restoreObjects in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBucket
```
public UpdateBucketResponse updateBucket(UpdateBucketRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    updateBucket in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateNamespaceMetadata
```
public UpdateNamespaceMetadataResponse updateNamespaceMetadata(UpdateNamespaceMetadataRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    updateNamespaceMetadata in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - uploadPart
```
public UploadPartResponse uploadPart(UploadPartRequest request)
```
    Description copied from interface: ObjectStorage
    
    Uploads a single part of a multipart upload.
    
    Specified by:
    
    uploadPart in interface ObjectStorage
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public ObjectStorageWaiters getWaiters()
```
    Description copied from interface: ObjectStorage
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface ObjectStorage
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public ObjectStoragePaginators getPaginators()
```
    Description copied from interface: 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.
    
    Specified by:
    
    getPaginators in interface ObjectStorage
    
    Returns:
    
    The service paginators.

Class ObjectStorageClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

ObjectStorageClient

ObjectStorageClient

ObjectStorageClient

ObjectStorageClient

ObjectStorageClient

ObjectStorageClient

ObjectStorageClient

ObjectStorageClient

Method Detail

builder

setEndpoint

setRegion

setRegion

close

abortMultipartUpload

cancelWorkRequest

commitMultipartUpload

copyObject

createBucket

createMultipartUpload

createPreauthenticatedRequest

deleteBucket

deleteObject

deleteObjectLifecyclePolicy

deletePreauthenticatedRequest

getBucket

getNamespace

getNamespaceMetadata

getObject

getObjectLifecyclePolicy

getPreauthenticatedRequest

getWorkRequest

headBucket

headObject

listBuckets

listMultipartUploadParts

listMultipartUploads

listObjects

listPreauthenticatedRequests

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

putObject

putObjectLifecyclePolicy

reencryptBucket

renameObject

restoreObjects

updateBucket

updateNamespaceMetadata

uploadPart

getWaiters

getPaginators