BatchDeploymentProperties Class

Package:
com.azure.resourcemanager.machinelearning.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0

public final class BatchDeploymentProperties
extends EndpointDeploymentPropertiesBase

Batch inference settings per deployment.

Constructor Summary

Constructor Description
BatchDeploymentProperties()

Creates an instance of BatchDeploymentProperties class.

Method Summary

Modifier and Type Method and Description
String compute()

Get the compute property: Compute target for batch inference operation.
BatchDeploymentConfiguration deploymentConfiguration()

Get the deploymentConfiguration property: Properties relevant to different deployment types.
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.
static BatchDeploymentProperties fromJson(JsonReader jsonReader)

Reads an instance of BatchDeploymentProperties from the JsonReader.
BatchLoggingLevel loggingLevel()

Get the loggingLevel property: Logging level for batch inference operation.
Integer maxConcurrencyPerInstance()

Get the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.
Long miniBatchSize()

Get the miniBatchSize property: Size of the mini-batch passed to each batch invocation.
AssetReferenceBase model()

Get the model property: Reference to the model asset for the endpoint deployment.
BatchOutputAction outputAction()

Get the outputAction property: Indicates how the output will be organized.
String outputFileName()

Get the outputFileName property: Customized output file name for append_row output action.
DeploymentProvisioningState provisioningState()

Get the provisioningState property: Provisioning state for the endpoint deployment.
DeploymentResourceConfiguration resources()

Get the resources property: Indicates compute configuration for the job.
BatchRetrySettings retrySettings()

Get the retrySettings property: Retry Settings for the batch inference operation.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
BatchDeploymentProperties withCodeConfiguration(CodeConfiguration codeConfiguration)

Set the codeConfiguration property: Code configuration for the endpoint deployment.
BatchDeploymentProperties withCompute(String compute)

Set the compute property: Compute target for batch inference operation.
BatchDeploymentProperties withDeploymentConfiguration(BatchDeploymentConfiguration deploymentConfiguration)

Set the deploymentConfiguration property: Properties relevant to different deployment types.
BatchDeploymentProperties withDescription(String description)

Set the description property: Description of the endpoint deployment.
BatchDeploymentProperties withEnvironmentId(String environmentId)

Set the environmentId property: ARM resource ID or AssetId of the environment specification for the endpoint deployment.
BatchDeploymentProperties withEnvironmentVariables(Map<String,String> environmentVariables)

Set the environmentVariables property: Environment variables configuration for the deployment.
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.
BatchDeploymentProperties withLoggingLevel(BatchLoggingLevel loggingLevel)

Set the loggingLevel property: Logging level for batch inference operation.
BatchDeploymentProperties withMaxConcurrencyPerInstance(Integer maxConcurrencyPerInstance)

Set the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.
BatchDeploymentProperties withMiniBatchSize(Long miniBatchSize)

Set the miniBatchSize property: Size of the mini-batch passed to each batch invocation.
BatchDeploymentProperties withModel(AssetReferenceBase model)

Set the model property: Reference to the model asset for the endpoint deployment.
BatchDeploymentProperties withOutputAction(BatchOutputAction outputAction)

Set the outputAction property: Indicates how the output will be organized.
BatchDeploymentProperties withOutputFileName(String outputFileName)

Set the outputFileName property: Customized output file name for append_row output action.
BatchDeploymentProperties withProperties(Map<String,String> properties)

Set the properties property: Property dictionary.
BatchDeploymentProperties withResources(DeploymentResourceConfiguration resources)

Set the resources property: Indicates compute configuration for the job.
BatchDeploymentProperties withRetrySettings(BatchRetrySettings retrySettings)

Set the retrySettings property: Retry Settings for the batch inference operation.

Methods inherited from EndpointDeploymentPropertiesBase

codeConfiguration description environmentId environmentVariables fromJson properties toJson validate withCodeConfiguration withDescription withEnvironmentId withEnvironmentVariables withProperties

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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.

deploymentConfiguration

public BatchDeploymentConfiguration deploymentConfiguration()

Get the deploymentConfiguration property: Properties relevant to different deployment types.

Returns:

the deploymentConfiguration value.

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.

fromJson

public static BatchDeploymentProperties fromJson(JsonReader jsonReader)

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.

loggingLevel

public BatchLoggingLevel loggingLevel()

Get the loggingLevel property: Logging level for batch inference operation.

Returns:

the loggingLevel value.

maxConcurrencyPerInstance

public Integer maxConcurrencyPerInstance()

Get the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.

Returns:

the maxConcurrencyPerInstance value.

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.

model

public AssetReferenceBase model()

Get the model property: Reference to the model asset for the endpoint deployment.

Returns:

the model value.

outputAction

public BatchOutputAction outputAction()

Get the outputAction property: Indicates how the output will be organized.

Returns:

the outputAction value.

outputFileName

public String outputFileName()

Get the outputFileName property: Customized output file name for append_row output action.

Returns:

the outputFileName value.

provisioningState

public DeploymentProvisioningState provisioningState()

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

Returns:

the provisioningState value.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

BatchDeploymentProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

BatchDeploymentProperties.validate()

withCodeConfiguration

public BatchDeploymentProperties withCodeConfiguration(CodeConfiguration codeConfiguration)

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

Overrides:

BatchDeploymentProperties.withCodeConfiguration(CodeConfiguration codeConfiguration)

Parameters:

codeConfiguration

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.

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.

withDescription

public BatchDeploymentProperties withDescription(String description)

Set the description property: Description of the endpoint deployment.

Overrides:

BatchDeploymentProperties.withDescription(String description)

Parameters:

description

withEnvironmentId

public BatchDeploymentProperties withEnvironmentId(String environmentId)

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

Overrides:

BatchDeploymentProperties.withEnvironmentId(String environmentId)

Parameters:

environmentId

withEnvironmentVariables

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

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

Overrides:

BatchDeploymentProperties.withEnvironmentVariables(Map<String,String> environmentVariables)

Parameters:

environmentVariables

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.

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.

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.

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.

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.

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.

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.

withProperties

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

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

Overrides:

BatchDeploymentProperties.withProperties(Map<String,String> properties)

Parameters:

properties

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.

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.

Applies to