ComputeInstance Class

public final class ComputeInstance
extends Compute

An Azure Machine Learning compute instance.

Constructor Summary

Constructor Description
ComputeInstance()

Creates an instance of ComputeInstance class.

Method Summary

Modifier and Type Method and Description
ComputeType computeType()

Get the computeType property: The type of compute.

OffsetDateTime createdOn()

Get the createdOn property: The time at which the compute was created.

static ComputeInstance fromJson(JsonReader jsonReader)

Reads an instance of ComputeInstance from the JsonReader.

Boolean isAttachedCompute()

Get the isAttachedCompute property: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

OffsetDateTime modifiedOn()

Get the modifiedOn property: The time at which the compute was last modified.

ComputeInstanceProperties properties()

Get the properties property: Properties of ComputeInstance.

List<ManagementError> provisioningErrors()

Get the provisioningErrors property: Errors during provisioning.

ProvisioningState provisioningState()

Get the provisioningState property: The provision state of the cluster.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

ComputeInstance withComputeLocation(String computeLocation)

Set the computeLocation property: Location for the underlying compute.

ComputeInstance withDescription(String description)

Set the description property: The description of the Machine Learning compute.

ComputeInstance withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

ComputeInstance withProperties(ComputeInstanceProperties properties)

Set the properties property: Properties of ComputeInstance.

ComputeInstance withResourceId(String resourceId)

Set the resourceId property: ARM resource id of the underlying compute.

Methods inherited from Compute

Methods inherited from java.lang.Object

Constructor Details

ComputeInstance

public ComputeInstance()

Creates an instance of ComputeInstance class.

Method Details

computeType

public ComputeType computeType()

Get the computeType property: The type of compute.

Overrides:

ComputeInstance.computeType()

Returns:

the computeType value.

createdOn

public OffsetDateTime createdOn()

Get the createdOn property: The time at which the compute was created.

Overrides:

ComputeInstance.createdOn()

Returns:

the createdOn value.

fromJson

public static ComputeInstance fromJson(JsonReader jsonReader)

Reads an instance of ComputeInstance from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ComputeInstance 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 ComputeInstance.

isAttachedCompute

public Boolean isAttachedCompute()

Get the isAttachedCompute property: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

Overrides:

ComputeInstance.isAttachedCompute()

Returns:

the isAttachedCompute value.

modifiedOn

public OffsetDateTime modifiedOn()

Get the modifiedOn property: The time at which the compute was last modified.

Overrides:

ComputeInstance.modifiedOn()

Returns:

the modifiedOn value.

properties

public ComputeInstanceProperties properties()

Get the properties property: Properties of ComputeInstance.

Returns:

the properties value.

provisioningErrors

public List<ManagementError> provisioningErrors()

Get the provisioningErrors property: Errors during provisioning.

Overrides:

ComputeInstance.provisioningErrors()

Returns:

the provisioningErrors value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

Overrides:

ComputeInstance.provisioningState()

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ComputeInstance.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

ComputeInstance.validate()

withComputeLocation

public ComputeInstance withComputeLocation(String computeLocation)

Set the computeLocation property: Location for the underlying compute.

Overrides:

ComputeInstance.withComputeLocation(String computeLocation)

Parameters:

computeLocation

withDescription

public ComputeInstance withDescription(String description)

Set the description property: The description of the Machine Learning compute.

Overrides:

ComputeInstance.withDescription(String description)

Parameters:

description

withDisableLocalAuth

public ComputeInstance withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

Overrides:

ComputeInstance.withDisableLocalAuth(Boolean disableLocalAuth)

Parameters:

disableLocalAuth

withProperties

public ComputeInstance withProperties(ComputeInstanceProperties properties)

Set the properties property: Properties of ComputeInstance.

Parameters:

properties - the properties value to set.

Returns:

the ComputeInstance object itself.

withResourceId

public ComputeInstance withResourceId(String resourceId)

Set the resourceId property: ARM resource id of the underlying compute.

Overrides:

ComputeInstance.withResourceId(String resourceId)

Parameters:

resourceId

Applies to