com.amazonaws.services.ec2.model.DescribePlacementGroupsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribePlacementGroupsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribePlacementGroupsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList groupNames;
/**
*
* The IDs of the placement groups.
*
*/
private com.amazonaws.internal.SdkInternalList groupIds;
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*
*
* @param 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.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(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
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlacementGroupsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlacementGroupsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public java.util.List getGroupNames() {
if (groupNames == null) {
groupNames = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*
*
* @param 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.
*
*
*/
public void setGroupNames(java.util.Collection groupNames) {
if (groupNames == null) {
this.groupNames = null;
return;
}
this.groupNames = new com.amazonaws.internal.SdkInternalList(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
* {@link #setGroupNames(java.util.Collection)} or {@link #withGroupNames(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlacementGroupsRequest withGroupNames(String... groupNames) {
if (this.groupNames == null) {
setGroupNames(new com.amazonaws.internal.SdkInternalList(groupNames.length));
}
for (String ele : groupNames) {
this.groupNames.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlacementGroupsRequest withGroupNames(java.util.Collection groupNames) {
setGroupNames(groupNames);
return this;
}
/**
*
* The IDs of the placement groups.
*
*
* @return The IDs of the placement groups.
*/
public java.util.List getGroupIds() {
if (groupIds == null) {
groupIds = new com.amazonaws.internal.SdkInternalList();
}
return groupIds;
}
/**
*
* The IDs of the placement groups.
*
*
* @param groupIds
* The IDs of the placement groups.
*/
public void setGroupIds(java.util.Collection groupIds) {
if (groupIds == null) {
this.groupIds = null;
return;
}
this.groupIds = new com.amazonaws.internal.SdkInternalList(groupIds);
}
/**
*
* The IDs of the placement groups.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGroupIds(java.util.Collection)} or {@link #withGroupIds(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param groupIds
* The IDs of the placement groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlacementGroupsRequest withGroupIds(String... groupIds) {
if (this.groupIds == null) {
setGroupIds(new com.amazonaws.internal.SdkInternalList(groupIds.length));
}
for (String ele : groupIds) {
this.groupIds.add(ele);
}
return this;
}
/**
*
* The IDs of the placement groups.
*
*
* @param groupIds
* The IDs of the placement groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlacementGroupsRequest withGroupIds(java.util.Collection groupIds) {
setGroupIds(groupIds);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribePlacementGroupsRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getGroupNames() != null)
sb.append("GroupNames: ").append(getGroupNames()).append(",");
if (getGroupIds() != null)
sb.append("GroupIds: ").append(getGroupIds());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribePlacementGroupsRequest == false)
return false;
DescribePlacementGroupsRequest other = (DescribePlacementGroupsRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getGroupNames() == null ^ this.getGroupNames() == null)
return false;
if (other.getGroupNames() != null && other.getGroupNames().equals(this.getGroupNames()) == false)
return false;
if (other.getGroupIds() == null ^ this.getGroupIds() == null)
return false;
if (other.getGroupIds() != null && other.getGroupIds().equals(this.getGroupIds()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getGroupNames() == null) ? 0 : getGroupNames().hashCode());
hashCode = prime * hashCode + ((getGroupIds() == null) ? 0 : getGroupIds().hashCode());
return hashCode;
}
@Override
public DescribePlacementGroupsRequest clone() {
return (DescribePlacementGroupsRequest) super.clone();
}
}