Interface LimitSummary.Builder

  • Method Details

    • displayName

      LimitSummary.Builder displayName(String displayName)

      The name of the limit used in lists to identify 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 name of the limit used in lists to identify 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.
    • amountRequirementName

      LimitSummary.Builder amountRequirementName(String amountRequirementName)

      The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

      Parameters:
      amountRequirementName - The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxCount

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

      The maxValue 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.

      The maxValue 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.
    • createdAt

      LimitSummary.Builder createdAt(Instant createdAt)

      The Unix timestamp of the date and time that the limit was created.

      Parameters:
      createdAt - The Unix timestamp of the date and time that the limit was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdBy

      LimitSummary.Builder createdBy(String createdBy)

      The user identifier of the person that created the limit.

      Parameters:
      createdBy - The user identifier of the person that created the limit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      LimitSummary.Builder updatedAt(Instant updatedAt)

      The Unix timestamp of the date and time that the limit was last updated.

      Parameters:
      updatedAt - The Unix timestamp of the date and time that the limit was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedBy

      LimitSummary.Builder updatedBy(String updatedBy)

      The user identifier of the person that last updated the limit.

      Parameters:
      updatedBy - The user identifier of the person that last updated the limit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • farmId

      LimitSummary.Builder farmId(String 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

      LimitSummary.Builder limitId(String limitId)

      The unique identifier of the limit.

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

      LimitSummary.Builder currentCount(Integer currentCount)

      The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.

      Parameters:
      currentCount - The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.