java.lang.Object
- software.amazon.awssdk.services.medialive.model.DescribeNodeSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DescribeNodeSummary.Builder,DescribeNodeSummary>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeNodeSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DescribeNodeSummary.Builder,DescribeNodeSummary>

Placeholder documentation for DescribeNodeSummary

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeNodeSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The ARN of the Node.
`static DescribeNodeSummary.Builder`	`builder()`
`List<String>`	`channelPlacementGroups()`	An array of IDs.
`String`	`clusterId()`	The ID of the Cluster that the Node belongs to.
`NodeConnectionState`	`connectionState()`	The current connection state of the Node.
`String`	`connectionStateAsString()`	The current connection state of the Node.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasChannelPlacementGroups()`	For responses, this returns true if the service returned a value for the ChannelPlacementGroups property.
`int`	`hashCode()`
`boolean`	`hasNodeInterfaceMappings()`	For responses, this returns true if the service returned a value for the NodeInterfaceMappings property.
`String`	`id()`	The unique ID of the Node.
`String`	`instanceArn()`	The EC2 ARN of the Instance associated with the Node.
`String`	`managedInstanceId()`	At the routing layer will get it from the callerId/context for use with bring your own device.
`String`	`name()`	The name that you specified for the Node.
`List<NodeInterfaceMapping>`	`nodeInterfaceMappings()`	Documentation update needed
`NodeRole`	`role()`	The initial role current role of the Node in the Cluster.
`String`	`roleAsString()`	The initial role current role of the Node in the Cluster.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeNodeSummary.Builder>`	`serializableBuilderClass()`
`NodeState`	`state()`	The current state of the Node.
`String`	`stateAsString()`	The current state of the Node.
`DescribeNodeSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - arn
```
public final String arn()
```
    The ARN of the Node. It is automatically assigned when the Node is created.
    
    Returns:
    
    The ARN of the Node. It is automatically assigned when the Node is created.
  - hasChannelPlacementGroups
```
public final boolean hasChannelPlacementGroups()
```
    For responses, this returns true if the service returned a value for the ChannelPlacementGroups 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.
  - channelPlacementGroups
```
public final List<String> channelPlacementGroups()
```
    An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
    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 hasChannelPlacementGroups() method.
    
    Returns:
    
    An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
  - clusterId
```
public final String clusterId()
```
    The ID of the Cluster that the Node belongs to.
    
    Returns:
    
    The ID of the Cluster that the Node belongs to.
  - connectionState
```
public final NodeConnectionState connectionState()
```
    The current connection state of the Node.
    If the service returns an enum value that is not available in the current SDK version, connectionState will return NodeConnectionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionStateAsString().
    
    Returns:
    
    The current connection state of the Node.
    
    See Also:
    
    NodeConnectionState
  - connectionStateAsString
```
public final String connectionStateAsString()
```
    The current connection state of the Node.
    If the service returns an enum value that is not available in the current SDK version, connectionState will return NodeConnectionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionStateAsString().
    
    Returns:
    
    The current connection state of the Node.
    
    See Also:
    
    NodeConnectionState
  - id
```
public final String id()
```
    The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
    
    Returns:
    
    The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
  - instanceArn
```
public final String instanceArn()
```
    The EC2 ARN of the Instance associated with the Node.
    
    Returns:
    
    The EC2 ARN of the Instance associated with the Node.
  - managedInstanceId
```
public final String managedInstanceId()
```
    At the routing layer will get it from the callerId/context for use with bring your own device.
    
    Returns:
    
    At the routing layer will get it from the callerId/context for use with bring your own device.
  - name
```
public final String name()
```
    The name that you specified for the Node.
    
    Returns:
    
    The name that you specified for the Node.
  - hasNodeInterfaceMappings
```
public final boolean hasNodeInterfaceMappings()
```
    For responses, this returns true if the service returned a value for the NodeInterfaceMappings 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.
  - nodeInterfaceMappings
```
public final List<NodeInterfaceMapping> nodeInterfaceMappings()
```
    Documentation update needed
    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 hasNodeInterfaceMappings() method.
    
    Returns:
    
    Documentation update needed
  - role
```
public final NodeRole role()
```
    The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
    If the service returns an enum value that is not available in the current SDK version, role will return NodeRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().
    
    Returns:
    
    The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
    
    See Also:
    
    NodeRole
  - roleAsString
```
public final String roleAsString()
```
    The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
    If the service returns an enum value that is not available in the current SDK version, role will return NodeRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().
    
    Returns:
    
    The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
    
    See Also:
    
    NodeRole
  - state
```
public final NodeState state()
```
    The current state of the Node.
    If the service returns an enum value that is not available in the current SDK version, state will return NodeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the Node.
    
    See Also:
    
    NodeState
  - stateAsString
```
public final String stateAsString()
```
    The current state of the Node.
    If the service returns an enum value that is not available in the current SDK version, state will return NodeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the Node.
    
    See Also:
    
    NodeState
  - toBuilder
```
public DescribeNodeSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeNodeSummary.Builder,DescribeNodeSummary>
  - builder
```
public static DescribeNodeSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeNodeSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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

Class DescribeNodeSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

hasChannelPlacementGroups

channelPlacementGroups

clusterId

connectionState

connectionStateAsString

id

instanceArn

managedInstanceId

name

hasNodeInterfaceMappings

nodeInterfaceMappings

role

roleAsString

state

stateAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField