com.amazonaws.services.ram.model

Class GetResourceSharesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ram.model.GetResourceSharesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetResourceSharesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetResourceSharesRequest()

Method Summary

Modifier and Type	Method and Description
GetResourceSharesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getMaxResults() Specifies the total number of results that you want included on each page of the response.
String	getName() Specifies the name of an individual resource share that you want to retrieve details about.
String	getNextToken() Specifies that you want to receive the next page of results.
String	getPermissionArn() Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).
Integer	getPermissionVersion() Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.
String	getResourceOwner() Specifies that you want to retrieve details of only those resource shares that match the following:
List<String>	getResourceShareArns() Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
String	getResourceShareStatus() Specifies that you want to retrieve details of only those resource shares that have this status.
List<TagFilter>	getTagFilters() Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.
int	hashCode()
void	setMaxResults(Integer maxResults) Specifies the total number of results that you want included on each page of the response.
void	setName(String name) Specifies the name of an individual resource share that you want to retrieve details about.
void	setNextToken(String nextToken) Specifies that you want to receive the next page of results.
void	setPermissionArn(String permissionArn) Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).
void	setPermissionVersion(Integer permissionVersion) Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.
void	setResourceOwner(String resourceOwner) Specifies that you want to retrieve details of only those resource shares that match the following:
void	setResourceShareArns(Collection<String> resourceShareArns) Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
void	setResourceShareStatus(String resourceShareStatus) Specifies that you want to retrieve details of only those resource shares that have this status.
void	setTagFilters(Collection<TagFilter> tagFilters) Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.
String	toString() Returns a string representation of this object.
GetResourceSharesRequest	withMaxResults(Integer maxResults) Specifies the total number of results that you want included on each page of the response.
GetResourceSharesRequest	withName(String name) Specifies the name of an individual resource share that you want to retrieve details about.
GetResourceSharesRequest	withNextToken(String nextToken) Specifies that you want to receive the next page of results.
GetResourceSharesRequest	withPermissionArn(String permissionArn) Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).
GetResourceSharesRequest	withPermissionVersion(Integer permissionVersion) Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.
GetResourceSharesRequest	withResourceOwner(ResourceOwner resourceOwner) Specifies that you want to retrieve details of only those resource shares that match the following:
GetResourceSharesRequest	withResourceOwner(String resourceOwner) Specifies that you want to retrieve details of only those resource shares that match the following:
GetResourceSharesRequest	withResourceShareArns(Collection<String> resourceShareArns) Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
GetResourceSharesRequest	withResourceShareArns(String... resourceShareArns) Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
GetResourceSharesRequest	withResourceShareStatus(ResourceShareStatus resourceShareStatus) Specifies that you want to retrieve details of only those resource shares that have this status.
GetResourceSharesRequest	withResourceShareStatus(String resourceShareStatus) Specifies that you want to retrieve details of only those resource shares that have this status.
GetResourceSharesRequest	withTagFilters(Collection<TagFilter> tagFilters) Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.
GetResourceSharesRequest	withTagFilters(TagFilter... tagFilters) Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetResourceSharesRequest

public GetResourceSharesRequest()

Method Detail

getResourceShareArns

public List<String> getResourceShareArns()

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

Returns:

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

setResourceShareArns

public void setResourceShareArns(Collection<String> resourceShareArns)

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

Parameters:

resourceShareArns - Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

withResourceShareArns

public GetResourceSharesRequest withResourceShareArns(String... resourceShareArns)

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

NOTE: This method appends the values to the existing list (if any). Use setResourceShareArns(java.util.Collection) or withResourceShareArns(java.util.Collection) if you want to override the existing values.

Parameters:

resourceShareArns - Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

Returns:

Returns a reference to this object so that method calls can be chained together.

withResourceShareArns

public GetResourceSharesRequest withResourceShareArns(Collection<String> resourceShareArns)

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

Parameters:

resourceShareArns - Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

Returns:

Returns a reference to this object so that method calls can be chained together.

setResourceShareStatus

public void setResourceShareStatus(String resourceShareStatus)

Specifies that you want to retrieve details of only those resource shares that have this status.

Parameters:

resourceShareStatus - Specifies that you want to retrieve details of only those resource shares that have this status.

See Also:

ResourceShareStatus

getResourceShareStatus

public String getResourceShareStatus()

Specifies that you want to retrieve details of only those resource shares that have this status.

Returns:

Specifies that you want to retrieve details of only those resource shares that have this status.

See Also:

ResourceShareStatus

withResourceShareStatus

public GetResourceSharesRequest withResourceShareStatus(String resourceShareStatus)

Specifies that you want to retrieve details of only those resource shares that have this status.

Parameters:

resourceShareStatus - Specifies that you want to retrieve details of only those resource shares that have this status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceShareStatus

withResourceShareStatus

public GetResourceSharesRequest withResourceShareStatus(ResourceShareStatus resourceShareStatus)

Specifies that you want to retrieve details of only those resource shares that have this status.

Parameters:

resourceShareStatus - Specifies that you want to retrieve details of only those resource shares that have this status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceShareStatus

setResourceOwner

public void setResourceOwner(String resourceOwner)

Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

Parameters:

resourceOwner - Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

See Also:

ResourceOwner

getResourceOwner

public String getResourceOwner()

Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

Returns:

Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

See Also:

ResourceOwner

withResourceOwner

public GetResourceSharesRequest withResourceOwner(String resourceOwner)

Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

Parameters:

resourceOwner - Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceOwner

withResourceOwner

public GetResourceSharesRequest withResourceOwner(ResourceOwner resourceOwner)

Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

Parameters:

resourceOwner - Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resource shares that your account shares with other accounts

• OTHER-ACCOUNTS – resource shares that other accounts share with your account

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceOwner

setName

public void setName(String name)

Specifies the name of an individual resource share that you want to retrieve details about.

Parameters:

name - Specifies the name of an individual resource share that you want to retrieve details about.

getName

public String getName()

Specifies the name of an individual resource share that you want to retrieve details about.

Returns:

Specifies the name of an individual resource share that you want to retrieve details about.

withName

public GetResourceSharesRequest withName(String name)

Specifies the name of an individual resource share that you want to retrieve details about.

Parameters:

name - Specifies the name of an individual resource share that you want to retrieve details about.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTagFilters

public List<TagFilter> getTagFilters()

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Returns:

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

setTagFilters

public void setTagFilters(Collection<TagFilter> tagFilters)

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Parameters:

tagFilters - Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

withTagFilters

public GetResourceSharesRequest withTagFilters(TagFilter... tagFilters)

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

NOTE: This method appends the values to the existing list (if any). Use setTagFilters(java.util.Collection) or withTagFilters(java.util.Collection) if you want to override the existing values.

Parameters:

tagFilters - Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagFilters

public GetResourceSharesRequest withTagFilters(Collection<TagFilter> tagFilters)

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Parameters:

tagFilters - Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

withNextToken

public GetResourceSharesRequest withNextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public GetResourceSharesRequest withMaxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPermissionArn

public void setPermissionArn(String permissionArn)

Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

Parameters:

permissionArn - Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

getPermissionArn

public String getPermissionArn()

Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

Returns:

Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

withPermissionArn

public GetResourceSharesRequest withPermissionArn(String permissionArn)

Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

Parameters:

permissionArn - Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

setPermissionVersion

public void setPermissionVersion(Integer permissionVersion)

Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

Parameters:

permissionVersion - Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

getPermissionVersion

public Integer getPermissionVersion()

Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

Returns:

Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

withPermissionVersion

public GetResourceSharesRequest withPermissionVersion(Integer permissionVersion)

Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

Parameters:

permissionVersion - Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetResourceSharesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()