Interface Schema.Builder

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

  • Method Details

    • columns

      Schema.Builder columns(Collection<Column> columns)

      The columns for the relation that this schema represents.

      Parameters:
      columns - The columns for the relation that this schema represents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • columns

      Schema.Builder columns(Column... columns)

      The columns for the relation that this schema represents.

      Parameters:
      columns - The columns for the relation that this schema represents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • columns

      Schema.Builder columns(Consumer<Column.Builder>... columns)

      The columns for the relation that this schema represents.

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

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

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

    • partitionKeys

      Schema.Builder partitionKeys(Collection<Column> partitionKeys)

      The partition keys for the dataset underlying this schema.

      Parameters:
      partitionKeys - The partition keys for the dataset underlying this schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partitionKeys

      Schema.Builder partitionKeys(Column... partitionKeys)

      The partition keys for the dataset underlying this schema.

      Parameters:
      partitionKeys - The partition keys for the dataset underlying this schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partitionKeys

      Schema.Builder partitionKeys(Consumer<Column.Builder>... partitionKeys)

      The partition keys for the dataset underlying this schema.

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

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

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

    • analysisRuleTypesWithStrings

      Schema.Builder analysisRuleTypesWithStrings(Collection<String> analysisRuleTypes)

      The analysis rule types that are associated with the schema. Currently, only one entry is present.

      Parameters:
      analysisRuleTypes - The analysis rule types that are associated with the schema. Currently, only one entry is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analysisRuleTypesWithStrings

      Schema.Builder analysisRuleTypesWithStrings(String... analysisRuleTypes)

      The analysis rule types that are associated with the schema. Currently, only one entry is present.

      Parameters:
      analysisRuleTypes - The analysis rule types that are associated with the schema. Currently, only one entry is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analysisRuleTypes

      Schema.Builder analysisRuleTypes(Collection<AnalysisRuleType> analysisRuleTypes)

      The analysis rule types that are associated with the schema. Currently, only one entry is present.

      Parameters:
      analysisRuleTypes - The analysis rule types that are associated with the schema. Currently, only one entry is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analysisRuleTypes

      Schema.Builder analysisRuleTypes(AnalysisRuleType... analysisRuleTypes)

      The analysis rule types that are associated with the schema. Currently, only one entry is present.

      Parameters:
      analysisRuleTypes - The analysis rule types that are associated with the schema. Currently, only one entry is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analysisMethod

      Schema.Builder analysisMethod(String analysisMethod)

      The analysis method for the schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      Parameters:
      analysisMethod - The analysis method for the schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • analysisMethod

      Schema.Builder analysisMethod(AnalysisMethod analysisMethod)

      The analysis method for the schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      Parameters:
      analysisMethod - The analysis method for the schema.

      DIRECT_QUERY allows SQL queries to be run directly on this table.

      DIRECT_JOB allows PySpark jobs to be run directly on this table.

      MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectedAnalysisMethodsWithStrings

      Schema.Builder selectedAnalysisMethodsWithStrings(Collection<String> selectedAnalysisMethods)

      The selected analysis methods for the schema.

      Parameters:
      selectedAnalysisMethods - The selected analysis methods for the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedAnalysisMethodsWithStrings

      Schema.Builder selectedAnalysisMethodsWithStrings(String... selectedAnalysisMethods)

      The selected analysis methods for the schema.

      Parameters:
      selectedAnalysisMethods - The selected analysis methods for the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedAnalysisMethods

      Schema.Builder selectedAnalysisMethods(Collection<SelectedAnalysisMethod> selectedAnalysisMethods)

      The selected analysis methods for the schema.

      Parameters:
      selectedAnalysisMethods - The selected analysis methods for the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedAnalysisMethods

      Schema.Builder selectedAnalysisMethods(SelectedAnalysisMethod... selectedAnalysisMethods)

      The selected analysis methods for the schema.

      Parameters:
      selectedAnalysisMethods - The selected analysis methods for the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creatorAccountId

      Schema.Builder creatorAccountId(String creatorAccountId)

      The unique account ID for the Amazon Web Services account that owns the schema.

      Parameters:
      creatorAccountId - The unique account ID for the Amazon Web Services account that owns the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Schema.Builder name(String name)

      A name for the schema. The schema relation is referred to by this name when queried by a protected query.

      Parameters:
      name - A name for the schema. The schema relation is referred to by this name when queried by a protected query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • collaborationId

      Schema.Builder collaborationId(String collaborationId)

      The unique ID for the collaboration that the schema belongs to.

      Parameters:
      collaborationId - The unique ID for the collaboration that the schema belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • collaborationArn

      Schema.Builder collaborationArn(String collaborationArn)

      The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

      Parameters:
      collaborationArn - The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Schema.Builder description(String description)

      A description for the schema.

      Parameters:
      description - A description for the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createTime

      Schema.Builder createTime(Instant createTime)

      The time at which the schema was created.

      Parameters:
      createTime - The time at which the schema was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updateTime

      Schema.Builder updateTime(Instant updateTime)

      The most recent time at which the schema was updated.

      Parameters:
      updateTime - The most recent time at which the schema was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      Schema.Builder type(String type)

      The type of schema.

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

    • type

      Schema.Builder type(SchemaType type)

      The type of schema.

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

    • schemaStatusDetails

      Schema.Builder schemaStatusDetails(Collection<SchemaStatusDetail> schemaStatusDetails)

      Details about the status of the schema. Currently, only one entry is present.

      Parameters:
      schemaStatusDetails - Details about the status of the schema. Currently, only one entry is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaStatusDetails

      Schema.Builder schemaStatusDetails(SchemaStatusDetail... schemaStatusDetails)

      Details about the status of the schema. Currently, only one entry is present.

      Parameters:
      schemaStatusDetails - Details about the status of the schema. Currently, only one entry is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaStatusDetails

      Schema.Builder schemaStatusDetails(Consumer<SchemaStatusDetail.Builder>... schemaStatusDetails)

      Details about the status of the schema. Currently, only one entry is present.

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

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

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

    • schemaTypeProperties

      Schema.Builder schemaTypeProperties(SchemaTypeProperties schemaTypeProperties)

      The schema type properties.

      Parameters:
      schemaTypeProperties - The schema type properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaTypeProperties

      default Schema.Builder schemaTypeProperties(Consumer<SchemaTypeProperties.Builder> schemaTypeProperties)

      The schema type properties.

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

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

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