Interface NamedEntityDefinition.Builder

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

  • Method Details

    • fieldName

      NamedEntityDefinition.Builder fieldName(String fieldName)

      The name of the entity.

      Parameters:
      fieldName - The name of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propertyName

      NamedEntityDefinition.Builder propertyName(String propertyName)

      The property name to be used for the named entity.

      Parameters:
      propertyName - The property name to be used for the named entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propertyRole

      NamedEntityDefinition.Builder propertyRole(String propertyRole)

      The property role. Valid values for this structure are PRIMARY and ID.

      Parameters:
      propertyRole - The property role. Valid values for this structure are PRIMARY and ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propertyRole

      NamedEntityDefinition.Builder propertyRole(PropertyRole propertyRole)

      The property role. Valid values for this structure are PRIMARY and ID.

      Parameters:
      propertyRole - The property role. Valid values for this structure are PRIMARY and ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propertyUsage

      NamedEntityDefinition.Builder propertyUsage(String propertyUsage)

      The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

      Parameters:
      propertyUsage - The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propertyUsage

      NamedEntityDefinition.Builder propertyUsage(PropertyUsage propertyUsage)

      The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

      Parameters:
      propertyUsage - The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metric

      NamedEntityDefinition.Builder metric(NamedEntityDefinitionMetric metric)

      The definition of a metric.

      Parameters:
      metric - The definition of a metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metric

      default NamedEntityDefinition.Builder metric(Consumer<NamedEntityDefinitionMetric.Builder> metric)

      The definition of a metric.

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

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

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

    • rankOrder

      NamedEntityDefinition.Builder rankOrder(Integer rankOrder)

      The rank order of the named entity definition.

      Parameters:
      rankOrder - The rank order of the named entity definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • presentationOrder

      NamedEntityDefinition.Builder presentationOrder(Integer presentationOrder)

      The presentation order of the named entity definition.

      Parameters:
      presentationOrder - The presentation order of the named entity definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isHidden

      NamedEntityDefinition.Builder isHidden(Boolean isHidden)

      A Boolean value that indicates whether the named entity definition is hidden.

      Parameters:
      isHidden - A Boolean value that indicates whether the named entity definition is hidden.
      Returns:
      Returns a reference to this object so that method calls can be chained together.