public class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
DescribeTags operation
.
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
MaxRecords
and
Marker
parameters together with the ARN parameter.MaxRecords
parameter can be a range from 10 to
50 results to return in a request.
If you specify both tag keys and tag values in the same request,
Amazon Redshift returns all resources that match any combination of
the specified keys and values. For example, if you have
owner
and environment
for tag keys, and
admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
NOOP
Constructor and Description |
---|
DescribeTagsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeTagsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getMarker()
A value that indicates the starting point for the next set of response
records in a subsequent request.
|
Integer |
getMaxRecords()
The maximum number or response records to return in each call.
|
String |
getResourceName()
The Amazon Resource Name (ARN) for which you want to describe the tag
or tags.
|
String |
getResourceType()
The type of resource with which you want to view tags.
|
List<String> |
getTagKeys()
A tag key or keys for which you want to return all matching resources
that are associated with the specified key or keys.
|
List<String> |
getTagValues()
A tag value or values for which you want to return all matching
resources that are associated with the specified value or values.
|
int |
hashCode() |
void |
setMarker(String marker)
A value that indicates the starting point for the next set of response
records in a subsequent request.
|
void |
setMaxRecords(Integer maxRecords)
The maximum number or response records to return in each call.
|
void |
setResourceName(String resourceName)
The Amazon Resource Name (ARN) for which you want to describe the tag
or tags.
|
void |
setResourceType(String resourceType)
The type of resource with which you want to view tags.
|
void |
setTagKeys(Collection<String> tagKeys)
A tag key or keys for which you want to return all matching resources
that are associated with the specified key or keys.
|
void |
setTagValues(Collection<String> tagValues)
A tag value or values for which you want to return all matching
resources that are associated with the specified value or values.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeTagsRequest |
withMarker(String marker)
A value that indicates the starting point for the next set of response
records in a subsequent request.
|
DescribeTagsRequest |
withMaxRecords(Integer maxRecords)
The maximum number or response records to return in each call.
|
DescribeTagsRequest |
withResourceName(String resourceName)
The Amazon Resource Name (ARN) for which you want to describe the tag
or tags.
|
DescribeTagsRequest |
withResourceType(String resourceType)
The type of resource with which you want to view tags.
|
DescribeTagsRequest |
withTagKeys(Collection<String> tagKeys)
A tag key or keys for which you want to return all matching resources
that are associated with the specified key or keys.
|
DescribeTagsRequest |
withTagKeys(String... tagKeys)
A tag key or keys for which you want to return all matching resources
that are associated with the specified key or keys.
|
DescribeTagsRequest |
withTagValues(Collection<String> tagValues)
A tag value or values for which you want to return all matching
resources that are associated with the specified value or values.
|
DescribeTagsRequest |
withTagValues(String... tagValues)
A tag value or values for which you want to return all matching
resources that are associated with the specified value or values.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getResourceName()
arn:aws:redshift:us-east-1:123456789:cluster:t1
.arn:aws:redshift:us-east-1:123456789:cluster:t1
.public void setResourceName(String resourceName)
arn:aws:redshift:us-east-1:123456789:cluster:t1
.resourceName
- The Amazon Resource Name (ARN) for which you want to describe the tag
or tags. For example,
arn:aws:redshift:us-east-1:123456789:cluster:t1
.public DescribeTagsRequest withResourceName(String resourceName)
arn:aws:redshift:us-east-1:123456789:cluster:t1
.
Returns a reference to this object so that method calls can be chained together.
resourceName
- The Amazon Resource Name (ARN) for which you want to describe the tag
or tags. For example,
arn:aws:redshift:us-east-1:123456789:cluster:t1
.public String getResourceType()
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
public void setResourceType(String resourceType)
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
resourceType
- The type of resource with which you want to view tags. Valid resource
types are: For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
public DescribeTagsRequest withResourceType(String resourceType)
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
Returns a reference to this object so that method calls can be chained together.
resourceType
- The type of resource with which you want to view tags. Valid resource
types are: For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
public Integer getMaxRecords()
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker
value.MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker
value.public void setMaxRecords(Integer maxRecords)
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker
value.maxRecords
- The maximum number or response records to return in each call. If the
number of remaining response records exceeds the specified
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker
value.public DescribeTagsRequest withMaxRecords(Integer maxRecords)
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker
value.
Returns a reference to this object so that method calls can be chained together.
maxRecords
- The maximum number or response records to return in each call. If the
number of remaining response records exceeds the specified
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker
value.public String getMarker()
marker
parameter and retrying the
command. If the marker
field is empty, all response
records have been retrieved for the request.marker
parameter and retrying the
command. If the marker
field is empty, all response
records have been retrieved for the request.public void setMarker(String marker)
marker
parameter and retrying the
command. If the marker
field is empty, all response
records have been retrieved for the request.marker
- A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response,
you can retrieve the next set of records by providing this returned
marker value in the marker
parameter and retrying the
command. If the marker
field is empty, all response
records have been retrieved for the request.public DescribeTagsRequest withMarker(String marker)
marker
parameter and retrying the
command. If the marker
field is empty, all response
records have been retrieved for the request.
Returns a reference to this object so that method calls can be chained together.
marker
- A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response,
you can retrieve the next set of records by providing this returned
marker value in the marker
parameter and retrying the
command. If the marker
field is empty, all response
records have been retrieved for the request.public List<String> getTagKeys()
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.public void setTagKeys(Collection<String> tagKeys)
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.tagKeys
- A tag key or keys for which you want to return all matching resources
that are associated with the specified key or keys. For example,
suppose that you have resources tagged with keys called
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.public DescribeTagsRequest withTagKeys(String... tagKeys)
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.
NOTE: This method appends the values to the existing list (if
any). Use setTagKeys(java.util.Collection)
or withTagKeys(java.util.Collection)
if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
tagKeys
- A tag key or keys for which you want to return all matching resources
that are associated with the specified key or keys. For example,
suppose that you have resources tagged with keys called
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.public DescribeTagsRequest withTagKeys(Collection<String> tagKeys)
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.
Returns a reference to this object so that method calls can be chained together.
tagKeys
- A tag key or keys for which you want to return all matching resources
that are associated with the specified key or keys. For example,
suppose that you have resources tagged with keys called
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.public List<String> getTagValues()
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.public void setTagValues(Collection<String> tagValues)
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.tagValues
- A tag value or values for which you want to return all matching
resources that are associated with the specified value or values. For
example, suppose that you have resources tagged with values called
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.public DescribeTagsRequest withTagValues(String... tagValues)
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.
NOTE: This method appends the values to the existing list (if
any). Use setTagValues(java.util.Collection)
or withTagValues(java.util.Collection)
if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
tagValues
- A tag value or values for which you want to return all matching
resources that are associated with the specified value or values. For
example, suppose that you have resources tagged with values called
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.public DescribeTagsRequest withTagValues(Collection<String> tagValues)
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.
Returns a reference to this object so that method calls can be chained together.
tagValues
- A tag value or values for which you want to return all matching
resources that are associated with the specified value or values. For
example, suppose that you have resources tagged with values called
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.public String toString()
toString
in class Object
Object.toString()
public DescribeTagsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.