software.amazon.awssdk.services.resourcegroups.model

Class ResourceQuery

java.lang.Object

software.amazon.awssdk.services.resourcegroups.model.ResourceQuery

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResourceQuery.Builder,ResourceQuery>

@Generated(value="software.amazon.awssdk:codegen")
public final class ResourceQuery
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResourceQuery.Builder,ResourceQuery>

The query that is used to define a resource group or a search for resources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResourceQuery.Builder

Method Summary

Modifier and Type	Method and Description
static ResourceQuery.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	query() The query that defines a group or a search.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceQuery.Builder>	serializableBuilderClass()
ResourceQuery.Builder	toBuilder()
String	toString() Returns a string representation of this object.
QueryType	type() The type of the query.
String	typeAsString() The type of the query.

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

type

public QueryType type()

The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

  For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"}.

    The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

  • An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"4"}

    The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

If the service returns an enum value that is not available in the current SDK version, type will return QueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

  For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"}.

    The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

  • An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"4"}

    The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

See Also:

QueryType

typeAsString

public String typeAsString()

The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

  For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"}.

    The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

  • An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"4"}

    The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

If the service returns an enum value that is not available in the current SDK version, type will return QueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the query. You can use the following values:

• CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

• TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

  For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

  [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

  The results of this query could include the following.

  • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

  • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

  The query would not include the following items in the results, however.

  • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"}.

    The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

  • An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"4"}

    The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

See Also:

QueryType

query

public String query()

The query that defines a group or a search.

Returns:

The query that defines a group or a search.

toBuilder

public ResourceQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceQuery.Builder,ResourceQuery>

builder

public static ResourceQuery.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo