software.amazon.awssdk.services.lakeformation.model

Class GrantPermissionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lakeformation.model.LakeFormationRequest

software.amazon.awssdk.services.lakeformation.model.GrantPermissionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GrantPermissionsRequest.Builder,GrantPermissionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GrantPermissionsRequest
extends LakeFormationRequest
implements ToCopyableBuilder<GrantPermissionsRequest.Builder,GrantPermissionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GrantPermissionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GrantPermissionsRequest.Builder	builder()
String	catalogId() The identifier for the Data Catalog.
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	hasPermissionsWithGrantOption() For responses, this returns true if the service returned a value for the PermissionsWithGrantOption property.
List<Permission>	permissions() The permissions granted to the principal on the resource.
List<String>	permissionsAsStrings() The permissions granted to the principal on the resource.
List<Permission>	permissionsWithGrantOption() Indicates a list of the granted permissions that the principal may pass to other users.
List<String>	permissionsWithGrantOptionAsStrings() Indicates a list of the granted permissions that the principal may pass to other users.
DataLakePrincipal	principal() The principal to be granted the permissions on the resource.
Resource	resource() The resource to which permissions are to be granted.
List<SdkField<?>>	sdkFields()
static Class<? extends GrantPermissionsRequest.Builder>	serializableBuilderClass()
GrantPermissionsRequest.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

catalogId

public final String catalogId()

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

Returns:

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

principal

public final DataLakePrincipal principal()

The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.

Returns:

The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.

resource

public final Resource resource()

The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.

Returns:

The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.

permissions

public final List<Permission> permissions()

The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

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 permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

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 the isEmpty() 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 permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

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 permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

permissionsWithGrantOption

public final List<Permission> permissionsWithGrantOption()

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

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 hasPermissionsWithGrantOption() method.

Returns:

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

hasPermissionsWithGrantOption

public final boolean hasPermissionsWithGrantOption()

For responses, this returns true if the service returned a value for the PermissionsWithGrantOption property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

permissionsWithGrantOptionAsStrings

public final List<String> permissionsWithGrantOptionAsStrings()

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

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 hasPermissionsWithGrantOption() method.

Returns:

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

toBuilder

public GrantPermissionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GrantPermissionsRequest.Builder,GrantPermissionsRequest>

Specified by:

toBuilder in class LakeFormationRequest

builder

public static GrantPermissionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GrantPermissionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo