Interface DeadlineAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DeadlineAsyncClient extends AwsClient
Service client for accessing AWSDeadlineCloud asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.

With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.

  • Field Details

  • Method Details

    • associateMemberToFarm

      default CompletableFuture<AssociateMemberToFarmResponse> associateMemberToFarm(AssociateMemberToFarmRequest associateMemberToFarmRequest)

      Assigns a farm membership level to a member.

      Parameters:
      associateMemberToFarmRequest -
      Returns:
      A Java Future containing the result of the AssociateMemberToFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateMemberToFarm

      default CompletableFuture<AssociateMemberToFarmResponse> associateMemberToFarm(Consumer<AssociateMemberToFarmRequest.Builder> associateMemberToFarmRequest)

      Assigns a farm membership level to a member.


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

      Parameters:
      associateMemberToFarmRequest - A Consumer that will call methods on AssociateMemberToFarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateMemberToFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateMemberToFleet

      default CompletableFuture<AssociateMemberToFleetResponse> associateMemberToFleet(AssociateMemberToFleetRequest associateMemberToFleetRequest)

      Assigns a fleet membership level to a member.

      Parameters:
      associateMemberToFleetRequest -
      Returns:
      A Java Future containing the result of the AssociateMemberToFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateMemberToFleet

      default CompletableFuture<AssociateMemberToFleetResponse> associateMemberToFleet(Consumer<AssociateMemberToFleetRequest.Builder> associateMemberToFleetRequest)

      Assigns a fleet membership level to a member.


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

      Parameters:
      associateMemberToFleetRequest - A Consumer that will call methods on AssociateMemberToFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateMemberToFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateMemberToJob

      default CompletableFuture<AssociateMemberToJobResponse> associateMemberToJob(AssociateMemberToJobRequest associateMemberToJobRequest)

      Assigns a job membership level to a member

      Parameters:
      associateMemberToJobRequest -
      Returns:
      A Java Future containing the result of the AssociateMemberToJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateMemberToJob

      default CompletableFuture<AssociateMemberToJobResponse> associateMemberToJob(Consumer<AssociateMemberToJobRequest.Builder> associateMemberToJobRequest)

      Assigns a job membership level to a member


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

      Parameters:
      associateMemberToJobRequest - A Consumer that will call methods on AssociateMemberToJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateMemberToJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateMemberToQueue

      default CompletableFuture<AssociateMemberToQueueResponse> associateMemberToQueue(AssociateMemberToQueueRequest associateMemberToQueueRequest)

      Assigns a queue membership level to a member

      Parameters:
      associateMemberToQueueRequest -
      Returns:
      A Java Future containing the result of the AssociateMemberToQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateMemberToQueue

      default CompletableFuture<AssociateMemberToQueueResponse> associateMemberToQueue(Consumer<AssociateMemberToQueueRequest.Builder> associateMemberToQueueRequest)

      Assigns a queue membership level to a member


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

      Parameters:
      associateMemberToQueueRequest - A Consumer that will call methods on AssociateMemberToQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateMemberToQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeFleetRoleForRead

      default CompletableFuture<AssumeFleetRoleForReadResponse> assumeFleetRoleForRead(AssumeFleetRoleForReadRequest assumeFleetRoleForReadRequest)

      Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

      Parameters:
      assumeFleetRoleForReadRequest -
      Returns:
      A Java Future containing the result of the AssumeFleetRoleForRead operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeFleetRoleForRead

      default CompletableFuture<AssumeFleetRoleForReadResponse> assumeFleetRoleForRead(Consumer<AssumeFleetRoleForReadRequest.Builder> assumeFleetRoleForReadRequest)

      Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.


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

      Parameters:
      assumeFleetRoleForReadRequest - A Consumer that will call methods on AssumeFleetRoleForReadRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssumeFleetRoleForRead operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeFleetRoleForWorker

      default CompletableFuture<AssumeFleetRoleForWorkerResponse> assumeFleetRoleForWorker(AssumeFleetRoleForWorkerRequest assumeFleetRoleForWorkerRequest)

      Get credentials from the fleet role for a worker.

      Parameters:
      assumeFleetRoleForWorkerRequest -
      Returns:
      A Java Future containing the result of the AssumeFleetRoleForWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeFleetRoleForWorker

      default CompletableFuture<AssumeFleetRoleForWorkerResponse> assumeFleetRoleForWorker(Consumer<AssumeFleetRoleForWorkerRequest.Builder> assumeFleetRoleForWorkerRequest)

      Get credentials from the fleet role for a worker.


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

      Parameters:
      assumeFleetRoleForWorkerRequest - A Consumer that will call methods on AssumeFleetRoleForWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssumeFleetRoleForWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeQueueRoleForRead

      default CompletableFuture<AssumeQueueRoleForReadResponse> assumeQueueRoleForRead(AssumeQueueRoleForReadRequest assumeQueueRoleForReadRequest)

      Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

      Parameters:
      assumeQueueRoleForReadRequest -
      Returns:
      A Java Future containing the result of the AssumeQueueRoleForRead operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeQueueRoleForRead

      default CompletableFuture<AssumeQueueRoleForReadResponse> assumeQueueRoleForRead(Consumer<AssumeQueueRoleForReadRequest.Builder> assumeQueueRoleForReadRequest)

      Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.


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

      Parameters:
      assumeQueueRoleForReadRequest - A Consumer that will call methods on AssumeQueueRoleForReadRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssumeQueueRoleForRead operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeQueueRoleForUser

      default CompletableFuture<AssumeQueueRoleForUserResponse> assumeQueueRoleForUser(AssumeQueueRoleForUserRequest assumeQueueRoleForUserRequest)

      Allows a user to assume a role for a queue.

      Parameters:
      assumeQueueRoleForUserRequest -
      Returns:
      A Java Future containing the result of the AssumeQueueRoleForUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeQueueRoleForUser

      default CompletableFuture<AssumeQueueRoleForUserResponse> assumeQueueRoleForUser(Consumer<AssumeQueueRoleForUserRequest.Builder> assumeQueueRoleForUserRequest)

      Allows a user to assume a role for a queue.


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

      Parameters:
      assumeQueueRoleForUserRequest - A Consumer that will call methods on AssumeQueueRoleForUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssumeQueueRoleForUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeQueueRoleForWorker

      default CompletableFuture<AssumeQueueRoleForWorkerResponse> assumeQueueRoleForWorker(AssumeQueueRoleForWorkerRequest assumeQueueRoleForWorkerRequest)

      Allows a worker to assume a queue role.

      Parameters:
      assumeQueueRoleForWorkerRequest -
      Returns:
      A Java Future containing the result of the AssumeQueueRoleForWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • assumeQueueRoleForWorker

      default CompletableFuture<AssumeQueueRoleForWorkerResponse> assumeQueueRoleForWorker(Consumer<AssumeQueueRoleForWorkerRequest.Builder> assumeQueueRoleForWorkerRequest)

      Allows a worker to assume a queue role.


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

      Parameters:
      assumeQueueRoleForWorkerRequest - A Consumer that will call methods on AssumeQueueRoleForWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssumeQueueRoleForWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • batchGetJobEntity

      default CompletableFuture<BatchGetJobEntityResponse> batchGetJobEntity(BatchGetJobEntityRequest batchGetJobEntityRequest)

      Get batched job details for a worker.

      Parameters:
      batchGetJobEntityRequest -
      Returns:
      A Java Future containing the result of the BatchGetJobEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • batchGetJobEntity

      default CompletableFuture<BatchGetJobEntityResponse> batchGetJobEntity(Consumer<BatchGetJobEntityRequest.Builder> batchGetJobEntityRequest)

      Get batched job details for a worker.


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

      Parameters:
      batchGetJobEntityRequest - A Consumer that will call methods on BatchGetJobEntityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetJobEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • copyJobTemplate

      default CompletableFuture<CopyJobTemplateResponse> copyJobTemplate(CopyJobTemplateRequest copyJobTemplateRequest)

      Copies a job template to an Amazon S3 bucket.

      Parameters:
      copyJobTemplateRequest -
      Returns:
      A Java Future containing the result of the CopyJobTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • copyJobTemplate

      default CompletableFuture<CopyJobTemplateResponse> copyJobTemplate(Consumer<CopyJobTemplateRequest.Builder> copyJobTemplateRequest)

      Copies a job template to an Amazon S3 bucket.


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

      Parameters:
      copyJobTemplateRequest - A Consumer that will call methods on CopyJobTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopyJobTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createBudget

      default CompletableFuture<CreateBudgetResponse> createBudget(CreateBudgetRequest createBudgetRequest)

      Creates a budget to set spending thresholds for your rendering activity.

      Parameters:
      createBudgetRequest -
      Returns:
      A Java Future containing the result of the CreateBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createBudget

      default CompletableFuture<CreateBudgetResponse> createBudget(Consumer<CreateBudgetRequest.Builder> createBudgetRequest)

      Creates a budget to set spending thresholds for your rendering activity.


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

      Parameters:
      createBudgetRequest - A Consumer that will call methods on CreateBudgetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFarm

      default CompletableFuture<CreateFarmResponse> createFarm(CreateFarmRequest createFarmRequest)

      Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

      Parameters:
      createFarmRequest -
      Returns:
      A Java Future containing the result of the CreateFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFarm

      default CompletableFuture<CreateFarmResponse> createFarm(Consumer<CreateFarmRequest.Builder> createFarmRequest)

      Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.


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

      Parameters:
      createFarmRequest - A Consumer that will call methods on CreateFarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFleet

      default CompletableFuture<CreateFleetResponse> createFleet(CreateFleetRequest createFleetRequest)

      Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

      Parameters:
      createFleetRequest -
      Returns:
      A Java Future containing the result of the CreateFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFleet

      default CompletableFuture<CreateFleetResponse> createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest)

      Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.


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

      Parameters:
      createFleetRequest - A Consumer that will call methods on CreateFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createJob

      default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)

      Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

      Parameters:
      createJobRequest -
      Returns:
      A Java Future containing the result of the CreateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createJob

      default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)

      Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.


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

      Parameters:
      createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLicenseEndpoint

      default CompletableFuture<CreateLicenseEndpointResponse> createLicenseEndpoint(CreateLicenseEndpointRequest createLicenseEndpointRequest)

      Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

      Parameters:
      createLicenseEndpointRequest -
      Returns:
      A Java Future containing the result of the CreateLicenseEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLicenseEndpoint

      default CompletableFuture<CreateLicenseEndpointResponse> createLicenseEndpoint(Consumer<CreateLicenseEndpointRequest.Builder> createLicenseEndpointRequest)

      Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.


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

      Parameters:
      createLicenseEndpointRequest - A Consumer that will call methods on CreateLicenseEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLicenseEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLimit

      default CompletableFuture<CreateLimitResponse> createLimit(CreateLimitRequest createLimitRequest)

      Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.

      You must add the amountRequirementName to a step in a job template to declare the limit requirement.

      Parameters:
      createLimitRequest -
      Returns:
      A Java Future containing the result of the CreateLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLimit

      default CompletableFuture<CreateLimitResponse> createLimit(Consumer<CreateLimitRequest.Builder> createLimitRequest)

      Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.

      You must add the amountRequirementName to a step in a job template to declare the limit requirement.


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

      Parameters:
      createLimitRequest - A Consumer that will call methods on CreateLimitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createMonitor

      default CompletableFuture<CreateMonitorResponse> createMonitor(CreateMonitorRequest createMonitorRequest)

      Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

      Parameters:
      createMonitorRequest -
      Returns:
      A Java Future containing the result of the CreateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createMonitor

      default CompletableFuture<CreateMonitorResponse> createMonitor(Consumer<CreateMonitorRequest.Builder> createMonitorRequest)

      Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.


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

      Parameters:
      createMonitorRequest - A Consumer that will call methods on CreateMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueue

      default CompletableFuture<CreateQueueResponse> createQueue(CreateQueueRequest createQueueRequest)

      Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

      Parameters:
      createQueueRequest -
      Returns:
      A Java Future containing the result of the CreateQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueue

      default CompletableFuture<CreateQueueResponse> createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest)

      Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.


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

      Parameters:
      createQueueRequest - A Consumer that will call methods on CreateQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueueEnvironment

      default CompletableFuture<CreateQueueEnvironmentResponse> createQueueEnvironment(CreateQueueEnvironmentRequest createQueueEnvironmentRequest)

      Creates an environment for a queue that defines how jobs in the queue run.

      Parameters:
      createQueueEnvironmentRequest -
      Returns:
      A Java Future containing the result of the CreateQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueueEnvironment

      default CompletableFuture<CreateQueueEnvironmentResponse> createQueueEnvironment(Consumer<CreateQueueEnvironmentRequest.Builder> createQueueEnvironmentRequest)

      Creates an environment for a queue that defines how jobs in the queue run.


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

      Parameters:
      createQueueEnvironmentRequest - A Consumer that will call methods on CreateQueueEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueueFleetAssociation

      default CompletableFuture<CreateQueueFleetAssociationResponse> createQueueFleetAssociation(CreateQueueFleetAssociationRequest createQueueFleetAssociationRequest)

      Creates an association between a queue and a fleet.

      Parameters:
      createQueueFleetAssociationRequest -
      Returns:
      A Java Future containing the result of the CreateQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueueFleetAssociation

      default CompletableFuture<CreateQueueFleetAssociationResponse> createQueueFleetAssociation(Consumer<CreateQueueFleetAssociationRequest.Builder> createQueueFleetAssociationRequest)

      Creates an association between a queue and a fleet.


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

      Parameters:
      createQueueFleetAssociationRequest - A Consumer that will call methods on CreateQueueFleetAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueueLimitAssociation

      default CompletableFuture<CreateQueueLimitAssociationResponse> createQueueLimitAssociation(CreateQueueLimitAssociationRequest createQueueLimitAssociationRequest)

      Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.

      Parameters:
      createQueueLimitAssociationRequest -
      Returns:
      A Java Future containing the result of the CreateQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueueLimitAssociation

      default CompletableFuture<CreateQueueLimitAssociationResponse> createQueueLimitAssociation(Consumer<CreateQueueLimitAssociationRequest.Builder> createQueueLimitAssociationRequest)

      Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.


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

      Parameters:
      createQueueLimitAssociationRequest - A Consumer that will call methods on CreateQueueLimitAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createStorageProfile

      default CompletableFuture<CreateStorageProfileResponse> createStorageProfile(CreateStorageProfileRequest createStorageProfileRequest)

      Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

      Parameters:
      createStorageProfileRequest -
      Returns:
      A Java Future containing the result of the CreateStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createStorageProfile

      default CompletableFuture<CreateStorageProfileResponse> createStorageProfile(Consumer<CreateStorageProfileRequest.Builder> createStorageProfileRequest)

      Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.


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

      Parameters:
      createStorageProfileRequest - A Consumer that will call methods on CreateStorageProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createWorker

      default CompletableFuture<CreateWorkerResponse> createWorker(CreateWorkerRequest createWorkerRequest)

      Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.

      Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

      Parameters:
      createWorkerRequest -
      Returns:
      A Java Future containing the result of the CreateWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createWorker

      default CompletableFuture<CreateWorkerResponse> createWorker(Consumer<CreateWorkerRequest.Builder> createWorkerRequest)

      Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.

      Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.


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

      Parameters:
      createWorkerRequest - A Consumer that will call methods on CreateWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteBudget

      default CompletableFuture<DeleteBudgetResponse> deleteBudget(DeleteBudgetRequest deleteBudgetRequest)

      Deletes a budget.

      Parameters:
      deleteBudgetRequest -
      Returns:
      A Java Future containing the result of the DeleteBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteBudget

      default CompletableFuture<DeleteBudgetResponse> deleteBudget(Consumer<DeleteBudgetRequest.Builder> deleteBudgetRequest)

      Deletes a budget.


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

      Parameters:
      deleteBudgetRequest - A Consumer that will call methods on DeleteBudgetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFarm

      default CompletableFuture<DeleteFarmResponse> deleteFarm(DeleteFarmRequest deleteFarmRequest)

      Deletes a farm.

      Parameters:
      deleteFarmRequest -
      Returns:
      A Java Future containing the result of the DeleteFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFarm

      default CompletableFuture<DeleteFarmResponse> deleteFarm(Consumer<DeleteFarmRequest.Builder> deleteFarmRequest)

      Deletes a farm.


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

      Parameters:
      deleteFarmRequest - A Consumer that will call methods on DeleteFarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFleet

      default CompletableFuture<DeleteFleetResponse> deleteFleet(DeleteFleetRequest deleteFleetRequest)

      Deletes a fleet.

      Parameters:
      deleteFleetRequest -
      Returns:
      A Java Future containing the result of the DeleteFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFleet

      default CompletableFuture<DeleteFleetResponse> deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest)

      Deletes a fleet.


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

      Parameters:
      deleteFleetRequest - A Consumer that will call methods on DeleteFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLicenseEndpoint

      default CompletableFuture<DeleteLicenseEndpointResponse> deleteLicenseEndpoint(DeleteLicenseEndpointRequest deleteLicenseEndpointRequest)

      Deletes a license endpoint.

      Parameters:
      deleteLicenseEndpointRequest -
      Returns:
      A Java Future containing the result of the DeleteLicenseEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLicenseEndpoint

      default CompletableFuture<DeleteLicenseEndpointResponse> deleteLicenseEndpoint(Consumer<DeleteLicenseEndpointRequest.Builder> deleteLicenseEndpointRequest)

      Deletes a license endpoint.


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

      Parameters:
      deleteLicenseEndpointRequest - A Consumer that will call methods on DeleteLicenseEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLicenseEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLimit

      default CompletableFuture<DeleteLimitResponse> deleteLimit(DeleteLimitRequest deleteLimitRequest)

      Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.

      Parameters:
      deleteLimitRequest -
      Returns:
      A Java Future containing the result of the DeleteLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLimit

      default CompletableFuture<DeleteLimitResponse> deleteLimit(Consumer<DeleteLimitRequest.Builder> deleteLimitRequest)

      Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.


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

      Parameters:
      deleteLimitRequest - A Consumer that will call methods on DeleteLimitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteMeteredProduct

      default CompletableFuture<DeleteMeteredProductResponse> deleteMeteredProduct(DeleteMeteredProductRequest deleteMeteredProductRequest)

      Deletes a metered product.

      Parameters:
      deleteMeteredProductRequest -
      Returns:
      A Java Future containing the result of the DeleteMeteredProduct operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteMeteredProduct

      default CompletableFuture<DeleteMeteredProductResponse> deleteMeteredProduct(Consumer<DeleteMeteredProductRequest.Builder> deleteMeteredProductRequest)

      Deletes a metered product.


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

      Parameters:
      deleteMeteredProductRequest - A Consumer that will call methods on DeleteMeteredProductRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMeteredProduct operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteMonitor

      default CompletableFuture<DeleteMonitorResponse> deleteMonitor(DeleteMonitorRequest deleteMonitorRequest)

      Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

      Parameters:
      deleteMonitorRequest -
      Returns:
      A Java Future containing the result of the DeleteMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteMonitor

      default CompletableFuture<DeleteMonitorResponse> deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest)

      Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.


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

      Parameters:
      deleteMonitorRequest - A Consumer that will call methods on DeleteMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueue

      default CompletableFuture<DeleteQueueResponse> deleteQueue(DeleteQueueRequest deleteQueueRequest)

      Deletes a queue.

      You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.

      Parameters:
      deleteQueueRequest -
      Returns:
      A Java Future containing the result of the DeleteQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueue

      default CompletableFuture<DeleteQueueResponse> deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest)

      Deletes a queue.

      You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.


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

      Parameters:
      deleteQueueRequest - A Consumer that will call methods on DeleteQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueueEnvironment

      default CompletableFuture<DeleteQueueEnvironmentResponse> deleteQueueEnvironment(DeleteQueueEnvironmentRequest deleteQueueEnvironmentRequest)

      Deletes a queue environment.

      Parameters:
      deleteQueueEnvironmentRequest -
      Returns:
      A Java Future containing the result of the DeleteQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueueEnvironment

      default CompletableFuture<DeleteQueueEnvironmentResponse> deleteQueueEnvironment(Consumer<DeleteQueueEnvironmentRequest.Builder> deleteQueueEnvironmentRequest)

      Deletes a queue environment.


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

      Parameters:
      deleteQueueEnvironmentRequest - A Consumer that will call methods on DeleteQueueEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueueFleetAssociation

      default CompletableFuture<DeleteQueueFleetAssociationResponse> deleteQueueFleetAssociation(DeleteQueueFleetAssociationRequest deleteQueueFleetAssociationRequest)

      Deletes a queue-fleet association.

      Parameters:
      deleteQueueFleetAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueueFleetAssociation

      default CompletableFuture<DeleteQueueFleetAssociationResponse> deleteQueueFleetAssociation(Consumer<DeleteQueueFleetAssociationRequest.Builder> deleteQueueFleetAssociationRequest)

      Deletes a queue-fleet association.


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

      Parameters:
      deleteQueueFleetAssociationRequest - A Consumer that will call methods on DeleteQueueFleetAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueueLimitAssociation

      default CompletableFuture<DeleteQueueLimitAssociationResponse> deleteQueueLimitAssociation(DeleteQueueLimitAssociationRequest deleteQueueLimitAssociationRequest)

      Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.

      Parameters:
      deleteQueueLimitAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueueLimitAssociation

      default CompletableFuture<DeleteQueueLimitAssociationResponse> deleteQueueLimitAssociation(Consumer<DeleteQueueLimitAssociationRequest.Builder> deleteQueueLimitAssociationRequest)

      Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.


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

      Parameters:
      deleteQueueLimitAssociationRequest - A Consumer that will call methods on DeleteQueueLimitAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteStorageProfile

      default CompletableFuture<DeleteStorageProfileResponse> deleteStorageProfile(DeleteStorageProfileRequest deleteStorageProfileRequest)

      Deletes a storage profile.

      Parameters:
      deleteStorageProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteStorageProfile

      default CompletableFuture<DeleteStorageProfileResponse> deleteStorageProfile(Consumer<DeleteStorageProfileRequest.Builder> deleteStorageProfileRequest)

      Deletes a storage profile.


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

      Parameters:
      deleteStorageProfileRequest - A Consumer that will call methods on DeleteStorageProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteWorker

      default CompletableFuture<DeleteWorkerResponse> deleteWorker(DeleteWorkerRequest deleteWorkerRequest)

      Deletes a worker.

      Parameters:
      deleteWorkerRequest -
      Returns:
      A Java Future containing the result of the DeleteWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteWorker

      default CompletableFuture<DeleteWorkerResponse> deleteWorker(Consumer<DeleteWorkerRequest.Builder> deleteWorkerRequest)

      Deletes a worker.


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

      Parameters:
      deleteWorkerRequest - A Consumer that will call methods on DeleteWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromFarm

      default CompletableFuture<DisassociateMemberFromFarmResponse> disassociateMemberFromFarm(DisassociateMemberFromFarmRequest disassociateMemberFromFarmRequest)

      Disassociates a member from a farm.

      Parameters:
      disassociateMemberFromFarmRequest -
      Returns:
      A Java Future containing the result of the DisassociateMemberFromFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromFarm

      default CompletableFuture<DisassociateMemberFromFarmResponse> disassociateMemberFromFarm(Consumer<DisassociateMemberFromFarmRequest.Builder> disassociateMemberFromFarmRequest)

      Disassociates a member from a farm.


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

      Parameters:
      disassociateMemberFromFarmRequest - A Consumer that will call methods on DisassociateMemberFromFarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateMemberFromFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromFleet

      default CompletableFuture<DisassociateMemberFromFleetResponse> disassociateMemberFromFleet(DisassociateMemberFromFleetRequest disassociateMemberFromFleetRequest)

      Disassociates a member from a fleet.

      Parameters:
      disassociateMemberFromFleetRequest -
      Returns:
      A Java Future containing the result of the DisassociateMemberFromFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromFleet

      default CompletableFuture<DisassociateMemberFromFleetResponse> disassociateMemberFromFleet(Consumer<DisassociateMemberFromFleetRequest.Builder> disassociateMemberFromFleetRequest)

      Disassociates a member from a fleet.


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

      Parameters:
      disassociateMemberFromFleetRequest - A Consumer that will call methods on DisassociateMemberFromFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateMemberFromFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromJob

      default CompletableFuture<DisassociateMemberFromJobResponse> disassociateMemberFromJob(DisassociateMemberFromJobRequest disassociateMemberFromJobRequest)

      Disassociates a member from a job.

      Parameters:
      disassociateMemberFromJobRequest -
      Returns:
      A Java Future containing the result of the DisassociateMemberFromJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromJob

      default CompletableFuture<DisassociateMemberFromJobResponse> disassociateMemberFromJob(Consumer<DisassociateMemberFromJobRequest.Builder> disassociateMemberFromJobRequest)

      Disassociates a member from a job.


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

      Parameters:
      disassociateMemberFromJobRequest - A Consumer that will call methods on DisassociateMemberFromJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateMemberFromJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromQueue

      default CompletableFuture<DisassociateMemberFromQueueResponse> disassociateMemberFromQueue(DisassociateMemberFromQueueRequest disassociateMemberFromQueueRequest)

      Disassociates a member from a queue.

      Parameters:
      disassociateMemberFromQueueRequest -
      Returns:
      A Java Future containing the result of the DisassociateMemberFromQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateMemberFromQueue

      default CompletableFuture<DisassociateMemberFromQueueResponse> disassociateMemberFromQueue(Consumer<DisassociateMemberFromQueueRequest.Builder> disassociateMemberFromQueueRequest)

      Disassociates a member from a queue.


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

      Parameters:
      disassociateMemberFromQueueRequest - A Consumer that will call methods on DisassociateMemberFromQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateMemberFromQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getBudget

      default CompletableFuture<GetBudgetResponse> getBudget(GetBudgetRequest getBudgetRequest)

      Get a budget.

      Parameters:
      getBudgetRequest -
      Returns:
      A Java Future containing the result of the GetBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getBudget

      default CompletableFuture<GetBudgetResponse> getBudget(Consumer<GetBudgetRequest.Builder> getBudgetRequest)

      Get a budget.


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

      Parameters:
      getBudgetRequest - A Consumer that will call methods on GetBudgetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFarm

      default CompletableFuture<GetFarmResponse> getFarm(GetFarmRequest getFarmRequest)

      Get a farm.

      Parameters:
      getFarmRequest -
      Returns:
      A Java Future containing the result of the GetFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFarm

      Get a farm.


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

      Parameters:
      getFarmRequest - A Consumer that will call methods on GetFarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFleet

      default CompletableFuture<GetFleetResponse> getFleet(GetFleetRequest getFleetRequest)

      Get a fleet.

      Parameters:
      getFleetRequest -
      Returns:
      A Java Future containing the result of the GetFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFleet

      Get a fleet.


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

      Parameters:
      getFleetRequest - A Consumer that will call methods on GetFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getJob

      default CompletableFuture<GetJobResponse> getJob(GetJobRequest getJobRequest)

      Gets a Deadline Cloud job.

      Parameters:
      getJobRequest -
      Returns:
      A Java Future containing the result of the GetJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getJob

      Gets a Deadline Cloud job.


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

      Parameters:
      getJobRequest - A Consumer that will call methods on GetJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getLicenseEndpoint

      default CompletableFuture<GetLicenseEndpointResponse> getLicenseEndpoint(GetLicenseEndpointRequest getLicenseEndpointRequest)

      Gets a licence endpoint.

      Parameters:
      getLicenseEndpointRequest -
      Returns:
      A Java Future containing the result of the GetLicenseEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getLicenseEndpoint

      default CompletableFuture<GetLicenseEndpointResponse> getLicenseEndpoint(Consumer<GetLicenseEndpointRequest.Builder> getLicenseEndpointRequest)

      Gets a licence endpoint.


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

      Parameters:
      getLicenseEndpointRequest - A Consumer that will call methods on GetLicenseEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLicenseEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getLimit

      default CompletableFuture<GetLimitResponse> getLimit(GetLimitRequest getLimitRequest)

      Gets information about a specific limit.

      Parameters:
      getLimitRequest -
      Returns:
      A Java Future containing the result of the GetLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getLimit

      Gets information about a specific limit.


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

      Parameters:
      getLimitRequest - A Consumer that will call methods on GetLimitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getMonitor

      default CompletableFuture<GetMonitorResponse> getMonitor(GetMonitorRequest getMonitorRequest)

      Gets information about the specified monitor.

      Parameters:
      getMonitorRequest -
      Returns:
      A Java Future containing the result of the GetMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getMonitor

      default CompletableFuture<GetMonitorResponse> getMonitor(Consumer<GetMonitorRequest.Builder> getMonitorRequest)

      Gets information about the specified monitor.


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

      Parameters:
      getMonitorRequest - A Consumer that will call methods on GetMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueue

      default CompletableFuture<GetQueueResponse> getQueue(GetQueueRequest getQueueRequest)

      Gets a queue.

      Parameters:
      getQueueRequest -
      Returns:
      A Java Future containing the result of the GetQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueue

      Gets a queue.


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

      Parameters:
      getQueueRequest - A Consumer that will call methods on GetQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueueEnvironment

      default CompletableFuture<GetQueueEnvironmentResponse> getQueueEnvironment(GetQueueEnvironmentRequest getQueueEnvironmentRequest)

      Gets a queue environment.

      Parameters:
      getQueueEnvironmentRequest -
      Returns:
      A Java Future containing the result of the GetQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueueEnvironment

      default CompletableFuture<GetQueueEnvironmentResponse> getQueueEnvironment(Consumer<GetQueueEnvironmentRequest.Builder> getQueueEnvironmentRequest)

      Gets a queue environment.


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

      Parameters:
      getQueueEnvironmentRequest - A Consumer that will call methods on GetQueueEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueueFleetAssociation

      default CompletableFuture<GetQueueFleetAssociationResponse> getQueueFleetAssociation(GetQueueFleetAssociationRequest getQueueFleetAssociationRequest)

      Gets a queue-fleet association.

      Parameters:
      getQueueFleetAssociationRequest -
      Returns:
      A Java Future containing the result of the GetQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueueFleetAssociation

      default CompletableFuture<GetQueueFleetAssociationResponse> getQueueFleetAssociation(Consumer<GetQueueFleetAssociationRequest.Builder> getQueueFleetAssociationRequest)

      Gets a queue-fleet association.


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

      Parameters:
      getQueueFleetAssociationRequest - A Consumer that will call methods on GetQueueFleetAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueueLimitAssociation

      default CompletableFuture<GetQueueLimitAssociationResponse> getQueueLimitAssociation(GetQueueLimitAssociationRequest getQueueLimitAssociationRequest)

      Gets information about a specific association between a queue and a limit.

      Parameters:
      getQueueLimitAssociationRequest -
      Returns:
      A Java Future containing the result of the GetQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getQueueLimitAssociation

      default CompletableFuture<GetQueueLimitAssociationResponse> getQueueLimitAssociation(Consumer<GetQueueLimitAssociationRequest.Builder> getQueueLimitAssociationRequest)

      Gets information about a specific association between a queue and a limit.


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

      Parameters:
      getQueueLimitAssociationRequest - A Consumer that will call methods on GetQueueLimitAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSession

      default CompletableFuture<GetSessionResponse> getSession(GetSessionRequest getSessionRequest)

      Gets a session.

      Parameters:
      getSessionRequest -
      Returns:
      A Java Future containing the result of the GetSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSession

      default CompletableFuture<GetSessionResponse> getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)

      Gets a session.


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

      Parameters:
      getSessionRequest - A Consumer that will call methods on GetSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSessionAction

      default CompletableFuture<GetSessionActionResponse> getSessionAction(GetSessionActionRequest getSessionActionRequest)

      Gets a session action for the job.

      Parameters:
      getSessionActionRequest -
      Returns:
      A Java Future containing the result of the GetSessionAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSessionAction

      default CompletableFuture<GetSessionActionResponse> getSessionAction(Consumer<GetSessionActionRequest.Builder> getSessionActionRequest)

      Gets a session action for the job.


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

      Parameters:
      getSessionActionRequest - A Consumer that will call methods on GetSessionActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSessionAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSessionsStatisticsAggregation

      default CompletableFuture<GetSessionsStatisticsAggregationResponse> getSessionsStatisticsAggregation(GetSessionsStatisticsAggregationRequest getSessionsStatisticsAggregationRequest)

      Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

      Parameters:
      getSessionsStatisticsAggregationRequest -
      Returns:
      A Java Future containing the result of the GetSessionsStatisticsAggregation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSessionsStatisticsAggregation

      default CompletableFuture<GetSessionsStatisticsAggregationResponse> getSessionsStatisticsAggregation(Consumer<GetSessionsStatisticsAggregationRequest.Builder> getSessionsStatisticsAggregationRequest)

      Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.


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

      Parameters:
      getSessionsStatisticsAggregationRequest - A Consumer that will call methods on GetSessionsStatisticsAggregationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSessionsStatisticsAggregation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSessionsStatisticsAggregationPaginator

      default GetSessionsStatisticsAggregationPublisher getSessionsStatisticsAggregationPaginator(GetSessionsStatisticsAggregationRequest getSessionsStatisticsAggregationRequest)

      This is a variant of getSessionsStatisticsAggregation(software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.GetSessionsStatisticsAggregationPublisher publisher = client.getSessionsStatisticsAggregationPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.GetSessionsStatisticsAggregationPublisher publisher = client.getSessionsStatisticsAggregationPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationResponse 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 getSessionsStatisticsAggregation(software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationRequest) operation.

      Parameters:
      getSessionsStatisticsAggregationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getSessionsStatisticsAggregationPaginator

      default GetSessionsStatisticsAggregationPublisher getSessionsStatisticsAggregationPaginator(Consumer<GetSessionsStatisticsAggregationRequest.Builder> getSessionsStatisticsAggregationRequest)

      This is a variant of getSessionsStatisticsAggregation(software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.GetSessionsStatisticsAggregationPublisher publisher = client.getSessionsStatisticsAggregationPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.GetSessionsStatisticsAggregationPublisher publisher = client.getSessionsStatisticsAggregationPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationResponse 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 getSessionsStatisticsAggregation(software.amazon.awssdk.services.deadline.model.GetSessionsStatisticsAggregationRequest) operation.


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

      Parameters:
      getSessionsStatisticsAggregationRequest - A Consumer that will call methods on GetSessionsStatisticsAggregationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getStep

      default CompletableFuture<GetStepResponse> getStep(GetStepRequest getStepRequest)

      Gets a step.

      Parameters:
      getStepRequest -
      Returns:
      A Java Future containing the result of the GetStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getStep

      Gets a step.


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

      Parameters:
      getStepRequest - A Consumer that will call methods on GetStepRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getStorageProfile

      default CompletableFuture<GetStorageProfileResponse> getStorageProfile(GetStorageProfileRequest getStorageProfileRequest)

      Gets a storage profile.

      Parameters:
      getStorageProfileRequest -
      Returns:
      A Java Future containing the result of the GetStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getStorageProfile

      default CompletableFuture<GetStorageProfileResponse> getStorageProfile(Consumer<GetStorageProfileRequest.Builder> getStorageProfileRequest)

      Gets a storage profile.


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

      Parameters:
      getStorageProfileRequest - A Consumer that will call methods on GetStorageProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getStorageProfileForQueue

      default CompletableFuture<GetStorageProfileForQueueResponse> getStorageProfileForQueue(GetStorageProfileForQueueRequest getStorageProfileForQueueRequest)

      Gets a storage profile for a queue.

      Parameters:
      getStorageProfileForQueueRequest -
      Returns:
      A Java Future containing the result of the GetStorageProfileForQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getStorageProfileForQueue

      default CompletableFuture<GetStorageProfileForQueueResponse> getStorageProfileForQueue(Consumer<GetStorageProfileForQueueRequest.Builder> getStorageProfileForQueueRequest)

      Gets a storage profile for a queue.


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

      Parameters:
      getStorageProfileForQueueRequest - A Consumer that will call methods on GetStorageProfileForQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStorageProfileForQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getTask

      default CompletableFuture<GetTaskResponse> getTask(GetTaskRequest getTaskRequest)

      Gets a task.

      Parameters:
      getTaskRequest -
      Returns:
      A Java Future containing the result of the GetTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getTask

      Gets a task.


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

      Parameters:
      getTaskRequest - A Consumer that will call methods on GetTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getWorker

      default CompletableFuture<GetWorkerResponse> getWorker(GetWorkerRequest getWorkerRequest)

      Gets a worker.

      Parameters:
      getWorkerRequest -
      Returns:
      A Java Future containing the result of the GetWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getWorker

      default CompletableFuture<GetWorkerResponse> getWorker(Consumer<GetWorkerRequest.Builder> getWorkerRequest)

      Gets a worker.


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

      Parameters:
      getWorkerRequest - A Consumer that will call methods on GetWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAvailableMeteredProducts

      default CompletableFuture<ListAvailableMeteredProductsResponse> listAvailableMeteredProducts(ListAvailableMeteredProductsRequest listAvailableMeteredProductsRequest)

      A list of the available metered products.

      Parameters:
      listAvailableMeteredProductsRequest -
      Returns:
      A Java Future containing the result of the ListAvailableMeteredProducts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAvailableMeteredProducts

      default CompletableFuture<ListAvailableMeteredProductsResponse> listAvailableMeteredProducts(Consumer<ListAvailableMeteredProductsRequest.Builder> listAvailableMeteredProductsRequest)

      A list of the available metered products.


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

      Parameters:
      listAvailableMeteredProductsRequest - A Consumer that will call methods on ListAvailableMeteredProductsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAvailableMeteredProducts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAvailableMeteredProductsPaginator

      default ListAvailableMeteredProductsPublisher listAvailableMeteredProductsPaginator(ListAvailableMeteredProductsRequest listAvailableMeteredProductsRequest)

      This is a variant of listAvailableMeteredProducts(software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListAvailableMeteredProductsPublisher publisher = client.listAvailableMeteredProductsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListAvailableMeteredProductsPublisher publisher = client.listAvailableMeteredProductsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsResponse 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 listAvailableMeteredProducts(software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsRequest) operation.

      Parameters:
      listAvailableMeteredProductsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAvailableMeteredProductsPaginator

      default ListAvailableMeteredProductsPublisher listAvailableMeteredProductsPaginator(Consumer<ListAvailableMeteredProductsRequest.Builder> listAvailableMeteredProductsRequest)

      This is a variant of listAvailableMeteredProducts(software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListAvailableMeteredProductsPublisher publisher = client.listAvailableMeteredProductsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListAvailableMeteredProductsPublisher publisher = client.listAvailableMeteredProductsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsResponse 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 listAvailableMeteredProducts(software.amazon.awssdk.services.deadline.model.ListAvailableMeteredProductsRequest) operation.


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

      Parameters:
      listAvailableMeteredProductsRequest - A Consumer that will call methods on ListAvailableMeteredProductsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBudgets

      default CompletableFuture<ListBudgetsResponse> listBudgets(ListBudgetsRequest listBudgetsRequest)

      A list of budgets in a farm.

      Parameters:
      listBudgetsRequest -
      Returns:
      A Java Future containing the result of the ListBudgets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBudgets

      default CompletableFuture<ListBudgetsResponse> listBudgets(Consumer<ListBudgetsRequest.Builder> listBudgetsRequest)

      A list of budgets in a farm.


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

      Parameters:
      listBudgetsRequest - A Consumer that will call methods on ListBudgetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBudgets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBudgetsPaginator

      default ListBudgetsPublisher listBudgetsPaginator(ListBudgetsRequest listBudgetsRequest)

      This is a variant of listBudgets(software.amazon.awssdk.services.deadline.model.ListBudgetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListBudgetsPublisher publisher = client.listBudgetsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListBudgetsPublisher publisher = client.listBudgetsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListBudgetsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListBudgetsResponse 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 listBudgets(software.amazon.awssdk.services.deadline.model.ListBudgetsRequest) operation.

      Parameters:
      listBudgetsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBudgetsPaginator

      default ListBudgetsPublisher listBudgetsPaginator(Consumer<ListBudgetsRequest.Builder> listBudgetsRequest)

      This is a variant of listBudgets(software.amazon.awssdk.services.deadline.model.ListBudgetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListBudgetsPublisher publisher = client.listBudgetsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListBudgetsPublisher publisher = client.listBudgetsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListBudgetsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListBudgetsResponse 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 listBudgets(software.amazon.awssdk.services.deadline.model.ListBudgetsRequest) operation.


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

      Parameters:
      listBudgetsRequest - A Consumer that will call methods on ListBudgetsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarmMembers

      default CompletableFuture<ListFarmMembersResponse> listFarmMembers(ListFarmMembersRequest listFarmMembersRequest)

      Lists the members of a farm.

      Parameters:
      listFarmMembersRequest -
      Returns:
      A Java Future containing the result of the ListFarmMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarmMembers

      default CompletableFuture<ListFarmMembersResponse> listFarmMembers(Consumer<ListFarmMembersRequest.Builder> listFarmMembersRequest)

      Lists the members of a farm.


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

      Parameters:
      listFarmMembersRequest - A Consumer that will call methods on ListFarmMembersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFarmMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarmMembersPaginator

      default ListFarmMembersPublisher listFarmMembersPaginator(ListFarmMembersRequest listFarmMembersRequest)

      This is a variant of listFarmMembers(software.amazon.awssdk.services.deadline.model.ListFarmMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmMembersPublisher publisher = client.listFarmMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmMembersPublisher publisher = client.listFarmMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFarmMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFarmMembersResponse 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 listFarmMembers(software.amazon.awssdk.services.deadline.model.ListFarmMembersRequest) operation.

      Parameters:
      listFarmMembersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarmMembersPaginator

      default ListFarmMembersPublisher listFarmMembersPaginator(Consumer<ListFarmMembersRequest.Builder> listFarmMembersRequest)

      This is a variant of listFarmMembers(software.amazon.awssdk.services.deadline.model.ListFarmMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmMembersPublisher publisher = client.listFarmMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmMembersPublisher publisher = client.listFarmMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFarmMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFarmMembersResponse 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 listFarmMembers(software.amazon.awssdk.services.deadline.model.ListFarmMembersRequest) operation.


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

      Parameters:
      listFarmMembersRequest - A Consumer that will call methods on ListFarmMembersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarms

      default CompletableFuture<ListFarmsResponse> listFarms(ListFarmsRequest listFarmsRequest)

      Lists farms.

      Parameters:
      listFarmsRequest -
      Returns:
      A Java Future containing the result of the ListFarms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarms

      default CompletableFuture<ListFarmsResponse> listFarms(Consumer<ListFarmsRequest.Builder> listFarmsRequest)

      Lists farms.


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

      Parameters:
      listFarmsRequest - A Consumer that will call methods on ListFarmsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFarms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarmsPaginator

      default ListFarmsPublisher listFarmsPaginator(ListFarmsRequest listFarmsRequest)

      This is a variant of listFarms(software.amazon.awssdk.services.deadline.model.ListFarmsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmsPublisher publisher = client.listFarmsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmsPublisher publisher = client.listFarmsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFarmsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFarmsResponse 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 listFarms(software.amazon.awssdk.services.deadline.model.ListFarmsRequest) operation.

      Parameters:
      listFarmsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFarmsPaginator

      default ListFarmsPublisher listFarmsPaginator(Consumer<ListFarmsRequest.Builder> listFarmsRequest)

      This is a variant of listFarms(software.amazon.awssdk.services.deadline.model.ListFarmsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmsPublisher publisher = client.listFarmsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFarmsPublisher publisher = client.listFarmsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFarmsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFarmsResponse 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 listFarms(software.amazon.awssdk.services.deadline.model.ListFarmsRequest) operation.


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

      Parameters:
      listFarmsRequest - A Consumer that will call methods on ListFarmsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleetMembers

      default CompletableFuture<ListFleetMembersResponse> listFleetMembers(ListFleetMembersRequest listFleetMembersRequest)

      Lists fleet members.

      Parameters:
      listFleetMembersRequest -
      Returns:
      A Java Future containing the result of the ListFleetMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleetMembers

      default CompletableFuture<ListFleetMembersResponse> listFleetMembers(Consumer<ListFleetMembersRequest.Builder> listFleetMembersRequest)

      Lists fleet members.


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

      Parameters:
      listFleetMembersRequest - A Consumer that will call methods on ListFleetMembersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFleetMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleetMembersPaginator

      default ListFleetMembersPublisher listFleetMembersPaginator(ListFleetMembersRequest listFleetMembersRequest)

      This is a variant of listFleetMembers(software.amazon.awssdk.services.deadline.model.ListFleetMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetMembersPublisher publisher = client.listFleetMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetMembersPublisher publisher = client.listFleetMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFleetMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFleetMembersResponse 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 listFleetMembers(software.amazon.awssdk.services.deadline.model.ListFleetMembersRequest) operation.

      Parameters:
      listFleetMembersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleetMembersPaginator

      default ListFleetMembersPublisher listFleetMembersPaginator(Consumer<ListFleetMembersRequest.Builder> listFleetMembersRequest)

      This is a variant of listFleetMembers(software.amazon.awssdk.services.deadline.model.ListFleetMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetMembersPublisher publisher = client.listFleetMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetMembersPublisher publisher = client.listFleetMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFleetMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFleetMembersResponse 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 listFleetMembers(software.amazon.awssdk.services.deadline.model.ListFleetMembersRequest) operation.


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

      Parameters:
      listFleetMembersRequest - A Consumer that will call methods on ListFleetMembersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleets

      default CompletableFuture<ListFleetsResponse> listFleets(ListFleetsRequest listFleetsRequest)

      Lists fleets.

      Parameters:
      listFleetsRequest -
      Returns:
      A Java Future containing the result of the ListFleets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleets

      default CompletableFuture<ListFleetsResponse> listFleets(Consumer<ListFleetsRequest.Builder> listFleetsRequest)

      Lists fleets.


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

      Parameters:
      listFleetsRequest - A Consumer that will call methods on ListFleetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFleets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleetsPaginator

      default ListFleetsPublisher listFleetsPaginator(ListFleetsRequest listFleetsRequest)

      This is a variant of listFleets(software.amazon.awssdk.services.deadline.model.ListFleetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFleetsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFleetsResponse 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 listFleets(software.amazon.awssdk.services.deadline.model.ListFleetsRequest) operation.

      Parameters:
      listFleetsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFleetsPaginator

      default ListFleetsPublisher listFleetsPaginator(Consumer<ListFleetsRequest.Builder> listFleetsRequest)

      This is a variant of listFleets(software.amazon.awssdk.services.deadline.model.ListFleetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListFleetsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListFleetsResponse 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 listFleets(software.amazon.awssdk.services.deadline.model.ListFleetsRequest) operation.


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

      Parameters:
      listFleetsRequest - A Consumer that will call methods on ListFleetsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobMembers

      default CompletableFuture<ListJobMembersResponse> listJobMembers(ListJobMembersRequest listJobMembersRequest)

      Lists members on a job.

      Parameters:
      listJobMembersRequest -
      Returns:
      A Java Future containing the result of the ListJobMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobMembers

      default CompletableFuture<ListJobMembersResponse> listJobMembers(Consumer<ListJobMembersRequest.Builder> listJobMembersRequest)

      Lists members on a job.


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

      Parameters:
      listJobMembersRequest - A Consumer that will call methods on ListJobMembersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListJobMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobMembersPaginator

      default ListJobMembersPublisher listJobMembersPaginator(ListJobMembersRequest listJobMembersRequest)

      This is a variant of listJobMembers(software.amazon.awssdk.services.deadline.model.ListJobMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListJobMembersPublisher publisher = client.listJobMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListJobMembersPublisher publisher = client.listJobMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListJobMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListJobMembersResponse 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 listJobMembers(software.amazon.awssdk.services.deadline.model.ListJobMembersRequest) operation.

      Parameters:
      listJobMembersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobMembersPaginator

      default ListJobMembersPublisher listJobMembersPaginator(Consumer<ListJobMembersRequest.Builder> listJobMembersRequest)

      This is a variant of listJobMembers(software.amazon.awssdk.services.deadline.model.ListJobMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListJobMembersPublisher publisher = client.listJobMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListJobMembersPublisher publisher = client.listJobMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListJobMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListJobMembersResponse 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 listJobMembers(software.amazon.awssdk.services.deadline.model.ListJobMembersRequest) operation.


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

      Parameters:
      listJobMembersRequest - A Consumer that will call methods on ListJobMembersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobParameterDefinitions

      default CompletableFuture<ListJobParameterDefinitionsResponse> listJobParameterDefinitions(ListJobParameterDefinitionsRequest listJobParameterDefinitionsRequest)

      Lists parameter definitions of a job.

      Parameters:
      listJobParameterDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListJobParameterDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobParameterDefinitions

      default CompletableFuture<ListJobParameterDefinitionsResponse> listJobParameterDefinitions(Consumer<ListJobParameterDefinitionsRequest.Builder> listJobParameterDefinitionsRequest)

      Lists parameter definitions of a job.


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

      Parameters:
      listJobParameterDefinitionsRequest - A Consumer that will call methods on ListJobParameterDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListJobParameterDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobParameterDefinitionsPaginator

      default ListJobParameterDefinitionsPublisher listJobParameterDefinitionsPaginator(ListJobParameterDefinitionsRequest listJobParameterDefinitionsRequest)

      This is a variant of listJobParameterDefinitions(software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListJobParameterDefinitionsPublisher publisher = client.listJobParameterDefinitionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListJobParameterDefinitionsPublisher publisher = client.listJobParameterDefinitionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsResponse 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 listJobParameterDefinitions(software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsRequest) operation.

      Parameters:
      listJobParameterDefinitionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobParameterDefinitionsPaginator

      default ListJobParameterDefinitionsPublisher listJobParameterDefinitionsPaginator(Consumer<ListJobParameterDefinitionsRequest.Builder> listJobParameterDefinitionsRequest)

      This is a variant of listJobParameterDefinitions(software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListJobParameterDefinitionsPublisher publisher = client.listJobParameterDefinitionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListJobParameterDefinitionsPublisher publisher = client.listJobParameterDefinitionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsResponse 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 listJobParameterDefinitions(software.amazon.awssdk.services.deadline.model.ListJobParameterDefinitionsRequest) operation.


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

      Parameters:
      listJobParameterDefinitionsRequest - A Consumer that will call methods on ListJobParameterDefinitionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobs

      default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)

      Lists jobs.

      Parameters:
      listJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobs

      Lists jobs.


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

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.deadline.model.ListJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListJobsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.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 listJobs(software.amazon.awssdk.services.deadline.model.ListJobsRequest) operation.

      Parameters:
      listJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.deadline.model.ListJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListJobsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.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 listJobs(software.amazon.awssdk.services.deadline.model.ListJobsRequest) operation.


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

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLicenseEndpoints

      default CompletableFuture<ListLicenseEndpointsResponse> listLicenseEndpoints(ListLicenseEndpointsRequest listLicenseEndpointsRequest)

      Lists license endpoints.

      Parameters:
      listLicenseEndpointsRequest -
      Returns:
      A Java Future containing the result of the ListLicenseEndpoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLicenseEndpoints

      default CompletableFuture<ListLicenseEndpointsResponse> listLicenseEndpoints(Consumer<ListLicenseEndpointsRequest.Builder> listLicenseEndpointsRequest)

      Lists license endpoints.


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

      Parameters:
      listLicenseEndpointsRequest - A Consumer that will call methods on ListLicenseEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLicenseEndpoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLicenseEndpointsPaginator

      default ListLicenseEndpointsPublisher listLicenseEndpointsPaginator(ListLicenseEndpointsRequest listLicenseEndpointsRequest)

      This is a variant of listLicenseEndpoints(software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListLicenseEndpointsPublisher publisher = client.listLicenseEndpointsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListLicenseEndpointsPublisher publisher = client.listLicenseEndpointsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsResponse 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 listLicenseEndpoints(software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsRequest) operation.

      Parameters:
      listLicenseEndpointsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLicenseEndpointsPaginator

      default ListLicenseEndpointsPublisher listLicenseEndpointsPaginator(Consumer<ListLicenseEndpointsRequest.Builder> listLicenseEndpointsRequest)

      This is a variant of listLicenseEndpoints(software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListLicenseEndpointsPublisher publisher = client.listLicenseEndpointsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListLicenseEndpointsPublisher publisher = client.listLicenseEndpointsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsResponse 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 listLicenseEndpoints(software.amazon.awssdk.services.deadline.model.ListLicenseEndpointsRequest) operation.


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

      Parameters:
      listLicenseEndpointsRequest - A Consumer that will call methods on ListLicenseEndpointsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLimits

      default CompletableFuture<ListLimitsResponse> listLimits(ListLimitsRequest listLimitsRequest)

      Gets a list of limits defined in the specified farm.

      Parameters:
      listLimitsRequest -
      Returns:
      A Java Future containing the result of the ListLimits operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLimits

      default CompletableFuture<ListLimitsResponse> listLimits(Consumer<ListLimitsRequest.Builder> listLimitsRequest)

      Gets a list of limits defined in the specified farm.


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

      Parameters:
      listLimitsRequest - A Consumer that will call methods on ListLimitsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLimits operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLimitsPaginator

      default ListLimitsPublisher listLimitsPaginator(ListLimitsRequest listLimitsRequest)

      This is a variant of listLimits(software.amazon.awssdk.services.deadline.model.ListLimitsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListLimitsPublisher publisher = client.listLimitsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListLimitsPublisher publisher = client.listLimitsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListLimitsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListLimitsResponse 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 listLimits(software.amazon.awssdk.services.deadline.model.ListLimitsRequest) operation.

      Parameters:
      listLimitsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listLimitsPaginator

      default ListLimitsPublisher listLimitsPaginator(Consumer<ListLimitsRequest.Builder> listLimitsRequest)

      This is a variant of listLimits(software.amazon.awssdk.services.deadline.model.ListLimitsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListLimitsPublisher publisher = client.listLimitsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListLimitsPublisher publisher = client.listLimitsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListLimitsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListLimitsResponse 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 listLimits(software.amazon.awssdk.services.deadline.model.ListLimitsRequest) operation.


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

      Parameters:
      listLimitsRequest - A Consumer that will call methods on ListLimitsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMeteredProducts

      default CompletableFuture<ListMeteredProductsResponse> listMeteredProducts(ListMeteredProductsRequest listMeteredProductsRequest)

      Lists metered products.

      Parameters:
      listMeteredProductsRequest -
      Returns:
      A Java Future containing the result of the ListMeteredProducts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMeteredProducts

      default CompletableFuture<ListMeteredProductsResponse> listMeteredProducts(Consumer<ListMeteredProductsRequest.Builder> listMeteredProductsRequest)

      Lists metered products.


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

      Parameters:
      listMeteredProductsRequest - A Consumer that will call methods on ListMeteredProductsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMeteredProducts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMeteredProductsPaginator

      default ListMeteredProductsPublisher listMeteredProductsPaginator(ListMeteredProductsRequest listMeteredProductsRequest)

      This is a variant of listMeteredProducts(software.amazon.awssdk.services.deadline.model.ListMeteredProductsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListMeteredProductsPublisher publisher = client.listMeteredProductsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListMeteredProductsPublisher publisher = client.listMeteredProductsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListMeteredProductsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListMeteredProductsResponse 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 listMeteredProducts(software.amazon.awssdk.services.deadline.model.ListMeteredProductsRequest) operation.

      Parameters:
      listMeteredProductsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMeteredProductsPaginator

      default ListMeteredProductsPublisher listMeteredProductsPaginator(Consumer<ListMeteredProductsRequest.Builder> listMeteredProductsRequest)

      This is a variant of listMeteredProducts(software.amazon.awssdk.services.deadline.model.ListMeteredProductsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListMeteredProductsPublisher publisher = client.listMeteredProductsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListMeteredProductsPublisher publisher = client.listMeteredProductsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListMeteredProductsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListMeteredProductsResponse 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 listMeteredProducts(software.amazon.awssdk.services.deadline.model.ListMeteredProductsRequest) operation.


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

      Parameters:
      listMeteredProductsRequest - A Consumer that will call methods on ListMeteredProductsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitors

      default CompletableFuture<ListMonitorsResponse> listMonitors(ListMonitorsRequest listMonitorsRequest)

      Gets a list of your monitors in Deadline Cloud.

      Parameters:
      listMonitorsRequest -
      Returns:
      A Java Future containing the result of the ListMonitors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitors

      default CompletableFuture<ListMonitorsResponse> listMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)

      Gets a list of your monitors in Deadline Cloud.


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

      Parameters:
      listMonitorsRequest - A Consumer that will call methods on ListMonitorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMonitors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitorsPaginator

      default ListMonitorsPublisher listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest)

      This is a variant of listMonitors(software.amazon.awssdk.services.deadline.model.ListMonitorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListMonitorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListMonitorsResponse 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 listMonitors(software.amazon.awssdk.services.deadline.model.ListMonitorsRequest) operation.

      Parameters:
      listMonitorsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listMonitorsPaginator

      default ListMonitorsPublisher listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)

      This is a variant of listMonitors(software.amazon.awssdk.services.deadline.model.ListMonitorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListMonitorsPublisher publisher = client.listMonitorsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListMonitorsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListMonitorsResponse 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 listMonitors(software.amazon.awssdk.services.deadline.model.ListMonitorsRequest) operation.


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

      Parameters:
      listMonitorsRequest - A Consumer that will call methods on ListMonitorsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueEnvironments

      default CompletableFuture<ListQueueEnvironmentsResponse> listQueueEnvironments(ListQueueEnvironmentsRequest listQueueEnvironmentsRequest)

      Lists queue environments.

      Parameters:
      listQueueEnvironmentsRequest -
      Returns:
      A Java Future containing the result of the ListQueueEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueEnvironments

      default CompletableFuture<ListQueueEnvironmentsResponse> listQueueEnvironments(Consumer<ListQueueEnvironmentsRequest.Builder> listQueueEnvironmentsRequest)

      Lists queue environments.


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

      Parameters:
      listQueueEnvironmentsRequest - A Consumer that will call methods on ListQueueEnvironmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueueEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueEnvironmentsPaginator

      default ListQueueEnvironmentsPublisher listQueueEnvironmentsPaginator(ListQueueEnvironmentsRequest listQueueEnvironmentsRequest)

      This is a variant of listQueueEnvironments(software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueEnvironmentsPublisher publisher = client.listQueueEnvironmentsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueEnvironmentsPublisher publisher = client.listQueueEnvironmentsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsResponse 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 listQueueEnvironments(software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsRequest) operation.

      Parameters:
      listQueueEnvironmentsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueEnvironmentsPaginator

      default ListQueueEnvironmentsPublisher listQueueEnvironmentsPaginator(Consumer<ListQueueEnvironmentsRequest.Builder> listQueueEnvironmentsRequest)

      This is a variant of listQueueEnvironments(software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueEnvironmentsPublisher publisher = client.listQueueEnvironmentsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueEnvironmentsPublisher publisher = client.listQueueEnvironmentsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsResponse 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 listQueueEnvironments(software.amazon.awssdk.services.deadline.model.ListQueueEnvironmentsRequest) operation.


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

      Parameters:
      listQueueEnvironmentsRequest - A Consumer that will call methods on ListQueueEnvironmentsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueFleetAssociations

      default CompletableFuture<ListQueueFleetAssociationsResponse> listQueueFleetAssociations(ListQueueFleetAssociationsRequest listQueueFleetAssociationsRequest)

      Lists queue-fleet associations.

      Parameters:
      listQueueFleetAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListQueueFleetAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueFleetAssociations

      default CompletableFuture<ListQueueFleetAssociationsResponse> listQueueFleetAssociations(Consumer<ListQueueFleetAssociationsRequest.Builder> listQueueFleetAssociationsRequest)

      Lists queue-fleet associations.


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

      Parameters:
      listQueueFleetAssociationsRequest - A Consumer that will call methods on ListQueueFleetAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueueFleetAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueFleetAssociationsPaginator

      default ListQueueFleetAssociationsPublisher listQueueFleetAssociationsPaginator(ListQueueFleetAssociationsRequest listQueueFleetAssociationsRequest)

      This is a variant of listQueueFleetAssociations(software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueFleetAssociationsPublisher publisher = client.listQueueFleetAssociationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueFleetAssociationsPublisher publisher = client.listQueueFleetAssociationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsResponse 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 listQueueFleetAssociations(software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsRequest) operation.

      Parameters:
      listQueueFleetAssociationsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueFleetAssociationsPaginator

      default ListQueueFleetAssociationsPublisher listQueueFleetAssociationsPaginator(Consumer<ListQueueFleetAssociationsRequest.Builder> listQueueFleetAssociationsRequest)

      This is a variant of listQueueFleetAssociations(software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueFleetAssociationsPublisher publisher = client.listQueueFleetAssociationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueFleetAssociationsPublisher publisher = client.listQueueFleetAssociationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsResponse 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 listQueueFleetAssociations(software.amazon.awssdk.services.deadline.model.ListQueueFleetAssociationsRequest) operation.


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

      Parameters:
      listQueueFleetAssociationsRequest - A Consumer that will call methods on ListQueueFleetAssociationsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueLimitAssociations

      default CompletableFuture<ListQueueLimitAssociationsResponse> listQueueLimitAssociations(ListQueueLimitAssociationsRequest listQueueLimitAssociationsRequest)

      Gets a list of the associations between queues and limits defined in a farm.

      Parameters:
      listQueueLimitAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListQueueLimitAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueLimitAssociations

      default CompletableFuture<ListQueueLimitAssociationsResponse> listQueueLimitAssociations(Consumer<ListQueueLimitAssociationsRequest.Builder> listQueueLimitAssociationsRequest)

      Gets a list of the associations between queues and limits defined in a farm.


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

      Parameters:
      listQueueLimitAssociationsRequest - A Consumer that will call methods on ListQueueLimitAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueueLimitAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueLimitAssociationsPaginator

      default ListQueueLimitAssociationsPublisher listQueueLimitAssociationsPaginator(ListQueueLimitAssociationsRequest listQueueLimitAssociationsRequest)

      This is a variant of listQueueLimitAssociations(software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueLimitAssociationsPublisher publisher = client.listQueueLimitAssociationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueLimitAssociationsPublisher publisher = client.listQueueLimitAssociationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsResponse 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 listQueueLimitAssociations(software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsRequest) operation.

      Parameters:
      listQueueLimitAssociationsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueLimitAssociationsPaginator

      default ListQueueLimitAssociationsPublisher listQueueLimitAssociationsPaginator(Consumer<ListQueueLimitAssociationsRequest.Builder> listQueueLimitAssociationsRequest)

      This is a variant of listQueueLimitAssociations(software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueLimitAssociationsPublisher publisher = client.listQueueLimitAssociationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueLimitAssociationsPublisher publisher = client.listQueueLimitAssociationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsResponse 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 listQueueLimitAssociations(software.amazon.awssdk.services.deadline.model.ListQueueLimitAssociationsRequest) operation.


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

      Parameters:
      listQueueLimitAssociationsRequest - A Consumer that will call methods on ListQueueLimitAssociationsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueMembers

      default CompletableFuture<ListQueueMembersResponse> listQueueMembers(ListQueueMembersRequest listQueueMembersRequest)

      Lists the members in a queue.

      Parameters:
      listQueueMembersRequest -
      Returns:
      A Java Future containing the result of the ListQueueMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueMembers

      default CompletableFuture<ListQueueMembersResponse> listQueueMembers(Consumer<ListQueueMembersRequest.Builder> listQueueMembersRequest)

      Lists the members in a queue.


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

      Parameters:
      listQueueMembersRequest - A Consumer that will call methods on ListQueueMembersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueueMembers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueMembersPaginator

      default ListQueueMembersPublisher listQueueMembersPaginator(ListQueueMembersRequest listQueueMembersRequest)

      This is a variant of listQueueMembers(software.amazon.awssdk.services.deadline.model.ListQueueMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueMembersPublisher publisher = client.listQueueMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueMembersPublisher publisher = client.listQueueMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueMembersResponse 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 listQueueMembers(software.amazon.awssdk.services.deadline.model.ListQueueMembersRequest) operation.

      Parameters:
      listQueueMembersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueueMembersPaginator

      default ListQueueMembersPublisher listQueueMembersPaginator(Consumer<ListQueueMembersRequest.Builder> listQueueMembersRequest)

      This is a variant of listQueueMembers(software.amazon.awssdk.services.deadline.model.ListQueueMembersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueMembersPublisher publisher = client.listQueueMembersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueueMembersPublisher publisher = client.listQueueMembersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueueMembersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueueMembersResponse 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 listQueueMembers(software.amazon.awssdk.services.deadline.model.ListQueueMembersRequest) operation.


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

      Parameters:
      listQueueMembersRequest - A Consumer that will call methods on ListQueueMembersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueues

      default CompletableFuture<ListQueuesResponse> listQueues(ListQueuesRequest listQueuesRequest)

      Lists queues.

      Parameters:
      listQueuesRequest -
      Returns:
      A Java Future containing the result of the ListQueues operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueues

      default CompletableFuture<ListQueuesResponse> listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)

      Lists queues.


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

      Parameters:
      listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueues operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueuesPaginator

      default ListQueuesPublisher listQueuesPaginator(ListQueuesRequest listQueuesRequest)

      This is a variant of listQueues(software.amazon.awssdk.services.deadline.model.ListQueuesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueuesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueuesResponse 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 listQueues(software.amazon.awssdk.services.deadline.model.ListQueuesRequest) operation.

      Parameters:
      listQueuesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listQueuesPaginator

      default ListQueuesPublisher listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest)

      This is a variant of listQueues(software.amazon.awssdk.services.deadline.model.ListQueuesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListQueuesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListQueuesResponse 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 listQueues(software.amazon.awssdk.services.deadline.model.ListQueuesRequest) operation.


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

      Parameters:
      listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionActions

      default CompletableFuture<ListSessionActionsResponse> listSessionActions(ListSessionActionsRequest listSessionActionsRequest)

      Lists session actions.

      Parameters:
      listSessionActionsRequest -
      Returns:
      A Java Future containing the result of the ListSessionActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionActions

      default CompletableFuture<ListSessionActionsResponse> listSessionActions(Consumer<ListSessionActionsRequest.Builder> listSessionActionsRequest)

      Lists session actions.


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

      Parameters:
      listSessionActionsRequest - A Consumer that will call methods on ListSessionActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSessionActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionActionsPaginator

      default ListSessionActionsPublisher listSessionActionsPaginator(ListSessionActionsRequest listSessionActionsRequest)

      This is a variant of listSessionActions(software.amazon.awssdk.services.deadline.model.ListSessionActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionActionsPublisher publisher = client.listSessionActionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionActionsPublisher publisher = client.listSessionActionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListSessionActionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListSessionActionsResponse 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 listSessionActions(software.amazon.awssdk.services.deadline.model.ListSessionActionsRequest) operation.

      Parameters:
      listSessionActionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionActionsPaginator

      default ListSessionActionsPublisher listSessionActionsPaginator(Consumer<ListSessionActionsRequest.Builder> listSessionActionsRequest)

      This is a variant of listSessionActions(software.amazon.awssdk.services.deadline.model.ListSessionActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionActionsPublisher publisher = client.listSessionActionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionActionsPublisher publisher = client.listSessionActionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListSessionActionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListSessionActionsResponse 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 listSessionActions(software.amazon.awssdk.services.deadline.model.ListSessionActionsRequest) operation.


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

      Parameters:
      listSessionActionsRequest - A Consumer that will call methods on ListSessionActionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessions

      default CompletableFuture<ListSessionsResponse> listSessions(ListSessionsRequest listSessionsRequest)

      Lists sessions.

      Parameters:
      listSessionsRequest -
      Returns:
      A Java Future containing the result of the ListSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessions

      default CompletableFuture<ListSessionsResponse> listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)

      Lists sessions.


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

      Parameters:
      listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionsForWorker

      default CompletableFuture<ListSessionsForWorkerResponse> listSessionsForWorker(ListSessionsForWorkerRequest listSessionsForWorkerRequest)

      Lists sessions for a worker.

      Parameters:
      listSessionsForWorkerRequest -
      Returns:
      A Java Future containing the result of the ListSessionsForWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionsForWorker

      default CompletableFuture<ListSessionsForWorkerResponse> listSessionsForWorker(Consumer<ListSessionsForWorkerRequest.Builder> listSessionsForWorkerRequest)

      Lists sessions for a worker.


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

      Parameters:
      listSessionsForWorkerRequest - A Consumer that will call methods on ListSessionsForWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSessionsForWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionsForWorkerPaginator

      default ListSessionsForWorkerPublisher listSessionsForWorkerPaginator(ListSessionsForWorkerRequest listSessionsForWorkerRequest)

      This is a variant of listSessionsForWorker(software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsForWorkerPublisher publisher = client.listSessionsForWorkerPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsForWorkerPublisher publisher = client.listSessionsForWorkerPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerResponse 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 listSessionsForWorker(software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerRequest) operation.

      Parameters:
      listSessionsForWorkerRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionsForWorkerPaginator

      default ListSessionsForWorkerPublisher listSessionsForWorkerPaginator(Consumer<ListSessionsForWorkerRequest.Builder> listSessionsForWorkerRequest)

      This is a variant of listSessionsForWorker(software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsForWorkerPublisher publisher = client.listSessionsForWorkerPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsForWorkerPublisher publisher = client.listSessionsForWorkerPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerResponse 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 listSessionsForWorker(software.amazon.awssdk.services.deadline.model.ListSessionsForWorkerRequest) operation.


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

      Parameters:
      listSessionsForWorkerRequest - A Consumer that will call methods on ListSessionsForWorkerRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionsPaginator

      default ListSessionsPublisher listSessionsPaginator(ListSessionsRequest listSessionsRequest)

      This is a variant of listSessions(software.amazon.awssdk.services.deadline.model.ListSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListSessionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListSessionsResponse 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 listSessions(software.amazon.awssdk.services.deadline.model.ListSessionsRequest) operation.

      Parameters:
      listSessionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSessionsPaginator

      default ListSessionsPublisher listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)

      This is a variant of listSessions(software.amazon.awssdk.services.deadline.model.ListSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListSessionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListSessionsResponse 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 listSessions(software.amazon.awssdk.services.deadline.model.ListSessionsRequest) operation.


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

      Parameters:
      listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepConsumers

      default CompletableFuture<ListStepConsumersResponse> listStepConsumers(ListStepConsumersRequest listStepConsumersRequest)

      Lists step consumers.

      Parameters:
      listStepConsumersRequest -
      Returns:
      A Java Future containing the result of the ListStepConsumers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepConsumers

      default CompletableFuture<ListStepConsumersResponse> listStepConsumers(Consumer<ListStepConsumersRequest.Builder> listStepConsumersRequest)

      Lists step consumers.


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

      Parameters:
      listStepConsumersRequest - A Consumer that will call methods on ListStepConsumersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStepConsumers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepConsumersPaginator

      default ListStepConsumersPublisher listStepConsumersPaginator(ListStepConsumersRequest listStepConsumersRequest)

      This is a variant of listStepConsumers(software.amazon.awssdk.services.deadline.model.ListStepConsumersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStepConsumersPublisher publisher = client.listStepConsumersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStepConsumersPublisher publisher = client.listStepConsumersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStepConsumersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStepConsumersResponse 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 listStepConsumers(software.amazon.awssdk.services.deadline.model.ListStepConsumersRequest) operation.

      Parameters:
      listStepConsumersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepConsumersPaginator

      default ListStepConsumersPublisher listStepConsumersPaginator(Consumer<ListStepConsumersRequest.Builder> listStepConsumersRequest)

      This is a variant of listStepConsumers(software.amazon.awssdk.services.deadline.model.ListStepConsumersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStepConsumersPublisher publisher = client.listStepConsumersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStepConsumersPublisher publisher = client.listStepConsumersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStepConsumersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStepConsumersResponse 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 listStepConsumers(software.amazon.awssdk.services.deadline.model.ListStepConsumersRequest) operation.


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

      Parameters:
      listStepConsumersRequest - A Consumer that will call methods on ListStepConsumersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepDependencies

      default CompletableFuture<ListStepDependenciesResponse> listStepDependencies(ListStepDependenciesRequest listStepDependenciesRequest)

      Lists the dependencies for a step.

      Parameters:
      listStepDependenciesRequest -
      Returns:
      A Java Future containing the result of the ListStepDependencies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepDependencies

      default CompletableFuture<ListStepDependenciesResponse> listStepDependencies(Consumer<ListStepDependenciesRequest.Builder> listStepDependenciesRequest)

      Lists the dependencies for a step.


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

      Parameters:
      listStepDependenciesRequest - A Consumer that will call methods on ListStepDependenciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStepDependencies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepDependenciesPaginator

      default ListStepDependenciesPublisher listStepDependenciesPaginator(ListStepDependenciesRequest listStepDependenciesRequest)

      This is a variant of listStepDependencies(software.amazon.awssdk.services.deadline.model.ListStepDependenciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStepDependenciesPublisher publisher = client.listStepDependenciesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStepDependenciesPublisher publisher = client.listStepDependenciesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStepDependenciesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStepDependenciesResponse 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 listStepDependencies(software.amazon.awssdk.services.deadline.model.ListStepDependenciesRequest) operation.

      Parameters:
      listStepDependenciesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepDependenciesPaginator

      default ListStepDependenciesPublisher listStepDependenciesPaginator(Consumer<ListStepDependenciesRequest.Builder> listStepDependenciesRequest)

      This is a variant of listStepDependencies(software.amazon.awssdk.services.deadline.model.ListStepDependenciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStepDependenciesPublisher publisher = client.listStepDependenciesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStepDependenciesPublisher publisher = client.listStepDependenciesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStepDependenciesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStepDependenciesResponse 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 listStepDependencies(software.amazon.awssdk.services.deadline.model.ListStepDependenciesRequest) operation.


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

      Parameters:
      listStepDependenciesRequest - A Consumer that will call methods on ListStepDependenciesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSteps

      default CompletableFuture<ListStepsResponse> listSteps(ListStepsRequest listStepsRequest)

      Lists steps for a job.

      Parameters:
      listStepsRequest -
      Returns:
      A Java Future containing the result of the ListSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listSteps

      default CompletableFuture<ListStepsResponse> listSteps(Consumer<ListStepsRequest.Builder> listStepsRequest)

      Lists steps for a job.


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

      Parameters:
      listStepsRequest - A Consumer that will call methods on ListStepsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepsPaginator

      default ListStepsPublisher listStepsPaginator(ListStepsRequest listStepsRequest)

      This is a variant of listSteps(software.amazon.awssdk.services.deadline.model.ListStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStepsPublisher publisher = client.listStepsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStepsPublisher publisher = client.listStepsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStepsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStepsResponse 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 listSteps(software.amazon.awssdk.services.deadline.model.ListStepsRequest) operation.

      Parameters:
      listStepsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStepsPaginator

      default ListStepsPublisher listStepsPaginator(Consumer<ListStepsRequest.Builder> listStepsRequest)

      This is a variant of listSteps(software.amazon.awssdk.services.deadline.model.ListStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStepsPublisher publisher = client.listStepsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStepsPublisher publisher = client.listStepsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStepsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStepsResponse 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 listSteps(software.amazon.awssdk.services.deadline.model.ListStepsRequest) operation.


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

      Parameters:
      listStepsRequest - A Consumer that will call methods on ListStepsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfiles

      default CompletableFuture<ListStorageProfilesResponse> listStorageProfiles(ListStorageProfilesRequest listStorageProfilesRequest)

      Lists storage profiles.

      Parameters:
      listStorageProfilesRequest -
      Returns:
      A Java Future containing the result of the ListStorageProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfiles

      default CompletableFuture<ListStorageProfilesResponse> listStorageProfiles(Consumer<ListStorageProfilesRequest.Builder> listStorageProfilesRequest)

      Lists storage profiles.


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

      Parameters:
      listStorageProfilesRequest - A Consumer that will call methods on ListStorageProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStorageProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfilesForQueue

      default CompletableFuture<ListStorageProfilesForQueueResponse> listStorageProfilesForQueue(ListStorageProfilesForQueueRequest listStorageProfilesForQueueRequest)

      Lists storage profiles for a queue.

      Parameters:
      listStorageProfilesForQueueRequest -
      Returns:
      A Java Future containing the result of the ListStorageProfilesForQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfilesForQueue

      default CompletableFuture<ListStorageProfilesForQueueResponse> listStorageProfilesForQueue(Consumer<ListStorageProfilesForQueueRequest.Builder> listStorageProfilesForQueueRequest)

      Lists storage profiles for a queue.


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

      Parameters:
      listStorageProfilesForQueueRequest - A Consumer that will call methods on ListStorageProfilesForQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStorageProfilesForQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfilesForQueuePaginator

      default ListStorageProfilesForQueuePublisher listStorageProfilesForQueuePaginator(ListStorageProfilesForQueueRequest listStorageProfilesForQueueRequest)

      This is a variant of listStorageProfilesForQueue(software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesForQueuePublisher publisher = client.listStorageProfilesForQueuePaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesForQueuePublisher publisher = client.listStorageProfilesForQueuePaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueResponse 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 listStorageProfilesForQueue(software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueRequest) operation.

      Parameters:
      listStorageProfilesForQueueRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfilesForQueuePaginator

      default ListStorageProfilesForQueuePublisher listStorageProfilesForQueuePaginator(Consumer<ListStorageProfilesForQueueRequest.Builder> listStorageProfilesForQueueRequest)

      This is a variant of listStorageProfilesForQueue(software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesForQueuePublisher publisher = client.listStorageProfilesForQueuePaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesForQueuePublisher publisher = client.listStorageProfilesForQueuePaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueResponse 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 listStorageProfilesForQueue(software.amazon.awssdk.services.deadline.model.ListStorageProfilesForQueueRequest) operation.


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

      Parameters:
      listStorageProfilesForQueueRequest - A Consumer that will call methods on ListStorageProfilesForQueueRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfilesPaginator

      default ListStorageProfilesPublisher listStorageProfilesPaginator(ListStorageProfilesRequest listStorageProfilesRequest)

      This is a variant of listStorageProfiles(software.amazon.awssdk.services.deadline.model.ListStorageProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesPublisher publisher = client.listStorageProfilesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesPublisher publisher = client.listStorageProfilesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStorageProfilesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStorageProfilesResponse 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 listStorageProfiles(software.amazon.awssdk.services.deadline.model.ListStorageProfilesRequest) operation.

      Parameters:
      listStorageProfilesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listStorageProfilesPaginator

      default ListStorageProfilesPublisher listStorageProfilesPaginator(Consumer<ListStorageProfilesRequest.Builder> listStorageProfilesRequest)

      This is a variant of listStorageProfiles(software.amazon.awssdk.services.deadline.model.ListStorageProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesPublisher publisher = client.listStorageProfilesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListStorageProfilesPublisher publisher = client.listStorageProfilesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListStorageProfilesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListStorageProfilesResponse 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 listStorageProfiles(software.amazon.awssdk.services.deadline.model.ListStorageProfilesRequest) operation.


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

      Parameters:
      listStorageProfilesRequest - A Consumer that will call methods on ListStorageProfilesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists tags for a resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists tags for a resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)

      Lists tasks for a job.

      Parameters:
      listTasksRequest -
      Returns:
      A Java Future containing the result of the ListTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)

      Lists tasks for a job.


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

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)

      This is a variant of listTasks(software.amazon.awssdk.services.deadline.model.ListTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListTasksResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListTasksResponse 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 listTasks(software.amazon.awssdk.services.deadline.model.ListTasksRequest) operation.

      Parameters:
      listTasksRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)

      This is a variant of listTasks(software.amazon.awssdk.services.deadline.model.ListTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListTasksResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListTasksResponse 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 listTasks(software.amazon.awssdk.services.deadline.model.ListTasksRequest) operation.


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

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkers

      default CompletableFuture<ListWorkersResponse> listWorkers(ListWorkersRequest listWorkersRequest)

      Lists workers.

      Parameters:
      listWorkersRequest -
      Returns:
      A Java Future containing the result of the ListWorkers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkers

      default CompletableFuture<ListWorkersResponse> listWorkers(Consumer<ListWorkersRequest.Builder> listWorkersRequest)

      Lists workers.


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

      Parameters:
      listWorkersRequest - A Consumer that will call methods on ListWorkersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkersPaginator

      default ListWorkersPublisher listWorkersPaginator(ListWorkersRequest listWorkersRequest)

      This is a variant of listWorkers(software.amazon.awssdk.services.deadline.model.ListWorkersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListWorkersPublisher publisher = client.listWorkersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListWorkersPublisher publisher = client.listWorkersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListWorkersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListWorkersResponse 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 listWorkers(software.amazon.awssdk.services.deadline.model.ListWorkersRequest) operation.

      Parameters:
      listWorkersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkersPaginator

      default ListWorkersPublisher listWorkersPaginator(Consumer<ListWorkersRequest.Builder> listWorkersRequest)

      This is a variant of listWorkers(software.amazon.awssdk.services.deadline.model.ListWorkersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.deadline.paginators.ListWorkersPublisher publisher = client.listWorkersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.deadline.paginators.ListWorkersPublisher publisher = client.listWorkersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.deadline.model.ListWorkersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.deadline.model.ListWorkersResponse 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 listWorkers(software.amazon.awssdk.services.deadline.model.ListWorkersRequest) operation.


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

      Parameters:
      listWorkersRequest - A Consumer that will call methods on ListWorkersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • putMeteredProduct

      default CompletableFuture<PutMeteredProductResponse> putMeteredProduct(PutMeteredProductRequest putMeteredProductRequest)

      Adds a metered product.

      Parameters:
      putMeteredProductRequest -
      Returns:
      A Java Future containing the result of the PutMeteredProduct operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • putMeteredProduct

      default CompletableFuture<PutMeteredProductResponse> putMeteredProduct(Consumer<PutMeteredProductRequest.Builder> putMeteredProductRequest)

      Adds a metered product.


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

      Parameters:
      putMeteredProductRequest - A Consumer that will call methods on PutMeteredProductRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutMeteredProduct operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchJobs

      default CompletableFuture<SearchJobsResponse> searchJobs(SearchJobsRequest searchJobsRequest)

      Searches for jobs.

      Parameters:
      searchJobsRequest -
      Returns:
      A Java Future containing the result of the SearchJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchJobs

      default CompletableFuture<SearchJobsResponse> searchJobs(Consumer<SearchJobsRequest.Builder> searchJobsRequest)

      Searches for jobs.


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

      Parameters:
      searchJobsRequest - A Consumer that will call methods on SearchJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchSteps

      default CompletableFuture<SearchStepsResponse> searchSteps(SearchStepsRequest searchStepsRequest)

      Searches for steps.

      Parameters:
      searchStepsRequest -
      Returns:
      A Java Future containing the result of the SearchSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchSteps

      default CompletableFuture<SearchStepsResponse> searchSteps(Consumer<SearchStepsRequest.Builder> searchStepsRequest)

      Searches for steps.


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

      Parameters:
      searchStepsRequest - A Consumer that will call methods on SearchStepsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchTasks

      default CompletableFuture<SearchTasksResponse> searchTasks(SearchTasksRequest searchTasksRequest)

      Searches for tasks.

      Parameters:
      searchTasksRequest -
      Returns:
      A Java Future containing the result of the SearchTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchTasks

      default CompletableFuture<SearchTasksResponse> searchTasks(Consumer<SearchTasksRequest.Builder> searchTasksRequest)

      Searches for tasks.


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

      Parameters:
      searchTasksRequest - A Consumer that will call methods on SearchTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchWorkers

      default CompletableFuture<SearchWorkersResponse> searchWorkers(SearchWorkersRequest searchWorkersRequest)

      Searches for workers.

      Parameters:
      searchWorkersRequest -
      Returns:
      A Java Future containing the result of the SearchWorkers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchWorkers

      default CompletableFuture<SearchWorkersResponse> searchWorkers(Consumer<SearchWorkersRequest.Builder> searchWorkersRequest)

      Searches for workers.


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

      Parameters:
      searchWorkersRequest - A Consumer that will call methods on SearchWorkersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchWorkers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startSessionsStatisticsAggregation

      default CompletableFuture<StartSessionsStatisticsAggregationResponse> startSessionsStatisticsAggregation(StartSessionsStatisticsAggregationRequest startSessionsStatisticsAggregationRequest)

      Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

      Parameters:
      startSessionsStatisticsAggregationRequest -
      Returns:
      A Java Future containing the result of the StartSessionsStatisticsAggregation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • startSessionsStatisticsAggregation

      default CompletableFuture<StartSessionsStatisticsAggregationResponse> startSessionsStatisticsAggregation(Consumer<StartSessionsStatisticsAggregationRequest.Builder> startSessionsStatisticsAggregationRequest)

      Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.


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

      Parameters:
      startSessionsStatisticsAggregationRequest - A Consumer that will call methods on StartSessionsStatisticsAggregationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartSessionsStatisticsAggregation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Tags a resource using the resource's ARN and desired tags.

      Parameters:
      tagResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Tags a resource using the resource's ARN and desired tags.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag from a resource using the resource's ARN and tag to remove.

      Parameters:
      untagResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes a tag from a resource using the resource's ARN and tag to remove.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateBudget

      default CompletableFuture<UpdateBudgetResponse> updateBudget(UpdateBudgetRequest updateBudgetRequest)

      Updates a budget that sets spending thresholds for rendering activity.

      Parameters:
      updateBudgetRequest -
      Returns:
      A Java Future containing the result of the UpdateBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateBudget

      default CompletableFuture<UpdateBudgetResponse> updateBudget(Consumer<UpdateBudgetRequest.Builder> updateBudgetRequest)

      Updates a budget that sets spending thresholds for rendering activity.


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

      Parameters:
      updateBudgetRequest - A Consumer that will call methods on UpdateBudgetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBudget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateFarm

      default CompletableFuture<UpdateFarmResponse> updateFarm(UpdateFarmRequest updateFarmRequest)

      Updates a farm.

      Parameters:
      updateFarmRequest -
      Returns:
      A Java Future containing the result of the UpdateFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateFarm

      default CompletableFuture<UpdateFarmResponse> updateFarm(Consumer<UpdateFarmRequest.Builder> updateFarmRequest)

      Updates a farm.


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

      Parameters:
      updateFarmRequest - A Consumer that will call methods on UpdateFarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateFleet

      default CompletableFuture<UpdateFleetResponse> updateFleet(UpdateFleetRequest updateFleetRequest)

      Updates a fleet.

      Parameters:
      updateFleetRequest -
      Returns:
      A Java Future containing the result of the UpdateFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateFleet

      default CompletableFuture<UpdateFleetResponse> updateFleet(Consumer<UpdateFleetRequest.Builder> updateFleetRequest)

      Updates a fleet.


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

      Parameters:
      updateFleetRequest - A Consumer that will call methods on UpdateFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFleet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateJob

      default CompletableFuture<UpdateJobResponse> updateJob(UpdateJobRequest updateJobRequest)

      Updates a job.

      When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

      An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

      Parameters:
      updateJobRequest -
      Returns:
      A Java Future containing the result of the UpdateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateJob

      default CompletableFuture<UpdateJobResponse> updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest)

      Updates a job.

      When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

      An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.


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

      Parameters:
      updateJobRequest - A Consumer that will call methods on UpdateJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateLimit

      default CompletableFuture<UpdateLimitResponse> updateLimit(UpdateLimitRequest updateLimitRequest)

      Updates the properties of the specified limit.

      Parameters:
      updateLimitRequest -
      Returns:
      A Java Future containing the result of the UpdateLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateLimit

      default CompletableFuture<UpdateLimitResponse> updateLimit(Consumer<UpdateLimitRequest.Builder> updateLimitRequest)

      Updates the properties of the specified limit.


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

      Parameters:
      updateLimitRequest - A Consumer that will call methods on UpdateLimitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLimit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateMonitor

      default CompletableFuture<UpdateMonitorResponse> updateMonitor(UpdateMonitorRequest updateMonitorRequest)

      Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.

      Parameters:
      updateMonitorRequest -
      Returns:
      A Java Future containing the result of the UpdateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateMonitor

      default CompletableFuture<UpdateMonitorResponse> updateMonitor(Consumer<UpdateMonitorRequest.Builder> updateMonitorRequest)

      Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.


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

      Parameters:
      updateMonitorRequest - A Consumer that will call methods on UpdateMonitorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMonitor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueue

      default CompletableFuture<UpdateQueueResponse> updateQueue(UpdateQueueRequest updateQueueRequest)

      Updates a queue.

      Parameters:
      updateQueueRequest -
      Returns:
      A Java Future containing the result of the UpdateQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueue

      default CompletableFuture<UpdateQueueResponse> updateQueue(Consumer<UpdateQueueRequest.Builder> updateQueueRequest)

      Updates a queue.


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

      Parameters:
      updateQueueRequest - A Consumer that will call methods on UpdateQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueueEnvironment

      default CompletableFuture<UpdateQueueEnvironmentResponse> updateQueueEnvironment(UpdateQueueEnvironmentRequest updateQueueEnvironmentRequest)

      Updates the queue environment.

      Parameters:
      updateQueueEnvironmentRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueueEnvironment

      default CompletableFuture<UpdateQueueEnvironmentResponse> updateQueueEnvironment(Consumer<UpdateQueueEnvironmentRequest.Builder> updateQueueEnvironmentRequest)

      Updates the queue environment.


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

      Parameters:
      updateQueueEnvironmentRequest - A Consumer that will call methods on UpdateQueueEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueueFleetAssociation

      default CompletableFuture<UpdateQueueFleetAssociationResponse> updateQueueFleetAssociation(UpdateQueueFleetAssociationRequest updateQueueFleetAssociationRequest)

      Updates a queue-fleet association.

      Parameters:
      updateQueueFleetAssociationRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueueFleetAssociation

      default CompletableFuture<UpdateQueueFleetAssociationResponse> updateQueueFleetAssociation(Consumer<UpdateQueueFleetAssociationRequest.Builder> updateQueueFleetAssociationRequest)

      Updates a queue-fleet association.


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

      Parameters:
      updateQueueFleetAssociationRequest - A Consumer that will call methods on UpdateQueueFleetAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueFleetAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueueLimitAssociation

      default CompletableFuture<UpdateQueueLimitAssociationResponse> updateQueueLimitAssociation(UpdateQueueLimitAssociationRequest updateQueueLimitAssociationRequest)

      Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.

      Parameters:
      updateQueueLimitAssociationRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueueLimitAssociation

      default CompletableFuture<UpdateQueueLimitAssociationResponse> updateQueueLimitAssociation(Consumer<UpdateQueueLimitAssociationRequest.Builder> updateQueueLimitAssociationRequest)

      Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.


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

      Parameters:
      updateQueueLimitAssociationRequest - A Consumer that will call methods on UpdateQueueLimitAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueLimitAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateSession

      default CompletableFuture<UpdateSessionResponse> updateSession(UpdateSessionRequest updateSessionRequest)

      Updates a session.

      Parameters:
      updateSessionRequest -
      Returns:
      A Java Future containing the result of the UpdateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateSession

      default CompletableFuture<UpdateSessionResponse> updateSession(Consumer<UpdateSessionRequest.Builder> updateSessionRequest)

      Updates a session.


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

      Parameters:
      updateSessionRequest - A Consumer that will call methods on UpdateSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateStep

      default CompletableFuture<UpdateStepResponse> updateStep(UpdateStepRequest updateStepRequest)

      Updates a step.

      Parameters:
      updateStepRequest -
      Returns:
      A Java Future containing the result of the UpdateStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateStep

      default CompletableFuture<UpdateStepResponse> updateStep(Consumer<UpdateStepRequest.Builder> updateStepRequest)

      Updates a step.


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

      Parameters:
      updateStepRequest - A Consumer that will call methods on UpdateStepRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateStorageProfile

      default CompletableFuture<UpdateStorageProfileResponse> updateStorageProfile(UpdateStorageProfileRequest updateStorageProfileRequest)

      Updates a storage profile.

      Parameters:
      updateStorageProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateStorageProfile

      default CompletableFuture<UpdateStorageProfileResponse> updateStorageProfile(Consumer<UpdateStorageProfileRequest.Builder> updateStorageProfileRequest)

      Updates a storage profile.


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

      Parameters:
      updateStorageProfileRequest - A Consumer that will call methods on UpdateStorageProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateStorageProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateTask

      default CompletableFuture<UpdateTaskResponse> updateTask(UpdateTaskRequest updateTaskRequest)

      Updates a task.

      Parameters:
      updateTaskRequest -
      Returns:
      A Java Future containing the result of the UpdateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateTask

      default CompletableFuture<UpdateTaskResponse> updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)

      Updates a task.


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

      Parameters:
      updateTaskRequest - A Consumer that will call methods on UpdateTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorker

      default CompletableFuture<UpdateWorkerResponse> updateWorker(UpdateWorkerRequest updateWorkerRequest)

      Updates a worker.

      Parameters:
      updateWorkerRequest -
      Returns:
      A Java Future containing the result of the UpdateWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorker

      default CompletableFuture<UpdateWorkerResponse> updateWorker(Consumer<UpdateWorkerRequest.Builder> updateWorkerRequest)

      Updates a worker.


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

      Parameters:
      updateWorkerRequest - A Consumer that will call methods on UpdateWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorkerSchedule

      default CompletableFuture<UpdateWorkerScheduleResponse> updateWorkerSchedule(UpdateWorkerScheduleRequest updateWorkerScheduleRequest)

      Updates the schedule for a worker.

      Parameters:
      updateWorkerScheduleRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkerSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorkerSchedule

      default CompletableFuture<UpdateWorkerScheduleResponse> updateWorkerSchedule(Consumer<UpdateWorkerScheduleRequest.Builder> updateWorkerScheduleRequest)

      Updates the schedule for a worker.


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

      Parameters:
      updateWorkerScheduleRequest - A Consumer that will call methods on UpdateWorkerScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkerSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have permission to perform the action.
      • InternalServerErrorException Deadline Cloud can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a request rate quota.
      • ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ValidationException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
      • 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.
      • DeadlineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • waiter

      default DeadlineAsyncWaiter waiter()
      Create an instance of DeadlineAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of DeadlineAsyncWaiter
    • serviceClientConfiguration

      default DeadlineServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration
    • create

      static DeadlineAsyncClient create()
      Create a DeadlineAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

      static DeadlineAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a DeadlineAsyncClient.