Class DeleteNodeResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DeleteNodeResponse.Builder,
DeleteNodeResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the Node.static DeleteNodeResponse.Builder
builder()
An array of IDs.final String
The ID of the Cluster that the Node belongs to.final NodeConnectionState
The current connection state of the Node.final String
The current connection state of the Node.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ChannelPlacementGroups property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NodeInterfaceMappings property.final boolean
For responses, this returns true if the service returned a value for the SdiSourceMappings property.final String
id()
The unique ID of the Node.final String
The ARN of the EC2 instance hosting the Node.final String
name()
The name that you specified for the Node.final List
<NodeInterfaceMapping> Documentation update neededfinal NodeRole
role()
The initial role current role of the Node in the Cluster.final String
The initial role current role of the Node in the Cluster.final List
<SdiSourceMapping> An array of SDI source mappings.static Class
<? extends DeleteNodeResponse.Builder> final NodeState
state()
The current state of the Node.final String
The current state of the Node.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.medialive.model.MediaLiveResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 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. -
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
The ID of the Cluster that the Node belongs to.- Returns:
- The ID of the Cluster that the Node belongs to.
-
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 returnNodeConnectionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionStateAsString()
.- Returns:
- The current connection state of the Node.
- See Also:
-
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 returnNodeConnectionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionStateAsString()
.- Returns:
- The current connection state of the Node.
- See Also:
-
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
The ARN of the EC2 instance hosting the Node.- Returns:
- The ARN of the EC2 instance hosting the Node.
-
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 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. -
nodeInterfaceMappings
Documentation update neededAttempts 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
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 returnNodeRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- 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
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 returnNodeRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- 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
The current state of the Node.If the service returns an enum value that is not available in the current SDK version,
state
will returnNodeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the Node.
- See Also:
-
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 returnNodeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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 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. -
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
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 interfaceToCopyableBuilder<DeleteNodeResponse.Builder,
DeleteNodeResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-