software.amazon.awssdk.services.ec2.model

Class DescribePlacementGroupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribePlacementGroupsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribePlacementGroupsRequest.Builder,DescribePlacementGroupsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribePlacementGroupsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribePlacementGroupsRequest.Builder,DescribePlacementGroupsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribePlacementGroupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribePlacementGroupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() The filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	groupIds() The IDs of the placement groups.
List<String>	groupNames() The names of the placement groups.
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
boolean	hasGroupIds() For responses, this returns true if the service returned a value for the GroupIds property.
boolean	hasGroupNames() For responses, this returns true if the service returned a value for the GroupNames property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribePlacementGroupsRequest.Builder>	serializableBuilderClass()
DescribePlacementGroupsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

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.

hasGroupNames

public final boolean hasGroupNames()

For responses, this returns true if the service returned a value for the GroupNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

groupNames

public final List<String> groupNames()

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupNames() method.

Returns:

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

hasGroupIds

public final boolean hasGroupIds()

For responses, this returns true if the service returned a value for the GroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

groupIds

public final List<String> groupIds()

The IDs of the placement groups.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupIds() method.

Returns:

The IDs of the placement groups.

toBuilder

public DescribePlacementGroupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePlacementGroupsRequest.Builder,DescribePlacementGroupsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribePlacementGroupsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribePlacementGroupsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo