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

com.pulumi.azurenative.machinelearning.inputs.WebServicePropertiesForGraphArgs Maven / Gradle / Ivy

// *** 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.machinelearning.inputs;

import com.pulumi.azurenative.machinelearning.inputs.AssetItemArgs;
import com.pulumi.azurenative.machinelearning.inputs.BlobLocationArgs;
import com.pulumi.azurenative.machinelearning.inputs.CommitmentPlanArgs;
import com.pulumi.azurenative.machinelearning.inputs.DiagnosticsConfigurationArgs;
import com.pulumi.azurenative.machinelearning.inputs.ExampleRequestArgs;
import com.pulumi.azurenative.machinelearning.inputs.GraphPackageArgs;
import com.pulumi.azurenative.machinelearning.inputs.MachineLearningWorkspaceArgs;
import com.pulumi.azurenative.machinelearning.inputs.RealtimeConfigurationArgs;
import com.pulumi.azurenative.machinelearning.inputs.ServiceInputOutputSpecificationArgs;
import com.pulumi.azurenative.machinelearning.inputs.StorageAccountArgs;
import com.pulumi.azurenative.machinelearning.inputs.WebServiceKeysArgs;
import com.pulumi.azurenative.machinelearning.inputs.WebServiceParameterArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.core.internal.Codegen;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


/**
 * Properties specific to a Graph based web service.
 * 
 */
public final class WebServicePropertiesForGraphArgs extends com.pulumi.resources.ResourceArgs {

    public static final WebServicePropertiesForGraphArgs Empty = new WebServicePropertiesForGraphArgs();

    /**
     * Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.
     * 
     */
    @Import(name="assets")
    private @Nullable Output> assets;

    /**
     * @return Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.
     * 
     */
    public Optional>> assets() {
        return Optional.ofNullable(this.assets);
    }

    /**
     * Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations.
     * 
     */
    @Import(name="commitmentPlan")
    private @Nullable Output commitmentPlan;

    /**
     * @return Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations.
     * 
     */
    public Optional> commitmentPlan() {
        return Optional.ofNullable(this.commitmentPlan);
    }

    /**
     * The description of the web service.
     * 
     */
    @Import(name="description")
    private @Nullable Output description;

    /**
     * @return The description of the web service.
     * 
     */
    public Optional> description() {
        return Optional.ofNullable(this.description);
    }

    /**
     * Settings controlling the diagnostics traces collection for the web service.
     * 
     */
    @Import(name="diagnostics")
    private @Nullable Output diagnostics;

    /**
     * @return Settings controlling the diagnostics traces collection for the web service.
     * 
     */
    public Optional> diagnostics() {
        return Optional.ofNullable(this.diagnostics);
    }

    /**
     * Defines sample input data for one or more of the service's inputs.
     * 
     */
    @Import(name="exampleRequest")
    private @Nullable Output exampleRequest;

    /**
     * @return Defines sample input data for one or more of the service's inputs.
     * 
     */
    public Optional> exampleRequest() {
        return Optional.ofNullable(this.exampleRequest);
    }

    /**
     * When set to true, sample data is included in the web service's swagger definition. The default value is true.
     * 
     */
    @Import(name="exposeSampleData")
    private @Nullable Output exposeSampleData;

    /**
     * @return When set to true, sample data is included in the web service's swagger definition. The default value is true.
     * 
     */
    public Optional> exposeSampleData() {
        return Optional.ofNullable(this.exposeSampleData);
    }

    /**
     * Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.
     * 
     */
    @Import(name="input")
    private @Nullable Output input;

    /**
     * @return Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.
     * 
     */
    public Optional> input() {
        return Optional.ofNullable(this.input);
    }

    /**
     * Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations.
     * 
     */
    @Import(name="keys")
    private @Nullable Output keys;

    /**
     * @return Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations.
     * 
     */
    public Optional> keys() {
        return Optional.ofNullable(this.keys);
    }

    /**
     * Specifies the Machine Learning workspace containing the experiment that is source for the web service.
     * 
     */
    @Import(name="machineLearningWorkspace")
    private @Nullable Output machineLearningWorkspace;

    /**
     * @return Specifies the Machine Learning workspace containing the experiment that is source for the web service.
     * 
     */
    public Optional> machineLearningWorkspace() {
        return Optional.ofNullable(this.machineLearningWorkspace);
    }

    /**
     * Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.
     * 
     */
    @Import(name="output")
    private @Nullable Output output;

    /**
     * @return Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.
     * 
     */
    public Optional> output() {
        return Optional.ofNullable(this.output);
    }

    /**
     * The definition of the graph package making up this web service.
     * 
     */
    @Import(name="package")
    private @Nullable Output package_;

    /**
     * @return The definition of the graph package making up this web service.
     * 
     */
    public Optional> package_() {
        return Optional.ofNullable(this.package_);
    }

    /**
     * Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time.
     * Expected value is 'Graph'.
     * 
     */
    @Import(name="packageType", required=true)
    private Output packageType;

    /**
     * @return Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time.
     * Expected value is 'Graph'.
     * 
     */
    public Output packageType() {
        return this.packageType;
    }

    /**
     * The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.
     * 
     */
    @Import(name="parameters")
    private @Nullable Output> parameters;

    /**
     * @return The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.
     * 
     */
    public Optional>> parameters() {
        return Optional.ofNullable(this.parameters);
    }

    /**
     * When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.
     * 
     */
    @Import(name="payloadsInBlobStorage")
    private @Nullable Output payloadsInBlobStorage;

    /**
     * @return When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.
     * 
     */
    public Optional> payloadsInBlobStorage() {
        return Optional.ofNullable(this.payloadsInBlobStorage);
    }

    /**
     * The URI of the payload blob. This parameter contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.
     * 
     */
    @Import(name="payloadsLocation")
    private @Nullable Output payloadsLocation;

    /**
     * @return The URI of the payload blob. This parameter contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.
     * 
     */
    public Optional> payloadsLocation() {
        return Optional.ofNullable(this.payloadsLocation);
    }

    /**
     * When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.
     * 
     */
    @Import(name="readOnly")
    private @Nullable Output readOnly;

    /**
     * @return When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.
     * 
     */
    public Optional> readOnly() {
        return Optional.ofNullable(this.readOnly);
    }

    /**
     * Contains the configuration settings for the web service endpoint.
     * 
     */
    @Import(name="realtimeConfiguration")
    private @Nullable Output realtimeConfiguration;

    /**
     * @return Contains the configuration settings for the web service endpoint.
     * 
     */
    public Optional> realtimeConfiguration() {
        return Optional.ofNullable(this.realtimeConfiguration);
    }

    /**
     * Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail.
     * 
     */
    @Import(name="storageAccount")
    private @Nullable Output storageAccount;

    /**
     * @return Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail.
     * 
     */
    public Optional> storageAccount() {
        return Optional.ofNullable(this.storageAccount);
    }

    /**
     * The title of the web service.
     * 
     */
    @Import(name="title")
    private @Nullable Output title;

    /**
     * @return The title of the web service.
     * 
     */
    public Optional> title() {
        return Optional.ofNullable(this.title);
    }

    private WebServicePropertiesForGraphArgs() {}

    private WebServicePropertiesForGraphArgs(WebServicePropertiesForGraphArgs $) {
        this.assets = $.assets;
        this.commitmentPlan = $.commitmentPlan;
        this.description = $.description;
        this.diagnostics = $.diagnostics;
        this.exampleRequest = $.exampleRequest;
        this.exposeSampleData = $.exposeSampleData;
        this.input = $.input;
        this.keys = $.keys;
        this.machineLearningWorkspace = $.machineLearningWorkspace;
        this.output = $.output;
        this.package_ = $.package_;
        this.packageType = $.packageType;
        this.parameters = $.parameters;
        this.payloadsInBlobStorage = $.payloadsInBlobStorage;
        this.payloadsLocation = $.payloadsLocation;
        this.readOnly = $.readOnly;
        this.realtimeConfiguration = $.realtimeConfiguration;
        this.storageAccount = $.storageAccount;
        this.title = $.title;
    }

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

    public static final class Builder {
        private WebServicePropertiesForGraphArgs $;

        public Builder() {
            $ = new WebServicePropertiesForGraphArgs();
        }

        public Builder(WebServicePropertiesForGraphArgs defaults) {
            $ = new WebServicePropertiesForGraphArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param assets Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.
         * 
         * @return builder
         * 
         */
        public Builder assets(@Nullable Output> assets) {
            $.assets = assets;
            return this;
        }

        /**
         * @param assets Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.
         * 
         * @return builder
         * 
         */
        public Builder assets(Map assets) {
            return assets(Output.of(assets));
        }

        /**
         * @param commitmentPlan Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations.
         * 
         * @return builder
         * 
         */
        public Builder commitmentPlan(@Nullable Output commitmentPlan) {
            $.commitmentPlan = commitmentPlan;
            return this;
        }

        /**
         * @param commitmentPlan Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations.
         * 
         * @return builder
         * 
         */
        public Builder commitmentPlan(CommitmentPlanArgs commitmentPlan) {
            return commitmentPlan(Output.of(commitmentPlan));
        }

        /**
         * @param description The description of the web service.
         * 
         * @return builder
         * 
         */
        public Builder description(@Nullable Output description) {
            $.description = description;
            return this;
        }

        /**
         * @param description The description of the web service.
         * 
         * @return builder
         * 
         */
        public Builder description(String description) {
            return description(Output.of(description));
        }

        /**
         * @param diagnostics Settings controlling the diagnostics traces collection for the web service.
         * 
         * @return builder
         * 
         */
        public Builder diagnostics(@Nullable Output diagnostics) {
            $.diagnostics = diagnostics;
            return this;
        }

        /**
         * @param diagnostics Settings controlling the diagnostics traces collection for the web service.
         * 
         * @return builder
         * 
         */
        public Builder diagnostics(DiagnosticsConfigurationArgs diagnostics) {
            return diagnostics(Output.of(diagnostics));
        }

        /**
         * @param exampleRequest Defines sample input data for one or more of the service's inputs.
         * 
         * @return builder
         * 
         */
        public Builder exampleRequest(@Nullable Output exampleRequest) {
            $.exampleRequest = exampleRequest;
            return this;
        }

        /**
         * @param exampleRequest Defines sample input data for one or more of the service's inputs.
         * 
         * @return builder
         * 
         */
        public Builder exampleRequest(ExampleRequestArgs exampleRequest) {
            return exampleRequest(Output.of(exampleRequest));
        }

        /**
         * @param exposeSampleData When set to true, sample data is included in the web service's swagger definition. The default value is true.
         * 
         * @return builder
         * 
         */
        public Builder exposeSampleData(@Nullable Output exposeSampleData) {
            $.exposeSampleData = exposeSampleData;
            return this;
        }

        /**
         * @param exposeSampleData When set to true, sample data is included in the web service's swagger definition. The default value is true.
         * 
         * @return builder
         * 
         */
        public Builder exposeSampleData(Boolean exposeSampleData) {
            return exposeSampleData(Output.of(exposeSampleData));
        }

        /**
         * @param input Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.
         * 
         * @return builder
         * 
         */
        public Builder input(@Nullable Output input) {
            $.input = input;
            return this;
        }

        /**
         * @param input Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification.
         * 
         * @return builder
         * 
         */
        public Builder input(ServiceInputOutputSpecificationArgs input) {
            return input(Output.of(input));
        }

        /**
         * @param keys Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations.
         * 
         * @return builder
         * 
         */
        public Builder keys(@Nullable Output keys) {
            $.keys = keys;
            return this;
        }

        /**
         * @param keys Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations.
         * 
         * @return builder
         * 
         */
        public Builder keys(WebServiceKeysArgs keys) {
            return keys(Output.of(keys));
        }

        /**
         * @param machineLearningWorkspace Specifies the Machine Learning workspace containing the experiment that is source for the web service.
         * 
         * @return builder
         * 
         */
        public Builder machineLearningWorkspace(@Nullable Output machineLearningWorkspace) {
            $.machineLearningWorkspace = machineLearningWorkspace;
            return this;
        }

        /**
         * @param machineLearningWorkspace Specifies the Machine Learning workspace containing the experiment that is source for the web service.
         * 
         * @return builder
         * 
         */
        public Builder machineLearningWorkspace(MachineLearningWorkspaceArgs machineLearningWorkspace) {
            return machineLearningWorkspace(Output.of(machineLearningWorkspace));
        }

        /**
         * @param output Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.
         * 
         * @return builder
         * 
         */
        public Builder output(@Nullable Output output) {
            $.output = output;
            return this;
        }

        /**
         * @param output Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification.
         * 
         * @return builder
         * 
         */
        public Builder output(ServiceInputOutputSpecificationArgs output) {
            return output(Output.of(output));
        }

        /**
         * @param package_ The definition of the graph package making up this web service.
         * 
         * @return builder
         * 
         */
        public Builder package_(@Nullable Output package_) {
            $.package_ = package_;
            return this;
        }

        /**
         * @param package_ The definition of the graph package making up this web service.
         * 
         * @return builder
         * 
         */
        public Builder package_(GraphPackageArgs package_) {
            return package_(Output.of(package_));
        }

        /**
         * @param packageType Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time.
         * Expected value is 'Graph'.
         * 
         * @return builder
         * 
         */
        public Builder packageType(Output packageType) {
            $.packageType = packageType;
            return this;
        }

        /**
         * @param packageType Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time.
         * Expected value is 'Graph'.
         * 
         * @return builder
         * 
         */
        public Builder packageType(String packageType) {
            return packageType(Output.of(packageType));
        }

        /**
         * @param parameters The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.
         * 
         * @return builder
         * 
         */
        public Builder parameters(@Nullable Output> parameters) {
            $.parameters = parameters;
            return this;
        }

        /**
         * @param parameters The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.
         * 
         * @return builder
         * 
         */
        public Builder parameters(Map parameters) {
            return parameters(Output.of(parameters));
        }

        /**
         * @param payloadsInBlobStorage When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.
         * 
         * @return builder
         * 
         */
        public Builder payloadsInBlobStorage(@Nullable Output payloadsInBlobStorage) {
            $.payloadsInBlobStorage = payloadsInBlobStorage;
            return this;
        }

        /**
         * @param payloadsInBlobStorage When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.
         * 
         * @return builder
         * 
         */
        public Builder payloadsInBlobStorage(Boolean payloadsInBlobStorage) {
            return payloadsInBlobStorage(Output.of(payloadsInBlobStorage));
        }

        /**
         * @param payloadsLocation The URI of the payload blob. This parameter contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.
         * 
         * @return builder
         * 
         */
        public Builder payloadsLocation(@Nullable Output payloadsLocation) {
            $.payloadsLocation = payloadsLocation;
            return this;
        }

        /**
         * @param payloadsLocation The URI of the payload blob. This parameter contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.
         * 
         * @return builder
         * 
         */
        public Builder payloadsLocation(BlobLocationArgs payloadsLocation) {
            return payloadsLocation(Output.of(payloadsLocation));
        }

        /**
         * @param readOnly When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.
         * 
         * @return builder
         * 
         */
        public Builder readOnly(@Nullable Output readOnly) {
            $.readOnly = readOnly;
            return this;
        }

        /**
         * @param readOnly When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.
         * 
         * @return builder
         * 
         */
        public Builder readOnly(Boolean readOnly) {
            return readOnly(Output.of(readOnly));
        }

        /**
         * @param realtimeConfiguration Contains the configuration settings for the web service endpoint.
         * 
         * @return builder
         * 
         */
        public Builder realtimeConfiguration(@Nullable Output realtimeConfiguration) {
            $.realtimeConfiguration = realtimeConfiguration;
            return this;
        }

        /**
         * @param realtimeConfiguration Contains the configuration settings for the web service endpoint.
         * 
         * @return builder
         * 
         */
        public Builder realtimeConfiguration(RealtimeConfigurationArgs realtimeConfiguration) {
            return realtimeConfiguration(Output.of(realtimeConfiguration));
        }

        /**
         * @param storageAccount Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail.
         * 
         * @return builder
         * 
         */
        public Builder storageAccount(@Nullable Output storageAccount) {
            $.storageAccount = storageAccount;
            return this;
        }

        /**
         * @param storageAccount Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail.
         * 
         * @return builder
         * 
         */
        public Builder storageAccount(StorageAccountArgs storageAccount) {
            return storageAccount(Output.of(storageAccount));
        }

        /**
         * @param title The title of the web service.
         * 
         * @return builder
         * 
         */
        public Builder title(@Nullable Output title) {
            $.title = title;
            return this;
        }

        /**
         * @param title The title of the web service.
         * 
         * @return builder
         * 
         */
        public Builder title(String title) {
            return title(Output.of(title));
        }

        public WebServicePropertiesForGraphArgs build() {
            $.packageType = Codegen.stringProp("packageType").output().arg($.packageType).require();
            return $;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy