Interface UpdateFleetRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>, DeadlineRequest.Builder, SdkBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateFleetRequest
@Mutable @NotThreadSafe public static interface UpdateFleetRequest.Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>

  • Method Details

    • clientToken

      UpdateFleetRequest.Builder clientToken(String clientToken)

      The unique token which the server uses to recognize retries of the same request.

      Parameters:
      clientToken - The unique token which the server uses to recognize retries of the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • farmId

      UpdateFleetRequest.Builder farmId(String farmId)

      The farm ID to update.

      Parameters:
      farmId - The farm ID to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fleetId

      UpdateFleetRequest.Builder fleetId(String fleetId)

      The fleet ID to update.

      Parameters:
      fleetId - The fleet ID to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      UpdateFleetRequest.Builder displayName(String displayName)

      The display name of the fleet to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Parameters:
      displayName - The display name of the fleet to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateFleetRequest.Builder description(String description)

      The description of the fleet to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Parameters:
      description - The description of the fleet to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      UpdateFleetRequest.Builder roleArn(String roleArn)

      The IAM role ARN that the fleet's workers assume while running jobs.

      Parameters:
      roleArn - The IAM role ARN that the fleet's workers assume while running jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minWorkerCount

      UpdateFleetRequest.Builder minWorkerCount(Integer minWorkerCount)

      The minimum number of workers in the fleet.

      Parameters:
      minWorkerCount - The minimum number of workers in the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxWorkerCount

      UpdateFleetRequest.Builder maxWorkerCount(Integer maxWorkerCount)

      The maximum number of workers in the fleet.

      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:
      maxWorkerCount - The maximum number of workers in the fleet.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      UpdateFleetRequest.Builder configuration(FleetConfiguration configuration)

      The fleet configuration to update.

      Parameters:
      configuration - The fleet configuration to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default UpdateFleetRequest.Builder configuration(Consumer<FleetConfiguration.Builder> configuration)

      The fleet configuration to update.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(FleetConfiguration).

      Parameters:
      configuration - a consumer that will call methods on FleetConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hostConfiguration

      UpdateFleetRequest.Builder hostConfiguration(HostConfiguration hostConfiguration)

      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

      Parameters:
      hostConfiguration - Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostConfiguration

      default UpdateFleetRequest.Builder hostConfiguration(Consumer<HostConfiguration.Builder> hostConfiguration)

      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hostConfiguration(HostConfiguration).

      Parameters:
      hostConfiguration - a consumer that will call methods on HostConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateFleetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.