com.amazonaws.services.redshift.model

Class DescribeTagsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.DescribeTagsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeTagsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeTagsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeTagsRequest

public DescribeTagsRequest()

Method Detail

setResourceName

public void setResourceName(String resourceName)

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

Parameters:

resourceName - The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

getResourceName

public String getResourceName()

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

Returns:

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

withResourceName

public DescribeTagsRequest withResourceName(String resourceName)

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

Parameters:

resourceName - The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

Returns:

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

setResourceType

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

Parameters:

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.

getResourceType

public String getResourceType()

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.

Returns:

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.

withResourceType

public DescribeTagsRequest withResourceType(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.

Parameters:

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.

Returns:

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

setMaxRecords

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

Parameters:

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.

getMaxRecords

public Integer getMaxRecords()

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.

Returns:

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.

withMaxRecords

public DescribeTagsRequest withMaxRecords(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.

Parameters:

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.

Returns:

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

setMarker

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

Parameters:

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.

getMarker

public String getMarker()

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.

Returns:

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.

withMarker

public DescribeTagsRequest withMarker(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.

Parameters:

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.

Returns:

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

getTagKeys

public 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. 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.

Returns:

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.

setTagKeys

public 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. 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.

Parameters:

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.

withTagKeys

public 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. 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.

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.

Parameters:

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.

Returns:

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

withTagKeys

public 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. 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.

Parameters:

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.

Returns:

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

getTagValues

public 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. 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.

Returns:

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.

setTagValues

public 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. 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.

Parameters:

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.

withTagValues

public 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. 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.

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.

Parameters:

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.

Returns:

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

withTagValues

public 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. 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.

Parameters:

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.

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 DescribeTagsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()