DescribePlacementGroupsRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribePlacementGroupsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasGroupIds()` Returns true if the GroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasGroupNames()` Returns true if the GroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 boolean hasFilters()
```
    Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - filters
```
public List<Filter> filters()
```
    The filters.
    - group-name - The name of the placement group.
    - 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.
    
    You can use hasFilters() to see if a value was sent in this field.
    Returns:
    The filters.
    
    group-name - The name of the placement group.
    
    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 boolean hasGroupNames()
```
    Returns true if the GroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - groupNames
```
public 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.
    
    You can use hasGroupNames() to see if a value was sent in this field.
    
    Returns:
    
    The names of the placement groups.
    
    Default: Describes all your placement groups, or only those otherwise specified.
  - hasGroupIds
```
public boolean hasGroupIds()
```
    Returns true if the GroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - groupIds
```
public List<String> groupIds()
```
    The IDs of the placement groups.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasGroupIds() to see if a value was sent in this field.
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribePlacementGroupsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

hasFilters

filters

hasGroupNames

groupNames

hasGroupIds

groupIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields