All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azurenative.machinelearningservices.outputs.BatchDeploymentResponse Maven / Gradle / Ivy

There is a newer version: 2.89.2
Show newest version
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.azurenative.machinelearningservices.outputs;

import com.pulumi.azurenative.machinelearningservices.outputs.BatchRetrySettingsResponse;
import com.pulumi.azurenative.machinelearningservices.outputs.CodeConfigurationResponse;
import com.pulumi.azurenative.machinelearningservices.outputs.DataPathAssetReferenceResponse;
import com.pulumi.azurenative.machinelearningservices.outputs.DeploymentResourceConfigurationResponse;
import com.pulumi.azurenative.machinelearningservices.outputs.IdAssetReferenceResponse;
import com.pulumi.azurenative.machinelearningservices.outputs.OutputPathAssetReferenceResponse;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Double;
import java.lang.Integer;
import java.lang.Object;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;

@CustomType
public final class BatchDeploymentResponse {
    /**
     * @return Code configuration for the endpoint deployment.
     * 
     */
    private @Nullable CodeConfigurationResponse codeConfiguration;
    /**
     * @return Compute target for batch inference operation.
     * 
     */
    private @Nullable String compute;
    /**
     * @return Description of the endpoint deployment.
     * 
     */
    private @Nullable String description;
    /**
     * @return ARM resource ID or AssetId of the environment specification for the endpoint deployment.
     * 
     */
    private @Nullable String environmentId;
    /**
     * @return Environment variables configuration for the deployment.
     * 
     */
    private @Nullable Map environmentVariables;
    /**
     * @return 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.
     * 
     */
    private @Nullable Integer errorThreshold;
    /**
     * @return Logging level for batch inference operation.
     * 
     */
    private @Nullable String loggingLevel;
    /**
     * @return Indicates maximum number of parallelism per instance.
     * 
     */
    private @Nullable Integer maxConcurrencyPerInstance;
    /**
     * @return 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.
     * 
     */
    private @Nullable Double miniBatchSize;
    /**
     * @return Reference to the model asset for the endpoint deployment.
     * 
     */
    private @Nullable Object model;
    /**
     * @return Indicates how the output will be organized.
     * 
     */
    private @Nullable String outputAction;
    /**
     * @return Customized output file name for append_row output action.
     * 
     */
    private @Nullable String outputFileName;
    /**
     * @return Property dictionary. Properties can be added, but not removed or altered.
     * 
     */
    private @Nullable Map properties;
    /**
     * @return Provisioning state for the endpoint deployment.
     * 
     */
    private String provisioningState;
    /**
     * @return Indicates compute configuration for the job.
     * If not provided, will default to the defaults defined in ResourceConfiguration.
     * 
     */
    private @Nullable DeploymentResourceConfigurationResponse resources;
    /**
     * @return Retry Settings for the batch inference operation.
     * If not provided, will default to the defaults defined in BatchRetrySettings.
     * 
     */
    private @Nullable BatchRetrySettingsResponse retrySettings;

    private BatchDeploymentResponse() {}
    /**
     * @return Code configuration for the endpoint deployment.
     * 
     */
    public Optional codeConfiguration() {
        return Optional.ofNullable(this.codeConfiguration);
    }
    /**
     * @return Compute target for batch inference operation.
     * 
     */
    public Optional compute() {
        return Optional.ofNullable(this.compute);
    }
    /**
     * @return Description of the endpoint deployment.
     * 
     */
    public Optional description() {
        return Optional.ofNullable(this.description);
    }
    /**
     * @return ARM resource ID or AssetId of the environment specification for the endpoint deployment.
     * 
     */
    public Optional environmentId() {
        return Optional.ofNullable(this.environmentId);
    }
    /**
     * @return Environment variables configuration for the deployment.
     * 
     */
    public Map environmentVariables() {
        return this.environmentVariables == null ? Map.of() : this.environmentVariables;
    }
    /**
     * @return 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.
     * 
     */
    public Optional errorThreshold() {
        return Optional.ofNullable(this.errorThreshold);
    }
    /**
     * @return Logging level for batch inference operation.
     * 
     */
    public Optional loggingLevel() {
        return Optional.ofNullable(this.loggingLevel);
    }
    /**
     * @return Indicates maximum number of parallelism per instance.
     * 
     */
    public Optional maxConcurrencyPerInstance() {
        return Optional.ofNullable(this.maxConcurrencyPerInstance);
    }
    /**
     * @return 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.
     * 
     */
    public Optional miniBatchSize() {
        return Optional.ofNullable(this.miniBatchSize);
    }
    /**
     * @return Reference to the model asset for the endpoint deployment.
     * 
     */
    public Optional model() {
        return Optional.ofNullable(this.model);
    }
    /**
     * @return Indicates how the output will be organized.
     * 
     */
    public Optional outputAction() {
        return Optional.ofNullable(this.outputAction);
    }
    /**
     * @return Customized output file name for append_row output action.
     * 
     */
    public Optional outputFileName() {
        return Optional.ofNullable(this.outputFileName);
    }
    /**
     * @return Property dictionary. Properties can be added, but not removed or altered.
     * 
     */
    public Map properties() {
        return this.properties == null ? Map.of() : this.properties;
    }
    /**
     * @return Provisioning state for the endpoint deployment.
     * 
     */
    public String provisioningState() {
        return this.provisioningState;
    }
    /**
     * @return Indicates compute configuration for the job.
     * If not provided, will default to the defaults defined in ResourceConfiguration.
     * 
     */
    public Optional resources() {
        return Optional.ofNullable(this.resources);
    }
    /**
     * @return Retry Settings for the batch inference operation.
     * If not provided, will default to the defaults defined in BatchRetrySettings.
     * 
     */
    public Optional retrySettings() {
        return Optional.ofNullable(this.retrySettings);
    }

    public static Builder builder() {
        return new Builder();
    }

    public static Builder builder(BatchDeploymentResponse defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private @Nullable CodeConfigurationResponse codeConfiguration;
        private @Nullable String compute;
        private @Nullable String description;
        private @Nullable String environmentId;
        private @Nullable Map environmentVariables;
        private @Nullable Integer errorThreshold;
        private @Nullable String loggingLevel;
        private @Nullable Integer maxConcurrencyPerInstance;
        private @Nullable Double miniBatchSize;
        private @Nullable Object model;
        private @Nullable String outputAction;
        private @Nullable String outputFileName;
        private @Nullable Map properties;
        private String provisioningState;
        private @Nullable DeploymentResourceConfigurationResponse resources;
        private @Nullable BatchRetrySettingsResponse retrySettings;
        public Builder() {}
        public Builder(BatchDeploymentResponse defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.codeConfiguration = defaults.codeConfiguration;
    	      this.compute = defaults.compute;
    	      this.description = defaults.description;
    	      this.environmentId = defaults.environmentId;
    	      this.environmentVariables = defaults.environmentVariables;
    	      this.errorThreshold = defaults.errorThreshold;
    	      this.loggingLevel = defaults.loggingLevel;
    	      this.maxConcurrencyPerInstance = defaults.maxConcurrencyPerInstance;
    	      this.miniBatchSize = defaults.miniBatchSize;
    	      this.model = defaults.model;
    	      this.outputAction = defaults.outputAction;
    	      this.outputFileName = defaults.outputFileName;
    	      this.properties = defaults.properties;
    	      this.provisioningState = defaults.provisioningState;
    	      this.resources = defaults.resources;
    	      this.retrySettings = defaults.retrySettings;
        }

        @CustomType.Setter
        public Builder codeConfiguration(@Nullable CodeConfigurationResponse codeConfiguration) {

            this.codeConfiguration = codeConfiguration;
            return this;
        }
        @CustomType.Setter
        public Builder compute(@Nullable String compute) {

            this.compute = compute;
            return this;
        }
        @CustomType.Setter
        public Builder description(@Nullable String description) {

            this.description = description;
            return this;
        }
        @CustomType.Setter
        public Builder environmentId(@Nullable String environmentId) {

            this.environmentId = environmentId;
            return this;
        }
        @CustomType.Setter
        public Builder environmentVariables(@Nullable Map environmentVariables) {

            this.environmentVariables = environmentVariables;
            return this;
        }
        @CustomType.Setter
        public Builder errorThreshold(@Nullable Integer errorThreshold) {

            this.errorThreshold = errorThreshold;
            return this;
        }
        @CustomType.Setter
        public Builder loggingLevel(@Nullable String loggingLevel) {

            this.loggingLevel = loggingLevel;
            return this;
        }
        @CustomType.Setter
        public Builder maxConcurrencyPerInstance(@Nullable Integer maxConcurrencyPerInstance) {

            this.maxConcurrencyPerInstance = maxConcurrencyPerInstance;
            return this;
        }
        @CustomType.Setter
        public Builder miniBatchSize(@Nullable Double miniBatchSize) {

            this.miniBatchSize = miniBatchSize;
            return this;
        }
        @CustomType.Setter
        public Builder model(@Nullable Object model) {

            this.model = model;
            return this;
        }
        @CustomType.Setter
        public Builder outputAction(@Nullable String outputAction) {

            this.outputAction = outputAction;
            return this;
        }
        @CustomType.Setter
        public Builder outputFileName(@Nullable String outputFileName) {

            this.outputFileName = outputFileName;
            return this;
        }
        @CustomType.Setter
        public Builder properties(@Nullable Map properties) {

            this.properties = properties;
            return this;
        }
        @CustomType.Setter
        public Builder provisioningState(String provisioningState) {
            if (provisioningState == null) {
              throw new MissingRequiredPropertyException("BatchDeploymentResponse", "provisioningState");
            }
            this.provisioningState = provisioningState;
            return this;
        }
        @CustomType.Setter
        public Builder resources(@Nullable DeploymentResourceConfigurationResponse resources) {

            this.resources = resources;
            return this;
        }
        @CustomType.Setter
        public Builder retrySettings(@Nullable BatchRetrySettingsResponse retrySettings) {

            this.retrySettings = retrySettings;
            return this;
        }
        public BatchDeploymentResponse build() {
            final var _resultValue = new BatchDeploymentResponse();
            _resultValue.codeConfiguration = codeConfiguration;
            _resultValue.compute = compute;
            _resultValue.description = description;
            _resultValue.environmentId = environmentId;
            _resultValue.environmentVariables = environmentVariables;
            _resultValue.errorThreshold = errorThreshold;
            _resultValue.loggingLevel = loggingLevel;
            _resultValue.maxConcurrencyPerInstance = maxConcurrencyPerInstance;
            _resultValue.miniBatchSize = miniBatchSize;
            _resultValue.model = model;
            _resultValue.outputAction = outputAction;
            _resultValue.outputFileName = outputFileName;
            _resultValue.properties = properties;
            _resultValue.provisioningState = provisioningState;
            _resultValue.resources = resources;
            _resultValue.retrySettings = retrySettings;
            return _resultValue;
        }
    }
}