Class ListPrincipalsForPolicyRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListPrincipalsForPolicyRequest.Builder,ListPrincipalsForPolicyRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe ID of the Amazon Web Services account that contains the policy.builder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final IntegerThe maximum number of results to return in a single call.final StringThe token returned by a previous call.final StringThe ARN of the policy.final PrincipalTypeAn optional filter that limits the results to principals of the specified type.final StringAn optional filter that limits the results to principals of the specified type.static Class<? extends ListPrincipalsForPolicyRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
-
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,
principalTypewill returnPrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprincipalTypeAsString().- 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
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,
principalTypewill returnPrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprincipalTypeAsString().- 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
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
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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ListPrincipalsForPolicyRequest.Builder,ListPrincipalsForPolicyRequest> - Specified by:
toBuilderin classQuickSightRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-