com.amazonaws.services.workspaces.model

Class DescribeWorkspaceBundlesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspaces.model.DescribeWorkspaceBundlesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeWorkspaceBundlesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeWorkspaceBundles operation.

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

See Also:

AmazonWorkspaces.describeWorkspaceBundles(DescribeWorkspaceBundlesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeWorkspaceBundlesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeWorkspaceBundlesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getBundleIds() An array of strings that contains the identifiers of the bundles to retrieve.
String	getNextToken() The NextToken value from a previous call to this operation.
String	getOwner() The owner of the bundles to retrieve.
int	hashCode()
void	setBundleIds(Collection<String> bundleIds) An array of strings that contains the identifiers of the bundles to retrieve.
void	setNextToken(String nextToken) The NextToken value from a previous call to this operation.
void	setOwner(String owner) The owner of the bundles to retrieve.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeWorkspaceBundlesRequest	withBundleIds(Collection<String> bundleIds) An array of strings that contains the identifiers of the bundles to retrieve.
DescribeWorkspaceBundlesRequest	withBundleIds(String... bundleIds) An array of strings that contains the identifiers of the bundles to retrieve.
DescribeWorkspaceBundlesRequest	withNextToken(String nextToken) The NextToken value from a previous call to this operation.
DescribeWorkspaceBundlesRequest	withOwner(String owner) The owner of the bundles to retrieve.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeWorkspaceBundlesRequest

public DescribeWorkspaceBundlesRequest()

Method Detail

getBundleIds

public List<String> getBundleIds()

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

Constraints:
Length: 1 - 25

Returns:

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

setBundleIds

public void setBundleIds(Collection<String> bundleIds)

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

Constraints:
Length: 1 - 25

Parameters:

bundleIds - An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

withBundleIds

public DescribeWorkspaceBundlesRequest withBundleIds(String... bundleIds)

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

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

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

Constraints:
Length: 1 - 25

Parameters:

bundleIds - An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

Returns:

A reference to this updated object so that method calls can be chained together.

withBundleIds

public DescribeWorkspaceBundlesRequest withBundleIds(Collection<String> bundleIds)

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

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

Constraints:
Length: 1 - 25

Parameters:

bundleIds - An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

Returns:

A reference to this updated object so that method calls can be chained together.

getOwner

public String getOwner()

The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

• null - Retrieves the bundles that belong to the account making the call.
• AMAZON - Retrieves the bundles that are provided by AWS.

Returns:

The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

• null - Retrieves the bundles that belong to the account making the call.
• AMAZON - Retrieves the bundles that are provided by AWS.

setOwner

public void setOwner(String owner)

The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

• null - Retrieves the bundles that belong to the account making the call.
• AMAZON - Retrieves the bundles that are provided by AWS.

Parameters:

owner - The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

• null - Retrieves the bundles that belong to the account making the call.
• AMAZON - Retrieves the bundles that are provided by AWS.

withOwner

public DescribeWorkspaceBundlesRequest withOwner(String owner)

The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

• null - Retrieves the bundles that belong to the account making the call.
• AMAZON - Retrieves the bundles that are provided by AWS.

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

Parameters:

owner - The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

• null - Retrieves the bundles that belong to the account making the call.
• AMAZON - Retrieves the bundles that are provided by AWS.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The NextToken value from a previous call to this operation. Pass null if this is the first call.

Constraints:
Length: 1 - 63

Returns:

The NextToken value from a previous call to this operation. Pass null if this is the first call.

setNextToken

public void setNextToken(String nextToken)

The NextToken value from a previous call to this operation. Pass null if this is the first call.

Constraints:
Length: 1 - 63

Parameters:

nextToken - The NextToken value from a previous call to this operation. Pass null if this is the first call.

withNextToken

public DescribeWorkspaceBundlesRequest withNextToken(String nextToken)

The NextToken value from a previous call to this operation. Pass null if this is the first call.

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

Constraints:
Length: 1 - 63

Parameters:

nextToken - The NextToken value from a previous call to this operation. Pass null if this is the first call.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeWorkspaceBundlesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()