com.amazonaws.services.resourcegroups.model

Class ResourceQuery

java.lang.Object

com.amazonaws.services.resourcegroups.model.ResourceQuery

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResourceQuery
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceQuery()

Method Summary

Modifier and Type	Method and Description
ResourceQuery	clone()
boolean	equals(Object obj)
String	getQuery() The query that defines a group or a search.
String	getType() The type of the query.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setQuery(String query) The query that defines a group or a search.
void	setType(String type) The type of the query.
String	toString() Returns a string representation of this object.
ResourceQuery	withQuery(String query) The query that defines a group or a search.
ResourceQuery	withType(QueryType type) The type of the query.
ResourceQuery	withType(String type) The type of the query.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceQuery

public ResourceQuery()

Method Detail

setType

public void setType(String 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.

Parameters:

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.

See Also:

QueryType

getType

public String getType()

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.

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

withType

public ResourceQuery withType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryType

withType

public ResourceQuery withType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryType

setQuery

public void setQuery(String query)

The query that defines a group or a search.

Parameters:

query - The query that defines a group or a search.

getQuery

public String getQuery()

The query that defines a group or a search.

Returns:

The query that defines a group or a search.

withQuery

public ResourceQuery withQuery(String query)

The query that defines a group or a search.

Parameters:

query - The query that defines a group or a search.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ResourceQuery clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.