software.amazon.awssdk.services.redshift.model

Class DescribeClusterSnapshotsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeClusterSnapshotsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeClusterSnapshotsRequest.Builder	builder()
Boolean	clusterExists() A value that indicates whether to return snapshots only for an existing cluster.
String	clusterIdentifier() The identifier of the cluster which generated the requested snapshots.
Instant	endTime() A time value that requests only snapshots created at or before the specified time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSortingEntities() For responses, this returns true if the service returned a value for the SortingEntities property.
boolean	hasTagKeys() For responses, this returns true if the service returned a value for the TagKeys property.
boolean	hasTagValues() For responses, this returns true if the service returned a value for the TagValues property.
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.
String	ownerAccount() The Amazon Web Services account used to create or copy the snapshot.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeClusterSnapshotsRequest.Builder>	serializableBuilderClass()
String	snapshotArn() The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.
String	snapshotIdentifier() The snapshot identifier of the snapshot about which to return information.
String	snapshotType() The type of snapshots for which you are requesting information.
List<SnapshotSortingEntity>	sortingEntities()
Instant	startTime() A value that requests only snapshots created at or after the specified time.
List<String>	tagKeys() A tag key or keys for which you want to return all matching cluster snapshots 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 cluster snapshots that are associated with the specified tag value or values.
DescribeClusterSnapshotsRequest.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

clusterIdentifier

public final String clusterIdentifier()

The identifier of the cluster which generated the requested snapshots.

Returns:

The identifier of the cluster which generated the requested snapshots.

snapshotIdentifier

public final String snapshotIdentifier()

The snapshot identifier of the snapshot about which to return information.

Returns:

The snapshot identifier of the snapshot about which to return information.

snapshotArn

public final String snapshotArn()

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

Returns:

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

snapshotType

public final String snapshotType()

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

Returns:

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

startTime

public final Instant startTime()

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Returns:

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

endTime

public final Instant endTime()

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Returns:

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

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 DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services 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.

Returns:

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services 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.

ownerAccount

public final String ownerAccount()

The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

Returns:

The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

hasTagKeys

public final boolean hasTagKeys()

For responses, this returns true if the service returned a value for the TagKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagKeys

public final List<String> tagKeys()

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagKeys() method.

Returns:

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

hasTagValues

public final boolean hasTagValues()

For responses, this returns true if the service returned a value for the TagValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagValues

public final List<String> tagValues()

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagValues() method.

Returns:

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

clusterExists

public final Boolean clusterExists()

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

• If ClusterExists is set to true, ClusterIdentifier is required.

• If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

Returns:

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

• If ClusterExists is set to true, ClusterIdentifier is required.

• If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

hasSortingEntities

public final boolean hasSortingEntities()

For responses, this returns true if the service returned a value for the SortingEntities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sortingEntities

public final List<SnapshotSortingEntity> sortingEntities()

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSortingEntities() method.

Returns:

toBuilder

public DescribeClusterSnapshotsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static DescribeClusterSnapshotsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeClusterSnapshotsRequest.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