Class CreateNodeRegistrationScriptRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.medialive.model.MediaLiveRequest
-
- software.amazon.awssdk.services.medialive.model.CreateNodeRegistrationScriptRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateNodeRegistrationScriptRequest.Builder,CreateNodeRegistrationScriptRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateNodeRegistrationScriptRequest extends MediaLiveRequest implements ToCopyableBuilder<CreateNodeRegistrationScriptRequest.Builder,CreateNodeRegistrationScriptRequest>
A request to create a new node registration script.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateNodeRegistrationScriptRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateNodeRegistrationScriptRequest.Builderbuilder()StringclusterId()The ID of the clusterbooleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNodeInterfaceMappings()For responses, this returns true if the service returned a value for the NodeInterfaceMappings property.Stringid()If you're generating a re-registration script for an already existing node, this is where you provide the id.Stringname()Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster.List<NodeInterfaceMapping>nodeInterfaceMappings()Documentation update neededStringrequestId()An ID that you assign to a create request.NodeRolerole()The initial role of the Node in the Cluster.StringroleAsString()The initial role of the Node in the Cluster.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateNodeRegistrationScriptRequest.Builder>serializableBuilderClass()CreateNodeRegistrationScriptRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
clusterId
public final String clusterId()
The ID of the cluster- Returns:
- The ID of the cluster
-
id
public final String id()
If you're generating a re-registration script for an already existing node, this is where you provide the id.- Returns:
- If you're generating a re-registration script for an already existing node, this is where you provide the id.
-
name
public final String name()
Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster. The pattern can include the variables $hn (hostname of the node hardware) and $ts for the date and time that the Node is created, in UTC (for example, 2024-08-20T23:35:12Z).- Returns:
- Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster. The pattern can include the variables $hn (hostname of the node hardware) and $ts for the date and time that the Node is created, in UTC (for example, 2024-08-20T23:35:12Z).
-
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
public final List<NodeInterfaceMapping> 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
-
requestId
public final String requestId()
An ID that you assign to a create request. This ID ensures idempotency when creating resources.- Returns:
- An ID that you assign to a create request. This ID ensures idempotency when creating resources.
-
role
public final NodeRole role()
The initial 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,
rolewill returnNodeRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromroleAsString().- Returns:
- The initial 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:
NodeRole
-
roleAsString
public final String roleAsString()
The initial 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,
rolewill returnNodeRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromroleAsString().- Returns:
- The initial 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:
NodeRole
-
toBuilder
public CreateNodeRegistrationScriptRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateNodeRegistrationScriptRequest.Builder,CreateNodeRegistrationScriptRequest>- Specified by:
toBuilderin classMediaLiveRequest
-
builder
public static CreateNodeRegistrationScriptRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateNodeRegistrationScriptRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-