Package com.azure.resourcemanager.machinelearning.models

Class BatchDeploymentProperties

java.lang.Object
com.azure.resourcemanager.machinelearning.models.EndpointDeploymentPropertiesBase
com.azure.resourcemanager.machinelearning.models.BatchDeploymentProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<EndpointDeploymentPropertiesBase>
public final class BatchDeploymentProperties extends EndpointDeploymentPropertiesBase
Batch inference settings per deployment.

  • Constructor Details

    • BatchDeploymentProperties

      public BatchDeploymentProperties()
      Creates an instance of BatchDeploymentProperties class.

  • Method Details

    • compute

      public String compute()
      Get the compute property: Compute target for batch inference operation.
      Returns:
      the compute value.

    • withCompute

      public BatchDeploymentProperties withCompute(String compute)
      Set the compute property: Compute target for batch inference operation.
      Parameters:
      compute - the compute value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • deploymentConfiguration

      public BatchDeploymentConfiguration deploymentConfiguration()
      Get the deploymentConfiguration property: Properties relevant to different deployment types.
      Returns:
      the deploymentConfiguration value.

    • withDeploymentConfiguration

      public BatchDeploymentProperties withDeploymentConfiguration(BatchDeploymentConfiguration deploymentConfiguration)
      Set the deploymentConfiguration property: Properties relevant to different deployment types.
      Parameters:
      deploymentConfiguration - the deploymentConfiguration value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • errorThreshold

      public Integer errorThreshold()
      Get the errorThreshold property: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored.
      Returns:
      the errorThreshold value.

    • withErrorThreshold

      public BatchDeploymentProperties withErrorThreshold(Integer errorThreshold)
      Set the errorThreshold property: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored.
      Parameters:
      errorThreshold - the errorThreshold value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • retrySettings

      public BatchRetrySettings retrySettings()
      Get the retrySettings property: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.
      Returns:
      the retrySettings value.

    • withRetrySettings

      public BatchDeploymentProperties withRetrySettings(BatchRetrySettings retrySettings)
      Set the retrySettings property: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.
      Parameters:
      retrySettings - the retrySettings value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • miniBatchSize

      public Long miniBatchSize()
      Get the miniBatchSize property: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch.
      Returns:
      the miniBatchSize value.

    • withMiniBatchSize

      public BatchDeploymentProperties withMiniBatchSize(Long miniBatchSize)
      Set the miniBatchSize property: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch.
      Parameters:
      miniBatchSize - the miniBatchSize value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • loggingLevel

      public BatchLoggingLevel loggingLevel()
      Get the loggingLevel property: Logging level for batch inference operation.
      Returns:
      the loggingLevel value.

    • withLoggingLevel

      public BatchDeploymentProperties withLoggingLevel(BatchLoggingLevel loggingLevel)
      Set the loggingLevel property: Logging level for batch inference operation.
      Parameters:
      loggingLevel - the loggingLevel value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • model

      public AssetReferenceBase model()
      Get the model property: Reference to the model asset for the endpoint deployment.
      Returns:
      the model value.

    • withModel

      public BatchDeploymentProperties withModel(AssetReferenceBase model)
      Set the model property: Reference to the model asset for the endpoint deployment.
      Parameters:
      model - the model value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • maxConcurrencyPerInstance

      public Integer maxConcurrencyPerInstance()
      Get the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.
      Returns:
      the maxConcurrencyPerInstance value.

    • withMaxConcurrencyPerInstance

      public BatchDeploymentProperties withMaxConcurrencyPerInstance(Integer maxConcurrencyPerInstance)
      Set the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.
      Parameters:
      maxConcurrencyPerInstance - the maxConcurrencyPerInstance value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • outputAction

      public BatchOutputAction outputAction()
      Get the outputAction property: Indicates how the output will be organized.
      Returns:
      the outputAction value.

    • withOutputAction

      public BatchDeploymentProperties withOutputAction(BatchOutputAction outputAction)
      Set the outputAction property: Indicates how the output will be organized.
      Parameters:
      outputAction - the outputAction value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • outputFileName

      public String outputFileName()
      Get the outputFileName property: Customized output file name for append_row output action.
      Returns:
      the outputFileName value.

    • withOutputFileName

      public BatchDeploymentProperties withOutputFileName(String outputFileName)
      Set the outputFileName property: Customized output file name for append_row output action.
      Parameters:
      outputFileName - the outputFileName value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • resources

      public DeploymentResourceConfiguration resources()
      Get the resources property: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
      Returns:
      the resources value.

    • withResources

      public BatchDeploymentProperties withResources(DeploymentResourceConfiguration resources)
      Set the resources property: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
      Parameters:
      resources - the resources value to set.
      Returns:
      the BatchDeploymentProperties object itself.

    • provisioningState

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

    • withDescription

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