com.amazonaws.services.cloudcontrolapi.model

Class ListResourcesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudcontrolapi.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() Reserved.
String	getNextToken() If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token.
String	getResourceModel() The resource model to use to select the resources to return.
String	getRoleArn() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation.
String	getTypeName() The name of the resource type.
String	getTypeVersionId() For private resource types, the type version to use in this resource operation.
int	hashCode()
void	setMaxResults(Integer maxResults) Reserved.
void	setNextToken(String nextToken) If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token.
void	setResourceModel(String resourceModel) The resource model to use to select the resources to return.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation.
void	setTypeName(String typeName) The name of the resource type.
void	setTypeVersionId(String typeVersionId) For private resource types, the type version to use in this resource operation.
String	toString() Returns a string representation of this object.
ListResourcesRequest	withMaxResults(Integer maxResults) Reserved.
ListResourcesRequest	withNextToken(String nextToken) If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token.
ListResourcesRequest	withResourceModel(String resourceModel) The resource model to use to select the resources to return.
ListResourcesRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation.
ListResourcesRequest	withTypeName(String typeName) The name of the resource type.
ListResourcesRequest	withTypeVersionId(String typeVersionId) For private resource types, the type version to use in this resource operation.

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

setTypeName

public void setTypeName(String typeName)

The name of the resource type.

Parameters:

typeName - The name of the resource type.

getTypeName

public String getTypeName()

The name of the resource type.

Returns:

The name of the resource type.

withTypeName

public ListResourcesRequest withTypeName(String typeName)

The name of the resource type.

Parameters:

typeName - The name of the resource type.

Returns:

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

setTypeVersionId

public void setTypeVersionId(String typeVersionId)

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

Parameters:

typeVersionId - For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

getTypeVersionId

public String getTypeVersionId()

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

Returns:

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

withTypeVersionId

public ListResourcesRequest withTypeVersionId(String typeVersionId)

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

Parameters:

typeVersionId - For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

Returns:

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

withRoleArn

public ListResourcesRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Parameters:

nextToken - If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

getNextToken

public String getNextToken()

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

withNextToken

public ListResourcesRequest withNextToken(String nextToken)

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Parameters:

nextToken - If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

Reserved.

Parameters:

maxResults - Reserved.

getMaxResults

public Integer getMaxResults()

Reserved.

Returns:

Reserved.

withMaxResults

public ListResourcesRequest withMaxResults(Integer maxResults)

Reserved.

Parameters:

maxResults - Reserved.

Returns:

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

setResourceModel

public void setResourceModel(String resourceModel)

The resource model to use to select the resources to return.

Parameters:

resourceModel - The resource model to use to select the resources to return.

getResourceModel

public String getResourceModel()

The resource model to use to select the resources to return.

Returns:

The resource model to use to select the resources to return.

withResourceModel

public ListResourcesRequest withResourceModel(String resourceModel)

The resource model to use to select the resources to return.

Parameters:

resourceModel - The resource model to use to select the resources to return.

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