Class GetUnfilteredTableMetadataRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.glue.model.GlueRequest
-
- software.amazon.awssdk.services.glue.model.GetUnfilteredTableMetadataRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetUnfilteredTableMetadataRequest.Builder,GetUnfilteredTableMetadataRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetUnfilteredTableMetadataRequest extends GlueRequest implements ToCopyableBuilder<GetUnfilteredTableMetadataRequest.Builder,GetUnfilteredTableMetadataRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetUnfilteredTableMetadataRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuditContext
auditContext()
A structure containing Lake Formation audit context information.static GetUnfilteredTableMetadataRequest.Builder
builder()
String
catalogId()
The catalog ID where the table resides.String
databaseName()
(Required) Specifies the name of a database that contains the table.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasPermissions()
For responses, this returns true if the service returned a value for the Permissions property.boolean
hasSupportedPermissionTypes()
For responses, this returns true if the service returned a value for the SupportedPermissionTypes property.String
name()
(Required) Specifies the name of a table for which you are requesting metadata.String
parentResourceArn()
The resource ARN of the view.List<Permission>
permissions()
The Lake Formation data permissions of the caller on the table.List<String>
permissionsAsStrings()
The Lake Formation data permissions of the caller on the table.QuerySessionContext
querySessionContext()
A structure used as a protocol between query engines and Lake Formation or Glue.String
region()
Specified only if the base tables belong to a different Amazon Web Services Region.String
rootResourceArn()
The resource ARN of the root view in a chain of nested views.List<SdkField<?>>
sdkFields()
static Class<? extends GetUnfilteredTableMetadataRequest.Builder>
serializableBuilderClass()
SupportedDialect
supportedDialect()
A structure specifying the dialect and dialect version used by the query engine.List<PermissionType>
supportedPermissionTypes()
Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling theGetUnfilteredTableMetadata
API operation.List<String>
supportedPermissionTypesAsStrings()
Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling theGetUnfilteredTableMetadata
API operation.GetUnfilteredTableMetadataRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
region
public final String region()
Specified only if the base tables belong to a different Amazon Web Services Region.
- Returns:
- Specified only if the base tables belong to a different Amazon Web Services Region.
-
catalogId
public final String catalogId()
The catalog ID where the table resides.
- Returns:
- The catalog ID where the table resides.
-
databaseName
public final String databaseName()
(Required) Specifies the name of a database that contains the table.
- Returns:
- (Required) Specifies the name of a database that contains the table.
-
name
public final String name()
(Required) Specifies the name of a table for which you are requesting metadata.
- Returns:
- (Required) Specifies the name of a table for which you are requesting metadata.
-
auditContext
public final AuditContext auditContext()
A structure containing Lake Formation audit context information.
- Returns:
- A structure containing Lake Formation audit context information.
-
supportedPermissionTypes
public final List<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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedPermissionTypes()
method.- Returns:
- 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. -
-
-
hasSupportedPermissionTypes
public final boolean hasSupportedPermissionTypes()
For responses, this returns true if the service returned a value for the SupportedPermissionTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
supportedPermissionTypesAsStrings
public final List<String> supportedPermissionTypesAsStrings()
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedPermissionTypes()
method.- Returns:
- 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. -
-
-
parentResourceArn
public final String parentResourceArn()
The resource ARN of the view.
- Returns:
- The resource ARN of the view.
-
rootResourceArn
public final String rootResourceArn()
The resource ARN of the root view in a chain of nested views.
- Returns:
- The resource ARN of the root view in a chain of nested views.
-
supportedDialect
public final SupportedDialect supportedDialect()
A structure specifying the dialect and dialect version used by the query engine.
- Returns:
- A structure specifying the dialect and dialect version used by the query engine.
-
permissions
public final List<Permission> permissions()
The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissions()
method.- Returns:
- The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
-
hasPermissions
public final boolean hasPermissions()
For responses, this returns true if the service returned a value for the Permissions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
permissionsAsStrings
public final List<String> permissionsAsStrings()
The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissions()
method.- Returns:
- The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
-
querySessionContext
public final 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.
- Returns:
- 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.
-
toBuilder
public GetUnfilteredTableMetadataRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetUnfilteredTableMetadataRequest.Builder,GetUnfilteredTableMetadataRequest>
- Specified by:
toBuilder
in classGlueRequest
-
builder
public static GetUnfilteredTableMetadataRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetUnfilteredTableMetadataRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-