Package software.amazon.awssdk.services.ram.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListPermissionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListPermissionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	Specifies the total number of results that you want included on each page of the response.
String	nextToken()	Specifies that you want to receive the next page of results.
PermissionTypeFilter	permissionType()	Specifies that you want to list only permissions of this type:
String	permissionTypeAsString()	Specifies that you want to list only permissions of this type:
String	resourceType()	Specifies that you want to list only those permissions that apply to the specified resource type.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPermissionsRequest.Builder>	serializableBuilderClass()
ListPermissionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

PermissionTypeFilter

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:

PermissionTypeFilter

toBuilder

public ListPermissionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>

Specified by:

toBuilder in class RamRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo