software.amazon.awssdk.services.redshift.model

Class DescribeSnapshotCopyGrantsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSnapshotCopyGrantsRequest.Builder,DescribeSnapshotCopyGrantsRequest>

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

The result of the DescribeSnapshotCopyGrants action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSnapshotCopyGrantsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeSnapshotCopyGrantsRequest.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() An optional parameter that specifies the starting point to return a set of response records.
Integer	maxRecords() The maximum number of response records to return in each call.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSnapshotCopyGrantsRequest.Builder>	serializableBuilderClass()
String	snapshotCopyGrantName() The name of the snapshot copy grant.
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.
DescribeSnapshotCopyGrantsRequest.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

snapshotCopyGrantName

public final String snapshotCopyGrantName()

The name of the snapshot copy grant.

Returns:

The name of the snapshot copy grant.

maxRecords

public final Integer maxRecords()

The maximum number of 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.

Default: 100

Constraints: minimum 20, maximum 100.

Returns:

The maximum number of 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.

Default: 100

Constraints: minimum 20, maximum 100.

marker

public final String marker()

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

Returns:

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

hasTagKeys

public final 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 final 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 final 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 final 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 DescribeSnapshotCopyGrantsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSnapshotCopyGrantsRequest.Builder,DescribeSnapshotCopyGrantsRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static DescribeSnapshotCopyGrantsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo