Interface FieldDefinition.Builder

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

  • Method Details

    • name

      FieldDefinition.Builder name(String name)

      The name of the field in the entity schema.

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

    • fieldDataType

      FieldDefinition.Builder fieldDataType(String fieldDataType)

      The data type of the field.

      Parameters:
      fieldDataType - The data type of the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fieldDataType

      FieldDefinition.Builder fieldDataType(FieldDataType fieldDataType)

      The data type of the field.

      Parameters:
      fieldDataType - The data type of the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • responseDateFormat

      FieldDefinition.Builder responseDateFormat(String responseDateFormat)

      The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds.

      Parameters:
      responseDateFormat - The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isPartitionable

      FieldDefinition.Builder isPartitionable(Boolean isPartitionable)

      Indicates whether this field can be used for partitioning queries to the data source.

      Parameters:
      isPartitionable - Indicates whether this field can be used for partitioning queries to the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isNullable

      FieldDefinition.Builder isNullable(Boolean isNullable)

      Indicates whether this field can contain null values.

      Parameters:
      isNullable - Indicates whether this field can contain null values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isQueryable

      FieldDefinition.Builder isQueryable(Boolean isQueryable)

      Indicates whether this field can be used in filter predicates when querying data.

      Parameters:
      isQueryable - Indicates whether this field can be used in filter predicates when querying data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isOrderable

      FieldDefinition.Builder isOrderable(Boolean isOrderable)

      Indicates whether this field can be used for ordering results.

      Parameters:
      isOrderable - Indicates whether this field can be used for ordering results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterOverrides

      FieldDefinition.Builder filterOverrides(FilterOverrides filterOverrides)

      Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.

      Parameters:
      filterOverrides - Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterOverrides

      default FieldDefinition.Builder filterOverrides(Consumer<FilterOverrides.Builder> filterOverrides)

      Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.

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

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

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