Class DescribeClusterSummary

java.lang.Object
software.amazon.awssdk.services.medialive.model.DescribeClusterSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DescribeClusterSummary.Builder,DescribeClusterSummary>
@Generated("software.amazon.awssdk:codegen") public final class DescribeClusterSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribeClusterSummary.Builder,DescribeClusterSummary>
Used in ListClustersResult.
See Also:

  • Method Details

    • arn

      public final String arn()
      The ARN of this Cluster. It is automatically assigned when the Cluster is created.
      Returns:
      The ARN of this Cluster. It is automatically assigned when the Cluster is created.

    • hasChannelIds

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

    • channelIds

      public final List<String> channelIds()
      An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.

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

      Returns:
      An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.

    • clusterType

      public final ClusterType clusterType()
      The hardware type for the Cluster.

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

      Returns:
      The hardware type for the Cluster.
      See Also:

    • clusterTypeAsString

      public final String clusterTypeAsString()
      The hardware type for the Cluster.

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

      Returns:
      The hardware type for the Cluster.
      See Also:

    • id

      public final String id()
      The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.
      Returns:
      The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.

    • instanceRoleArn

      public final String instanceRoleArn()
      The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.
      Returns:
      The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.

    • name

      public final String name()
      The name that you specified for the Cluster.
      Returns:
      The name that you specified for the Cluster.

    • networkSettings

      public final ClusterNetworkSettings networkSettings()
      Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
      Returns:
      Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.

    • state

      public final ClusterState state()
      The current state of the Cluster.

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

      Returns:
      The current state of the Cluster.
      See Also:

    • stateAsString

      public final String stateAsString()
      The current state of the Cluster.

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

      Returns:
      The current state of the Cluster.
      See Also:

    • toBuilder

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

    • builder

      public static DescribeClusterSummary.Builder builder()

    • serializableBuilderClass

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