Class DescribeSnapshotSchedulesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeSnapshotSchedulesRequest.Builder,
DescribeSnapshotSchedulesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The unique identifier for the cluster whose snapshot schedules you want to view.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TagKeys property.final boolean
For responses, this returns true if the service returned a value for the TagValues property.final String
marker()
A value that indicates the starting point for the next set of response records in a subsequent request.final Integer
The maximum number or response records to return in each call.final String
A unique identifier for a snapshot schedule.static Class
<? extends DescribeSnapshotSchedulesRequest.Builder> tagKeys()
The key value for a snapshot schedule tag.The value corresponding to the key of the snapshot schedule tag.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterIdentifier
The unique identifier for the cluster whose snapshot schedules you want to view.
- Returns:
- The unique identifier for the cluster whose snapshot schedules you want to view.
-
scheduleIdentifier
A unique identifier for a snapshot schedule.
- Returns:
- A unique identifier for a snapshot schedule.
-
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 theisEmpty()
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
The key value for a snapshot schedule tag.
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:
- The key value for a snapshot schedule tag.
-
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 theisEmpty()
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
The value corresponding to the key of the snapshot schedule tag.
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:
- The value corresponding to the key of the snapshot schedule tag.
-
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 themarker
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 themarker
field is empty, all response records have been retrieved for the request.
-
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 amarker
field of the response. You can retrieve the next set of records by retrying the command with the returnedmarker
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 amarker
field of the response. You can retrieve the next set of records by retrying the command with the returnedmarker
value.
-
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 interfaceToCopyableBuilder<DescribeSnapshotSchedulesRequest.Builder,
DescribeSnapshotSchedulesRequest> - Specified by:
toBuilder
in classRedshiftRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-