Interface SchemaDefinition.Builder

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

  • Method Details

    • type

      SchemaDefinition.Builder type(String type)

      The type of the schema definition. This field specifies the data type of the schema.

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

    • type

      SchemaDefinition.Builder type(SchemaType type)

      The type of the schema definition. This field specifies the data type of the schema.

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

    • properties

      SchemaDefinition.Builder properties(Map<String,SchemaDefinition> properties)

      The properties of the schema definition. These properties define the fields in the schema.

      Parameters:
      properties - The properties of the schema definition. These properties define the fields in the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • required

      SchemaDefinition.Builder required(Collection<String> required)

      The required fields in the schema definition. These fields must be provided when using the schema.

      Parameters:
      required - The required fields in the schema definition. These fields must be provided when using the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • required

      SchemaDefinition.Builder required(String... required)

      The required fields in the schema definition. These fields must be provided when using the schema.

      Parameters:
      required - The required fields in the schema definition. These fields must be provided when using the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      SchemaDefinition.Builder items(SchemaDefinition items)

      The items in the schema definition. This field is used for array types to define the structure of the array elements.

      Parameters:
      items - The items in the schema definition. This field is used for array types to define the structure of the array elements.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      default SchemaDefinition.Builder items(Consumer<SchemaDefinition.Builder> items)

      The items in the schema definition. This field is used for array types to define the structure of the array elements.

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

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

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

    • description

      SchemaDefinition.Builder description(String description)

      The description of the schema definition. This description provides information about the purpose and usage of the schema.

      Parameters:
      description - The description of the schema definition. This description provides information about the purpose and usage of the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.