@Generated(value="software.amazon.awssdk:codegen") public interface SnowballAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
AWS Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static SnowballAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SnowballAsyncClient . |
default CompletableFuture<CancelClusterResponse> |
cancelCluster(CancelClusterRequest cancelClusterRequest)
Cancels a cluster job.
|
default CompletableFuture<CancelClusterResponse> |
cancelCluster(Consumer<CancelClusterRequest.Builder> cancelClusterRequest)
Cancels a cluster job.
|
default CompletableFuture<CancelJobResponse> |
cancelJob(CancelJobRequest cancelJobRequest)
Cancels the specified job.
|
default CompletableFuture<CancelJobResponse> |
cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)
Cancels the specified job.
|
static SnowballAsyncClient |
create()
Create a
SnowballAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<CreateAddressResponse> |
createAddress(Consumer<CreateAddressRequest.Builder> createAddressRequest)
Creates an address for a Snowball to be shipped to.
|
default CompletableFuture<CreateAddressResponse> |
createAddress(CreateAddressRequest createAddressRequest)
Creates an address for a Snowball to be shipped to.
|
default CompletableFuture<CreateClusterResponse> |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates an empty cluster.
|
default CompletableFuture<CreateClusterResponse> |
createCluster(CreateClusterRequest createClusterRequest)
Creates an empty cluster.
|
default CompletableFuture<CreateJobResponse> |
createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates a job to import or export data between Amazon S3 and your on-premises data center.
|
default CompletableFuture<CreateJobResponse> |
createJob(CreateJobRequest createJobRequest)
Creates a job to the other job attributes are inherited from the cluster.
|
default CompletableFuture<DescribeAddressResponse> |
describeAddress(Consumer<DescribeAddressRequest.Builder> describeAddressRequest)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
default CompletableFuture<DescribeAddressResponse> |
describeAddress(DescribeAddressRequest describeAddressRequest)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
default CompletableFuture<DescribeAddressesResponse> |
describeAddresses()
Returns a specified number of
ADDRESS objects. |
default CompletableFuture<DescribeAddressesResponse> |
describeAddresses(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
default CompletableFuture<DescribeAddressesResponse> |
describeAddresses(DescribeAddressesRequest describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
default DescribeAddressesPublisher |
describeAddressesPaginator()
Returns a specified number of
ADDRESS objects. |
default DescribeAddressesPublisher |
describeAddressesPaginator(DescribeAddressesRequest describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
default CompletableFuture<DescribeClusterResponse> |
describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
default CompletableFuture<DescribeClusterResponse> |
describeCluster(DescribeClusterRequest describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
default CompletableFuture<DescribeJobResponse> |
describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
default CompletableFuture<DescribeJobResponse> |
describeJob(DescribeJobRequest describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
default CompletableFuture<GetJobManifestResponse> |
getJobManifest(Consumer<GetJobManifestRequest.Builder> getJobManifestRequest)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
default CompletableFuture<GetJobManifestResponse> |
getJobManifest(GetJobManifestRequest getJobManifestRequest)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
default CompletableFuture<GetJobUnlockCodeResponse> |
getJobUnlockCode(Consumer<GetJobUnlockCodeRequest.Builder> getJobUnlockCodeRequest)
Returns the
UnlockCode code value for the specified job. |
default CompletableFuture<GetJobUnlockCodeResponse> |
getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)
Returns the
UnlockCode code value for the specified job. |
default CompletableFuture<GetSnowballUsageResponse> |
getSnowballUsage()
Returns information about the Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
default CompletableFuture<GetSnowballUsageResponse> |
getSnowballUsage(Consumer<GetSnowballUsageRequest.Builder> getSnowballUsageRequest)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
default CompletableFuture<GetSnowballUsageResponse> |
getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
default CompletableFuture<ListClusterJobsResponse> |
listClusterJobs(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default CompletableFuture<ListClusterJobsResponse> |
listClusterJobs(ListClusterJobsRequest listClusterJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default CompletableFuture<ListClustersResponse> |
listClusters()
Returns an array of
ClusterListEntry objects of the specified length. |
default CompletableFuture<ListClustersResponse> |
listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns an array of
ClusterListEntry objects of the specified length. |
default CompletableFuture<ListClustersResponse> |
listClusters(ListClustersRequest listClustersRequest)
Returns an array of
ClusterListEntry objects of the specified length. |
default CompletableFuture<ListJobsResponse> |
listJobs()
Returns an array of
JobListEntry objects of the specified length. |
default CompletableFuture<ListJobsResponse> |
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default CompletableFuture<ListJobsResponse> |
listJobs(ListJobsRequest listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default ListJobsPublisher |
listJobsPaginator()
Returns an array of
JobListEntry objects of the specified length. |
default ListJobsPublisher |
listJobsPaginator(ListJobsRequest listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default CompletableFuture<UpdateClusterResponse> |
updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
While a cluster's
ClusterState value is in the AwaitingQuorum state, you can update
some of the information associated with a cluster. |
default CompletableFuture<UpdateClusterResponse> |
updateCluster(UpdateClusterRequest updateClusterRequest)
While a cluster's
ClusterState value is in the AwaitingQuorum state, you can update
some of the information associated with a cluster. |
default CompletableFuture<UpdateJobResponse> |
updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest)
While a job's
JobState value is New , you can update some of the information associated
with a job. |
default CompletableFuture<UpdateJobResponse> |
updateJob(UpdateJobRequest updateJobRequest)
While a job's
JobState value is New , you can update some of the information associated
with a job. |
serviceName
close
static final String SERVICE_NAME
static SnowballAsyncClient create()
SnowballAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static SnowballAsyncClientBuilder builder()
SnowballAsyncClient
.default CompletableFuture<CancelClusterResponse> cancelCluster(CancelClusterRequest cancelClusterRequest)
Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum
status.
You'll have at least an hour after creating a cluster job to cancel it.
cancelClusterRequest
- default CompletableFuture<CancelClusterResponse> cancelCluster(Consumer<CancelClusterRequest.Builder> cancelClusterRequest)
Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum
status.
You'll have at least an hour after creating a cluster job to cancel it.
CancelClusterRequest.Builder
avoiding the need to
create one manually via CancelClusterRequest.builder()
cancelClusterRequest
- a Consumer
that will call methods on CancelClusterRequest.Builder
.default CompletableFuture<CancelJobResponse> cancelJob(CancelJobRequest cancelJobRequest)
Cancels the specified job. You can only cancel a job before its JobState
value changes to
PreparingAppliance
. Requesting the ListJobs
or DescribeJob
action will
return a job's JobState
as part of the response element data returned.
cancelJobRequest
- default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)
Cancels the specified job. You can only cancel a job before its JobState
value changes to
PreparingAppliance
. Requesting the ListJobs
or DescribeJob
action will
return a job's JobState
as part of the response element data returned.
CancelJobRequest.Builder
avoiding the need to
create one manually via CancelJobRequest.builder()
cancelJobRequest
- a Consumer
that will call methods on CancelJobRequest.Builder
.default CompletableFuture<CreateAddressResponse> createAddress(CreateAddressRequest createAddressRequest)
Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
createAddressRequest
- default CompletableFuture<CreateAddressResponse> createAddress(Consumer<CreateAddressRequest.Builder> createAddressRequest)
Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
CreateAddressRequest.Builder
avoiding the need to
create one manually via CreateAddressRequest.builder()
createAddressRequest
- a Consumer
that will call methods on CreateAddressRequest.Builder
.default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)
Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
createClusterRequest
- default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
CreateClusterRequest.Builder
avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest
- a Consumer
that will call methods on CreateClusterRequest.Builder
.default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)
Creates a job to the other job attributes are inherited from the cluster.
createJobRequest
- default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must
have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for
a node in a cluster, you only need to provide the clusterId
value; the other job attributes are
inherited from the cluster.
CreateJobRequest.Builder
avoiding the need to
create one manually via CreateJobRequest.builder()
createJobRequest
- a Consumer
that will call methods on CreateJobRequest.Builder
.default CompletableFuture<DescribeAddressResponse> describeAddress(DescribeAddressRequest describeAddressRequest)
Takes an AddressId
and returns specific details about that address in the form of an
Address
object.
describeAddressRequest
- default CompletableFuture<DescribeAddressResponse> describeAddress(Consumer<DescribeAddressRequest.Builder> describeAddressRequest)
Takes an AddressId
and returns specific details about that address in the form of an
Address
object.
DescribeAddressRequest.Builder
avoiding the need
to create one manually via DescribeAddressRequest.builder()
describeAddressRequest
- a Consumer
that will call methods on DescribeAddressRequest.Builder
.default CompletableFuture<DescribeAddressesResponse> describeAddresses(DescribeAddressesRequest describeAddressesRequest)
Returns a specified number of ADDRESS
objects. Calling this API in one of the US regions will return
addresses from the list of all addresses associated with this account in all US regions.
describeAddressesRequest
- NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<DescribeAddressesResponse> describeAddresses()
Returns a specified number of ADDRESS
objects. Calling this API in one of the US regions will return
addresses from the list of all addresses associated with this account in all US regions.
NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<DescribeAddressesResponse> describeAddresses(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest)
Returns a specified number of ADDRESS
objects. Calling this API in one of the US regions will return
addresses from the list of all addresses associated with this account in all US regions.
DescribeAddressesRequest.Builder
avoiding the need
to create one manually via DescribeAddressesRequest.builder()
describeAddressesRequest
- a Consumer
that will call methods on DescribeAddressesRequest.Builder
.NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default DescribeAddressesPublisher describeAddressesPaginator(DescribeAddressesRequest describeAddressesRequest)
Returns a specified number of ADDRESS
objects. Calling this API in one of the US regions will return
addresses from the list of all addresses associated with this account in all US regions.
This is a variant of
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
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 forEach helper method
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
describeAddressesRequest
- NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default DescribeAddressesPublisher describeAddressesPaginator()
Returns a specified number of ADDRESS
objects. Calling this API in one of the US regions will return
addresses from the list of all addresses associated with this account in all US regions.
This is a variant of
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
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 forEach helper method
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeClusterRequest
- default CompletableFuture<DescribeClusterResponse> describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
DescribeClusterRequest.Builder
avoiding the need
to create one manually via DescribeClusterRequest.builder()
describeClusterRequest
- a Consumer
that will call methods on DescribeClusterRequest.Builder
.default CompletableFuture<DescribeJobResponse> describeJob(DescribeJobRequest describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJobRequest
- default CompletableFuture<DescribeJobResponse> describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important metadata.
DescribeJobRequest.Builder
avoiding the need to
create one manually via DescribeJobRequest.builder()
describeJobRequest
- a Consumer
that will call methods on DescribeJobRequest.Builder
.default CompletableFuture<GetJobManifestResponse> getJobManifest(GetJobManifestRequest getJobManifestRequest)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId
value. You can access the manifest file for up to 60 minutes after this request has been made.
To access the manifest file after 60 minutes have passed, you'll have to make another call to the
GetJobManifest
action.
The manifest is an encrypted file that you can download after your job enters the WithCustomer
status. The manifest is decrypted by using the UnlockCode
code value, when you pass both values to
the Snowball through the Snowball client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of an UnlockCode
value in the same
location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from
gaining access to the Snowball associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
getJobManifestRequest
- default CompletableFuture<GetJobManifestResponse> getJobManifest(Consumer<GetJobManifestRequest.Builder> getJobManifestRequest)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId
value. You can access the manifest file for up to 60 minutes after this request has been made.
To access the manifest file after 60 minutes have passed, you'll have to make another call to the
GetJobManifest
action.
The manifest is an encrypted file that you can download after your job enters the WithCustomer
status. The manifest is decrypted by using the UnlockCode
code value, when you pass both values to
the Snowball through the Snowball client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of an UnlockCode
value in the same
location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from
gaining access to the Snowball associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
GetJobManifestRequest.Builder
avoiding the need to
create one manually via GetJobManifestRequest.builder()
getJobManifestRequest
- a Consumer
that will call methods on GetJobManifestRequest.Builder
.default CompletableFuture<GetJobUnlockCodeResponse> getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)
Returns the UnlockCode
code value for the specified job. A particular UnlockCode
value
can be accessed for up to 90 days after the associated job has been created.
The UnlockCode
value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code
is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the
Snowball client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of the UnlockCode
in the same location
as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access
to the Snowball associated with that job.
getJobUnlockCodeRequest
- default CompletableFuture<GetJobUnlockCodeResponse> getJobUnlockCode(Consumer<GetJobUnlockCodeRequest.Builder> getJobUnlockCodeRequest)
Returns the UnlockCode
code value for the specified job. A particular UnlockCode
value
can be accessed for up to 90 days after the associated job has been created.
The UnlockCode
value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code
is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the
Snowball client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of the UnlockCode
in the same location
as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access
to the Snowball associated with that job.
GetJobUnlockCodeRequest.Builder
avoiding the need
to create one manually via GetJobUnlockCodeRequest.builder()
getJobUnlockCodeRequest
- a Consumer
that will call methods on GetJobUnlockCodeRequest.Builder
.default CompletableFuture<GetSnowballUsageResponse> getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
getSnowballUsageRequest
- default CompletableFuture<GetSnowballUsageResponse> getSnowballUsage()
Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
default CompletableFuture<GetSnowballUsageResponse> getSnowballUsage(Consumer<GetSnowballUsageRequest.Builder> getSnowballUsageRequest)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
GetSnowballUsageRequest.Builder
avoiding the need
to create one manually via GetSnowballUsageRequest.builder()
getSnowballUsageRequest
- a Consumer
that will call methods on GetSnowballUsageRequest.Builder
.default CompletableFuture<ListClusterJobsResponse> listClusterJobs(ListClusterJobsRequest listClusterJobsRequest)
Returns an array of JobListEntry
objects of the specified length. Each JobListEntry
object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
listClusterJobsRequest
- NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<ListClusterJobsResponse> listClusterJobs(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest)
Returns an array of JobListEntry
objects of the specified length. Each JobListEntry
object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
ListClusterJobsRequest.Builder
avoiding the need
to create one manually via ListClusterJobsRequest.builder()
listClusterJobsRequest
- a Consumer
that will call methods on ListClusterJobsRequest.Builder
.NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)
Returns an array of ClusterListEntry
objects of the specified length. Each
ClusterListEntry
object contains a cluster's state, a cluster's ID, and other important status
information.
listClustersRequest
- NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<ListClustersResponse> listClusters()
Returns an array of ClusterListEntry
objects of the specified length. Each
ClusterListEntry
object contains a cluster's state, a cluster's ID, and other important status
information.
NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns an array of ClusterListEntry
objects of the specified length. Each
ClusterListEntry
object contains a cluster's state, a cluster's ID, and other important status
information.
ListClustersRequest.Builder
avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest
- a Consumer
that will call methods on ListClustersRequest.Builder
.NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)
Returns an array of JobListEntry
objects of the specified length. Each JobListEntry
object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case
of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs
associated with this account in all US regions.
listJobsRequest
- NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<ListJobsResponse> listJobs()
Returns an array of JobListEntry
objects of the specified length. Each JobListEntry
object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case
of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs
associated with this account in all US regions.
NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Returns an array of JobListEntry
objects of the specified length. Each JobListEntry
object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case
of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs
associated with this account in all US regions.
ListJobsRequest.Builder
avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest
- a Consumer
that will call methods on ListJobsRequest.Builder
.NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest)
Returns an array of JobListEntry
objects of the specified length. Each JobListEntry
object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case
of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs
associated with this account in all US regions.
This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
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 forEach helper method
software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowball.model.ListJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
listJobsRequest
- NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default ListJobsPublisher listJobsPaginator()
Returns an array of JobListEntry
objects of the specified length. Each JobListEntry
object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case
of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs
associated with this account in all US regions.
This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
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 forEach helper method
software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowball.model.ListJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
NextToken
string was altered unexpectedly, and the
operation has stopped. Run the operation without changing the NextToken
string, and try
again.default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest)
While a cluster's ClusterState
value is in the AwaitingQuorum
state, you can update
some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60
minutes after the cluster being created, this action is no longer available.
updateClusterRequest
- default CompletableFuture<UpdateClusterResponse> updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
While a cluster's ClusterState
value is in the AwaitingQuorum
state, you can update
some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60
minutes after the cluster being created, this action is no longer available.
UpdateClusterRequest.Builder
avoiding the need to
create one manually via UpdateClusterRequest.builder()
updateClusterRequest
- a Consumer
that will call methods on UpdateClusterRequest.Builder
.default CompletableFuture<UpdateJobResponse> updateJob(UpdateJobRequest updateJobRequest)
While a job's JobState
value is New
, you can update some of the information associated
with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created,
this action is no longer available.
updateJobRequest
- default CompletableFuture<UpdateJobResponse> updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest)
While a job's JobState
value is New
, you can update some of the information associated
with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created,
this action is no longer available.
UpdateJobRequest.Builder
avoiding the need to
create one manually via UpdateJobRequest.builder()
updateJobRequest
- a Consumer
that will call methods on UpdateJobRequest.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.