software.amazon.awssdk.services.batch.BatchAsyncClient Maven / Gradle / Ivy
Show all versions of batch Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.batch;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.batch.model.CancelJobRequest;
import software.amazon.awssdk.services.batch.model.CancelJobResponse;
import software.amazon.awssdk.services.batch.model.CreateComputeEnvironmentRequest;
import software.amazon.awssdk.services.batch.model.CreateComputeEnvironmentResponse;
import software.amazon.awssdk.services.batch.model.CreateJobQueueRequest;
import software.amazon.awssdk.services.batch.model.CreateJobQueueResponse;
import software.amazon.awssdk.services.batch.model.DeleteComputeEnvironmentRequest;
import software.amazon.awssdk.services.batch.model.DeleteComputeEnvironmentResponse;
import software.amazon.awssdk.services.batch.model.DeleteJobQueueRequest;
import software.amazon.awssdk.services.batch.model.DeleteJobQueueResponse;
import software.amazon.awssdk.services.batch.model.DeregisterJobDefinitionRequest;
import software.amazon.awssdk.services.batch.model.DeregisterJobDefinitionResponse;
import software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest;
import software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse;
import software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest;
import software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse;
import software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest;
import software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse;
import software.amazon.awssdk.services.batch.model.DescribeJobsRequest;
import software.amazon.awssdk.services.batch.model.DescribeJobsResponse;
import software.amazon.awssdk.services.batch.model.ListJobsRequest;
import software.amazon.awssdk.services.batch.model.ListJobsResponse;
import software.amazon.awssdk.services.batch.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.batch.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.batch.model.RegisterJobDefinitionRequest;
import software.amazon.awssdk.services.batch.model.RegisterJobDefinitionResponse;
import software.amazon.awssdk.services.batch.model.SubmitJobRequest;
import software.amazon.awssdk.services.batch.model.SubmitJobResponse;
import software.amazon.awssdk.services.batch.model.TagResourceRequest;
import software.amazon.awssdk.services.batch.model.TagResourceResponse;
import software.amazon.awssdk.services.batch.model.TerminateJobRequest;
import software.amazon.awssdk.services.batch.model.TerminateJobResponse;
import software.amazon.awssdk.services.batch.model.UntagResourceRequest;
import software.amazon.awssdk.services.batch.model.UntagResourceResponse;
import software.amazon.awssdk.services.batch.model.UpdateComputeEnvironmentRequest;
import software.amazon.awssdk.services.batch.model.UpdateComputeEnvironmentResponse;
import software.amazon.awssdk.services.batch.model.UpdateJobQueueRequest;
import software.amazon.awssdk.services.batch.model.UpdateJobQueueResponse;
import software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsPublisher;
import software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsPublisher;
import software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesPublisher;
import software.amazon.awssdk.services.batch.paginators.ListJobsPublisher;
/**
* Service client for accessing AWS Batch asynchronously. This can be created using the static {@link #builder()}
* method.
*
*
* Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for
* developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of
* this computing workload to remove the undifferentiated heavy lifting of configuring and managing required
* infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these
* advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
* helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.
*
*
* As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically
* provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific
* workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can
* focus your time and energy on analyzing results and solving your specific problems.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface BatchAsyncClient extends SdkClient {
String SERVICE_NAME = "batch";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "batch";
/**
* Create a {@link BatchAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static BatchAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link BatchAsyncClient}.
*/
static BatchAsyncClientBuilder builder() {
return new DefaultBatchAsyncClientBuilder();
}
/**
*
* Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
* RUNNABLE state are canceled. Jobs that have progressed to STARTING or
* RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These
* jobs must be terminated with the TerminateJob operation.
*
*
* @param cancelJobRequest
* Contains the parameters for CancelJob.
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.CancelJob
* @see AWS API
* Documentation
*/
default CompletableFuture cancelJob(CancelJobRequest cancelJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
* RUNNABLE state are canceled. Jobs that have progressed to STARTING or
* RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These
* jobs must be terminated with the TerminateJob operation.
*
*
*
* This is a convenience which creates an instance of the {@link CancelJobRequest.Builder} avoiding the need to
* create one manually via {@link CancelJobRequest#builder()}
*
*
* @param cancelJobRequest
* A {@link Consumer} that will call methods on {@link CancelJobRequest.Builder} to create a request.
* Contains the parameters for CancelJob.
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.CancelJob
* @see AWS API
* Documentation
*/
default CompletableFuture cancelJob(Consumer cancelJobRequest) {
return cancelJob(CancelJobRequest.builder().applyMutation(cancelJobRequest).build());
}
/**
*
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute
* environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources.
* UNMANAGED compute environments can only use EC2 resources.
*
*
* In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources
* within the environment. This is based on the compute resource specification that you define or the launch template that you
* specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2
* Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can
* optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a
* specified percentage of the On-Demand price.
*
*
*
* Multi-node parallel jobs aren't supported on Spot Instances.
*
*
*
* In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility
* with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify
* that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container
* instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your
* unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon
* ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For
* more information, see Launching an
* Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.
*
*
*
* AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
* doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're
* responsible for managing the guest operating system (including its updates and security patches) and any
* additional application software or utilities that you install on the compute resources. To use a new AMI for your
* AWS Batch jobs, complete these steps:
*
*
* -
*
* Create a new compute environment with the new AMI.
*
*
* -
*
* Add the compute environment to an existing job queue.
*
*
* -
*
* Remove the earlier compute environment from your job queue.
*
*
* -
*
* Delete the earlier compute environment.
*
*
*
*
*
* @param createComputeEnvironmentRequest
* Contains the parameters for CreateComputeEnvironment.
* @return A Java Future containing the result of the CreateComputeEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.CreateComputeEnvironment
* @see AWS API Documentation
*/
default CompletableFuture createComputeEnvironment(
CreateComputeEnvironmentRequest createComputeEnvironmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute
* environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources.
* UNMANAGED compute environments can only use EC2 resources.
*
*
* In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources
* within the environment. This is based on the compute resource specification that you define or the launch template that you
* specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2
* Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can
* optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a
* specified percentage of the On-Demand price.
*
*
*
* Multi-node parallel jobs aren't supported on Spot Instances.
*
*
*
* In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility
* with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify
* that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container
* instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your
* unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon
* ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For
* more information, see Launching an
* Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.
*
*
*
* AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
* doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're
* responsible for managing the guest operating system (including its updates and security patches) and any
* additional application software or utilities that you install on the compute resources. To use a new AMI for your
* AWS Batch jobs, complete these steps:
*
*
* -
*
* Create a new compute environment with the new AMI.
*
*
* -
*
* Add the compute environment to an existing job queue.
*
*
* -
*
* Remove the earlier compute environment from your job queue.
*
*
* -
*
* Delete the earlier compute environment.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateComputeEnvironmentRequest.Builder} avoiding
* the need to create one manually via {@link CreateComputeEnvironmentRequest#builder()}
*
*
* @param createComputeEnvironmentRequest
* A {@link Consumer} that will call methods on {@link CreateComputeEnvironmentRequest.Builder} to create a
* request. Contains the parameters for CreateComputeEnvironment.
* @return A Java Future containing the result of the CreateComputeEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.CreateComputeEnvironment
* @see AWS API Documentation
*/
default CompletableFuture createComputeEnvironment(
Consumer createComputeEnvironmentRequest) {
return createComputeEnvironment(CreateComputeEnvironmentRequest.builder().applyMutation(createComputeEnvironmentRequest)
.build());
}
/**
*
* Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to
* the queue and assign an order of preference for the compute environments.
*
*
* You also set a priority to the job queue that determines the order that the AWS Batch scheduler places jobs onto
* its associated compute environments. For example, if a compute environment is associated with more than one job
* queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.
*
*
* @param createJobQueueRequest
* Contains the parameters for CreateJobQueue.
* @return A Java Future containing the result of the CreateJobQueue operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.CreateJobQueue
* @see AWS API
* Documentation
*/
default CompletableFuture createJobQueue(CreateJobQueueRequest createJobQueueRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to
* the queue and assign an order of preference for the compute environments.
*
*
* You also set a priority to the job queue that determines the order that the AWS Batch scheduler places jobs onto
* its associated compute environments. For example, if a compute environment is associated with more than one job
* queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.
*
*
*
* This is a convenience which creates an instance of the {@link CreateJobQueueRequest.Builder} avoiding the need to
* create one manually via {@link CreateJobQueueRequest#builder()}
*
*
* @param createJobQueueRequest
* A {@link Consumer} that will call methods on {@link CreateJobQueueRequest.Builder} to create a request.
* Contains the parameters for CreateJobQueue.
* @return A Java Future containing the result of the CreateJobQueue operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.CreateJobQueue
* @see AWS API
* Documentation
*/
default CompletableFuture createJobQueue(Consumer createJobQueueRequest) {
return createJobQueue(CreateJobQueueRequest.builder().applyMutation(createJobQueueRequest).build());
}
/**
*
* Deletes an AWS Batch compute environment.
*
*
* Before you can delete a compute environment, you must set its state to DISABLED with the
* UpdateComputeEnvironment API operation and disassociate it from any job queues with the
* UpdateJobQueue API operation. Compute environments that use AWS Fargate resources must terminate all
* active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
* environment enters an invalid state.
*
*
* @param deleteComputeEnvironmentRequest
* Contains the parameters for DeleteComputeEnvironment.
* @return A Java Future containing the result of the DeleteComputeEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DeleteComputeEnvironment
* @see AWS API Documentation
*/
default CompletableFuture deleteComputeEnvironment(
DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an AWS Batch compute environment.
*
*
* Before you can delete a compute environment, you must set its state to DISABLED with the
* UpdateComputeEnvironment API operation and disassociate it from any job queues with the
* UpdateJobQueue API operation. Compute environments that use AWS Fargate resources must terminate all
* active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
* environment enters an invalid state.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteComputeEnvironmentRequest.Builder} avoiding
* the need to create one manually via {@link DeleteComputeEnvironmentRequest#builder()}
*
*
* @param deleteComputeEnvironmentRequest
* A {@link Consumer} that will call methods on {@link DeleteComputeEnvironmentRequest.Builder} to create a
* request. Contains the parameters for DeleteComputeEnvironment.
* @return A Java Future containing the result of the DeleteComputeEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DeleteComputeEnvironment
* @see AWS API Documentation
*/
default CompletableFuture deleteComputeEnvironment(
Consumer deleteComputeEnvironmentRequest) {
return deleteComputeEnvironment(DeleteComputeEnvironmentRequest.builder().applyMutation(deleteComputeEnvironmentRequest)
.build());
}
/**
*
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue
* operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated
* at a rate of about 16 jobs each second.
*
*
* It's not necessary to disassociate compute environments from a queue before submitting a
* DeleteJobQueue request.
*
*
* @param deleteJobQueueRequest
* Contains the parameters for DeleteJobQueue.
* @return A Java Future containing the result of the DeleteJobQueue operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DeleteJobQueue
* @see AWS API
* Documentation
*/
default CompletableFuture deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue
* operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated
* at a rate of about 16 jobs each second.
*
*
* It's not necessary to disassociate compute environments from a queue before submitting a
* DeleteJobQueue request.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteJobQueueRequest.Builder} avoiding the need to
* create one manually via {@link DeleteJobQueueRequest#builder()}
*
*
* @param deleteJobQueueRequest
* A {@link Consumer} that will call methods on {@link DeleteJobQueueRequest.Builder} to create a request.
* Contains the parameters for DeleteJobQueue.
* @return A Java Future containing the result of the DeleteJobQueue operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DeleteJobQueue
* @see AWS API
* Documentation
*/
default CompletableFuture deleteJobQueue(Consumer deleteJobQueueRequest) {
return deleteJobQueue(DeleteJobQueueRequest.builder().applyMutation(deleteJobQueueRequest).build());
}
/**
*
* Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
*
*
* @param deregisterJobDefinitionRequest
* @return A Java Future containing the result of the DeregisterJobDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DeregisterJobDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture deregisterJobDefinition(
DeregisterJobDefinitionRequest deregisterJobDefinitionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
*
*
*
* This is a convenience which creates an instance of the {@link DeregisterJobDefinitionRequest.Builder} avoiding
* the need to create one manually via {@link DeregisterJobDefinitionRequest#builder()}
*
*
* @param deregisterJobDefinitionRequest
* A {@link Consumer} that will call methods on {@link DeregisterJobDefinitionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeregisterJobDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DeregisterJobDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture deregisterJobDefinition(
Consumer deregisterJobDefinitionRequest) {
return deregisterJobDefinition(DeregisterJobDefinitionRequest.builder().applyMutation(deregisterJobDefinitionRequest)
.build());
}
/**
*
* Describes one or more of your compute environments.
*
*
* If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
* operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances
* into.
*
*
* @param describeComputeEnvironmentsRequest
* Contains the parameters for DescribeComputeEnvironments.
* @return A Java Future containing the result of the DescribeComputeEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
default CompletableFuture describeComputeEnvironments(
DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes one or more of your compute environments.
*
*
* If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
* operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances
* into.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeComputeEnvironmentsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeComputeEnvironmentsRequest#builder()}
*
*
* @param describeComputeEnvironmentsRequest
* A {@link Consumer} that will call methods on {@link DescribeComputeEnvironmentsRequest.Builder} to create
* a request. Contains the parameters for DescribeComputeEnvironments.
* @return A Java Future containing the result of the DescribeComputeEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
default CompletableFuture describeComputeEnvironments(
Consumer describeComputeEnvironmentsRequest) {
return describeComputeEnvironments(DescribeComputeEnvironmentsRequest.builder()
.applyMutation(describeComputeEnvironmentsRequest).build());
}
/**
*
* Describes one or more of your compute environments.
*
*
* If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
* operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances
* into.
*
*
* @return A Java Future containing the result of the DescribeComputeEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
default CompletableFuture describeComputeEnvironments() {
return describeComputeEnvironments(DescribeComputeEnvironmentsRequest.builder().build());
}
/**
*
* Describes one or more of your compute environments.
*
*
* If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
* operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances
* into.
*
*
*
* This is a variant of
* {@link #describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsPublisher publisher = client.describeComputeEnvironmentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsPublisher publisher = client.describeComputeEnvironmentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse 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
* {@link #describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
default DescribeComputeEnvironmentsPublisher describeComputeEnvironmentsPaginator() {
return describeComputeEnvironmentsPaginator(DescribeComputeEnvironmentsRequest.builder().build());
}
/**
*
* Describes one or more of your compute environments.
*
*
* If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
* operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances
* into.
*
*
*
* This is a variant of
* {@link #describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsPublisher publisher = client.describeComputeEnvironmentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsPublisher publisher = client.describeComputeEnvironmentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse 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
* {@link #describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)}
* operation.
*
*
* @param describeComputeEnvironmentsRequest
* Contains the parameters for DescribeComputeEnvironments.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
default DescribeComputeEnvironmentsPublisher describeComputeEnvironmentsPaginator(
DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes one or more of your compute environments.
*
*
* If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
* operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances
* into.
*
*
*
* This is a variant of
* {@link #describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsPublisher publisher = client.describeComputeEnvironmentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeComputeEnvironmentsPublisher publisher = client.describeComputeEnvironmentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsResponse 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
* {@link #describeComputeEnvironments(software.amazon.awssdk.services.batch.model.DescribeComputeEnvironmentsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeComputeEnvironmentsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeComputeEnvironmentsRequest#builder()}
*
*
* @param describeComputeEnvironmentsRequest
* A {@link Consumer} that will call methods on {@link DescribeComputeEnvironmentsRequest.Builder} to create
* a request. Contains the parameters for DescribeComputeEnvironments.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeComputeEnvironments
* @see AWS API Documentation
*/
default DescribeComputeEnvironmentsPublisher describeComputeEnvironmentsPaginator(
Consumer describeComputeEnvironmentsRequest) {
return describeComputeEnvironmentsPaginator(DescribeComputeEnvironmentsRequest.builder()
.applyMutation(describeComputeEnvironmentsRequest).build());
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
* @param describeJobDefinitionsRequest
* Contains the parameters for DescribeJobDefinitions.
* @return A Java Future containing the result of the DescribeJobDefinitions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
default CompletableFuture describeJobDefinitions(
DescribeJobDefinitionsRequest describeJobDefinitionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeJobDefinitionsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeJobDefinitionsRequest#builder()}
*
*
* @param describeJobDefinitionsRequest
* A {@link Consumer} that will call methods on {@link DescribeJobDefinitionsRequest.Builder} to create a
* request. Contains the parameters for DescribeJobDefinitions.
* @return A Java Future containing the result of the DescribeJobDefinitions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
default CompletableFuture describeJobDefinitions(
Consumer describeJobDefinitionsRequest) {
return describeJobDefinitions(DescribeJobDefinitionsRequest.builder().applyMutation(describeJobDefinitionsRequest)
.build());
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
* @return A Java Future containing the result of the DescribeJobDefinitions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
default CompletableFuture describeJobDefinitions() {
return describeJobDefinitions(DescribeJobDefinitionsRequest.builder().build());
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
*
* This is a variant of
* {@link #describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsPublisher publisher = client.describeJobDefinitionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsPublisher publisher = client.describeJobDefinitionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse 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
* {@link #describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
default DescribeJobDefinitionsPublisher describeJobDefinitionsPaginator() {
return describeJobDefinitionsPaginator(DescribeJobDefinitionsRequest.builder().build());
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
*
* This is a variant of
* {@link #describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsPublisher publisher = client.describeJobDefinitionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsPublisher publisher = client.describeJobDefinitionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse 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
* {@link #describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)}
* operation.
*
*
* @param describeJobDefinitionsRequest
* Contains the parameters for DescribeJobDefinitions.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
default DescribeJobDefinitionsPublisher describeJobDefinitionsPaginator(
DescribeJobDefinitionsRequest describeJobDefinitionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
*
* This is a variant of
* {@link #describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsPublisher publisher = client.describeJobDefinitionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobDefinitionsPublisher publisher = client.describeJobDefinitionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsResponse 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
* {@link #describeJobDefinitions(software.amazon.awssdk.services.batch.model.DescribeJobDefinitionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeJobDefinitionsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeJobDefinitionsRequest#builder()}
*
*
* @param describeJobDefinitionsRequest
* A {@link Consumer} that will call methods on {@link DescribeJobDefinitionsRequest.Builder} to create a
* request. Contains the parameters for DescribeJobDefinitions.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
default DescribeJobDefinitionsPublisher describeJobDefinitionsPaginator(
Consumer describeJobDefinitionsRequest) {
return describeJobDefinitionsPaginator(DescribeJobDefinitionsRequest.builder()
.applyMutation(describeJobDefinitionsRequest).build());
}
/**
*
* Describes one or more of your job queues.
*
*
* @param describeJobQueuesRequest
* Contains the parameters for DescribeJobQueues.
* @return A Java Future containing the result of the DescribeJobQueues operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
default CompletableFuture describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes one or more of your job queues.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeJobQueuesRequest.Builder} avoiding the need
* to create one manually via {@link DescribeJobQueuesRequest#builder()}
*
*
* @param describeJobQueuesRequest
* A {@link Consumer} that will call methods on {@link DescribeJobQueuesRequest.Builder} to create a request.
* Contains the parameters for DescribeJobQueues.
* @return A Java Future containing the result of the DescribeJobQueues operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
default CompletableFuture describeJobQueues(
Consumer describeJobQueuesRequest) {
return describeJobQueues(DescribeJobQueuesRequest.builder().applyMutation(describeJobQueuesRequest).build());
}
/**
*
* Describes one or more of your job queues.
*
*
* @return A Java Future containing the result of the DescribeJobQueues operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
default CompletableFuture describeJobQueues() {
return describeJobQueues(DescribeJobQueuesRequest.builder().build());
}
/**
*
* Describes one or more of your job queues.
*
*
*
* This is a variant of
* {@link #describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesPublisher publisher = client.describeJobQueuesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesPublisher publisher = client.describeJobQueuesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse 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
* {@link #describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
default DescribeJobQueuesPublisher describeJobQueuesPaginator() {
return describeJobQueuesPaginator(DescribeJobQueuesRequest.builder().build());
}
/**
*
* Describes one or more of your job queues.
*
*
*
* This is a variant of
* {@link #describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesPublisher publisher = client.describeJobQueuesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesPublisher publisher = client.describeJobQueuesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse 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
* {@link #describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)} operation.
*
*
* @param describeJobQueuesRequest
* Contains the parameters for DescribeJobQueues.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
default DescribeJobQueuesPublisher describeJobQueuesPaginator(DescribeJobQueuesRequest describeJobQueuesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes one or more of your job queues.
*
*
*
* This is a variant of
* {@link #describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesPublisher publisher = client.describeJobQueuesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.DescribeJobQueuesPublisher publisher = client.describeJobQueuesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.DescribeJobQueuesResponse 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
* {@link #describeJobQueues(software.amazon.awssdk.services.batch.model.DescribeJobQueuesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeJobQueuesRequest.Builder} avoiding the need
* to create one manually via {@link DescribeJobQueuesRequest#builder()}
*
*
* @param describeJobQueuesRequest
* A {@link Consumer} that will call methods on {@link DescribeJobQueuesRequest.Builder} to create a request.
* Contains the parameters for DescribeJobQueues.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobQueues
* @see AWS API
* Documentation
*/
default DescribeJobQueuesPublisher describeJobQueuesPaginator(
Consumer describeJobQueuesRequest) {
return describeJobQueuesPaginator(DescribeJobQueuesRequest.builder().applyMutation(describeJobQueuesRequest).build());
}
/**
*
* Describes a list of AWS Batch jobs.
*
*
* @param describeJobsRequest
* Contains the parameters for DescribeJobs.
* @return A Java Future containing the result of the DescribeJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobs
* @see AWS API
* Documentation
*/
default CompletableFuture describeJobs(DescribeJobsRequest describeJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a list of AWS Batch jobs.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeJobsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeJobsRequest#builder()}
*
*
* @param describeJobsRequest
* A {@link Consumer} that will call methods on {@link DescribeJobsRequest.Builder} to create a request.
* Contains the parameters for DescribeJobs.
* @return A Java Future containing the result of the DescribeJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.DescribeJobs
* @see AWS API
* Documentation
*/
default CompletableFuture describeJobs(Consumer describeJobsRequest) {
return describeJobs(DescribeJobsRequest.builder().applyMutation(describeJobsRequest).build());
}
/**
*
* Returns a list of AWS Batch jobs.
*
*
* You must specify only one of the following items:
*
*
* -
*
* A job queue ID to return a list of jobs in that job queue
*
*
* -
*
* A multi-node parallel job ID to return a list of nodes for that job
*
*
* -
*
* An array job ID to return a list of the children for that job
*
*
*
*
* You can filter the results by job status with the jobStatus parameter. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
* @param listJobsRequest
* Contains the parameters for ListJobs.
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listJobs(ListJobsRequest listJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of AWS Batch jobs.
*
*
* You must specify only one of the following items:
*
*
* -
*
* A job queue ID to return a list of jobs in that job queue
*
*
* -
*
* A multi-node parallel job ID to return a list of nodes for that job
*
*
* -
*
* An array job ID to return a list of the children for that job
*
*
*
*
* You can filter the results by job status with the jobStatus parameter. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
*
* This is a convenience which creates an instance of the {@link ListJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListJobsRequest#builder()}
*
*
* @param listJobsRequest
* A {@link Consumer} that will call methods on {@link ListJobsRequest.Builder} to create a request. Contains
* the parameters for ListJobs.
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listJobs(Consumer listJobsRequest) {
return listJobs(ListJobsRequest.builder().applyMutation(listJobsRequest).build());
}
/**
*
* Returns a list of AWS Batch jobs.
*
*
* You must specify only one of the following items:
*
*
* -
*
* A job queue ID to return a list of jobs in that job queue
*
*
* -
*
* A multi-node parallel job ID to return a list of nodes for that job
*
*
* -
*
* An array job ID to return a list of the children for that job
*
*
*
*
* You can filter the results by job status with the jobStatus parameter. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
*
* This is a variant of {@link #listJobs(software.amazon.awssdk.services.batch.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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.ListJobsResponse 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
* {@link #listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)} operation.
*
*
* @param listJobsRequest
* Contains the parameters for ListJobs.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of AWS Batch jobs.
*
*
* You must specify only one of the following items:
*
*
* -
*
* A job queue ID to return a list of jobs in that job queue
*
*
* -
*
* A multi-node parallel job ID to return a list of nodes for that job
*
*
* -
*
* An array job ID to return a list of the children for that job
*
*
*
*
* You can filter the results by job status with the jobStatus parameter. If you don't specify a
* status, only RUNNING jobs are returned.
*
*
*
* This is a variant of {@link #listJobs(software.amazon.awssdk.services.batch.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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.batch.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.batch.model.ListJobsResponse 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
* {@link #listJobs(software.amazon.awssdk.services.batch.model.ListJobsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListJobsRequest#builder()}
*
*
* @param listJobsRequest
* A {@link Consumer} that will call methods on {@link ListJobsRequest.Builder} to create a request. Contains
* the parameters for ListJobs.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsPublisher listJobsPaginator(Consumer listJobsRequest) {
return listJobsPaginator(ListJobsRequest.builder().applyMutation(listJobsRequest).build());
}
/**
*
* Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs,
* job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not
* supported.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs,
* job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not
* supported.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Registers an AWS Batch job definition.
*
*
* @param registerJobDefinitionRequest
* Contains the parameters for RegisterJobDefinition.
* @return A Java Future containing the result of the RegisterJobDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.RegisterJobDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture registerJobDefinition(
RegisterJobDefinitionRequest registerJobDefinitionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Registers an AWS Batch job definition.
*
*
*
* This is a convenience which creates an instance of the {@link RegisterJobDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link RegisterJobDefinitionRequest#builder()}
*
*
* @param registerJobDefinitionRequest
* A {@link Consumer} that will call methods on {@link RegisterJobDefinitionRequest.Builder} to create a
* request. Contains the parameters for RegisterJobDefinition.
* @return A Java Future containing the result of the RegisterJobDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.RegisterJobDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture registerJobDefinition(
Consumer registerJobDefinitionRequest) {
return registerJobDefinition(RegisterJobDefinitionRequest.builder().applyMutation(registerJobDefinitionRequest).build());
}
/**
*
* Submits an AWS Batch job from a job definition. Parameters that are specified during SubmitJob override
* parameters defined in the job definition. vCPU and memory requirements that are specified in the
* ResourceRequirements objects in the job definition are the exception. They can't be overridden this
* way using the memory and vcpus parameters. Rather, you must specify updates to job
* definition parameters in a ResourceRequirements object that's included in the
* containerOverrides parameter.
*
*
*
* Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14
* days, Fargate resources might become unavailable and job might be terminated.
*
*
*
* @param submitJobRequest
* Contains the parameters for SubmitJob.
* @return A Java Future containing the result of the SubmitJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.SubmitJob
* @see AWS API
* Documentation
*/
default CompletableFuture submitJob(SubmitJobRequest submitJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Submits an AWS Batch job from a job definition. Parameters that are specified during SubmitJob override
* parameters defined in the job definition. vCPU and memory requirements that are specified in the
* ResourceRequirements objects in the job definition are the exception. They can't be overridden this
* way using the memory and vcpus parameters. Rather, you must specify updates to job
* definition parameters in a ResourceRequirements object that's included in the
* containerOverrides parameter.
*
*
*
* Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14
* days, Fargate resources might become unavailable and job might be terminated.
*
*
*
* This is a convenience which creates an instance of the {@link SubmitJobRequest.Builder} avoiding the need to
* create one manually via {@link SubmitJobRequest#builder()}
*
*
* @param submitJobRequest
* A {@link Consumer} that will call methods on {@link SubmitJobRequest.Builder} to create a request.
* Contains the parameters for SubmitJob.
* @return A Java Future containing the result of the SubmitJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.SubmitJob
* @see AWS API
* Documentation
*/
default CompletableFuture submitJob(Consumer submitJobRequest) {
return submitJob(SubmitJobRequest.builder().applyMutation(submitJobRequest).build());
}
/**
*
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
* resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
* associated with that resource are deleted as well. AWS Batch resources that support tags are compute
* environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP)
* jobs are not supported.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
* resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
* associated with that resource are deleted as well. AWS Batch resources that support tags are compute
* environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP)
* jobs are not supported.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are
* terminated, which causes them to transition to FAILED. Jobs that have not progressed to the
* STARTING state are cancelled.
*
*
* @param terminateJobRequest
* Contains the parameters for TerminateJob.
* @return A Java Future containing the result of the TerminateJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.TerminateJob
* @see AWS API
* Documentation
*/
default CompletableFuture terminateJob(TerminateJobRequest terminateJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are
* terminated, which causes them to transition to FAILED. Jobs that have not progressed to the
* STARTING state are cancelled.
*
*
*
* This is a convenience which creates an instance of the {@link TerminateJobRequest.Builder} avoiding the need to
* create one manually via {@link TerminateJobRequest#builder()}
*
*
* @param terminateJobRequest
* A {@link Consumer} that will call methods on {@link TerminateJobRequest.Builder} to create a request.
* Contains the parameters for TerminateJob.
* @return A Java Future containing the result of the TerminateJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.TerminateJob
* @see AWS API
* Documentation
*/
default CompletableFuture terminateJob(Consumer terminateJobRequest) {
return terminateJob(TerminateJobRequest.builder().applyMutation(terminateJobRequest).build());
}
/**
*
* Deletes specified tags from an AWS Batch resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes specified tags from an AWS Batch resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates an AWS Batch compute environment.
*
*
* @param updateComputeEnvironmentRequest
* Contains the parameters for UpdateComputeEnvironment.
* @return A Java Future containing the result of the UpdateComputeEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.UpdateComputeEnvironment
* @see AWS API Documentation
*/
default CompletableFuture updateComputeEnvironment(
UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates an AWS Batch compute environment.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateComputeEnvironmentRequest.Builder} avoiding
* the need to create one manually via {@link UpdateComputeEnvironmentRequest#builder()}
*
*
* @param updateComputeEnvironmentRequest
* A {@link Consumer} that will call methods on {@link UpdateComputeEnvironmentRequest.Builder} to create a
* request. Contains the parameters for UpdateComputeEnvironment.
* @return A Java Future containing the result of the UpdateComputeEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.UpdateComputeEnvironment
* @see AWS API Documentation
*/
default CompletableFuture updateComputeEnvironment(
Consumer updateComputeEnvironmentRequest) {
return updateComputeEnvironment(UpdateComputeEnvironmentRequest.builder().applyMutation(updateComputeEnvironmentRequest)
.build());
}
/**
*
* Updates a job queue.
*
*
* @param updateJobQueueRequest
* Contains the parameters for UpdateJobQueue.
* @return A Java Future containing the result of the UpdateJobQueue operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.UpdateJobQueue
* @see AWS API
* Documentation
*/
default CompletableFuture updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a job queue.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateJobQueueRequest.Builder} avoiding the need to
* create one manually via {@link UpdateJobQueueRequest#builder()}
*
*
* @param updateJobQueueRequest
* A {@link Consumer} that will call methods on {@link UpdateJobQueueRequest.Builder} to create a request.
* Contains the parameters for UpdateJobQueue.
* @return A Java Future containing the result of the UpdateJobQueue operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ClientException These errors are usually caused by a client action, such as using an action or
* resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying
* an identifier that's not valid.
* - ServerException These errors are usually caused by a server issue.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - BatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample BatchAsyncClient.UpdateJobQueue
* @see AWS API
* Documentation
*/
default CompletableFuture updateJobQueue(Consumer updateJobQueueRequest) {
return updateJobQueue(UpdateJobQueueRequest.builder().applyMutation(updateJobQueueRequest).build());
}
}