@Generated(value="software.amazon.awssdk:codegen") public final class ListGroupResourcesRequest extends ResourceGroupsRequest implements ToCopyableBuilder<ListGroupResourcesRequest.Builder,ListGroupResourcesRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListGroupResourcesRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListGroupResourcesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<ResourceFilter> |
filters()
Filters, formatted as ResourceFilter objects, that you want to apply to a
ListGroupResources
operation. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
group()
The name or the ARN of the resource group
|
String |
groupName()
|
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).
|
int |
hashCode() |
Integer |
maxResults()
The total number of results that you want included on each page of the response.
|
String |
nextToken()
The parameter for receiving additional results if you receive a
NextToken response in a previous
request. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListGroupResourcesRequest.Builder> |
serializableBuilderClass() |
ListGroupResourcesRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String groupName()
Deprecated - don't use this parameter. Use the Group request field instead.
Deprecated - don't use this parameter. Use the Group request field instead.
public final String group()
The name or the ARN of the resource group
public final boolean hasFilters()
public final List<ResourceFilter> 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, AWS 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 AWS CloudFormation stack-based queries).
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.
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, AWS 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 AWS CloudFormation stack-based queries).
public final Integer 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.
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 final String 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.
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 ListGroupResourcesRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ListGroupResourcesRequest.Builder,ListGroupResourcesRequest>toBuilder in class ResourceGroupsRequestpublic static ListGroupResourcesRequest.Builder builder()
public static Class<? extends ListGroupResourcesRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.