Package software.amazon.awssdk.services.glue.model

Interface Field.Builder

    • Method Detail

      • fieldName

        Field.Builder fieldName​(String fieldName)

        A unique identifier for the field.

        Parameters:
        fieldName - A unique identifier for the field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • label

        Field.Builder label​(String label)

        A readable label used for the field.

        Parameters:
        label - A readable label used for the field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        Field.Builder description​(String description)

        A description of the field.

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

      • fieldType

        Field.Builder fieldType​(String fieldType)

        The type of data in the field.

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

      • fieldType

        Field.Builder fieldType​(FieldDataType fieldType)

        The type of data in the field.

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

      • isPrimaryKey

        Field.Builder isPrimaryKey​(Boolean isPrimaryKey)

        Indicates whether this field can used as a primary key for the given entity.

        Parameters:
        isPrimaryKey - Indicates whether this field can used as a primary key for the given entity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isNullable

        Field.Builder isNullable​(Boolean isNullable)

        Indicates whether this field can be nullable or not.

        Parameters:
        isNullable - Indicates whether this field can be nullable or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isRetrievable

        Field.Builder isRetrievable​(Boolean isRetrievable)

        Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.

        Parameters:
        isRetrievable - Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isFilterable

        Field.Builder isFilterable​(Boolean isFilterable)

        Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.

        Parameters:
        isFilterable - Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isPartitionable

        Field.Builder isPartitionable​(Boolean isPartitionable)

        Indicates whether a given field can be used in partitioning the query made to SaaS.

        Parameters:
        isPartitionable - Indicates whether a given field can be used in partitioning the query made to SaaS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isCreateable

        Field.Builder isCreateable​(Boolean isCreateable)

        Indicates whether this field can be created as part of a destination write.

        Parameters:
        isCreateable - Indicates whether this field can be created as part of a destination write.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isUpdateable

        Field.Builder isUpdateable​(Boolean isUpdateable)

        Indicates whether this field can be updated as part of a destination write.

        Parameters:
        isUpdateable - Indicates whether this field can be updated as part of a destination write.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isUpsertable

        Field.Builder isUpsertable​(Boolean isUpsertable)

        Indicates whether this field can be upserted as part of a destination write.

        Parameters:
        isUpsertable - Indicates whether this field can be upserted as part of a destination write.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isDefaultOnCreate

        Field.Builder isDefaultOnCreate​(Boolean isDefaultOnCreate)

        Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.

        Parameters:
        isDefaultOnCreate - Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedValues

        Field.Builder supportedValues​(Collection<String> supportedValues)

        A list of supported values for the field.

        Parameters:
        supportedValues - A list of supported values for the field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedValues

        Field.Builder supportedValues​(String... supportedValues)

        A list of supported values for the field.

        Parameters:
        supportedValues - A list of supported values for the field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedFilterOperatorsWithStrings

        Field.Builder supportedFilterOperatorsWithStrings​(Collection<String> supportedFilterOperators)

        Indicates the support filter operators for this field.

        Parameters:
        supportedFilterOperators - Indicates the support filter operators for this field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedFilterOperatorsWithStrings

        Field.Builder supportedFilterOperatorsWithStrings​(String... supportedFilterOperators)

        Indicates the support filter operators for this field.

        Parameters:
        supportedFilterOperators - Indicates the support filter operators for this field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedFilterOperators

        Field.Builder supportedFilterOperators​(Collection<FieldFilterOperator> supportedFilterOperators)

        Indicates the support filter operators for this field.

        Parameters:
        supportedFilterOperators - Indicates the support filter operators for this field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedFilterOperators

        Field.Builder supportedFilterOperators​(FieldFilterOperator... supportedFilterOperators)

        Indicates the support filter operators for this field.

        Parameters:
        supportedFilterOperators - Indicates the support filter operators for this field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentField

        Field.Builder parentField​(String parentField)

        A parent field name for a nested field.

        Parameters:
        parentField - A parent field name for a nested field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nativeDataType

        Field.Builder nativeDataType​(String nativeDataType)

        The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.

        Parameters:
        nativeDataType - The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customProperties

        Field.Builder customProperties​(Map<String,​String> customProperties)

        Optional map of keys which may be returned.

        Parameters:
        customProperties - Optional map of keys which may be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.