Package software.amazon.awssdk.services.lakeformation.model

Class ListPermissionsRequest

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.ListPermissionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListPermissionsRequest extends LakeFormationRequest implements ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>

  • Method Details

    • 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()

      Specifies a principal to filter the permissions returned.

      Returns:
      Specifies a principal to filter the permissions returned.

    • resourceType

      public final DataLakeResourceType resourceType()

      Specifies a resource type to filter the permissions returned.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return DataLakeResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      Specifies a resource type to filter the permissions returned.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      Specifies a resource type to filter the permissions returned.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return DataLakeResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      Specifies a resource type to filter the permissions returned.
      See Also:

    • resource

      public final Resource resource()

      A resource where you will get a list of the principal permissions.

      This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.

      Returns:
      A resource where you will get a list of the principal permissions.

      This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.

    • nextToken

      public final String nextToken()

      A continuation token, if this is not the first call to retrieve this list.

      Returns:
      A continuation token, if this is not the first call to retrieve this list.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return.

      Returns:
      The maximum number of results to return.

    • includeRelated

      public final String includeRelated()

      Indicates that related permissions should be included in the results.

      Returns:
      Indicates that related permissions should be included in the results.

    • toBuilder

      public ListPermissionsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>
      Specified by:
      toBuilder in class LakeFormationRequest
      Returns:
      a builder for type T

    • builder

      public static ListPermissionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListPermissionsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.