@Generated(value="software.amazon.awssdk:codegen") public final class DescribeTagsRequest extends RedshiftRequest implements ToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeTagsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeTagsRequest.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 |
marker()
A value that indicates the starting point for the next set of response records in a subsequent request.
|
Integer |
maxRecords()
The maximum number or response records to return in each call.
|
String |
resourceName()
The Amazon Resource Name (ARN) for which you want to describe the tag or tags.
|
String |
resourceType()
The type of resource with which you want to view tags.
|
static Class<? extends DescribeTagsRequest.Builder> |
serializableBuilderClass() |
List<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.
|
List<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.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String 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
.
arn:aws:redshift:us-east-1:123456789:cluster:t1
.public String resourceType()
The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant
For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant
For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
public Integer 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.
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 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.
marker
parameter and retrying the command. If the marker
field is empty, all response records have been retrieved for the request.public List<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. 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
toBuilder
in class RedshiftRequest
public static DescribeTagsRequest.Builder builder()
public static Class<? extends DescribeTagsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.