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("software.amazon.awssdk:codegen") public final class DescribeClusterSnapshotsRequest extends RedshiftRequest implements ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>
      Specified by:
      toBuilder in class RedshiftRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.