Interface UpdateLimitRequest.Builder

  • Method Details

    • farmId

      The unique identifier of the farm that contains the limit.

      Parameters:
      farmId - The unique identifier of the farm that contains the limit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • limitId

      The unique identifier of the limit to update.

      Parameters:
      limitId - The unique identifier of the limit to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • displayName

      UpdateLimitRequest.Builder displayName(String displayName)

      The new display name of the limit.

      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 new display name of the limit.

      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

      UpdateLimitRequest.Builder description(String description)

      The new description of the limit.

      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 new description of the limit.

      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.
    • maxCount

      UpdateLimitRequest.Builder maxCount(Integer maxCount)

      The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

      If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.

      The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

      Parameters:
      maxCount - The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

      If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.

      The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

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

      UpdateLimitRequest.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

      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.