@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface MediaStoreAsyncClient extends AwsClient
builder()
method.
An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static MediaStoreAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
MediaStoreAsyncClient. |
static MediaStoreAsyncClient |
create()
Create a
MediaStoreAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateContainerResponse> |
createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest)
Creates a storage container to hold objects.
|
default CompletableFuture<CreateContainerResponse> |
createContainer(CreateContainerRequest createContainerRequest)
Creates a storage container to hold objects.
|
default CompletableFuture<DeleteContainerResponse> |
deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest)
Deletes the specified container.
|
default CompletableFuture<DeleteContainerResponse> |
deleteContainer(DeleteContainerRequest deleteContainerRequest)
Deletes the specified container.
|
default CompletableFuture<DeleteContainerPolicyResponse> |
deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
|
default CompletableFuture<DeleteContainerPolicyResponse> |
deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
|
default CompletableFuture<DeleteCorsPolicyResponse> |
deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<DeleteCorsPolicyResponse> |
deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<DeleteLifecyclePolicyResponse> |
deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
Removes an object lifecycle policy from a container.
|
default CompletableFuture<DeleteLifecyclePolicyResponse> |
deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
Removes an object lifecycle policy from a container.
|
default CompletableFuture<DeleteMetricPolicyResponse> |
deleteMetricPolicy(Consumer<DeleteMetricPolicyRequest.Builder> deleteMetricPolicyRequest)
Deletes the metric policy that is associated with the specified container.
|
default CompletableFuture<DeleteMetricPolicyResponse> |
deleteMetricPolicy(DeleteMetricPolicyRequest deleteMetricPolicyRequest)
Deletes the metric policy that is associated with the specified container.
|
default CompletableFuture<DescribeContainerResponse> |
describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)
Retrieves the properties of the requested container.
|
default CompletableFuture<DescribeContainerResponse> |
describeContainer(DescribeContainerRequest describeContainerRequest)
Retrieves the properties of the requested container.
|
default CompletableFuture<GetContainerPolicyResponse> |
getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest)
Retrieves the access policy for the specified container.
|
default CompletableFuture<GetContainerPolicyResponse> |
getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest)
Retrieves the access policy for the specified container.
|
default CompletableFuture<GetCorsPolicyResponse> |
getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<GetCorsPolicyResponse> |
getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<GetLifecyclePolicyResponse> |
getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)
Retrieves the object lifecycle policy that is assigned to a container.
|
default CompletableFuture<GetLifecyclePolicyResponse> |
getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
Retrieves the object lifecycle policy that is assigned to a container.
|
default CompletableFuture<GetMetricPolicyResponse> |
getMetricPolicy(Consumer<GetMetricPolicyRequest.Builder> getMetricPolicyRequest)
Returns the metric policy for the specified container.
|
default CompletableFuture<GetMetricPolicyResponse> |
getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest)
Returns the metric policy for the specified container.
|
default CompletableFuture<ListContainersResponse> |
listContainers()
Lists the properties of all containers in AWS Elemental MediaStore.
|
default CompletableFuture<ListContainersResponse> |
listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default CompletableFuture<ListContainersResponse> |
listContainers(ListContainersRequest listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersPublisher |
listContainersPaginator()
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersPublisher |
listContainersPaginator(Consumer<ListContainersRequest.Builder> listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersPublisher |
listContainersPaginator(ListContainersRequest listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of the tags assigned to the specified container.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified container.
|
default CompletableFuture<PutContainerPolicyResponse> |
putContainerPolicy(Consumer<PutContainerPolicyRequest.Builder> putContainerPolicyRequest)
Creates an access policy for the specified container to restrict the users and clients that can access it.
|
default CompletableFuture<PutContainerPolicyResponse> |
putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest)
Creates an access policy for the specified container to restrict the users and clients that can access it.
|
default CompletableFuture<PutCorsPolicyResponse> |
putCorsPolicy(Consumer<PutCorsPolicyRequest.Builder> putCorsPolicyRequest)
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service
cross-origin requests.
|
default CompletableFuture<PutCorsPolicyResponse> |
putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest)
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service
cross-origin requests.
|
default CompletableFuture<PutLifecyclePolicyResponse> |
putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest)
Writes an object lifecycle policy to a container.
|
default CompletableFuture<PutLifecyclePolicyResponse> |
putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
Writes an object lifecycle policy to a container.
|
default CompletableFuture<PutMetricPolicyResponse> |
putMetricPolicy(Consumer<PutMetricPolicyRequest.Builder> putMetricPolicyRequest)
The metric policy that you want to add to the container.
|
default CompletableFuture<PutMetricPolicyResponse> |
putMetricPolicy(PutMetricPolicyRequest putMetricPolicyRequest)
The metric policy that you want to add to the container.
|
default MediaStoreServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartAccessLoggingResponse> |
startAccessLogging(Consumer<StartAccessLoggingRequest.Builder> startAccessLoggingRequest)
Starts access logging on the specified container.
|
default CompletableFuture<StartAccessLoggingResponse> |
startAccessLogging(StartAccessLoggingRequest startAccessLoggingRequest)
Starts access logging on the specified container.
|
default CompletableFuture<StopAccessLoggingResponse> |
stopAccessLogging(Consumer<StopAccessLoggingRequest.Builder> stopAccessLoggingRequest)
Stops access logging on the specified container.
|
default CompletableFuture<StopAccessLoggingResponse> |
stopAccessLogging(StopAccessLoggingRequest stopAccessLoggingRequest)
Stops access logging on the specified container.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to the specified AWS Elemental MediaStore container.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to the specified AWS Elemental MediaStore container.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified container.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified container.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateContainerResponse> createContainer(CreateContainerRequest createContainerRequest)
Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
createContainerRequest - default CompletableFuture<CreateContainerResponse> createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest)
Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
This is a convenience which creates an instance of the CreateContainerRequest.Builder avoiding the need
to create one manually via CreateContainerRequest.builder()
createContainerRequest - A Consumer that will call methods on
CreateContainerRequest.Builder to create a
request.default CompletableFuture<DeleteContainerResponse> deleteContainer(DeleteContainerRequest deleteContainerRequest)
Deletes the specified container. Before you make a DeleteContainer request, delete any objects in
the container or in any folders in the container. You can delete only empty containers.
deleteContainerRequest - default CompletableFuture<DeleteContainerResponse> deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest)
Deletes the specified container. Before you make a DeleteContainer request, delete any objects in
the container or in any folders in the container. You can delete only empty containers.
This is a convenience which creates an instance of the DeleteContainerRequest.Builder avoiding the need
to create one manually via DeleteContainerRequest.builder()
deleteContainerRequest - A Consumer that will call methods on
DeleteContainerRequest.Builder to create a
request.default CompletableFuture<DeleteContainerPolicyResponse> deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
deleteContainerPolicyRequest - default CompletableFuture<DeleteContainerPolicyResponse> deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
This is a convenience which creates an instance of the DeleteContainerPolicyRequest.Builder avoiding the
need to create one manually via DeleteContainerPolicyRequest.builder()
deleteContainerPolicyRequest - A Consumer that will call methods on
DeleteContainerPolicyRequest.Builder to create a
request.default CompletableFuture<DeleteCorsPolicyResponse> deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action.
The container owner has this permission by default and can grant this permission to others.
deleteCorsPolicyRequest - default CompletableFuture<DeleteCorsPolicyResponse> deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action.
The container owner has this permission by default and can grant this permission to others.
This is a convenience which creates an instance of the DeleteCorsPolicyRequest.Builder avoiding the need
to create one manually via DeleteCorsPolicyRequest.builder()
deleteCorsPolicyRequest - A Consumer that will call methods on
DeleteCorsPolicyRequest.Builder to create a
request.default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
deleteLifecyclePolicyRequest - default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the
need to create one manually via DeleteLifecyclePolicyRequest.builder()
deleteLifecyclePolicyRequest - A Consumer that will call methods on
DeleteLifecyclePolicyRequest.Builder to create a
request.default CompletableFuture<DeleteMetricPolicyResponse> deleteMetricPolicy(DeleteMetricPolicyRequest deleteMetricPolicyRequest)
Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.
deleteMetricPolicyRequest - default CompletableFuture<DeleteMetricPolicyResponse> deleteMetricPolicy(Consumer<DeleteMetricPolicyRequest.Builder> deleteMetricPolicyRequest)
Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.
This is a convenience which creates an instance of the DeleteMetricPolicyRequest.Builder avoiding the
need to create one manually via DeleteMetricPolicyRequest.builder()
deleteMetricPolicyRequest - A Consumer that will call methods on
DeleteMetricPolicyRequest.Builder to create a
request.default CompletableFuture<DescribeContainerResponse> describeContainer(DescribeContainerRequest describeContainerRequest)
Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a
container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint
does not change after it has been assigned. The DescribeContainer request returns a single
Container object based on ContainerName. To return all Container objects
that are associated with a specified AWS account, use ListContainers.
describeContainerRequest - default CompletableFuture<DescribeContainerResponse> describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)
Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a
container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint
does not change after it has been assigned. The DescribeContainer request returns a single
Container object based on ContainerName. To return all Container objects
that are associated with a specified AWS account, use ListContainers.
This is a convenience which creates an instance of the DescribeContainerRequest.Builder avoiding the need
to create one manually via DescribeContainerRequest.builder()
describeContainerRequest - A Consumer that will call methods on
DescribeContainerRequest.Builder to create a
request.default CompletableFuture<GetContainerPolicyResponse> getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest)
Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
getContainerPolicyRequest - default CompletableFuture<GetContainerPolicyResponse> getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest)
Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
This is a convenience which creates an instance of the GetContainerPolicyRequest.Builder avoiding the
need to create one manually via GetContainerPolicyRequest.builder()
getContainerPolicyRequest - A Consumer that will call methods on
GetContainerPolicyRequest.Builder to create a
request.default CompletableFuture<GetCorsPolicyResponse> getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By
default, the container owner has this permission and can grant it to others.
getCorsPolicyRequest - default CompletableFuture<GetCorsPolicyResponse> getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By
default, the container owner has this permission and can grant it to others.
This is a convenience which creates an instance of the GetCorsPolicyRequest.Builder avoiding the need to
create one manually via GetCorsPolicyRequest.builder()
getCorsPolicyRequest - A Consumer that will call methods on
GetCorsPolicyRequest.Builder to create a request.default CompletableFuture<GetLifecyclePolicyResponse> getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
Retrieves the object lifecycle policy that is assigned to a container.
getLifecyclePolicyRequest - default CompletableFuture<GetLifecyclePolicyResponse> getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)
Retrieves the object lifecycle policy that is assigned to a container.
This is a convenience which creates an instance of the GetLifecyclePolicyRequest.Builder avoiding the
need to create one manually via GetLifecyclePolicyRequest.builder()
getLifecyclePolicyRequest - A Consumer that will call methods on
GetLifecyclePolicyRequest.Builder to create a
request.default CompletableFuture<GetMetricPolicyResponse> getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest)
Returns the metric policy for the specified container.
getMetricPolicyRequest - default CompletableFuture<GetMetricPolicyResponse> getMetricPolicy(Consumer<GetMetricPolicyRequest.Builder> getMetricPolicyRequest)
Returns the metric policy for the specified container.
This is a convenience which creates an instance of the GetMetricPolicyRequest.Builder avoiding the need
to create one manually via GetMetricPolicyRequest.builder()
getMetricPolicyRequest - A Consumer that will call methods on
GetMetricPolicyRequest.Builder to create a
request.default CompletableFuture<ListContainersResponse> listContainers(ListContainersRequest listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you can include the MaxResults
parameter to receive a limited number of containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this time with the NextToken
parameter (with the returned token as its value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
listContainersRequest - default CompletableFuture<ListContainersResponse> listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you can include the MaxResults
parameter to receive a limited number of containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this time with the NextToken
parameter (with the returned token as its value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
This is a convenience which creates an instance of the ListContainersRequest.Builder avoiding the need to
create one manually via ListContainersRequest.builder()
listContainersRequest - A Consumer that will call methods on
ListContainersRequest.Builder to create a
request.default CompletableFuture<ListContainersResponse> listContainers()
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you can include the MaxResults
parameter to receive a limited number of containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this time with the NextToken
parameter (with the returned token as its value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
default ListContainersPublisher listContainersPaginator()
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you can include the MaxResults
parameter to receive a limited number of containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this time with the NextToken
parameter (with the returned token as its value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
This is a variant of
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediastore.paginators.ListContainersPublisher publisher = client.listContainersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediastore.paginators.ListContainersPublisher publisher = client.listContainersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediastore.model.ListContainersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediastore.model.ListContainersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.
default ListContainersPublisher listContainersPaginator(ListContainersRequest listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you can include the MaxResults
parameter to receive a limited number of containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this time with the NextToken
parameter (with the returned token as its value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
This is a variant of
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediastore.paginators.ListContainersPublisher publisher = client.listContainersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediastore.paginators.ListContainersPublisher publisher = client.listContainersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediastore.model.ListContainersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediastore.model.ListContainersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.
listContainersRequest - default ListContainersPublisher listContainersPaginator(Consumer<ListContainersRequest.Builder> listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you can include the MaxResults
parameter to receive a limited number of containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this time with the NextToken
parameter (with the returned token as its value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
This is a variant of
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediastore.paginators.ListContainersPublisher publisher = client.listContainersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediastore.paginators.ListContainersPublisher publisher = client.listContainersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediastore.model.ListContainersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediastore.model.ListContainersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.
This is a convenience which creates an instance of the ListContainersRequest.Builder avoiding the need to
create one manually via ListContainersRequest.builder()
listContainersRequest - A Consumer that will call methods on
ListContainersRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified container.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of the tags assigned to the specified container.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PutContainerPolicyResponse> putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest)
Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
For this release of the REST API, you can create only one policy for a container. If you enter
PutContainerPolicy twice, the second command modifies the existing policy.
putContainerPolicyRequest - default CompletableFuture<PutContainerPolicyResponse> putContainerPolicy(Consumer<PutContainerPolicyRequest.Builder> putContainerPolicyRequest)
Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
For this release of the REST API, you can create only one policy for a container. If you enter
PutContainerPolicy twice, the second command modifies the existing policy.
This is a convenience which creates an instance of the PutContainerPolicyRequest.Builder avoiding the
need to create one manually via PutContainerPolicyRequest.builder()
putContainerPolicyRequest - A Consumer that will call methods on
PutContainerPolicyRequest.Builder to create a
request.default CompletableFuture<PutCorsPolicyResponse> putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest)
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.
To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.
putCorsPolicyRequest - default CompletableFuture<PutCorsPolicyResponse> putCorsPolicy(Consumer<PutCorsPolicyRequest.Builder> putCorsPolicyRequest)
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.
To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.
This is a convenience which creates an instance of the PutCorsPolicyRequest.Builder avoiding the need to
create one manually via PutCorsPolicyRequest.builder()
putCorsPolicyRequest - A Consumer that will call methods on
PutCorsPolicyRequest.Builder to create a request.default CompletableFuture<PutLifecyclePolicyResponse> putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.
For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.
putLifecyclePolicyRequest - default CompletableFuture<PutLifecyclePolicyResponse> putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest)
Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.
For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.
This is a convenience which creates an instance of the PutLifecyclePolicyRequest.Builder avoiding the
need to create one manually via PutLifecyclePolicyRequest.builder()
putLifecyclePolicyRequest - A Consumer that will call methods on
PutLifecyclePolicyRequest.Builder to create a
request.default CompletableFuture<PutMetricPolicyResponse> putMetricPolicy(PutMetricPolicyRequest putMetricPolicyRequest)
The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.
putMetricPolicyRequest - default CompletableFuture<PutMetricPolicyResponse> putMetricPolicy(Consumer<PutMetricPolicyRequest.Builder> putMetricPolicyRequest)
The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.
This is a convenience which creates an instance of the PutMetricPolicyRequest.Builder avoiding the need
to create one manually via PutMetricPolicyRequest.builder()
putMetricPolicyRequest - A Consumer that will call methods on
PutMetricPolicyRequest.Builder to create a
request.default CompletableFuture<StartAccessLoggingResponse> startAccessLogging(StartAccessLoggingRequest startAccessLoggingRequest)
Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.
startAccessLoggingRequest - default CompletableFuture<StartAccessLoggingResponse> startAccessLogging(Consumer<StartAccessLoggingRequest.Builder> startAccessLoggingRequest)
Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.
This is a convenience which creates an instance of the StartAccessLoggingRequest.Builder avoiding the
need to create one manually via StartAccessLoggingRequest.builder()
startAccessLoggingRequest - A Consumer that will call methods on
StartAccessLoggingRequest.Builder to create a
request.default CompletableFuture<StopAccessLoggingResponse> stopAccessLogging(StopAccessLoggingRequest stopAccessLoggingRequest)
Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.
stopAccessLoggingRequest - default CompletableFuture<StopAccessLoggingResponse> stopAccessLogging(Consumer<StopAccessLoggingRequest.Builder> stopAccessLoggingRequest)
Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.
This is a convenience which creates an instance of the StopAccessLoggingRequest.Builder avoiding the need
to create one manually via StopAccessLoggingRequest.builder()
stopAccessLoggingRequest - A Consumer that will call methods on
StopAccessLoggingRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified container. You can specify one or more tags to remove.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified container. You can specify one or more tags to remove.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.default MediaStoreServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic MediaStoreAsyncClient create()
MediaStoreAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static MediaStoreAsyncClientBuilder builder()
MediaStoreAsyncClient.Copyright © 2023. All rights reserved.