Class BatchDeploymentDetails
- java.lang.Object
-
- com.azure.resourcemanager.machinelearning.models.EndpointDeploymentPropertiesBase
-
- com.azure.resourcemanager.machinelearning.models.BatchDeploymentDetails
-
public final class BatchDeploymentDetails extends EndpointDeploymentPropertiesBase
Batch inference settings per deployment.
-
-
Constructor Summary
Constructors Constructor Description BatchDeploymentDetails()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
compute()
Get the compute property: Compute target for batch inference operation.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.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.ResourceConfiguration
resources()
Get the resources property: Indicates compute configuration for the job.BatchRetrySettings
retrySettings()
Get the retrySettings property: Retry Settings for the batch inference operation.void
validate()
Validates the instance.BatchDeploymentDetails
withCodeConfiguration(CodeConfiguration codeConfiguration)
Set the codeConfiguration property: Code configuration for the endpoint deployment.BatchDeploymentDetails
withCompute(String compute)
Set the compute property: Compute target for batch inference operation.BatchDeploymentDetails
withDescription(String description)
Set the description property: Description of the endpoint deployment.BatchDeploymentDetails
withEnvironmentId(String environmentId)
Set the environmentId property: ARM resource ID of the environment specification for the endpoint deployment.BatchDeploymentDetails
withEnvironmentVariables(Map<String,String> environmentVariables)
Set the environmentVariables property: Environment variables configuration for the deployment.BatchDeploymentDetails
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.BatchDeploymentDetails
withLoggingLevel(BatchLoggingLevel loggingLevel)
Set the loggingLevel property: Logging level for batch inference operation.BatchDeploymentDetails
withMaxConcurrencyPerInstance(Integer maxConcurrencyPerInstance)
Set the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.BatchDeploymentDetails
withMiniBatchSize(Long miniBatchSize)
Set the miniBatchSize property: Size of the mini-batch passed to each batch invocation.BatchDeploymentDetails
withModel(AssetReferenceBase model)
Set the model property: Reference to the model asset for the endpoint deployment.BatchDeploymentDetails
withOutputAction(BatchOutputAction outputAction)
Set the outputAction property: Indicates how the output will be organized.BatchDeploymentDetails
withOutputFileName(String outputFileName)
Set the outputFileName property: Customized output file name for append_row output action.BatchDeploymentDetails
withProperties(Map<String,String> properties)
Set the properties property: Property dictionary.BatchDeploymentDetails
withResources(ResourceConfiguration resources)
Set the resources property: Indicates compute configuration for the job.BatchDeploymentDetails
withRetrySettings(BatchRetrySettings retrySettings)
Set the retrySettings property: Retry Settings for the batch inference operation.-
Methods inherited from class com.azure.resourcemanager.machinelearning.models.EndpointDeploymentPropertiesBase
codeConfiguration, description, environmentId, environmentVariables, properties
-
-
-
-
Method Detail
-
compute
public String compute()
Get the compute property: Compute target for batch inference operation.- Returns:
- the compute value.
-
withCompute
public BatchDeploymentDetails withCompute(String compute)
Set the compute property: Compute target for batch inference operation.- Parameters:
compute
- the compute value to set.- Returns:
- the BatchDeploymentDetails 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 BatchDeploymentDetails 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 BatchDeploymentDetails object itself.
-
loggingLevel
public BatchLoggingLevel loggingLevel()
Get the loggingLevel property: Logging level for batch inference operation.- Returns:
- the loggingLevel value.
-
withLoggingLevel
public BatchDeploymentDetails withLoggingLevel(BatchLoggingLevel loggingLevel)
Set the loggingLevel property: Logging level for batch inference operation.- Parameters:
loggingLevel
- the loggingLevel value to set.- Returns:
- the BatchDeploymentDetails object itself.
-
maxConcurrencyPerInstance
public Integer maxConcurrencyPerInstance()
Get the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.- Returns:
- the maxConcurrencyPerInstance value.
-
withMaxConcurrencyPerInstance
public BatchDeploymentDetails withMaxConcurrencyPerInstance(Integer maxConcurrencyPerInstance)
Set the maxConcurrencyPerInstance property: Indicates maximum number of parallelism per instance.- Parameters:
maxConcurrencyPerInstance
- the maxConcurrencyPerInstance value to set.- Returns:
- the BatchDeploymentDetails 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 BatchDeploymentDetails 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 BatchDeploymentDetails 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 BatchDeploymentDetails 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 BatchDeploymentDetails object itself.
-
outputAction
public BatchOutputAction outputAction()
Get the outputAction property: Indicates how the output will be organized.- Returns:
- the outputAction value.
-
withOutputAction
public BatchDeploymentDetails withOutputAction(BatchOutputAction outputAction)
Set the outputAction property: Indicates how the output will be organized.- Parameters:
outputAction
- the outputAction value to set.- Returns:
- the BatchDeploymentDetails 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 BatchDeploymentDetails 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 BatchDeploymentDetails object itself.
-
provisioningState
public DeploymentProvisioningState provisioningState()
Get the provisioningState property: Provisioning state for the endpoint deployment.- Returns:
- the provisioningState value.
-
resources
public ResourceConfiguration 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 BatchDeploymentDetails withResources(ResourceConfiguration 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 BatchDeploymentDetails 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 BatchDeploymentDetails 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 BatchDeploymentDetails object itself.
-
withCodeConfiguration
public BatchDeploymentDetails withCodeConfiguration(CodeConfiguration codeConfiguration)
Set the codeConfiguration property: Code configuration for the endpoint deployment.- Overrides:
withCodeConfiguration
in classEndpointDeploymentPropertiesBase
- Parameters:
codeConfiguration
- the codeConfiguration value to set.- Returns:
- the EndpointDeploymentPropertiesBase object itself.
-
withDescription
public BatchDeploymentDetails withDescription(String description)
Set the description property: Description of the endpoint deployment.- Overrides:
withDescription
in classEndpointDeploymentPropertiesBase
- Parameters:
description
- the description value to set.- Returns:
- the EndpointDeploymentPropertiesBase object itself.
-
withEnvironmentId
public BatchDeploymentDetails withEnvironmentId(String environmentId)
Set the environmentId property: ARM resource ID of the environment specification for the endpoint deployment.- Overrides:
withEnvironmentId
in classEndpointDeploymentPropertiesBase
- Parameters:
environmentId
- the environmentId value to set.- Returns:
- the EndpointDeploymentPropertiesBase object itself.
-
withEnvironmentVariables
public BatchDeploymentDetails withEnvironmentVariables(Map<String,String> environmentVariables)
Set the environmentVariables property: Environment variables configuration for the deployment.- Overrides:
withEnvironmentVariables
in classEndpointDeploymentPropertiesBase
- Parameters:
environmentVariables
- the environmentVariables value to set.- Returns:
- the EndpointDeploymentPropertiesBase object itself.
-
withProperties
public BatchDeploymentDetails withProperties(Map<String,String> properties)
Set the properties property: Property dictionary. Properties can be added, but not removed or altered.- Overrides:
withProperties
in classEndpointDeploymentPropertiesBase
- Parameters:
properties
- the properties value to set.- Returns:
- the EndpointDeploymentPropertiesBase object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classEndpointDeploymentPropertiesBase
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-