com.amazonaws.services.resourcegroups.model.ListGroupResourcesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-resourcegroups 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.resourcegroups.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListGroupResourcesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
*
* Deprecated - don't use this parameter. Use the Group request field instead.
*
*
*/
@Deprecated
private String groupName;
/**
*
* The name or the ARN of the resource group
*
*/
private String group;
/**
*
* Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources
* operation. Filters the results to include only those of the specified resource types.
*
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the format
* AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the group.
* For example, if a group contains only S3 buckets because its query specifies only that resource type, but your
* resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances.
* In this case, a ListGroupResources request returns a BadRequestException error with a
* message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the query
* associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed resource
* types for the query type (tag-based or Amazon CloudFront stack-based queries).
*
*/
private java.util.List filters;
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*/
private Integer maxResults;
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*/
private String nextToken;
/**
*
*
* Deprecated - don't use this parameter. Use the Group request field instead.
*
*
*
* @param groupName
*
* Deprecated - don't use this parameter. Use the Group request field instead.
*
*/
@Deprecated
public void setGroupName(String groupName) {
this.groupName = groupName;
}
/**
*
*
* Deprecated - don't use this parameter. Use the Group request field instead.
*
*
*
* @return
* Deprecated - don't use this parameter. Use the Group request field instead.
*
*/
@Deprecated
public String getGroupName() {
return this.groupName;
}
/**
*
*
* Deprecated - don't use this parameter. Use the Group request field instead.
*
*
*
* @param groupName
*
* Deprecated - don't use this parameter. Use the Group request field instead.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public ListGroupResourcesRequest withGroupName(String groupName) {
setGroupName(groupName);
return this;
}
/**
*
* The name or the ARN of the resource group
*
*
* @param group
* The name or the ARN of the resource group
*/
public void setGroup(String group) {
this.group = group;
}
/**
*
* The name or the ARN of the resource group
*
*
* @return The name or the ARN of the resource group
*/
public String getGroup() {
return this.group;
}
/**
*
* The name or the ARN of the resource group
*
*
* @param group
* The name or the ARN of the resource group
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGroupResourcesRequest withGroup(String group) {
setGroup(group);
return this;
}
/**
*
* Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources
* operation. Filters the results to include only those of the specified resource types.
*
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the format
* AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the group.
* For example, if a group contains only S3 buckets because its query specifies only that resource type, but your
* resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances.
* In this case, a ListGroupResources request returns a BadRequestException error with a
* message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the query
* associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed resource
* types for the query type (tag-based or Amazon CloudFront stack-based queries).
*
*
* @return Filters, formatted as ResourceFilter objects, that you want to apply to a
* ListGroupResources operation. Filters the results to include only those of the specified
* resource types.
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the
* format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the
* group. For example, if a group contains only S3 buckets because its query specifies only that resource
* type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not
* filter for EC2 instances. In this case, a ListGroupResources request returns a
* BadRequestException error with a message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the
* query associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed
* resource types for the query type (tag-based or Amazon CloudFront stack-based queries).
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources
* operation. Filters the results to include only those of the specified resource types.
*
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the format
* AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the group.
* For example, if a group contains only S3 buckets because its query specifies only that resource type, but your
* resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances.
* In this case, a ListGroupResources request returns a BadRequestException error with a
* message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the query
* associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed resource
* types for the query type (tag-based or Amazon CloudFront stack-based queries).
*
*
* @param filters
* Filters, formatted as ResourceFilter objects, that you want to apply to a
* ListGroupResources operation. Filters the results to include only those of the specified
* resource types.
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the
* format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the
* group. For example, if a group contains only S3 buckets because its query specifies only that resource
* type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not
* filter for EC2 instances. In this case, a ListGroupResources request returns a
* BadRequestException error with a message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the
* query associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed
* resource types for the query type (tag-based or Amazon CloudFront stack-based queries).
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources
* operation. Filters the results to include only those of the specified resource types.
*
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the format
* AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the group.
* For example, if a group contains only S3 buckets because its query specifies only that resource type, but your
* resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances.
* In this case, a ListGroupResources request returns a BadRequestException error with a
* message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the query
* associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed resource
* types for the query type (tag-based or Amazon CloudFront stack-based queries).
*
*
* 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
* Filters, formatted as ResourceFilter objects, that you want to apply to a
* ListGroupResources operation. Filters the results to include only those of the specified
* resource types.
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the
* format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the
* group. For example, if a group contains only S3 buckets because its query specifies only that resource
* type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not
* filter for EC2 instances. In this case, a ListGroupResources request returns a
* BadRequestException error with a message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the
* query associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed
* resource types for the query type (tag-based or Amazon CloudFront stack-based queries).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGroupResourcesRequest withFilters(ResourceFilter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (ResourceFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources
* operation. Filters the results to include only those of the specified resource types.
*
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the format
* AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the group.
* For example, if a group contains only S3 buckets because its query specifies only that resource type, but your
* resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances.
* In this case, a ListGroupResources request returns a BadRequestException error with a
* message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the query
* associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed resource
* types for the query type (tag-based or Amazon CloudFront stack-based queries).
*
*
* @param filters
* Filters, formatted as ResourceFilter objects, that you want to apply to a
* ListGroupResources operation. Filters the results to include only those of the specified
* resource types.
*
* -
*
* resource-type - Filter resources by their type. Specify up to five resource types in the
* format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or
* AWS::S3::Bucket.
*
*
*
*
* When you specify a resource-type filter for ListGroupResources, Resource Groups
* validates your filter resource types against the types that are defined in the query associated with the
* group. For example, if a group contains only S3 buckets because its query specifies only that resource
* type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not
* filter for EC2 instances. In this case, a ListGroupResources request returns a
* BadRequestException error with a message similar to the following:
*
*
* The resource types specified as filters in the request are not valid.
*
*
* The error includes a list of resource types that failed the validation because they are not part of the
* query associated with the group. This validation doesn't occur when the group query specifies
* AWS::AllSupported, because a group based on such a query can contain any of the allowed
* resource types for the query type (tag-based or Amazon CloudFront stack-based queries).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGroupResourcesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*
* @param maxResults
* The total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond
* the maximum you specify, the NextToken response element is present and has a value (is not
* null). Include that value as the NextToken request parameter in the next call to the
* operation to get the next part of the results. Note that the service might return fewer results than the
* maximum even when there are more results available. You should check NextToken after every
* operation to ensure that you receive all of the results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*
* @return The total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist
* beyond the maximum you specify, the NextToken response element is present and has a value
* (is not null). Include that value as the NextToken request parameter in the next call to the
* operation to get the next part of the results. Note that the service might return fewer results than the
* maximum even when there are more results available. You should check NextToken after every
* operation to ensure that you receive all of the results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The total number of results that you want included on each page of the response. If you do not include this
* parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum
* you specify, the NextToken response element is present and has a value (is not null). Include that
* value as the NextToken request parameter in the next call to the operation to get the next part of
* the results. Note that the service might return fewer results than the maximum even when there are more results
* available. You should check NextToken after every operation to ensure that you receive all of the
* results.
*
*
* @param maxResults
* The total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond
* the maximum you specify, the NextToken response element is present and has a value (is not
* null). Include that value as the NextToken request parameter in the next call to the
* operation to get the next part of the results. Note that the service might return fewer results than the
* maximum even when there are more results available. You should check NextToken after every
* operation to ensure that you receive all of the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGroupResourcesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*
* @param nextToken
* The parameter for receiving additional results if you receive a NextToken response in a
* previous request. A NextToken response indicates that more output is available. Set this
* parameter to the value provided by a previous call's NextToken response to indicate where the
* output should continue from.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*
* @return The parameter for receiving additional results if you receive a NextToken response in a
* previous request. A NextToken response indicates that more output is available. Set this
* parameter to the value provided by a previous call's NextToken response to indicate where
* the output should continue from.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The parameter for receiving additional results if you receive a NextToken response in a previous
* request. A NextToken response indicates that more output is available. Set this parameter to the
* value provided by a previous call's NextToken response to indicate where the output should continue
* from.
*
*
* @param nextToken
* The parameter for receiving additional results if you receive a NextToken response in a
* previous request. A NextToken response indicates that more output is available. Set this
* parameter to the value provided by a previous call's NextToken response to indicate where the
* output should continue from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGroupResourcesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* 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 (getGroupName() != null)
sb.append("GroupName: ").append(getGroupName()).append(",");
if (getGroup() != null)
sb.append("Group: ").append(getGroup()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListGroupResourcesRequest == false)
return false;
ListGroupResourcesRequest other = (ListGroupResourcesRequest) obj;
if (other.getGroupName() == null ^ this.getGroupName() == null)
return false;
if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == false)
return false;
if (other.getGroup() == null ^ this.getGroup() == null)
return false;
if (other.getGroup() != null && other.getGroup().equals(this.getGroup()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode());
hashCode = prime * hashCode + ((getGroup() == null) ? 0 : getGroup().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public ListGroupResourcesRequest clone() {
return (ListGroupResourcesRequest) super.clone();
}
}