Package com.azure.resourcemanager.machinelearning.models

Class OnlineEndpointProperties

java.lang.Object
com.azure.resourcemanager.machinelearning.fluent.models.EndpointPropertiesBaseInner
com.azure.resourcemanager.machinelearning.models.OnlineEndpointProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<EndpointPropertiesBaseInner>
public final class OnlineEndpointProperties extends EndpointPropertiesBaseInner
Online endpoint configuration.

  • Constructor Details

    • OnlineEndpointProperties

      public OnlineEndpointProperties()
      Creates an instance of OnlineEndpointProperties class.

  • Method Details

    • provisioningState

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

    • compute

      public String compute()
      Get the compute property: ARM resource ID of the compute if it exists. optional.
      Returns:
      the compute value.

    • withCompute

      public OnlineEndpointProperties withCompute(String compute)
      Set the compute property: ARM resource ID of the compute if it exists. optional.
      Parameters:
      compute - the compute value to set.
      Returns:
      the OnlineEndpointProperties object itself.

    • publicNetworkAccess

      public PublicNetworkAccessType publicNetworkAccess()
      Get the publicNetworkAccess property: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
      Returns:
      the publicNetworkAccess value.

    • withPublicNetworkAccess

      public OnlineEndpointProperties withPublicNetworkAccess(PublicNetworkAccessType publicNetworkAccess)
      Set the publicNetworkAccess property: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the OnlineEndpointProperties object itself.

    • traffic

      public Map<String,Integer> traffic()
      Get the traffic property: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.
      Returns:
      the traffic value.

    • withTraffic

      public OnlineEndpointProperties withTraffic(Map<String,Integer> traffic)
      Set the traffic property: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.
      Parameters:
      traffic - the traffic value to set.
      Returns:
      the OnlineEndpointProperties object itself.

    • mirrorTraffic

      public Map<String,Integer> mirrorTraffic()
      Get the mirrorTraffic property: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
      Returns:
      the mirrorTraffic value.

    • withMirrorTraffic

      public OnlineEndpointProperties withMirrorTraffic(Map<String,Integer> mirrorTraffic)
      Set the mirrorTraffic property: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
      Parameters:
      mirrorTraffic - the mirrorTraffic value to set.
      Returns:
      the OnlineEndpointProperties object itself.

    • scoringUri

      public String scoringUri()
      Get the scoringUri property: Endpoint URI.
      Overrides:
      scoringUri in class EndpointPropertiesBaseInner
      Returns:
      the scoringUri value.

    • swaggerUri

      public String swaggerUri()
      Get the swaggerUri property: Endpoint Swagger URI.
      Overrides:
      swaggerUri in class EndpointPropertiesBaseInner
      Returns:
      the swaggerUri value.

    • withDescription

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

    • withProperties

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

    • withAuthMode

      public OnlineEndpointProperties withAuthMode(EndpointAuthMode authMode)
      Set the authMode property: [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
      Overrides:
      withAuthMode in class EndpointPropertiesBaseInner
      Parameters:
      authMode - the authMode value to set.
      Returns:
      the EndpointPropertiesBaseInner object itself.

    • withKeys

      public OnlineEndpointProperties withKeys(EndpointAuthKeysInner keys)
      Set the keys property: EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
      Overrides:
      withKeys in class EndpointPropertiesBaseInner
      Parameters:
      keys - the keys value to set.
      Returns:
      the EndpointPropertiesBaseInner object itself.

    • validate

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

    • fromJson

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