Interface FieldTypeDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FieldTypeDetails.Builder,FieldTypeDetails>, SdkBuilder<FieldTypeDetails.Builder,FieldTypeDetails>, SdkPojo
Enclosing class:
FieldTypeDetails

public static interface FieldTypeDetails.Builder extends SdkPojo, CopyableBuilder<FieldTypeDetails.Builder,FieldTypeDetails>
  • Method Details

    • fieldType

      FieldTypeDetails.Builder fieldType(String fieldType)

      The type of field, such as string, integer, date, and so on.

      Parameters:
      fieldType - The type of field, such as string, integer, date, and so on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterOperatorsWithStrings

      FieldTypeDetails.Builder filterOperatorsWithStrings(Collection<String> filterOperators)

      The list of operators supported by a field.

      Parameters:
      filterOperators - The list of operators supported by a field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterOperatorsWithStrings

      FieldTypeDetails.Builder filterOperatorsWithStrings(String... filterOperators)

      The list of operators supported by a field.

      Parameters:
      filterOperators - The list of operators supported by a field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterOperators

      FieldTypeDetails.Builder filterOperators(Collection<Operator> filterOperators)

      The list of operators supported by a field.

      Parameters:
      filterOperators - The list of operators supported by a field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterOperators

      FieldTypeDetails.Builder filterOperators(Operator... filterOperators)

      The list of operators supported by a field.

      Parameters:
      filterOperators - The list of operators supported by a field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • supportedValues

      FieldTypeDetails.Builder supportedValues(Collection<String> supportedValues)

      The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

      Parameters:
      supportedValues - The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • supportedValues

      FieldTypeDetails.Builder supportedValues(String... supportedValues)

      The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

      Parameters:
      supportedValues - The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • valueRegexPattern

      FieldTypeDetails.Builder valueRegexPattern(String valueRegexPattern)

      The regular expression pattern for the field name.

      Parameters:
      valueRegexPattern - The regular expression pattern for the field name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • supportedDateFormat

      FieldTypeDetails.Builder supportedDateFormat(String supportedDateFormat)

      The date format that the field supports.

      Parameters:
      supportedDateFormat - The date format that the field supports.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fieldValueRange

      FieldTypeDetails.Builder fieldValueRange(Range fieldValueRange)

      The range of values this field can hold.

      Parameters:
      fieldValueRange - The range of values this field can hold.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fieldValueRange

      default FieldTypeDetails.Builder fieldValueRange(Consumer<Range.Builder> fieldValueRange)

      The range of values this field can hold.

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

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

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

      FieldTypeDetails.Builder fieldLengthRange(Range fieldLengthRange)

      This is the allowable length range for this field's value.

      Parameters:
      fieldLengthRange - This is the allowable length range for this field's value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fieldLengthRange

      default FieldTypeDetails.Builder fieldLengthRange(Consumer<Range.Builder> fieldLengthRange)

      This is the allowable length range for this field's value.

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

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

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