Package software.amazon.awssdk.services.cleanrooms.model

Interface Schema.Builder

    • Method Detail

      • columns

        Schema.Builder columns​(Collection<Column> columns)

        The columns for the relation this schema represents.

        Parameters:
        columns - The columns for the relation 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 this schema represents.

        Parameters:
        columns - The columns for the relation 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 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).

        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:
        #columns(java.util.Collection)

      • 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).

        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:
        #partitionKeys(java.util.Collection)

      • analysisRuleTypesWithStrings

        Schema.Builder analysisRuleTypesWithStrings​(Collection<String> analysisRuleTypes)

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

        Parameters:
        analysisRuleTypes - The analysis rule types 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 associated with the schema. Currently, only one entry is present.

        Parameters:
        analysisRuleTypes - The analysis rule types 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 associated with the schema. Currently, only one entry is present.

        Parameters:
        analysisRuleTypes - The analysis rule types 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 associated with the schema. Currently, only one entry is present.

        Parameters:
        analysisRuleTypes - The analysis rule types 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. The only valid value is currently DIRECT_QUERY.

        Parameters:
        analysisMethod - The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalysisMethod, AnalysisMethod

      • analysisMethod

        Schema.Builder analysisMethod​(AnalysisMethod analysisMethod)

        The analysis method for the schema. The only valid value is currently DIRECT_QUERY.

        Parameters:
        analysisMethod - The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalysisMethod, AnalysisMethod

      • 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 ARN for the collaboration that the schema belongs to.

        Parameters:
        collaborationArn - The unique 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 the schema was created.

        Parameters:
        createTime - The time 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 time the schema was last updated.

        Parameters:
        updateTime - The time the schema was last 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. The only valid value is currently `TABLE`.

        Parameters:
        type - The type of schema. The only valid value is currently `TABLE`.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SchemaType, SchemaType

      • type

        Schema.Builder type​(SchemaType type)

        The type of schema. The only valid value is currently `TABLE`.

        Parameters:
        type - The type of schema. The only valid value is currently `TABLE`.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SchemaType, SchemaType