Class ListPermissionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListPermissionsRequest.Builder,
ListPermissionsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(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 int
hashCode()
final Integer
Specifies the total number of results that you want included on each page of the response.final String
Specifies that you want to receive the next page of results.final PermissionTypeFilter
Specifies that you want to list only permissions of this type:final String
Specifies that you want to list only permissions of this type:final String
Specifies that you want to list only those permissions that apply to the specified resource type.static Class
<? extends ListPermissionsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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'sNextToken
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'sNextToken
response to request the next page of results.
-
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 theNextToken
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 checkNextToken
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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.
-
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 returnPermissionTypeFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionTypeAsString()
.- 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
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 returnPermissionTypeFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionTypeAsString()
.- 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
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 interfaceToCopyableBuilder<ListPermissionsRequest.Builder,
ListPermissionsRequest> - Specified by:
toBuilder
in classRamRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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. -
getValueForField
Description copied from class:SdkRequest
Used 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:
getValueForField
in 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
-