Class DescribeChannelPlacementGroupSummary
- java.lang.Object
-
- software.amazon.awssdk.services.medialive.model.DescribeChannelPlacementGroupSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DescribeChannelPlacementGroupSummary.Builder,DescribeChannelPlacementGroupSummary>
@Generated("software.amazon.awssdk:codegen") public final class DescribeChannelPlacementGroupSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribeChannelPlacementGroupSummary.Builder,DescribeChannelPlacementGroupSummary>
Contains the response for ListChannelPlacementGroups- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeChannelPlacementGroupSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The ARN of this ChannelPlacementGroup.static DescribeChannelPlacementGroupSummary.Builderbuilder()List<String>channels()Used in ListChannelPlacementGroupsResultStringclusterId()The ID of the Cluster that the Node belongs to.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasChannels()For responses, this returns true if the service returned a value for the Channels property.inthashCode()booleanhasNodes()For responses, this returns true if the service returned a value for the Nodes property.Stringid()The ID of the ChannelPlacementGroup.Stringname()The name that you specified for the ChannelPlacementGroup.List<String>nodes()An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DescribeChannelPlacementGroupSummary.Builder>serializableBuilderClass()ChannelPlacementGroupStatestate()The current state of the ChannelPlacementGroup.StringstateAsString()The current state of the ChannelPlacementGroup.DescribeChannelPlacementGroupSummary.BuildertoBuilder()StringtoString()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 ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.- Returns:
- The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.
-
hasChannels
public final boolean hasChannels()
For responses, this returns true if the service returned a value for the Channels property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
channels
public final List<String> channels()
Used in ListChannelPlacementGroupsResultAttempts 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
hasChannels()method.- Returns:
- Used in ListChannelPlacementGroupsResult
-
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.
-
id
public final String id()
The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.- Returns:
- The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.
-
name
public final String name()
The name that you specified for the ChannelPlacementGroup.- Returns:
- The name that you specified for the ChannelPlacementGroup.
-
hasNodes
public final boolean hasNodes()
For responses, this returns true if the service returned a value for the Nodes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
nodes
public final List<String> nodes()
An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup.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
hasNodes()method.- Returns:
- An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup.
-
state
public final ChannelPlacementGroupState state()
The current state of the ChannelPlacementGroup.If the service returns an enum value that is not available in the current SDK version,
statewill returnChannelPlacementGroupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the ChannelPlacementGroup.
- See Also:
ChannelPlacementGroupState
-
stateAsString
public final String stateAsString()
The current state of the ChannelPlacementGroup.If the service returns an enum value that is not available in the current SDK version,
statewill returnChannelPlacementGroupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the ChannelPlacementGroup.
- See Also:
ChannelPlacementGroupState
-
toBuilder
public DescribeChannelPlacementGroupSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeChannelPlacementGroupSummary.Builder,DescribeChannelPlacementGroupSummary>
-
builder
public static DescribeChannelPlacementGroupSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeChannelPlacementGroupSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-