com.amazonaws.services.ec2.model

Class DescribePlacementGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribePlacementGroupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribePlacementGroupsRequest>, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribePlacementGroupsRequest()

Method Summary

Modifier and Type	Method and Description
DescribePlacementGroupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribePlacementGroupsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() The filters.
List<String>	getGroupIds() The IDs of the placement groups.
List<String>	getGroupNames() The names of the placement groups.
int	hashCode()
void	setFilters(Collection<Filter> filters) The filters.
void	setGroupIds(Collection<String> groupIds) The IDs of the placement groups.
void	setGroupNames(Collection<String> groupNames) The names of the placement groups.
String	toString() Returns a string representation of this object.
DescribePlacementGroupsRequest	withFilters(Collection<Filter> filters) The filters.
DescribePlacementGroupsRequest	withFilters(Filter... filters) The filters.
DescribePlacementGroupsRequest	withGroupIds(Collection<String> groupIds) The IDs of the placement groups.
DescribePlacementGroupsRequest	withGroupIds(String... groupIds) The IDs of the placement groups.
DescribePlacementGroupsRequest	withGroupNames(Collection<String> groupNames) The names of the placement groups.
DescribePlacementGroupsRequest	withGroupNames(String... groupNames) The names of the placement groups.

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

DescribePlacementGroupsRequest

public DescribePlacementGroupsRequest()

Method Detail

getFilters

public List<Filter> getFilters()

The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Returns:

The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

setFilters

public void setFilters(Collection<Filter> filters)

The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Parameters:

filters - The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

withFilters

public DescribePlacementGroupsRequest withFilters(Filter... filters)

The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

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

Parameters:

filters - The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Returns:

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

withFilters

public DescribePlacementGroupsRequest withFilters(Collection<Filter> filters)

The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Parameters:

filters - The filters.

• group-name - The name of the placement group.

• group-arn - The Amazon Resource Name (ARN) of the placement group.

• spread-level - The spread level for the placement group (host | rack).

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Returns:

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

getGroupNames

public List<String> getGroupNames()

The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

Returns:

The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

setGroupNames

public void setGroupNames(Collection<String> groupNames)

The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

Parameters:

groupNames - The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

withGroupNames

public DescribePlacementGroupsRequest withGroupNames(String... groupNames)

The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

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

Parameters:

groupNames - The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

Returns:

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

withGroupNames

public DescribePlacementGroupsRequest withGroupNames(Collection<String> groupNames)

The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

Parameters:

groupNames - The names of the placement groups.

Constraints:

• You can specify a name only if the placement group is owned by your account.

• If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

Returns:

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

getGroupIds

public List<String> getGroupIds()

The IDs of the placement groups.

Returns:

The IDs of the placement groups.

setGroupIds

public void setGroupIds(Collection<String> groupIds)

The IDs of the placement groups.

Parameters:

groupIds - The IDs of the placement groups.

withGroupIds

public DescribePlacementGroupsRequest withGroupIds(String... groupIds)

The IDs of the placement groups.

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

Parameters:

groupIds - The IDs of the placement groups.

Returns:

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

withGroupIds

public DescribePlacementGroupsRequest withGroupIds(Collection<String> groupIds)

The IDs of the placement groups.

Parameters:

groupIds - The IDs of the placement groups.

Returns:

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

getDryRunRequest

public Request<DescribePlacementGroupsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribePlacementGroupsRequest>

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