software.amazon.awssdk.services.ram.model

Class GetResourceShareAssociationsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetResourceShareAssociationsRequest.Builder,GetResourceShareAssociationsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetResourceShareAssociationsRequest.Builder

Method Summary

Modifier and Type	Method and Description
ResourceShareAssociationStatus	associationStatus() Specifies that you want to retrieve only associations that have this status.
String	associationStatusAsString() Specifies that you want to retrieve only associations that have this status.
ResourceShareAssociationType	associationType() Specifies whether you want to retrieve the associations that involve a specified resource or principal.
String	associationTypeAsString() Specifies whether you want to retrieve the associations that involve a specified resource or principal.
static GetResourceShareAssociationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	principal() Specifies the ID of the principal whose resource shares you want to retrieve.
String	resourceArn() Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.
List<String>	resourceShareArns() Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.
List<SdkField<?>>	sdkFields()
static Class<? extends GetResourceShareAssociationsRequest.Builder>	serializableBuilderClass()
GetResourceShareAssociationsRequest.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

associationType

public final ResourceShareAssociationType associationType()

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

• PRINCIPAL – list the principals whose associations you want to see.

• RESOURCE – list the resources whose associations you want to see.

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

Returns:

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

• PRINCIPAL – list the principals whose associations you want to see.

• RESOURCE – list the resources whose associations you want to see.

See Also:

ResourceShareAssociationType

associationTypeAsString

public final String associationTypeAsString()

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

• PRINCIPAL – list the principals whose associations you want to see.

• RESOURCE – list the resources whose associations you want to see.

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

Returns:

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

• PRINCIPAL – list the principals whose associations you want to see.

• RESOURCE – list the resources whose associations you want to see.

See Also:

ResourceShareAssociationType

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 a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

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 a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

resourceArn

public final String resourceArn()

Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.

You cannot specify this parameter if the association type is PRINCIPAL.

Returns:

Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.

You cannot specify this parameter if the association type is PRINCIPAL.

principal

public final String principal()

Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM user or role.

You cannot specify this parameter if the association type is RESOURCE.

Returns:

Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM user or role.

You cannot specify this parameter if the association type is RESOURCE.

associationStatus

public final ResourceShareAssociationStatus associationStatus()

Specifies that you want to retrieve only associations that have this status.

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

Returns:

Specifies that you want to retrieve only associations that have this status.

See Also:

ResourceShareAssociationStatus

associationStatusAsString

public final String associationStatusAsString()

Specifies that you want to retrieve only associations that have this status.

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

Returns:

Specifies that you want to retrieve only associations that have this status.

See Also:

ResourceShareAssociationStatus

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 GetResourceShareAssociationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourceShareAssociationsRequest.Builder,GetResourceShareAssociationsRequest>

Specified by:

toBuilder in class RamRequest

builder

public static GetResourceShareAssociationsRequest.Builder builder()

serializableBuilderClass

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