software.amazon.awssdk.services.resourcegroupstaggingapi.model

Class GetResourcesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resourcegroupstaggingapi.model.ResourceGroupsTaggingAPIRequest

software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest

All Implemented Interfaces:

ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetResourcesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetResourcesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	paginationToken() A string that indicates that additional data is available.
Integer	resourcesPerPage() A limit that restricts the number of resources returned by GetResources in paginated output.
List<String>	resourceTypeFilters() The constraints on the resources that you want returned.
static Class<? extends GetResourcesRequest.Builder>	serializableBuilderClass()
List<TagFilter>	tagFilters() A list of tags (keys and values).
Integer	tagsPerPage() A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output.
GetResourcesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

paginationToken

public String paginationToken()

A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Returns:

A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

tagFilters

public List<TagFilter> tagFilters()

A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values.

If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter.

If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.

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

Returns:

A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values.

If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter.

If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.

resourcesPerPage

public Integer resourcesPerPage()

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items.

Returns:

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items.

tagsPerPage

public Integer tagsPerPage()

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

Returns:

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

resourceTypeFilters

public List<String> resourceTypeFilters()

The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

Returns:

The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

toBuilder

public GetResourcesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

Specified by:

toBuilder in class ResourceGroupsTaggingAPIRequest

Returns:

a builder for type T

builder

public static GetResourcesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value