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

com.pulumi.aws.apigateway.inputs.GetExportArgs 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.aws.apigateway.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class GetExportArgs extends com.pulumi.resources.InvokeArgs {

    public static final GetExportArgs Empty = new GetExportArgs();

    /**
     * Content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `export_type` `ofoas30` and `swagger`.
     * 
     */
    @Import(name="accepts")
    private @Nullable Output accepts;

    /**
     * @return Content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `export_type` `ofoas30` and `swagger`.
     * 
     */
    public Optional> accepts() {
        return Optional.ofNullable(this.accepts);
    }

    /**
     * Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
     * 
     */
    @Import(name="exportType", required=true)
    private Output exportType;

    /**
     * @return Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
     * 
     */
    public Output exportType() {
        return this.exportType;
    }

    /**
     * Key-value map of query string parameters that specify properties of the export. the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `extensions='authorizers'` will export the API with x-amazon-apigateway-authorizer extensions.
     * 
     */
    @Import(name="parameters")
    private @Nullable Output> parameters;

    /**
     * @return Key-value map of query string parameters that specify properties of the export. the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `extensions='authorizers'` will export the API with x-amazon-apigateway-authorizer extensions.
     * 
     */
    public Optional>> parameters() {
        return Optional.ofNullable(this.parameters);
    }

    /**
     * Identifier of the associated REST API.
     * 
     */
    @Import(name="restApiId", required=true)
    private Output restApiId;

    /**
     * @return Identifier of the associated REST API.
     * 
     */
    public Output restApiId() {
        return this.restApiId;
    }

    /**
     * Name of the Stage that will be exported.
     * 
     */
    @Import(name="stageName", required=true)
    private Output stageName;

    /**
     * @return Name of the Stage that will be exported.
     * 
     */
    public Output stageName() {
        return this.stageName;
    }

    private GetExportArgs() {}

    private GetExportArgs(GetExportArgs $) {
        this.accepts = $.accepts;
        this.exportType = $.exportType;
        this.parameters = $.parameters;
        this.restApiId = $.restApiId;
        this.stageName = $.stageName;
    }

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

    public static final class Builder {
        private GetExportArgs $;

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

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

        /**
         * @param accepts Content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `export_type` `ofoas30` and `swagger`.
         * 
         * @return builder
         * 
         */
        public Builder accepts(@Nullable Output accepts) {
            $.accepts = accepts;
            return this;
        }

        /**
         * @param accepts Content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `export_type` `ofoas30` and `swagger`.
         * 
         * @return builder
         * 
         */
        public Builder accepts(String accepts) {
            return accepts(Output.of(accepts));
        }

        /**
         * @param exportType Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
         * 
         * @return builder
         * 
         */
        public Builder exportType(Output exportType) {
            $.exportType = exportType;
            return this;
        }

        /**
         * @param exportType Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
         * 
         * @return builder
         * 
         */
        public Builder exportType(String exportType) {
            return exportType(Output.of(exportType));
        }

        /**
         * @param parameters Key-value map of query string parameters that specify properties of the export. the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `extensions='authorizers'` will export the API with x-amazon-apigateway-authorizer extensions.
         * 
         * @return builder
         * 
         */
        public Builder parameters(@Nullable Output> parameters) {
            $.parameters = parameters;
            return this;
        }

        /**
         * @param parameters Key-value map of query string parameters that specify properties of the export. the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `extensions='authorizers'` will export the API with x-amazon-apigateway-authorizer extensions.
         * 
         * @return builder
         * 
         */
        public Builder parameters(Map parameters) {
            return parameters(Output.of(parameters));
        }

        /**
         * @param restApiId Identifier of the associated REST API.
         * 
         * @return builder
         * 
         */
        public Builder restApiId(Output restApiId) {
            $.restApiId = restApiId;
            return this;
        }

        /**
         * @param restApiId Identifier of the associated REST API.
         * 
         * @return builder
         * 
         */
        public Builder restApiId(String restApiId) {
            return restApiId(Output.of(restApiId));
        }

        /**
         * @param stageName Name of the Stage that will be exported.
         * 
         * @return builder
         * 
         */
        public Builder stageName(Output stageName) {
            $.stageName = stageName;
            return this;
        }

        /**
         * @param stageName Name of the Stage that will be exported.
         * 
         * @return builder
         * 
         */
        public Builder stageName(String stageName) {
            return stageName(Output.of(stageName));
        }

        public GetExportArgs build() {
            if ($.exportType == null) {
                throw new MissingRequiredPropertyException("GetExportArgs", "exportType");
            }
            if ($.restApiId == null) {
                throw new MissingRequiredPropertyException("GetExportArgs", "restApiId");
            }
            if ($.stageName == null) {
                throw new MissingRequiredPropertyException("GetExportArgs", "stageName");
            }
            return $;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy