Package software.amazon.awssdk.services.mediastoredata

Interface MediaStoreDataClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MediaStoreDataClient
extends AwsClient

Service client for accessing MediaStore Data. This can be created using the static builder() method.

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service. Objects are the fundamental entities that are stored in AWS Elemental MediaStore.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MediaStoreDataClientBuilder	builder()	Create a builder that can be used to configure and create a MediaStoreDataClient.
static MediaStoreDataClient	create()	Create a MediaStoreDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteObjectResponse	deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)	Deletes an object at the specified path.
default DeleteObjectResponse	deleteObject(DeleteObjectRequest deleteObjectRequest)	Deletes an object at the specified path.
default DescribeObjectResponse	describeObject(Consumer<DescribeObjectRequest.Builder> describeObjectRequest)	Gets the headers for an object at the specified path.
default DescribeObjectResponse	describeObject(DescribeObjectRequest describeObjectRequest)	Gets the headers for an object at the specified path.
default ResponseInputStream<GetObjectResponse>	getObject(Consumer<GetObjectRequest.Builder> getObjectRequest)	Downloads the object at the specified path.
default GetObjectResponse	getObject(Consumer<GetObjectRequest.Builder> getObjectRequest, Path destinationPath)	Downloads the object at the specified path.
default <ReturnT> ReturnT	getObject(Consumer<GetObjectRequest.Builder> getObjectRequest, ResponseTransformer<GetObjectResponse,ReturnT> responseTransformer)	Downloads the object at the specified path.
default ResponseInputStream<GetObjectResponse>	getObject(GetObjectRequest getObjectRequest)	Downloads the object at the specified path.
default GetObjectResponse	getObject(GetObjectRequest getObjectRequest, Path destinationPath)	Downloads the object at the specified path.
default <ReturnT> ReturnT	getObject(GetObjectRequest getObjectRequest, ResponseTransformer<GetObjectResponse,ReturnT> responseTransformer)	Downloads the object at the specified path.
default ResponseBytes<GetObjectResponse>	getObjectAsBytes(Consumer<GetObjectRequest.Builder> getObjectRequest)	Downloads the object at the specified path.
default ResponseBytes<GetObjectResponse>	getObjectAsBytes(GetObjectRequest getObjectRequest)	Downloads the object at the specified path.
default ListItemsResponse	listItems(Consumer<ListItemsRequest.Builder> listItemsRequest)	Provides a list of metadata entries about folders and objects in the specified folder.
default ListItemsResponse	listItems(ListItemsRequest listItemsRequest)	Provides a list of metadata entries about folders and objects in the specified folder.
default ListItemsIterable	listItemsPaginator(Consumer<ListItemsRequest.Builder> listItemsRequest)	This is a variant of listItems(software.amazon.awssdk.services.mediastoredata.model.ListItemsRequest) operation.
default ListItemsIterable	listItemsPaginator(ListItemsRequest listItemsRequest)	This is a variant of listItems(software.amazon.awssdk.services.mediastoredata.model.ListItemsRequest) operation.
default PutObjectResponse	putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, Path sourcePath)	Uploads an object to the specified path.
default PutObjectResponse	putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, RequestBody requestBody)	Uploads an object to the specified path.
default PutObjectResponse	putObject(PutObjectRequest putObjectRequest, Path sourcePath)	Uploads an object to the specified path.
default PutObjectResponse	putObject(PutObjectRequest putObjectRequest, RequestBody requestBody)	Uploads an object to the specified path.
default MediaStoreDataServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

deleteObject

default DeleteObjectResponse deleteObject(DeleteObjectRequest deleteObjectRequest)
                                   throws ContainerNotFoundException,
ObjectNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Deletes an object at the specified path.

Parameters:

deleteObjectRequest -

Returns:

Result of the DeleteObject operation returned by the service.

See Also:

• AWS API Documentation

deleteObject

default DeleteObjectResponse deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
                                   throws ContainerNotFoundException,
ObjectNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Deletes an object at the specified path.

This is a convenience which creates an instance of the DeleteObjectRequest.Builder avoiding the need to create one manually via DeleteObjectRequest.builder()

Parameters:

deleteObjectRequest - A Consumer that will call methods on DeleteObjectRequest.Builder to create a request.

Returns:

Result of the DeleteObject operation returned by the service.

See Also:

• AWS API Documentation

describeObject

default DescribeObjectResponse describeObject(DescribeObjectRequest describeObjectRequest)
                                       throws ContainerNotFoundException,
ObjectNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Gets the headers for an object at the specified path.

Parameters:

describeObjectRequest -

Returns:

Result of the DescribeObject operation returned by the service.

See Also:

• AWS API Documentation

describeObject

default DescribeObjectResponse describeObject(Consumer<DescribeObjectRequest.Builder> describeObjectRequest)
                                       throws ContainerNotFoundException,
ObjectNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Gets the headers for an object at the specified path.

This is a convenience which creates an instance of the DescribeObjectRequest.Builder avoiding the need to create one manually via DescribeObjectRequest.builder()

Parameters:

describeObjectRequest - A Consumer that will call methods on DescribeObjectRequest.Builder to create a request.

Returns:

Result of the DescribeObject operation returned by the service.

See Also:

• AWS API Documentation

getObject

default <ReturnT> ReturnT getObject(GetObjectRequest getObjectRequest,
 ResponseTransformer<GetObjectResponse,ReturnT> responseTransformer)
                             throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

Parameters:

getObjectRequest -

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetObjectResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The bytes of the object.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation

getObject

default <ReturnT> ReturnT getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
 ResponseTransformer<GetObjectResponse,ReturnT> responseTransformer)
                             throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

This is a convenience which creates an instance of the GetObjectRequest.Builder avoiding the need to create one manually via GetObjectRequest.builder()

Parameters:

getObjectRequest - A Consumer that will call methods on GetObjectRequest.Builder to create a request.

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetObjectResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The bytes of the object.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation

getObject

default GetObjectResponse getObject(GetObjectRequest getObjectRequest,
 Path destinationPath)
                             throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

Parameters:

getObjectRequest -

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The bytes of the object.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• getObject(GetObjectRequest, ResponseTransformer)
• AWS API Documentation

getObject

default GetObjectResponse getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
 Path destinationPath)
                             throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

This is a convenience which creates an instance of the GetObjectRequest.Builder avoiding the need to create one manually via GetObjectRequest.builder()

Parameters:

getObjectRequest - A Consumer that will call methods on GetObjectRequest.Builder to create a request.

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The bytes of the object.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• getObject(GetObjectRequest, ResponseTransformer)
• AWS API Documentation

getObject

default ResponseInputStream<GetObjectResponse> getObject(GetObjectRequest getObjectRequest)
                                                  throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

Parameters:

getObjectRequest -

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The bytes of the object.

'.

See Also:

• getObject(getObject, ResponseTransformer)
• AWS API Documentation

getObject

default ResponseInputStream<GetObjectResponse> getObject(Consumer<GetObjectRequest.Builder> getObjectRequest)
                                                  throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

This is a convenience which creates an instance of the GetObjectRequest.Builder avoiding the need to create one manually via GetObjectRequest.builder()

Parameters:

getObjectRequest - A Consumer that will call methods on GetObjectRequest.Builder to create a request.

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The bytes of the object.

'.

See Also:

• getObject(getObject, ResponseTransformer)
• AWS API Documentation

getObjectAsBytes

default ResponseBytes<GetObjectResponse> getObjectAsBytes(GetObjectRequest getObjectRequest)
                                                   throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

Parameters:

getObjectRequest -

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The bytes of the object.

'.

See Also:

• getObject(getObject, ResponseTransformer)
• AWS API Documentation

getObjectAsBytes

default ResponseBytes<GetObjectResponse> getObjectAsBytes(Consumer<GetObjectRequest.Builder> getObjectRequest)
                                                   throws ContainerNotFoundException,
ObjectNotFoundException,
RequestedRangeNotSatisfiableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

This is a convenience which creates an instance of the GetObjectRequest.Builder avoiding the need to create one manually via GetObjectRequest.builder()

Parameters:

getObjectRequest - A Consumer that will call methods on GetObjectRequest.Builder to create a request.

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The bytes of the object.

'.

See Also:

• getObject(getObject, ResponseTransformer)
• AWS API Documentation

listItems

default ListItemsResponse listItems(ListItemsRequest listItemsRequest)
                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Provides a list of metadata entries about folders and objects in the specified folder.

Parameters:

listItemsRequest -

Returns:

Result of the ListItems operation returned by the service.

See Also:

• AWS API Documentation

listItems

default ListItemsResponse listItems(Consumer<ListItemsRequest.Builder> listItemsRequest)
                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Provides a list of metadata entries about folders and objects in the specified folder.

This is a convenience which creates an instance of the ListItemsRequest.Builder avoiding the need to create one manually via ListItemsRequest.builder()

Parameters:

listItemsRequest - A Consumer that will call methods on ListItemsRequest.Builder to create a request.

Returns:

Result of the ListItems operation returned by the service.

See Also:

• AWS API Documentation

listItemsPaginator

default ListItemsIterable listItemsPaginator(ListItemsRequest listItemsRequest)
                                      throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

This is a variant of listItems(software.amazon.awssdk.services.mediastoredata.model.ListItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mediastoredata.paginators.ListItemsIterable responses = client.listItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mediastoredata.paginators.ListItemsIterable responses = client.listItemsPaginator(request);
     for (software.amazon.awssdk.services.mediastoredata.model.ListItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mediastoredata.paginators.ListItemsIterable responses = client.listItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listItems(software.amazon.awssdk.services.mediastoredata.model.ListItemsRequest) operation.

Parameters:

listItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listItemsPaginator

default ListItemsIterable listItemsPaginator(Consumer<ListItemsRequest.Builder> listItemsRequest)
                                      throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

This is a variant of listItems(software.amazon.awssdk.services.mediastoredata.model.ListItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mediastoredata.paginators.ListItemsIterable responses = client.listItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mediastoredata.paginators.ListItemsIterable responses = client.listItemsPaginator(request);
     for (software.amazon.awssdk.services.mediastoredata.model.ListItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mediastoredata.paginators.ListItemsIterable responses = client.listItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listItems(software.amazon.awssdk.services.mediastoredata.model.ListItemsRequest) operation.

This is a convenience which creates an instance of the ListItemsRequest.Builder avoiding the need to create one manually via ListItemsRequest.builder()

Parameters:

listItemsRequest - A Consumer that will call methods on ListItemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putObject

default PutObjectResponse putObject(PutObjectRequest putObjectRequest,
 RequestBody requestBody)
                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

Parameters:

putObjectRequest -

requestBody - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following.

 RequestBody.fromFile(new File("myfile.txt"))
 

See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

The bytes to be stored.

'

Returns:

Result of the PutObject operation returned by the service.

See Also:

• AWS API Documentation

putObject

default PutObjectResponse putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
 RequestBody requestBody)
                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

This is a convenience which creates an instance of the PutObjectRequest.Builder avoiding the need to create one manually via PutObjectRequest.builder()

Parameters:

putObjectRequest - A Consumer that will call methods on PutObjectRequest.Builder to create a request.

requestBody - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following.

 RequestBody.fromFile(new File("myfile.txt"))
 

See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

The bytes to be stored.

'

Returns:

Result of the PutObject operation returned by the service.

See Also:

• AWS API Documentation

putObject

default PutObjectResponse putObject(PutObjectRequest putObjectRequest,
 Path sourcePath)
                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

Parameters:

putObjectRequest -

sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows '

The bytes to be stored.

'

Returns:

Result of the PutObject operation returned by the service.

See Also:

• putObject(PutObjectRequest, RequestBody)
• AWS API Documentation

putObject

default PutObjectResponse putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
 Path sourcePath)
                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreDataException

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

This is a convenience which creates an instance of the PutObjectRequest.Builder avoiding the need to create one manually via PutObjectRequest.builder()

Parameters:

putObjectRequest - A Consumer that will call methods on PutObjectRequest.Builder to create a request.

sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows '

The bytes to be stored.

'

Returns:

Result of the PutObject operation returned by the service.

See Also:

• putObject(PutObjectRequest, RequestBody)
• AWS API Documentation

create

static MediaStoreDataClient create()

Create a MediaStoreDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MediaStoreDataClientBuilder builder()

Create a builder that can be used to configure and create a MediaStoreDataClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MediaStoreDataServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration