Struct aws_sdk_glue::operation::get_unfiltered_table_metadata::builders::GetUnfilteredTableMetadataFluentBuilder

pub struct GetUnfilteredTableMetadataFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetUnfilteredTableMetadata.

Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.

For IAM authorization, the public IAM action associated with this API is glue:GetTable.

Implementations

impl GetUnfilteredTableMetadataFluentBuilder

pub fn as_input(&self) -> &GetUnfilteredTableMetadataInputBuilder

Access the GetUnfilteredTableMetadata as a reference.

pub async fn send( self, ) -> Result<GetUnfilteredTableMetadataOutput, SdkError<GetUnfilteredTableMetadataError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<GetUnfilteredTableMetadataOutput, GetUnfilteredTableMetadataError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn region(self, input: impl Into<String>) -> Self

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

pub fn set_region(self, input: Option<String>) -> Self

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

pub fn get_region(&self) -> &Option<String>

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

pub fn catalog_id(self, input: impl Into<String>) -> Self

The catalog ID where the table resides.

pub fn set_catalog_id(self, input: Option<String>) -> Self

The catalog ID where the table resides.

pub fn get_catalog_id(&self) -> &Option<String>

The catalog ID where the table resides.

pub fn database_name(self, input: impl Into<String>) -> Self

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

pub fn set_database_name(self, input: Option<String>) -> Self

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

pub fn get_database_name(&self) -> &Option<String>

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

pub fn name(self, input: impl Into<String>) -> Self

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

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn get_name(&self) -> &Option<String>

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

pub fn audit_context(self, input: AuditContext) -> Self

A structure containing Lake Formation audit context information.

pub fn set_audit_context(self, input: Option<AuditContext>) -> Self

A structure containing Lake Formation audit context information.

pub fn get_audit_context(&self) -> &Option<AuditContext>

A structure containing Lake Formation audit context information.

pub fn supported_permission_types(self, input: PermissionType) -> Self

Appends an item to SupportedPermissionTypes.

To override the contents of this collection use set_supported_permission_types.

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.

pub fn set_supported_permission_types( self, input: Option<Vec<PermissionType>>, ) -> Self

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.

pub fn get_supported_permission_types(&self) -> &Option<Vec<PermissionType>>

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.

pub fn parent_resource_arn(self, input: impl Into<String>) -> Self

The resource ARN of the view.

pub fn set_parent_resource_arn(self, input: Option<String>) -> Self

The resource ARN of the view.

pub fn get_parent_resource_arn(&self) -> &Option<String>

The resource ARN of the view.

pub fn root_resource_arn(self, input: impl Into<String>) -> Self

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

pub fn set_root_resource_arn(self, input: Option<String>) -> Self

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

pub fn get_root_resource_arn(&self) -> &Option<String>

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

pub fn supported_dialect(self, input: SupportedDialect) -> Self

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

pub fn set_supported_dialect(self, input: Option<SupportedDialect>) -> Self

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

pub fn get_supported_dialect(&self) -> &Option<SupportedDialect>

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

pub fn permissions(self, input: Permission) -> Self

Appends an item to Permissions.

To override the contents of this collection use set_permissions.

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

pub fn set_permissions(self, input: Option<Vec<Permission>>) -> Self

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

pub fn get_permissions(&self) -> &Option<Vec<Permission>>

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

pub fn query_session_context(self, input: QuerySessionContext) -> Self

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.

pub fn set_query_session_context( self, input: Option<QuerySessionContext>, ) -> Self

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.

pub fn get_query_session_context(&self) -> &Option<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.

Trait Implementations

impl Clone for GetUnfilteredTableMetadataFluentBuilder

fn clone(&self) -> GetUnfilteredTableMetadataFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetUnfilteredTableMetadataFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.