Class DescribeNodeConfigurationOptionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeNodeConfigurationOptionsRequest.Builder,
DescribeNodeConfigurationOptionsRequest>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal ActionType
The action type to evaluate for possible node configurations.final String
The action type to evaluate for possible node configurations.builder()
final String
The identifier of the cluster to evaluate for possible node configurations.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
A set of name, operator, and value items to filter the results.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final String
marker()
An optional parameter that specifies the starting point to return a set of response records.final Integer
The maximum number of response records to return in each call.final String
The Amazon Web Services account used to create or copy the snapshot.static Class
<? extends DescribeNodeConfigurationOptionsRequest.Builder> final String
The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.final String
The identifier of the snapshot to evaluate for possible node configurations.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
-
actionType
The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
If the service returns an enum value that is not available in the current SDK version,
actionType
will returnActionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionTypeAsString()
.- Returns:
- The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
- See Also:
-
actionTypeAsString
The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
If the service returns an enum value that is not available in the current SDK version,
actionType
will returnActionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionTypeAsString()
.- Returns:
- The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
- See Also:
-
clusterIdentifier
The identifier of the cluster to evaluate for possible node configurations.
- Returns:
- The identifier of the cluster to evaluate for possible node configurations.
-
snapshotIdentifier
The identifier of the snapshot to evaluate for possible node configurations.
- Returns:
- The identifier of the snapshot to evaluate for possible node configurations.
-
snapshotArn
The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
- Returns:
- The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
-
ownerAccount
The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
- Returns:
- The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
-
hasFilters
public final boolean hasFilters()For responses, this returns true if the service returned a value for the Filters 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. -
filters
A set of name, operator, and value items to filter the results.
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
hasFilters()
method.- Returns:
- A set of name, operator, and value items to filter the results.
-
marker
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in
MaxRecords
, Amazon Web Services returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 DescribeNodeConfigurationOptions request exceed the value specified in
MaxRecords
, Amazon Web Services returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.
-
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 amarker
field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
500
Constraints: minimum 100, maximum 500.
- 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 amarker
field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
500
Constraints: minimum 100, maximum 500.
-
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<DescribeNodeConfigurationOptionsRequest.Builder,
DescribeNodeConfigurationOptionsRequest> - Specified by:
toBuilder
in classRedshiftRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeNodeConfigurationOptionsRequest.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
-