Package software.amazon.awssdk.services.redshift.model

Class DescribeNodeConfigurationOptionsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeNodeConfigurationOptionsRequest.Builder,DescribeNodeConfigurationOptionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeNodeConfigurationOptionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
ActionType	actionType()	The action type to evaluate for possible node configurations.
String	actionTypeAsString()	The action type to evaluate for possible node configurations.
static DescribeNodeConfigurationOptionsRequest.Builder	builder()
String	clusterIdentifier()	The identifier of the cluster to evaluate for possible node configurations.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<NodeConfigurationOptionsFilter>	filters()	A set of name, operator, and value items to filter the results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
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 DescribeNodeConfigurationOptionsRequest.Builder>	serializableBuilderClass()
String	snapshotArn()	The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
String	snapshotIdentifier()	The identifier of the snapshot to evaluate for possible node configurations.
DescribeNodeConfigurationOptionsRequest.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

actionType

public final ActionType 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 return ActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionTypeAsString().

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:

ActionType

actionTypeAsString

public final String 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 return ActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionTypeAsString().

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:

ActionType

clusterIdentifier

public final String 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

public final String 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

public final String 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

public final String 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 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.

filters

public final List<NodeConfigurationOptionsFilter> 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

public final String 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 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 DescribeNodeConfigurationOptions 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.

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: 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 a marker 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

public DescribeNodeConfigurationOptionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeNodeConfigurationOptionsRequest.Builder,DescribeNodeConfigurationOptionsRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static DescribeNodeConfigurationOptionsRequest.Builder builder()

serializableBuilderClass

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