Package software.amazon.awssdk.services.medialive.model

Class UpdateNodeStateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.medialive.model.MediaLiveRequest

software.amazon.awssdk.services.medialive.model.UpdateNodeStateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateNodeStateRequest.Builder,UpdateNodeStateRequest>

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

A request to update the state of a node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateNodeStateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateNodeStateRequest.Builder	builder()
String	clusterId()	The ID of the cluster
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	nodeId()	The ID of the node.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateNodeStateRequest.Builder>	serializableBuilderClass()
UpdateNodeState	state()	The state to apply to the Node.
String	stateAsString()	The state to apply to the Node.
UpdateNodeStateRequest.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

clusterId

public final String clusterId()

The ID of the cluster

Returns:

The ID of the cluster

nodeId

public final String nodeId()

The ID of the node.

Returns:

The ID of the node.

state

public final UpdateNodeState state()

The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won't use it.

If the service returns an enum value that is not available in the current SDK version, state will return UpdateNodeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won't use it.

See Also:

UpdateNodeState

stateAsString

public final String stateAsString()

The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won't use it.

If the service returns an enum value that is not available in the current SDK version, state will return UpdateNodeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won't use it.

See Also:

UpdateNodeState

toBuilder

public UpdateNodeStateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateNodeStateRequest.Builder,UpdateNodeStateRequest>

Specified by:

toBuilder in class MediaLiveRequest

builder

public static UpdateNodeStateRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo