Class BatchEndpointProperties

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

public final class BatchEndpointProperties extends EndpointPropertiesBaseInner
Batch endpoint configuration.
  • Constructor Details

    • BatchEndpointProperties

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

    • defaults

      public BatchEndpointDefaults defaults()
      Get the defaults property: Default values for Batch Endpoint.
      Returns:
      the defaults value.
    • withDefaults

      public BatchEndpointProperties withDefaults(BatchEndpointDefaults defaults)
      Set the defaults property: Default values for Batch Endpoint.
      Parameters:
      defaults - the defaults value to set.
      Returns:
      the BatchEndpointProperties object itself.
    • provisioningState

      public EndpointProvisioningState provisioningState()
      Get the provisioningState property: Provisioning state for the endpoint.
      Returns:
      the provisioningState value.
    • 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 BatchEndpointProperties 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 BatchEndpointProperties 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 BatchEndpointProperties 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

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