software.amazon.awssdk.services.ram.model

Class ListPrincipalsRequest

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.ListPrincipalsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListPrincipalsRequest.Builder,ListPrincipalsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListPrincipalsRequest
extends RamRequest
implements ToCopyableBuilder<ListPrincipalsRequest.Builder,ListPrincipalsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListPrincipalsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListPrincipalsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of results to return with a single call.
String	nextToken() The token for the next page of results.
List<String>	principals() The principals.
String	resourceArn() The Amazon Resource Name (ARN) of the resource.
ResourceOwner	resourceOwner() The type of owner.
String	resourceOwnerAsString() The type of owner.
List<String>	resourceShareArns() The Amazon Resource Names (ARN) of the resource shares.
String	resourceType() The resource type.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPrincipalsRequest.Builder>	serializableBuilderClass()
ListPrincipalsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

resourceOwner

public ResourceOwner resourceOwner()

The type of owner.

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

Returns:

The type of owner.

See Also:

ResourceOwner

resourceOwnerAsString

public String resourceOwnerAsString()

The type of owner.

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

Returns:

The type of owner.

See Also:

ResourceOwner

resourceArn

public String resourceArn()

The Amazon Resource Name (ARN) of the resource.

Returns:

The Amazon Resource Name (ARN) of the resource.

principals

public List<String> principals()

The principals.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The principals.

resourceType

public String resourceType()

The resource type.

Returns:

The resource type.

resourceShareArns

public List<String> resourceShareArns()

The Amazon Resource Names (ARN) of the resource shares.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The Amazon Resource Names (ARN) of the resource shares.

nextToken

public String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

maxResults

public Integer maxResults()

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

toBuilder

public ListPrincipalsRequest.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<ListPrincipalsRequest.Builder,ListPrincipalsRequest>

Specified by:

toBuilder in class RamRequest

Returns:

a builder for type T

builder

public static ListPrincipalsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListPrincipalsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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 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.