Interface GrantItem.Builder

  • Method Details

    • dimensionKey

      GrantItem.Builder dimensionKey(String dimensionKey)

      The machine-readable key identifying the entitlement dimension.

      Parameters:
      dimensionKey - The machine-readable key identifying the entitlement dimension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • displayName

      GrantItem.Builder displayName(String displayName)

      The human-readable name of the entitlement dimension.

      Parameters:
      displayName - The human-readable name of the entitlement dimension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      GrantItem.Builder description(String description)

      A description of the entitlement.

      Parameters:
      description - A description of the entitlement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dimensionLabels

      GrantItem.Builder dimensionLabels(Collection<DimensionLabel> dimensionLabels)

      Labels used to categorize this entitlement, such as by region.

      Parameters:
      dimensionLabels - Labels used to categorize this entitlement, such as by region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dimensionLabels

      GrantItem.Builder dimensionLabels(DimensionLabel... dimensionLabels)

      Labels used to categorize this entitlement, such as by region.

      Parameters:
      dimensionLabels - Labels used to categorize this entitlement, such as by region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dimensionLabels

      GrantItem.Builder dimensionLabels(Consumer<DimensionLabel.Builder>... dimensionLabels)

      Labels used to categorize this entitlement, such as by region.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensionLabels(List<DimensionLabel>).

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

      The unit of measurement for the entitlement.

      Parameters:
      unit - The unit of measurement for the entitlement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxQuantity

      GrantItem.Builder maxQuantity(Integer maxQuantity)

      The maximum quantity of the entitlement that can be granted.

      Parameters:
      maxQuantity - The maximum quantity of the entitlement that can be granted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.