com.amazonaws.services.ram.model

Class ListResourcesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ram.model.ListResourcesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListResourcesRequest
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
ListResourcesRequest()

Method Summary

Modifier and Type	Method and Description
ListResourcesRequest	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	getNextToken() Specifies that you want to receive the next page of results.
String	getPrincipal() Specifies that you want to list only the resource shares that are associated with the specified principal.
List<String>	getResourceArns() Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).
String	getResourceOwner() Specifies that you want to list only the resource shares that match the following:
String	getResourceRegionScope() Specifies that you want the results to include only resources that have the specified scope.
List<String>	getResourceShareArns() Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).
String	getResourceType() Specifies that you want to list only the resource shares that include resources of the specified resource type.
int	hashCode()
void	setMaxResults(Integer maxResults) Specifies the total number of results that you want included on each page of the response.
void	setNextToken(String nextToken) Specifies that you want to receive the next page of results.
void	setPrincipal(String principal) Specifies that you want to list only the resource shares that are associated with the specified principal.
void	setResourceArns(Collection<String> resourceArns) Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).
void	setResourceOwner(String resourceOwner) Specifies that you want to list only the resource shares that match the following:
void	setResourceRegionScope(String resourceRegionScope) Specifies that you want the results to include only resources that have the specified scope.
void	setResourceShareArns(Collection<String> resourceShareArns) Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).
void	setResourceType(String resourceType) Specifies that you want to list only the resource shares that include resources of the specified resource type.
String	toString() Returns a string representation of this object.
ListResourcesRequest	withMaxResults(Integer maxResults) Specifies the total number of results that you want included on each page of the response.
ListResourcesRequest	withNextToken(String nextToken) Specifies that you want to receive the next page of results.
ListResourcesRequest	withPrincipal(String principal) Specifies that you want to list only the resource shares that are associated with the specified principal.
ListResourcesRequest	withResourceArns(Collection<String> resourceArns) Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).
ListResourcesRequest	withResourceArns(String... resourceArns) Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).
ListResourcesRequest	withResourceOwner(ResourceOwner resourceOwner) Specifies that you want to list only the resource shares that match the following:
ListResourcesRequest	withResourceOwner(String resourceOwner) Specifies that you want to list only the resource shares that match the following:
ListResourcesRequest	withResourceRegionScope(ResourceRegionScopeFilter resourceRegionScope) Specifies that you want the results to include only resources that have the specified scope.
ListResourcesRequest	withResourceRegionScope(String resourceRegionScope) Specifies that you want the results to include only resources that have the specified scope.
ListResourcesRequest	withResourceShareArns(Collection<String> resourceShareArns) Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).
ListResourcesRequest	withResourceShareArns(String... resourceShareArns) Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).
ListResourcesRequest	withResourceType(String resourceType) Specifies that you want to list only the resource shares that include resources of the specified resource type.

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

ListResourcesRequest

public ListResourcesRequest()

Method Detail

setResourceOwner

public void setResourceOwner(String resourceOwner)

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

• SELF – resources that your account shares with other accounts

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

Parameters:

resourceOwner - Specifies that you want to list only the resource shares that match the following:

• SELF – resources that your account shares with other accounts

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

See Also:

ResourceOwner

getResourceOwner

public String getResourceOwner()

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

• SELF – resources that your account shares with other accounts

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

Returns:

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

• SELF – resources that your account shares with other accounts

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

See Also:

ResourceOwner

withResourceOwner

public ListResourcesRequest withResourceOwner(String resourceOwner)

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

• SELF – resources that your account shares with other accounts

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

Parameters:

resourceOwner - Specifies that you want to list only the resource shares that match the following:

• SELF – resources that your account shares with other accounts

• OTHER-ACCOUNTS – resources 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 ListResourcesRequest withResourceOwner(ResourceOwner resourceOwner)

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

• SELF – resources that your account shares with other accounts

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

Parameters:

resourceOwner - Specifies that you want to list only the resource shares that match the following:

• SELF – resources that your account shares with other accounts

• OTHER-ACCOUNTS – resources 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

setPrincipal

public void setPrincipal(String principal)

Specifies that you want to list only the resource shares that are associated with the specified principal.

Parameters:

principal - Specifies that you want to list only the resource shares that are associated with the specified principal.

getPrincipal

public String getPrincipal()

Specifies that you want to list only the resource shares that are associated with the specified principal.

Returns:

Specifies that you want to list only the resource shares that are associated with the specified principal.

withPrincipal

public ListResourcesRequest withPrincipal(String principal)

Specifies that you want to list only the resource shares that are associated with the specified principal.

Parameters:

principal - Specifies that you want to list only the resource shares that are associated with the specified principal.

Returns:

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

setResourceType

public void setResourceType(String resourceType)

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

Parameters:

resourceType - Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

getResourceType

public String getResourceType()

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

Returns:

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

withResourceType

public ListResourcesRequest withResourceType(String resourceType)

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

Parameters:

resourceType - Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

Returns:

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

getResourceArns

public List<String> getResourceArns()

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

Returns:

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

setResourceArns

public void setResourceArns(Collection<String> resourceArns)

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

Parameters:

resourceArns - Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

withResourceArns

public ListResourcesRequest withResourceArns(String... resourceArns)

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

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

Parameters:

resourceArns - Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

Returns:

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

withResourceArns

public ListResourcesRequest withResourceArns(Collection<String> resourceArns)

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

Parameters:

resourceArns - Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

Returns:

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

getResourceShareArns

public List<String> getResourceShareArns()

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

Returns:

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

setResourceShareArns

public void setResourceShareArns(Collection<String> resourceShareArns)

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

Parameters:

resourceShareArns - Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

withResourceShareArns

public ListResourcesRequest withResourceShareArns(String... resourceShareArns)

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

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 that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

Returns:

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

withResourceShareArns

public ListResourcesRequest withResourceShareArns(Collection<String> resourceShareArns)

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

Parameters:

resourceShareArns - Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

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

setResourceRegionScope

public void setResourceRegionScope(String resourceRegionScope)

Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Parameters:

resourceRegionScope - Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

See Also:

ResourceRegionScopeFilter

getResourceRegionScope

public String getResourceRegionScope()

Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Returns:

Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

See Also:

ResourceRegionScopeFilter

withResourceRegionScope

public ListResourcesRequest withResourceRegionScope(String resourceRegionScope)

Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Parameters:

resourceRegionScope - Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Returns:

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

See Also:

ResourceRegionScopeFilter

withResourceRegionScope

public ListResourcesRequest withResourceRegionScope(ResourceRegionScopeFilter resourceRegionScope)

Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Parameters:

resourceRegionScope - Specifies that you want the results to include only resources that have the specified scope.

• ALL – the results include both global and regional resources or resource types.

• GLOBAL – the results include only global resources or resource types.

• REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Returns:

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

See Also:

ResourceRegionScopeFilter

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 ListResourcesRequest 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()