Class DescribeNodeSummary

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • hasSdiSourceMappings

      public final boolean hasSdiSourceMappings()
      For responses, this returns true if the service returned a value for the SdiSourceMappings 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.

    • sdiSourceMappings

      public final List<SdiSourceMapping> sdiSourceMappings()
      An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.

      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 hasSdiSourceMappings() method.

      Returns:
      An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.

    • toBuilder

      public DescribeNodeSummary.Builder 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 interface ToCopyableBuilder<DescribeNodeSummary.Builder,DescribeNodeSummary>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.