Class ComputeInstanceProperties

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

public final class ComputeInstanceProperties extends Object implements com.azure.json.JsonSerializable<ComputeInstanceProperties>
Compute Instance properties.
  • Constructor Details

    • ComputeInstanceProperties

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

    • vmSize

      public String vmSize()
      Get the vmSize property: Virtual Machine Size.
      Returns:
      the vmSize value.
    • withVmSize

      public ComputeInstanceProperties withVmSize(String vmSize)
      Set the vmSize property: Virtual Machine Size.
      Parameters:
      vmSize - the vmSize value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • subnet

      public ResourceId subnet()
      Get the subnet property: Virtual network subnet resource ID the compute nodes belong to.
      Returns:
      the subnet value.
    • withSubnet

      public ComputeInstanceProperties withSubnet(ResourceId subnet)
      Set the subnet property: Virtual network subnet resource ID the compute nodes belong to.
      Parameters:
      subnet - the subnet value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • applicationSharingPolicy

      public ApplicationSharingPolicy applicationSharingPolicy()
      Get the applicationSharingPolicy property: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.
      Returns:
      the applicationSharingPolicy value.
    • withApplicationSharingPolicy

      public ComputeInstanceProperties withApplicationSharingPolicy(ApplicationSharingPolicy applicationSharingPolicy)
      Set the applicationSharingPolicy property: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.
      Parameters:
      applicationSharingPolicy - the applicationSharingPolicy value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • sshSettings

      public ComputeInstanceSshSettings sshSettings()
      Get the sshSettings property: Specifies policy and settings for SSH access.
      Returns:
      the sshSettings value.
    • withSshSettings

      public ComputeInstanceProperties withSshSettings(ComputeInstanceSshSettings sshSettings)
      Set the sshSettings property: Specifies policy and settings for SSH access.
      Parameters:
      sshSettings - the sshSettings value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • customServices

      public List<CustomService> customServices()
      Get the customServices property: List of Custom Services added to the compute.
      Returns:
      the customServices value.
    • withCustomServices

      public ComputeInstanceProperties withCustomServices(List<CustomService> customServices)
      Set the customServices property: List of Custom Services added to the compute.
      Parameters:
      customServices - the customServices value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • osImageMetadata

      public ImageMetadata osImageMetadata()
      Get the osImageMetadata property: Returns metadata about the operating system image for this compute instance.
      Returns:
      the osImageMetadata value.
    • connectivityEndpoints

      public ComputeInstanceConnectivityEndpoints connectivityEndpoints()
      Get the connectivityEndpoints property: Describes all connectivity endpoints available for this ComputeInstance.
      Returns:
      the connectivityEndpoints value.
    • applications

      public List<ComputeInstanceApplication> applications()
      Get the applications property: Describes available applications and their endpoints on this ComputeInstance.
      Returns:
      the applications value.
    • createdBy

      public ComputeInstanceCreatedBy createdBy()
      Get the createdBy property: Describes information on user who created this ComputeInstance.
      Returns:
      the createdBy value.
    • errors

      public List<com.azure.core.management.exception.ManagementError> errors()
      Get the errors property: Collection of errors encountered on this ComputeInstance.
      Returns:
      the errors value.
    • state

      public ComputeInstanceState state()
      Get the state property: The current state of this ComputeInstance.
      Returns:
      the state value.
    • computeInstanceAuthorizationType

      public ComputeInstanceAuthorizationType computeInstanceAuthorizationType()
      Get the computeInstanceAuthorizationType property: The Compute Instance Authorization type. Available values are personal (default).
      Returns:
      the computeInstanceAuthorizationType value.
    • withComputeInstanceAuthorizationType

      public ComputeInstanceProperties withComputeInstanceAuthorizationType(ComputeInstanceAuthorizationType computeInstanceAuthorizationType)
      Set the computeInstanceAuthorizationType property: The Compute Instance Authorization type. Available values are personal (default).
      Parameters:
      computeInstanceAuthorizationType - the computeInstanceAuthorizationType value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • personalComputeInstanceSettings

      public PersonalComputeInstanceSettings personalComputeInstanceSettings()
      Get the personalComputeInstanceSettings property: Settings for a personal compute instance.
      Returns:
      the personalComputeInstanceSettings value.
    • withPersonalComputeInstanceSettings

      public ComputeInstanceProperties withPersonalComputeInstanceSettings(PersonalComputeInstanceSettings personalComputeInstanceSettings)
      Set the personalComputeInstanceSettings property: Settings for a personal compute instance.
      Parameters:
      personalComputeInstanceSettings - the personalComputeInstanceSettings value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • setupScripts

      public SetupScripts setupScripts()
      Get the setupScripts property: Details of customized scripts to execute for setting up the cluster.
      Returns:
      the setupScripts value.
    • withSetupScripts

      public ComputeInstanceProperties withSetupScripts(SetupScripts setupScripts)
      Set the setupScripts property: Details of customized scripts to execute for setting up the cluster.
      Parameters:
      setupScripts - the setupScripts value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • lastOperation

      public ComputeInstanceLastOperation lastOperation()
      Get the lastOperation property: The last operation on ComputeInstance.
      Returns:
      the lastOperation value.
    • schedules

      public ComputeSchedules schedules()
      Get the schedules property: The list of schedules to be applied on the computes.
      Returns:
      the schedules value.
    • withSchedules

      public ComputeInstanceProperties withSchedules(ComputeSchedules schedules)
      Set the schedules property: The list of schedules to be applied on the computes.
      Parameters:
      schedules - the schedules value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • enableNodePublicIp

      public Boolean enableNodePublicIp()
      Get the enableNodePublicIp property: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.
      Returns:
      the enableNodePublicIp value.
    • withEnableNodePublicIp

      public ComputeInstanceProperties withEnableNodePublicIp(Boolean enableNodePublicIp)
      Set the enableNodePublicIp property: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.
      Parameters:
      enableNodePublicIp - the enableNodePublicIp value to set.
      Returns:
      the ComputeInstanceProperties object itself.
    • containers

      public List<ComputeInstanceContainer> containers()
      Get the containers property: Describes informations of containers on this ComputeInstance.
      Returns:
      the containers value.
    • dataDisks

      public List<ComputeInstanceDataDisk> dataDisks()
      Get the dataDisks property: Describes informations of dataDisks on this ComputeInstance.
      Returns:
      the dataDisks value.
    • dataMounts

      public List<ComputeInstanceDataMount> dataMounts()
      Get the dataMounts property: Describes informations of dataMounts on this ComputeInstance.
      Returns:
      the dataMounts value.
    • versions

      public ComputeInstanceVersion versions()
      Get the versions property: ComputeInstance version.
      Returns:
      the versions 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<ComputeInstanceProperties>
      Throws:
      IOException
    • fromJson

      public static ComputeInstanceProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ComputeInstanceProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ComputeInstanceProperties 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 ComputeInstanceProperties.