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

Interface GetUnfilteredTableMetadataRequest.Builder

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

  • Method Details

    • region

      GetUnfilteredTableMetadataRequest.Builder region(String region)

      Specified only if the base tables belong to a different Amazon Web Services Region.

      Parameters:
      region - Specified only if the base tables belong to a different Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • catalogId

      GetUnfilteredTableMetadataRequest.Builder catalogId(String catalogId)

      The catalog ID where the table resides.

      Parameters:
      catalogId - The catalog ID where the table resides.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      GetUnfilteredTableMetadataRequest.Builder databaseName(String databaseName)

      (Required) Specifies the name of a database that contains the table.

      Parameters:
      databaseName - (Required) Specifies the name of a database that contains the table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetUnfilteredTableMetadataRequest.Builder name(String name)

      (Required) Specifies the name of a table for which you are requesting metadata.

      Parameters:
      name - (Required) Specifies the name of a table for which you are requesting metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • auditContext

      GetUnfilteredTableMetadataRequest.Builder auditContext(AuditContext auditContext)

      A structure containing Lake Formation audit context information.

      Parameters:
      auditContext - A structure containing Lake Formation audit context information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • auditContext

      default GetUnfilteredTableMetadataRequest.Builder auditContext(Consumer<AuditContext.Builder> auditContext)

      A structure containing Lake Formation audit context information.

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

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

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

    • supportedPermissionTypesWithStrings

      GetUnfilteredTableMetadataRequest.Builder supportedPermissionTypesWithStrings(Collection<String> supportedPermissionTypes)

      Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

      Parameters:
      supportedPermissionTypes - Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

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

    • supportedPermissionTypesWithStrings

      GetUnfilteredTableMetadataRequest.Builder supportedPermissionTypesWithStrings(String... supportedPermissionTypes)

      Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

      Parameters:
      supportedPermissionTypes - Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

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

    • supportedPermissionTypes

      GetUnfilteredTableMetadataRequest.Builder supportedPermissionTypes(Collection<PermissionType> supportedPermissionTypes)

      Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

      Parameters:
      supportedPermissionTypes - Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

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

    • supportedPermissionTypes

      GetUnfilteredTableMetadataRequest.Builder supportedPermissionTypes(PermissionType... supportedPermissionTypes)

      Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

      Parameters:
      supportedPermissionTypes - Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:

      • COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.

      • CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.

      • NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.

      • NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.

      Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.

      Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.

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

    • parentResourceArn

      GetUnfilteredTableMetadataRequest.Builder parentResourceArn(String parentResourceArn)

      The resource ARN of the view.

      Parameters:
      parentResourceArn - The resource ARN of the view.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rootResourceArn

      GetUnfilteredTableMetadataRequest.Builder rootResourceArn(String rootResourceArn)

      The resource ARN of the root view in a chain of nested views.

      Parameters:
      rootResourceArn - The resource ARN of the root view in a chain of nested views.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedDialect

      GetUnfilteredTableMetadataRequest.Builder supportedDialect(SupportedDialect supportedDialect)

      A structure specifying the dialect and dialect version used by the query engine.

      Parameters:
      supportedDialect - A structure specifying the dialect and dialect version used by the query engine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedDialect

      default GetUnfilteredTableMetadataRequest.Builder supportedDialect(Consumer<SupportedDialect.Builder> supportedDialect)

      A structure specifying the dialect and dialect version used by the query engine.

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

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

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

    • permissionsWithStrings

      GetUnfilteredTableMetadataRequest.Builder permissionsWithStrings(Collection<String> permissions)

      The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.

      Parameters:
      permissions - The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissionsWithStrings

      GetUnfilteredTableMetadataRequest.Builder permissionsWithStrings(String... permissions)

      The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.

      Parameters:
      permissions - The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      GetUnfilteredTableMetadataRequest.Builder permissions(Collection<Permission> permissions)

      The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.

      Parameters:
      permissions - The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      GetUnfilteredTableMetadataRequest.Builder permissions(Permission... permissions)

      The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.

      Parameters:
      permissions - The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • querySessionContext

      GetUnfilteredTableMetadataRequest.Builder querySessionContext(QuerySessionContext querySessionContext)

      A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

      Parameters:
      querySessionContext - A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • querySessionContext

      default GetUnfilteredTableMetadataRequest.Builder querySessionContext(Consumer<QuerySessionContext.Builder> querySessionContext)

      A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

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

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

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

    • overrideConfiguration

      GetUnfilteredTableMetadataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      GetUnfilteredTableMetadataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder