Package com.azure.resourcemanager.machinelearning.models

Class OnlineDeploymentProperties

java.lang.Object
com.azure.resourcemanager.machinelearning.models.EndpointDeploymentPropertiesBase
com.azure.resourcemanager.machinelearning.models.OnlineDeploymentProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<EndpointDeploymentPropertiesBase>
Direct Known Subclasses:
KubernetesOnlineDeployment, ManagedOnlineDeployment
public class OnlineDeploymentProperties extends EndpointDeploymentPropertiesBase
The OnlineDeploymentProperties model.

  • Constructor Details

    • OnlineDeploymentProperties

      public OnlineDeploymentProperties()
      Creates an instance of OnlineDeploymentProperties class.

  • Method Details

    • endpointComputeType

      public EndpointComputeType endpointComputeType()
      Get the endpointComputeType property: [Required] The compute type of the endpoint.
      Returns:
      the endpointComputeType value.

    • scaleSettings

      public OnlineScaleSettings scaleSettings()
      Get 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.
      Returns:
      the scaleSettings value.

    • withScaleSettings

      public OnlineDeploymentProperties 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.
      Parameters:
      scaleSettings - the scaleSettings value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • requestSettings

      public OnlineRequestSettings requestSettings()
      Get the requestSettings property: Request settings for the deployment.
      Returns:
      the requestSettings value.

    • withRequestSettings

      public OnlineDeploymentProperties withRequestSettings(OnlineRequestSettings requestSettings)
      Set the requestSettings property: Request settings for the deployment.
      Parameters:
      requestSettings - the requestSettings value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • modelMountPath

      public String modelMountPath()
      Get the modelMountPath property: The path to mount the model in custom container.
      Returns:
      the modelMountPath value.

    • withModelMountPath

      public OnlineDeploymentProperties withModelMountPath(String modelMountPath)
      Set the modelMountPath property: The path to mount the model in custom container.
      Parameters:
      modelMountPath - the modelMountPath value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • appInsightsEnabled

      public Boolean appInsightsEnabled()
      Get the appInsightsEnabled property: If true, enables Application Insights logging.
      Returns:
      the appInsightsEnabled value.

    • withAppInsightsEnabled

      public OnlineDeploymentProperties withAppInsightsEnabled(Boolean appInsightsEnabled)
      Set the appInsightsEnabled property: If true, enables Application Insights logging.
      Parameters:
      appInsightsEnabled - the appInsightsEnabled value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • livenessProbe

      public ProbeSettings livenessProbe()
      Get the livenessProbe property: Liveness probe monitors the health of the container regularly.
      Returns:
      the livenessProbe value.

    • withLivenessProbe

      public OnlineDeploymentProperties withLivenessProbe(ProbeSettings livenessProbe)
      Set the livenessProbe property: Liveness probe monitors the health of the container regularly.
      Parameters:
      livenessProbe - the livenessProbe value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • readinessProbe

      public ProbeSettings readinessProbe()
      Get the readinessProbe property: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.
      Returns:
      the readinessProbe value.

    • withReadinessProbe

      public OnlineDeploymentProperties 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.
      Parameters:
      readinessProbe - the readinessProbe value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • provisioningState

      public DeploymentProvisioningState provisioningState()
      Get the provisioningState property: Provisioning state for the endpoint deployment.
      Returns:
      the provisioningState value.

    • instanceType

      public String instanceType()
      Get the instanceType property: Compute instance type.
      Returns:
      the instanceType value.

    • withInstanceType

      public OnlineDeploymentProperties withInstanceType(String instanceType)
      Set the instanceType property: Compute instance type.
      Parameters:
      instanceType - the instanceType value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • model

      public String model()
      Get the model property: The URI path to the model.
      Returns:
      the model value.

    • withModel

      public OnlineDeploymentProperties withModel(String model)
      Set the model property: The URI path to the model.
      Parameters:
      model - the model value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • egressPublicNetworkAccess

      public EgressPublicNetworkAccessType egressPublicNetworkAccess()
      Get the egressPublicNetworkAccess property: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.
      Returns:
      the egressPublicNetworkAccess value.

    • withEgressPublicNetworkAccess

      public OnlineDeploymentProperties withEgressPublicNetworkAccess(EgressPublicNetworkAccessType egressPublicNetworkAccess)
      Set the egressPublicNetworkAccess property: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.
      Parameters:
      egressPublicNetworkAccess - the egressPublicNetworkAccess value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • dataCollector

      public DataCollector dataCollector()
      Get the dataCollector property: The mdc configuration, we disable mdc when it's null.
      Returns:
      the dataCollector value.

    • withDataCollector

      public OnlineDeploymentProperties withDataCollector(DataCollector dataCollector)
      Set the dataCollector property: The mdc configuration, we disable mdc when it's null.
      Parameters:
      dataCollector - the dataCollector value to set.
      Returns:
      the OnlineDeploymentProperties object itself.

    • withDescription

      public OnlineDeploymentProperties withDescription(String description)
      Set the description property: Description of the endpoint deployment.
      Overrides:
      withDescription in class EndpointDeploymentPropertiesBase
      Parameters:
      description - the description value to set.
      Returns:
      the EndpointDeploymentPropertiesBase object itself.

    • withProperties

      public OnlineDeploymentProperties withProperties(Map<String,String> properties)
      Set the properties property: Property dictionary. Properties can be added, but not removed or altered.
      Overrides:
      withProperties in class EndpointDeploymentPropertiesBase
      Parameters:
      properties - the properties value to set.
      Returns:
      the EndpointDeploymentPropertiesBase object itself.

    • withCodeConfiguration

      public OnlineDeploymentProperties withCodeConfiguration(CodeConfiguration codeConfiguration)
      Set the codeConfiguration property: Code configuration for the endpoint deployment.
      Overrides:
      withCodeConfiguration in class EndpointDeploymentPropertiesBase
      Parameters:
      codeConfiguration - the codeConfiguration value to set.
      Returns:
      the EndpointDeploymentPropertiesBase object itself.

    • withEnvironmentId

      public OnlineDeploymentProperties withEnvironmentId(String environmentId)
      Set the environmentId property: ARM resource ID or AssetId of the environment specification for the endpoint deployment.
      Overrides:
      withEnvironmentId in class EndpointDeploymentPropertiesBase
      Parameters:
      environmentId - the environmentId value to set.
      Returns:
      the EndpointDeploymentPropertiesBase object itself.

    • withEnvironmentVariables

      public OnlineDeploymentProperties withEnvironmentVariables(Map<String,String> environmentVariables)
      Set the environmentVariables property: Environment variables configuration for the deployment.
      Overrides:
      withEnvironmentVariables in class EndpointDeploymentPropertiesBase
      Parameters:
      environmentVariables - the environmentVariables value to set.
      Returns:
      the EndpointDeploymentPropertiesBase object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class EndpointDeploymentPropertiesBase
      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 EndpointDeploymentPropertiesBase
      Throws:
      IOException

    • fromJson

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