Package com.azure.resourcemanager.machinelearning.models

Class KubernetesOnlineDeployment

java.lang.Object

com.azure.resourcemanager.machinelearning.models.EndpointDeploymentPropertiesBase

com.azure.resourcemanager.machinelearning.models.OnlineDeploymentProperties

com.azure.resourcemanager.machinelearning.models.KubernetesOnlineDeployment

All Implemented Interfaces:

com.azure.json.JsonSerializable<EndpointDeploymentPropertiesBase>

public final class KubernetesOnlineDeployment
extends OnlineDeploymentProperties

Properties specific to a KubernetesOnlineDeployment.

Constructor Summary

Constructors

Constructor	Description
KubernetesOnlineDeployment()	Creates an instance of KubernetesOnlineDeployment class.

Method Summary

Modifier and Type	Method	Description
ContainerResourceRequirements	containerResourceRequirements()	Get the containerResourceRequirements property: The resource requirements for the container (cpu and memory).
EndpointComputeType	endpointComputeType()	Get the endpointComputeType property: [Required] The compute type of the endpoint.
static KubernetesOnlineDeployment	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of KubernetesOnlineDeployment from the JsonReader.
DeploymentProvisioningState	provisioningState()	Get the provisioningState property: Provisioning state for the endpoint deployment.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)
void	validate()	Validates the instance.
KubernetesOnlineDeployment	withAppInsightsEnabled(Boolean appInsightsEnabled)	Set the appInsightsEnabled property: If true, enables Application Insights logging.
KubernetesOnlineDeployment	withCodeConfiguration(CodeConfiguration codeConfiguration)	Set the codeConfiguration property: Code configuration for the endpoint deployment.
KubernetesOnlineDeployment	withContainerResourceRequirements(ContainerResourceRequirements containerResourceRequirements)	Set the containerResourceRequirements property: The resource requirements for the container (cpu and memory).
KubernetesOnlineDeployment	withDataCollector(DataCollector dataCollector)	Set the dataCollector property: The mdc configuration, we disable mdc when it's null.
KubernetesOnlineDeployment	withDescription(String description)	Set the description property: Description of the endpoint deployment.
KubernetesOnlineDeployment	withEgressPublicNetworkAccess(EgressPublicNetworkAccessType egressPublicNetworkAccess)	Set the egressPublicNetworkAccess property: If Enabled, allow egress public network access.
KubernetesOnlineDeployment	withEnvironmentId(String environmentId)	Set the environmentId property: ARM resource ID or AssetId of the environment specification for the endpoint deployment.
KubernetesOnlineDeployment	withEnvironmentVariables(Map<String,String> environmentVariables)	Set the environmentVariables property: Environment variables configuration for the deployment.
KubernetesOnlineDeployment	withInstanceType(String instanceType)	Set the instanceType property: Compute instance type.
KubernetesOnlineDeployment	withLivenessProbe(ProbeSettings livenessProbe)	Set the livenessProbe property: Liveness probe monitors the health of the container regularly.
KubernetesOnlineDeployment	withModel(String model)	Set the model property: The URI path to the model.
KubernetesOnlineDeployment	withModelMountPath(String modelMountPath)	Set the modelMountPath property: The path to mount the model in custom container.
KubernetesOnlineDeployment	withProperties(Map<String,String> properties)	Set the properties property: Property dictionary.
KubernetesOnlineDeployment	withReadinessProbe(ProbeSettings readinessProbe)	Set the readinessProbe property: Readiness probe validates if the container is ready to serve traffic.
KubernetesOnlineDeployment	withRequestSettings(OnlineRequestSettings requestSettings)	Set the requestSettings property: Request settings for the deployment.
KubernetesOnlineDeployment	withScaleSettings(OnlineScaleSettings scaleSettings)	Set the scaleSettings property: Scale settings for the deployment.

Methods inherited from class com.azure.resourcemanager.machinelearning.models.OnlineDeploymentProperties

appInsightsEnabled, dataCollector, egressPublicNetworkAccess, instanceType, livenessProbe, model, modelMountPath, readinessProbe, requestSettings, scaleSettings

Methods inherited from class com.azure.resourcemanager.machinelearning.models.EndpointDeploymentPropertiesBase

codeConfiguration, description, environmentId, environmentVariables, properties

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

KubernetesOnlineDeployment

public KubernetesOnlineDeployment()

Creates an instance of KubernetesOnlineDeployment class.

Method Details

endpointComputeType

public EndpointComputeType endpointComputeType()

Get the endpointComputeType property: [Required] The compute type of the endpoint.

Overrides:

endpointComputeType in class OnlineDeploymentProperties

Returns:

the endpointComputeType value.

containerResourceRequirements

public ContainerResourceRequirements containerResourceRequirements()

Get the containerResourceRequirements property: The resource requirements for the container (cpu and memory).

Returns:

the containerResourceRequirements value.

withContainerResourceRequirements

public KubernetesOnlineDeployment withContainerResourceRequirements(ContainerResourceRequirements containerResourceRequirements)

Set the containerResourceRequirements property: The resource requirements for the container (cpu and memory).

Parameters:

containerResourceRequirements - the containerResourceRequirements value to set.

Returns:

the KubernetesOnlineDeployment object itself.

provisioningState

public DeploymentProvisioningState provisioningState()

Get the provisioningState property: Provisioning state for the endpoint deployment.

Overrides:

provisioningState in class OnlineDeploymentProperties

Returns:

the provisioningState value.

withScaleSettings

public KubernetesOnlineDeployment withScaleSettings(OnlineScaleSettings scaleSettings)

Set the scaleSettings property: Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment and to DefaultScaleSettings for ManagedOnlineDeployment.

Overrides:

withScaleSettings in class OnlineDeploymentProperties

Parameters:

scaleSettings - the scaleSettings value to set.

Returns:

the OnlineDeploymentProperties object itself.

withRequestSettings

public KubernetesOnlineDeployment withRequestSettings(OnlineRequestSettings requestSettings)

Set the requestSettings property: Request settings for the deployment.

Overrides:

withRequestSettings in class OnlineDeploymentProperties

Parameters:

requestSettings - the requestSettings value to set.

Returns:

the OnlineDeploymentProperties object itself.

withModelMountPath

public KubernetesOnlineDeployment withModelMountPath(String modelMountPath)

Set the modelMountPath property: The path to mount the model in custom container.

Overrides:

withModelMountPath in class OnlineDeploymentProperties

Parameters:

modelMountPath - the modelMountPath value to set.

Returns:

the OnlineDeploymentProperties object itself.

withAppInsightsEnabled

public KubernetesOnlineDeployment withAppInsightsEnabled(Boolean appInsightsEnabled)

Set the appInsightsEnabled property: If true, enables Application Insights logging.

Overrides:

withAppInsightsEnabled in class OnlineDeploymentProperties

Parameters:

appInsightsEnabled - the appInsightsEnabled value to set.

Returns:

the OnlineDeploymentProperties object itself.

withLivenessProbe

public KubernetesOnlineDeployment withLivenessProbe(ProbeSettings livenessProbe)

Set the livenessProbe property: Liveness probe monitors the health of the container regularly.

Overrides:

withLivenessProbe in class OnlineDeploymentProperties

Parameters:

livenessProbe - the livenessProbe value to set.

Returns:

the OnlineDeploymentProperties object itself.

withReadinessProbe

public KubernetesOnlineDeployment withReadinessProbe(ProbeSettings readinessProbe)

Set the readinessProbe property: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.

Overrides:

withReadinessProbe in class OnlineDeploymentProperties

Parameters:

readinessProbe - the readinessProbe value to set.

Returns:

the OnlineDeploymentProperties object itself.

withInstanceType

public KubernetesOnlineDeployment withInstanceType(String instanceType)

Set the instanceType property: Compute instance type.

Overrides:

withInstanceType in class OnlineDeploymentProperties

Parameters:

instanceType - the instanceType value to set.

Returns:

the OnlineDeploymentProperties object itself.

withModel

public KubernetesOnlineDeployment withModel(String model)

Set the model property: The URI path to the model.

Overrides:

withModel in class OnlineDeploymentProperties

Parameters:

model - the model value to set.

Returns:

the OnlineDeploymentProperties object itself.

withEgressPublicNetworkAccess

public KubernetesOnlineDeployment withEgressPublicNetworkAccess(EgressPublicNetworkAccessType egressPublicNetworkAccess)

Set the egressPublicNetworkAccess property: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.

Overrides:

withEgressPublicNetworkAccess in class OnlineDeploymentProperties

Parameters:

egressPublicNetworkAccess - the egressPublicNetworkAccess value to set.

Returns:

the OnlineDeploymentProperties object itself.

withDataCollector

public KubernetesOnlineDeployment withDataCollector(DataCollector dataCollector)

Set the dataCollector property: The mdc configuration, we disable mdc when it's null.

Overrides:

withDataCollector in class OnlineDeploymentProperties

Parameters:

dataCollector - the dataCollector value to set.

Returns:

the OnlineDeploymentProperties object itself.

withDescription

public KubernetesOnlineDeployment withDescription(String description)

Set the description property: Description of the endpoint deployment.

Overrides:

withDescription in class OnlineDeploymentProperties

Parameters:

description - the description value to set.

Returns:

the EndpointDeploymentPropertiesBase object itself.

withProperties

public KubernetesOnlineDeployment withProperties(Map<String,String> properties)

Set the properties property: Property dictionary. Properties can be added, but not removed or altered.

Overrides:

withProperties in class OnlineDeploymentProperties

Parameters:

properties - the properties value to set.

Returns:

the EndpointDeploymentPropertiesBase object itself.

withCodeConfiguration

public KubernetesOnlineDeployment withCodeConfiguration(CodeConfiguration codeConfiguration)

Set the codeConfiguration property: Code configuration for the endpoint deployment.

Overrides:

withCodeConfiguration in class OnlineDeploymentProperties

Parameters:

codeConfiguration - the codeConfiguration value to set.

Returns:

the EndpointDeploymentPropertiesBase object itself.

withEnvironmentId

public KubernetesOnlineDeployment withEnvironmentId(String environmentId)

Set the environmentId property: ARM resource ID or AssetId of the environment specification for the endpoint deployment.

Overrides:

withEnvironmentId in class OnlineDeploymentProperties

Parameters:

environmentId - the environmentId value to set.

Returns:

the EndpointDeploymentPropertiesBase object itself.

withEnvironmentVariables

public KubernetesOnlineDeployment withEnvironmentVariables(Map<String,String> environmentVariables)

Set the environmentVariables property: Environment variables configuration for the deployment.

Overrides:

withEnvironmentVariables in class OnlineDeploymentProperties

Parameters:

environmentVariables - the environmentVariables value to set.

Returns:

the EndpointDeploymentPropertiesBase object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class OnlineDeploymentProperties

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<EndpointDeploymentPropertiesBase>

Overrides:

toJson in class OnlineDeploymentProperties

Throws:

IOException

fromJson

public static KubernetesOnlineDeployment fromJson(com.azure.json.JsonReader jsonReader)
                                           throws IOException

Reads an instance of KubernetesOnlineDeployment from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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