Class AmlComputeNodeInformation

java.lang.Object
com.azure.resourcemanager.machinelearning.models.AmlComputeNodeInformation
All Implemented Interfaces:
com.azure.json.JsonSerializable<AmlComputeNodeInformation>

public final class AmlComputeNodeInformation extends Object implements com.azure.json.JsonSerializable<AmlComputeNodeInformation>
Compute node information related to a AmlCompute.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of AmlComputeNodeInformation class.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of AmlComputeNodeInformation from the JsonReader.
    Get the nodeId property: ID of the compute node.
    Get the nodeState property: State of the compute node.
    Get the port property: SSH port number of the node.
    Get the privateIpAddress property: Private IP address of the compute node.
    Get the publicIpAddress property: Public IP address of the compute node.
    Get the runId property: ID of the Experiment running on the node, if any else null.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    Validates the instance.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString
  • Constructor Details

    • AmlComputeNodeInformation

      public AmlComputeNodeInformation()
      Creates an instance of AmlComputeNodeInformation class.
  • Method Details

    • nodeId

      public String nodeId()
      Get the nodeId property: ID of the compute node.
      Returns:
      the nodeId value.
    • privateIpAddress

      public String privateIpAddress()
      Get the privateIpAddress property: Private IP address of the compute node.
      Returns:
      the privateIpAddress value.
    • publicIpAddress

      public String publicIpAddress()
      Get the publicIpAddress property: Public IP address of the compute node.
      Returns:
      the publicIpAddress value.
    • port

      public Integer port()
      Get the port property: SSH port number of the node.
      Returns:
      the port value.
    • nodeState

      public NodeState nodeState()
      Get the nodeState property: State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.
      Returns:
      the nodeState value.
    • runId

      public String runId()
      Get the runId property: ID of the Experiment running on the node, if any else null.
      Returns:
      the runId value.
    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AmlComputeNodeInformation>
      Throws:
      IOException
    • fromJson

      public static AmlComputeNodeInformation fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AmlComputeNodeInformation from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AmlComputeNodeInformation if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the AmlComputeNodeInformation.