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("software.amazon.awssdk:codegen") public final class GetResourceShareAssociationsRequest extends RamRequest implements ToCopyableBuilder<GetResourceShareAssociationsRequest.Builder,GetResourceShareAssociationsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetResourceShareAssociationsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ResourceShareAssociationStatusassociationStatus()Specifies that you want to retrieve only associations that have this status.StringassociationStatusAsString()Specifies that you want to retrieve only associations that have this status.ResourceShareAssociationTypeassociationType()Specifies whether you want to retrieve the associations that involve a specified resource or principal.StringassociationTypeAsString()Specifies whether you want to retrieve the associations that involve a specified resource or principal.static GetResourceShareAssociationsRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasResourceShareArns()For responses, this returns true if the service returned a value for the ResourceShareArns property.IntegermaxResults()Specifies the total number of results that you want included on each page of the response.StringnextToken()Specifies that you want to receive the next page of results.Stringprincipal()Specifies the ID of the principal whose resource shares you want to retrieve.StringresourceArn()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.BuildertoBuilder()StringtoString()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,
associationTypewill returnResourceShareAssociationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassociationTypeAsString().- 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,
associationTypewill returnResourceShareAssociationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassociationTypeAsString().- 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 theisEmpty()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 role or user.
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 role or user.
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,
associationStatuswill returnResourceShareAssociationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassociationStatusAsString().- 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,
associationStatuswill returnResourceShareAssociationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassociationStatusAsString().- 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
NextTokenresponse 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'sNextTokenresponse 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
NextTokenresponse 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'sNextTokenresponse 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
NextTokenresponse element is returned with a value (not null). Include the specified value as theNextTokenrequest 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 checkNextTokenafter 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
NextTokenresponse element is returned with a value (not null). Include the specified value as theNextTokenrequest 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 checkNextTokenafter every operation to ensure that you receive all of the results.
-
toBuilder
public GetResourceShareAssociationsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetResourceShareAssociationsRequest.Builder,GetResourceShareAssociationsRequest>- Specified by:
toBuilderin classRamRequest
-
builder
public static GetResourceShareAssociationsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetResourceShareAssociationsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-