Class ListPrincipalsForPolicyRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPrincipalsForPolicyRequest.Builder,ListPrincipalsForPolicyRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListPrincipalsForPolicyRequest extends QuickSightRequest implements ToCopyableBuilder<ListPrincipalsForPolicyRequest.Builder,ListPrincipalsForPolicyRequest>
  • Method Details

    • accountId

      public final String accountId()

      The ID of the Amazon Web Services account that contains the policy.

      Returns:
      The ID of the Amazon Web Services account that contains the policy.
    • policyArn

      public final String policyArn()

      The ARN of the policy.

      Returns:
      The ARN of the policy.
    • principalType

      public final PrincipalType principalType()

      An optional filter that limits the results to principals of the specified type. If you don't specify a value, the operation returns principals of all types. You can specify one of the following values:

      • USER – An Amazon Quick Sight user.

      • GROUP – An Amazon Quick Sight group.

      • ACCOUNT – The Amazon Quick Sight account.

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

      Returns:
      An optional filter that limits the results to principals of the specified type. If you don't specify a value, the operation returns principals of all types. You can specify one of the following values:

      • USER – An Amazon Quick Sight user.

      • GROUP – An Amazon Quick Sight group.

      • ACCOUNT – The Amazon Quick Sight account.

      See Also:
    • principalTypeAsString

      public final String principalTypeAsString()

      An optional filter that limits the results to principals of the specified type. If you don't specify a value, the operation returns principals of all types. You can specify one of the following values:

      • USER – An Amazon Quick Sight user.

      • GROUP – An Amazon Quick Sight group.

      • ACCOUNT – The Amazon Quick Sight account.

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

      Returns:
      An optional filter that limits the results to principals of the specified type. If you don't specify a value, the operation returns principals of all types. You can specify one of the following values:

      • USER – An Amazon Quick Sight user.

      • GROUP – An Amazon Quick Sight group.

      • ACCOUNT – The Amazon Quick Sight account.

      See Also:
    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single call. Valid range is 1–100. If you don't specify a value, the operation returns up to 100 results.

      Returns:
      The maximum number of results to return in a single call. Valid range is 1–100. If you don't specify a value, the operation returns up to 100 results.
    • nextToken

      public final String nextToken()

      The token returned by a previous call. Use it to get the next page of results.

      Returns:
      The token returned by a previous call. Use it to get the next page of results.
    • 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<ListPrincipalsForPolicyRequest.Builder,ListPrincipalsForPolicyRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T
    • builder

      public static ListPrincipalsForPolicyRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ListPrincipalsForPolicyRequest.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.