Class ListPermissionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ram.model.RamRequest
software.amazon.awssdk.services.ram.model.ListPermissionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListPermissionsRequest extends RamRequest implements ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>

  • Method Details

    • resourceType

      public final String resourceType()

      Specifies that you want to list only those permissions that apply to the specified resource type. This parameter is not case sensitive.

      For example, to list only permissions that apply to Amazon EC2 subnets, specify ec2:subnet. You can use the ListResourceTypes operation to get the specific string required.

      Returns:
      Specifies that you want to list only those permissions that apply to the specified resource type. This parameter is not case sensitive.

      For example, to list only permissions that apply to Amazon EC2 subnets, specify ec2:subnet. You can use the ListResourceTypes operation to get the specific string required.

    • nextToken

      public final String nextToken()

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

      Returns:
      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults

      public final Integer maxResults()

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

      Returns:
      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    • permissionType

      public final PermissionTypeFilter permissionType()

      Specifies that you want to list only permissions of this type:

      • AWS – returns only Amazon Web Services managed permissions.

      • LOCAL – returns only customer managed permissions

      • ALL – returns both Amazon Web Services managed permissions and customer managed permissions.

      If you don't specify this parameter, the default is All.

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

      Returns:
      Specifies that you want to list only permissions of this type:

      • AWS – returns only Amazon Web Services managed permissions.

      • LOCAL – returns only customer managed permissions

      • ALL – returns both Amazon Web Services managed permissions and customer managed permissions.

      If you don't specify this parameter, the default is All.

      See Also:

    • permissionTypeAsString

      public final String permissionTypeAsString()

      Specifies that you want to list only permissions of this type:

      • AWS – returns only Amazon Web Services managed permissions.

      • LOCAL – returns only customer managed permissions

      • ALL – returns both Amazon Web Services managed permissions and customer managed permissions.

      If you don't specify this parameter, the default is All.

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

      Returns:
      Specifies that you want to list only permissions of this type:

      • AWS – returns only Amazon Web Services managed permissions.

      • LOCAL – returns only customer managed permissions

      • ALL – returns both Amazon Web Services managed permissions and customer managed permissions.

      If you don't specify this parameter, the default is All.

      See Also:

    • 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 RamRequest
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.