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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeClusterSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The ARN of this Cluster.
`static DescribeClusterSummary.Builder`	`builder()`
`List<String>`	`channelIds()`	An array of the IDs of the Channels that are associated with this Cluster.
`ClusterType`	`clusterType()`	The hardware type for the Cluster.
`String`	`clusterTypeAsString()`	The hardware type for the Cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasChannelIds()`	For responses, this returns true if the service returned a value for the ChannelIds property.
`int`	`hashCode()`
`String`	`id()`	The ID of the Cluster.
`String`	`instanceRoleArn()`	The ARN of the IAM role for the Node in this Cluster.
`String`	`name()`	The name that you specified for the Cluster.
`ClusterNetworkSettings`	`networkSettings()`	Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeClusterSummary.Builder>`	`serializableBuilderClass()`
`ClusterState`	`state()`	The current state of the Cluster.
`String`	`stateAsString()`	The current state of the Cluster.
`DescribeClusterSummary.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 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:
    
    ClusterType
  - 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:
    
    ClusterType
  - 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:
    
    ClusterState
  - 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:
    
    ClusterState
  - toBuilder
```
public DescribeClusterSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeClusterSummary.Builder,DescribeClusterSummary>
  - 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)
```
    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 DescribeClusterSummary

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

hasChannelIds

channelIds

clusterType

clusterTypeAsString

id

instanceRoleArn

name

networkSettings

state

stateAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField