Package software.amazon.awssdk.services.medialive.model

Class CreateNodeRequest

    • Method Detail

      • clusterId

        public final String clusterId()
        The ID of the cluster.
        Returns:
        The ID of the cluster.

      • name

        public final String name()
        The user-specified name of the Node to be created.
        Returns:
        The user-specified name of the Node to be created.

      • 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 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.

      • nodeInterfaceMappings

        public final List<NodeInterfaceMappingCreateRequest> nodeInterfaceMappings()
        Documentation update needed

        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 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, role will return NodeRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

        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, role will return NodeRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

        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

      • hasTags

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

      • tags

        public final Map<String,​String> tags()
        A collection of key-value pairs.

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

        Returns:
        A collection of key-value pairs.

      • 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