All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.pulumi.azurenative.datafactory.inputs.RestResourceDatasetArgs 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.datafactory.inputs;

import com.pulumi.azurenative.datafactory.inputs.DatasetFolderArgs;
import com.pulumi.azurenative.datafactory.inputs.LinkedServiceReferenceArgs;
import com.pulumi.azurenative.datafactory.inputs.ParameterSpecificationArgs;
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.Object;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


/**
 * A Rest service dataset.
 * 
 */
public final class RestResourceDatasetArgs extends com.pulumi.resources.ResourceArgs {

    public static final RestResourceDatasetArgs Empty = new RestResourceDatasetArgs();

    /**
     * The additional HTTP headers in the request to the RESTful API.
     * 
     */
    @Import(name="additionalHeaders")
    private @Nullable Output> additionalHeaders;

    /**
     * @return The additional HTTP headers in the request to the RESTful API.
     * 
     */
    public Optional>> additionalHeaders() {
        return Optional.ofNullable(this.additionalHeaders);
    }

    /**
     * List of tags that can be used for describing the Dataset.
     * 
     */
    @Import(name="annotations")
    private @Nullable Output> annotations;

    /**
     * @return List of tags that can be used for describing the Dataset.
     * 
     */
    public Optional>> annotations() {
        return Optional.ofNullable(this.annotations);
    }

    /**
     * Dataset description.
     * 
     */
    @Import(name="description")
    private @Nullable Output description;

    /**
     * @return Dataset description.
     * 
     */
    public Optional> description() {
        return Optional.ofNullable(this.description);
    }

    /**
     * The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
     * 
     */
    @Import(name="folder")
    private @Nullable Output folder;

    /**
     * @return The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
     * 
     */
    public Optional> folder() {
        return Optional.ofNullable(this.folder);
    }

    /**
     * Linked service reference.
     * 
     */
    @Import(name="linkedServiceName", required=true)
    private Output linkedServiceName;

    /**
     * @return Linked service reference.
     * 
     */
    public Output linkedServiceName() {
        return this.linkedServiceName;
    }

    /**
     * The pagination rules to compose next page requests.
     * 
     */
    @Import(name="paginationRules")
    private @Nullable Output> paginationRules;

    /**
     * @return The pagination rules to compose next page requests.
     * 
     */
    public Optional>> paginationRules() {
        return Optional.ofNullable(this.paginationRules);
    }

    /**
     * Parameters for dataset.
     * 
     */
    @Import(name="parameters")
    private @Nullable Output> parameters;

    /**
     * @return Parameters for dataset.
     * 
     */
    public Optional>> parameters() {
        return Optional.ofNullable(this.parameters);
    }

    /**
     * The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="relativeUrl")
    private @Nullable Output relativeUrl;

    /**
     * @return The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> relativeUrl() {
        return Optional.ofNullable(this.relativeUrl);
    }

    /**
     * The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="requestBody")
    private @Nullable Output requestBody;

    /**
     * @return The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> requestBody() {
        return Optional.ofNullable(this.requestBody);
    }

    /**
     * The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="requestMethod")
    private @Nullable Output requestMethod;

    /**
     * @return The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> requestMethod() {
        return Optional.ofNullable(this.requestMethod);
    }

    /**
     * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
     * 
     */
    @Import(name="schema")
    private @Nullable Output schema;

    /**
     * @return Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
     * 
     */
    public Optional> schema() {
        return Optional.ofNullable(this.schema);
    }

    /**
     * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
     * 
     */
    @Import(name="structure")
    private @Nullable Output structure;

    /**
     * @return Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
     * 
     */
    public Optional> structure() {
        return Optional.ofNullable(this.structure);
    }

    /**
     * Type of dataset.
     * Expected value is 'RestResource'.
     * 
     */
    @Import(name="type", required=true)
    private Output type;

    /**
     * @return Type of dataset.
     * Expected value is 'RestResource'.
     * 
     */
    public Output type() {
        return this.type;
    }

    private RestResourceDatasetArgs() {}

    private RestResourceDatasetArgs(RestResourceDatasetArgs $) {
        this.additionalHeaders = $.additionalHeaders;
        this.annotations = $.annotations;
        this.description = $.description;
        this.folder = $.folder;
        this.linkedServiceName = $.linkedServiceName;
        this.paginationRules = $.paginationRules;
        this.parameters = $.parameters;
        this.relativeUrl = $.relativeUrl;
        this.requestBody = $.requestBody;
        this.requestMethod = $.requestMethod;
        this.schema = $.schema;
        this.structure = $.structure;
        this.type = $.type;
    }

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

    public static final class Builder {
        private RestResourceDatasetArgs $;

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

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

        /**
         * @param additionalHeaders The additional HTTP headers in the request to the RESTful API.
         * 
         * @return builder
         * 
         */
        public Builder additionalHeaders(@Nullable Output> additionalHeaders) {
            $.additionalHeaders = additionalHeaders;
            return this;
        }

        /**
         * @param additionalHeaders The additional HTTP headers in the request to the RESTful API.
         * 
         * @return builder
         * 
         */
        public Builder additionalHeaders(Map additionalHeaders) {
            return additionalHeaders(Output.of(additionalHeaders));
        }

        /**
         * @param annotations List of tags that can be used for describing the Dataset.
         * 
         * @return builder
         * 
         */
        public Builder annotations(@Nullable Output> annotations) {
            $.annotations = annotations;
            return this;
        }

        /**
         * @param annotations List of tags that can be used for describing the Dataset.
         * 
         * @return builder
         * 
         */
        public Builder annotations(List annotations) {
            return annotations(Output.of(annotations));
        }

        /**
         * @param annotations List of tags that can be used for describing the Dataset.
         * 
         * @return builder
         * 
         */
        public Builder annotations(Object... annotations) {
            return annotations(List.of(annotations));
        }

        /**
         * @param description Dataset description.
         * 
         * @return builder
         * 
         */
        public Builder description(@Nullable Output description) {
            $.description = description;
            return this;
        }

        /**
         * @param description Dataset description.
         * 
         * @return builder
         * 
         */
        public Builder description(String description) {
            return description(Output.of(description));
        }

        /**
         * @param folder The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
         * 
         * @return builder
         * 
         */
        public Builder folder(@Nullable Output folder) {
            $.folder = folder;
            return this;
        }

        /**
         * @param folder The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
         * 
         * @return builder
         * 
         */
        public Builder folder(DatasetFolderArgs folder) {
            return folder(Output.of(folder));
        }

        /**
         * @param linkedServiceName Linked service reference.
         * 
         * @return builder
         * 
         */
        public Builder linkedServiceName(Output linkedServiceName) {
            $.linkedServiceName = linkedServiceName;
            return this;
        }

        /**
         * @param linkedServiceName Linked service reference.
         * 
         * @return builder
         * 
         */
        public Builder linkedServiceName(LinkedServiceReferenceArgs linkedServiceName) {
            return linkedServiceName(Output.of(linkedServiceName));
        }

        /**
         * @param paginationRules The pagination rules to compose next page requests.
         * 
         * @return builder
         * 
         */
        public Builder paginationRules(@Nullable Output> paginationRules) {
            $.paginationRules = paginationRules;
            return this;
        }

        /**
         * @param paginationRules The pagination rules to compose next page requests.
         * 
         * @return builder
         * 
         */
        public Builder paginationRules(Map paginationRules) {
            return paginationRules(Output.of(paginationRules));
        }

        /**
         * @param parameters Parameters for dataset.
         * 
         * @return builder
         * 
         */
        public Builder parameters(@Nullable Output> parameters) {
            $.parameters = parameters;
            return this;
        }

        /**
         * @param parameters Parameters for dataset.
         * 
         * @return builder
         * 
         */
        public Builder parameters(Map parameters) {
            return parameters(Output.of(parameters));
        }

        /**
         * @param relativeUrl The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder relativeUrl(@Nullable Output relativeUrl) {
            $.relativeUrl = relativeUrl;
            return this;
        }

        /**
         * @param relativeUrl The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder relativeUrl(Object relativeUrl) {
            return relativeUrl(Output.of(relativeUrl));
        }

        /**
         * @param requestBody The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder requestBody(@Nullable Output requestBody) {
            $.requestBody = requestBody;
            return this;
        }

        /**
         * @param requestBody The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder requestBody(Object requestBody) {
            return requestBody(Output.of(requestBody));
        }

        /**
         * @param requestMethod The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder requestMethod(@Nullable Output requestMethod) {
            $.requestMethod = requestMethod;
            return this;
        }

        /**
         * @param requestMethod The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder requestMethod(Object requestMethod) {
            return requestMethod(Output.of(requestMethod));
        }

        /**
         * @param schema Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
         * 
         * @return builder
         * 
         */
        public Builder schema(@Nullable Output schema) {
            $.schema = schema;
            return this;
        }

        /**
         * @param schema Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
         * 
         * @return builder
         * 
         */
        public Builder schema(Object schema) {
            return schema(Output.of(schema));
        }

        /**
         * @param structure Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
         * 
         * @return builder
         * 
         */
        public Builder structure(@Nullable Output structure) {
            $.structure = structure;
            return this;
        }

        /**
         * @param structure Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
         * 
         * @return builder
         * 
         */
        public Builder structure(Object structure) {
            return structure(Output.of(structure));
        }

        /**
         * @param type Type of dataset.
         * Expected value is 'RestResource'.
         * 
         * @return builder
         * 
         */
        public Builder type(Output type) {
            $.type = type;
            return this;
        }

        /**
         * @param type Type of dataset.
         * Expected value is 'RestResource'.
         * 
         * @return builder
         * 
         */
        public Builder type(String type) {
            return type(Output.of(type));
        }

        public RestResourceDatasetArgs build() {
            if ($.linkedServiceName == null) {
                throw new MissingRequiredPropertyException("RestResourceDatasetArgs", "linkedServiceName");
            }
            $.type = Codegen.stringProp("type").output().arg($.type).require();
            return $;
        }
    }

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy