software.amazon.awssdk.services.redshift.model

Class DescribeTagsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshift.model.RedshiftRequest

software.amazon.awssdk.services.redshift.model.DescribeTagsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeTagsRequest
extends RedshiftRequest
implements ToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeTagsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeTagsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagKeys() Returns true if the TagKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTagValues() Returns true if the TagValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
List<SdkField<?>>	sdkFields()
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()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

resourceName

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

resourceType

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.

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.

maxRecords

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.

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.

marker

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.

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.

hasTagKeys

public boolean hasTagKeys()

Returns true if the TagKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tagKeys

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.

You can use hasTagKeys() to see if a value was sent in this field.

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.

hasTagValues

public boolean hasTagValues()

Returns true if the TagValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tagValues

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.

You can use hasTagValues() to see if a value was sent in this field.

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.

toBuilder

public DescribeTagsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static DescribeTagsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo