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() For responses, this returns true if the service returned a value for the Principals property.
boolean	hasResourceShareArns() For responses, this returns true if the service returned a value for the ResourceShareArns property.
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.
List<String>	principals() Specifies that you want to list information for only the listed principals.
String	resourceArn() Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).
ResourceOwner	resourceOwner() Specifies that you want to list information for only resource shares that match the following:
String	resourceOwnerAsString() Specifies that you want to list information for only resource shares that match the following:
List<String>	resourceShareArns() Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).
String	resourceType() Specifies that you want to list information for only principals associated with resource shares that include the specified 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()

Specifies that you want to list information for only resource shares that match the following:

• SELF – principals that your account is sharing resources with

• OTHER-ACCOUNTS – principals that are sharing resources with your account

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:

Specifies that you want to list information for only resource shares that match the following:

• SELF – principals that your account is sharing resources with

• OTHER-ACCOUNTS – principals that are sharing resources with your account

See Also:

ResourceOwner

resourceOwnerAsString

public final String resourceOwnerAsString()

Specifies that you want to list information for only resource shares that match the following:

• SELF – principals that your account is sharing resources with

• OTHER-ACCOUNTS – principals that are sharing resources with your account

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:

Specifies that you want to list information for only resource shares that match the following:

• SELF – principals that your account is sharing resources with

• OTHER-ACCOUNTS – principals that are sharing resources with your account

See Also:

ResourceOwner

resourceArn

public final String resourceArn()

Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

Returns:

Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

hasPrincipals

public final boolean hasPrincipals()

For responses, this returns true if the service returned a value for the Principals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

principals

public final List<String> principals()

Specifies that you want to list information for only the listed principals.

You can include the following values:

• An Amazon Web Services account ID, for example: 123456789012

• An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

• An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

• An ARN of an IAM role, for example: iam::123456789012:role/rolename

• An ARN of an IAM user, for example: iam::123456789012user/username

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrincipals() method.

Returns:

Specifies that you want to list information for only the listed principals.

You can include the following values:

• An Amazon Web Services account ID, for example: 123456789012

• An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

• An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

• An ARN of an IAM role, for example: iam::123456789012:role/rolename

• An ARN of an IAM user, for example: iam::123456789012user/username

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

resourceType

public final String resourceType()

Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

For a list of valid values, query the ListResourceTypes operation.

Returns:

Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

For a list of valid values, query the ListResourceTypes operation.

hasResourceShareArns

public final boolean hasResourceShareArns()

For responses, this returns true if the service returned a value for the ResourceShareArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

resourceShareArns

public final List<String> resourceShareArns()

Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceShareArns() method.

Returns:

Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

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.

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