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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPrincipals() Returns true if the Principals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasResourceShareArns() Returns true if the ResourceShareArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
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

resourceOwner

public final 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 final 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 final String resourceArn()

The Amazon Resource Name (ARN) of the resource.

Returns:

The Amazon Resource Name (ARN) of the resource.

hasPrincipals

public final boolean hasPrincipals()

Returns true if the Principals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

principals

public final List<String> principals()

The principals.

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

You can use hasPrincipals() to see if a value was sent in this field.

Returns:

The principals.

resourceType

public final String resourceType()

The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup | route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

Returns:

The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

hasResourceShareArns

public final boolean hasResourceShareArns()

Returns true if the ResourceShareArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

resourceShareArns

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

You can use hasResourceShareArns() to see if a value was sent in this field.

Returns:

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

nextToken

public final String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

maxResults

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPrincipalsRequest.Builder,ListPrincipalsRequest>

Specified by:

toBuilder in class RamRequest

builder

public static ListPrincipalsRequest.Builder builder()

serializableBuilderClass

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