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

com.pulumi.googlenative.dataflow.v1b3.outputs.EnvironmentResponse 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.googlenative.dataflow.v1b3.outputs;

import com.pulumi.core.annotations.CustomType;
import com.pulumi.googlenative.dataflow.v1b3.outputs.DebugOptionsResponse;
import com.pulumi.googlenative.dataflow.v1b3.outputs.WorkerPoolResponse;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;

@CustomType
public final class EnvironmentResponse {
    /**
     * @return The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
     * 
     */
    private String clusterManagerApiService;
    /**
     * @return The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
     * 
     */
    private String dataset;
    /**
     * @return Any debugging options to be supplied to the job.
     * 
     */
    private DebugOptionsResponse debugOptions;
    /**
     * @return The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.
     * 
     */
    private List experiments;
    /**
     * @return Which Flexible Resource Scheduling mode to run in.
     * 
     */
    private String flexResourceSchedulingGoal;
    /**
     * @return Experimental settings.
     * 
     */
    private Map internalExperiments;
    /**
     * @return The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
     * 
     */
    private Map sdkPipelineOptions;
    /**
     * @return Identity to run virtual machines as. Defaults to the default account.
     * 
     */
    private String serviceAccountEmail;
    /**
     * @return If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY
     * 
     */
    private String serviceKmsKeyName;
    /**
     * @return The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on).
     * 
     */
    private List serviceOptions;
    /**
     * @return The shuffle mode used for the job.
     * 
     */
    private String shuffleMode;
    /**
     * @return The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
     * 
     */
    private String tempStoragePrefix;
    /**
     * @return A description of the process that generated the request.
     * 
     */
    private Map userAgent;
    /**
     * @return A structure describing which components and their versions of the service are required in order to run the job.
     * 
     */
    private Map version;
    /**
     * @return The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
     * 
     */
    private List workerPools;
    /**
     * @return The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
     * 
     */
    private String workerRegion;
    /**
     * @return The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.
     * 
     */
    private String workerZone;

    private EnvironmentResponse() {}
    /**
     * @return The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
     * 
     */
    public String clusterManagerApiService() {
        return this.clusterManagerApiService;
    }
    /**
     * @return The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
     * 
     */
    public String dataset() {
        return this.dataset;
    }
    /**
     * @return Any debugging options to be supplied to the job.
     * 
     */
    public DebugOptionsResponse debugOptions() {
        return this.debugOptions;
    }
    /**
     * @return The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.
     * 
     */
    public List experiments() {
        return this.experiments;
    }
    /**
     * @return Which Flexible Resource Scheduling mode to run in.
     * 
     */
    public String flexResourceSchedulingGoal() {
        return this.flexResourceSchedulingGoal;
    }
    /**
     * @return Experimental settings.
     * 
     */
    public Map internalExperiments() {
        return this.internalExperiments;
    }
    /**
     * @return The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
     * 
     */
    public Map sdkPipelineOptions() {
        return this.sdkPipelineOptions;
    }
    /**
     * @return Identity to run virtual machines as. Defaults to the default account.
     * 
     */
    public String serviceAccountEmail() {
        return this.serviceAccountEmail;
    }
    /**
     * @return If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY
     * 
     */
    public String serviceKmsKeyName() {
        return this.serviceKmsKeyName;
    }
    /**
     * @return The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on).
     * 
     */
    public List serviceOptions() {
        return this.serviceOptions;
    }
    /**
     * @return The shuffle mode used for the job.
     * 
     */
    public String shuffleMode() {
        return this.shuffleMode;
    }
    /**
     * @return The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
     * 
     */
    public String tempStoragePrefix() {
        return this.tempStoragePrefix;
    }
    /**
     * @return A description of the process that generated the request.
     * 
     */
    public Map userAgent() {
        return this.userAgent;
    }
    /**
     * @return A structure describing which components and their versions of the service are required in order to run the job.
     * 
     */
    public Map version() {
        return this.version;
    }
    /**
     * @return The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
     * 
     */
    public List workerPools() {
        return this.workerPools;
    }
    /**
     * @return The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
     * 
     */
    public String workerRegion() {
        return this.workerRegion;
    }
    /**
     * @return The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.
     * 
     */
    public String workerZone() {
        return this.workerZone;
    }

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

    public static Builder builder(EnvironmentResponse defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private String clusterManagerApiService;
        private String dataset;
        private DebugOptionsResponse debugOptions;
        private List experiments;
        private String flexResourceSchedulingGoal;
        private Map internalExperiments;
        private Map sdkPipelineOptions;
        private String serviceAccountEmail;
        private String serviceKmsKeyName;
        private List serviceOptions;
        private String shuffleMode;
        private String tempStoragePrefix;
        private Map userAgent;
        private Map version;
        private List workerPools;
        private String workerRegion;
        private String workerZone;
        public Builder() {}
        public Builder(EnvironmentResponse defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.clusterManagerApiService = defaults.clusterManagerApiService;
    	      this.dataset = defaults.dataset;
    	      this.debugOptions = defaults.debugOptions;
    	      this.experiments = defaults.experiments;
    	      this.flexResourceSchedulingGoal = defaults.flexResourceSchedulingGoal;
    	      this.internalExperiments = defaults.internalExperiments;
    	      this.sdkPipelineOptions = defaults.sdkPipelineOptions;
    	      this.serviceAccountEmail = defaults.serviceAccountEmail;
    	      this.serviceKmsKeyName = defaults.serviceKmsKeyName;
    	      this.serviceOptions = defaults.serviceOptions;
    	      this.shuffleMode = defaults.shuffleMode;
    	      this.tempStoragePrefix = defaults.tempStoragePrefix;
    	      this.userAgent = defaults.userAgent;
    	      this.version = defaults.version;
    	      this.workerPools = defaults.workerPools;
    	      this.workerRegion = defaults.workerRegion;
    	      this.workerZone = defaults.workerZone;
        }

        @CustomType.Setter
        public Builder clusterManagerApiService(String clusterManagerApiService) {
            this.clusterManagerApiService = Objects.requireNonNull(clusterManagerApiService);
            return this;
        }
        @CustomType.Setter
        public Builder dataset(String dataset) {
            this.dataset = Objects.requireNonNull(dataset);
            return this;
        }
        @CustomType.Setter
        public Builder debugOptions(DebugOptionsResponse debugOptions) {
            this.debugOptions = Objects.requireNonNull(debugOptions);
            return this;
        }
        @CustomType.Setter
        public Builder experiments(List experiments) {
            this.experiments = Objects.requireNonNull(experiments);
            return this;
        }
        public Builder experiments(String... experiments) {
            return experiments(List.of(experiments));
        }
        @CustomType.Setter
        public Builder flexResourceSchedulingGoal(String flexResourceSchedulingGoal) {
            this.flexResourceSchedulingGoal = Objects.requireNonNull(flexResourceSchedulingGoal);
            return this;
        }
        @CustomType.Setter
        public Builder internalExperiments(Map internalExperiments) {
            this.internalExperiments = Objects.requireNonNull(internalExperiments);
            return this;
        }
        @CustomType.Setter
        public Builder sdkPipelineOptions(Map sdkPipelineOptions) {
            this.sdkPipelineOptions = Objects.requireNonNull(sdkPipelineOptions);
            return this;
        }
        @CustomType.Setter
        public Builder serviceAccountEmail(String serviceAccountEmail) {
            this.serviceAccountEmail = Objects.requireNonNull(serviceAccountEmail);
            return this;
        }
        @CustomType.Setter
        public Builder serviceKmsKeyName(String serviceKmsKeyName) {
            this.serviceKmsKeyName = Objects.requireNonNull(serviceKmsKeyName);
            return this;
        }
        @CustomType.Setter
        public Builder serviceOptions(List serviceOptions) {
            this.serviceOptions = Objects.requireNonNull(serviceOptions);
            return this;
        }
        public Builder serviceOptions(String... serviceOptions) {
            return serviceOptions(List.of(serviceOptions));
        }
        @CustomType.Setter
        public Builder shuffleMode(String shuffleMode) {
            this.shuffleMode = Objects.requireNonNull(shuffleMode);
            return this;
        }
        @CustomType.Setter
        public Builder tempStoragePrefix(String tempStoragePrefix) {
            this.tempStoragePrefix = Objects.requireNonNull(tempStoragePrefix);
            return this;
        }
        @CustomType.Setter
        public Builder userAgent(Map userAgent) {
            this.userAgent = Objects.requireNonNull(userAgent);
            return this;
        }
        @CustomType.Setter
        public Builder version(Map version) {
            this.version = Objects.requireNonNull(version);
            return this;
        }
        @CustomType.Setter
        public Builder workerPools(List workerPools) {
            this.workerPools = Objects.requireNonNull(workerPools);
            return this;
        }
        public Builder workerPools(WorkerPoolResponse... workerPools) {
            return workerPools(List.of(workerPools));
        }
        @CustomType.Setter
        public Builder workerRegion(String workerRegion) {
            this.workerRegion = Objects.requireNonNull(workerRegion);
            return this;
        }
        @CustomType.Setter
        public Builder workerZone(String workerZone) {
            this.workerZone = Objects.requireNonNull(workerZone);
            return this;
        }
        public EnvironmentResponse build() {
            final var o = new EnvironmentResponse();
            o.clusterManagerApiService = clusterManagerApiService;
            o.dataset = dataset;
            o.debugOptions = debugOptions;
            o.experiments = experiments;
            o.flexResourceSchedulingGoal = flexResourceSchedulingGoal;
            o.internalExperiments = internalExperiments;
            o.sdkPipelineOptions = sdkPipelineOptions;
            o.serviceAccountEmail = serviceAccountEmail;
            o.serviceKmsKeyName = serviceKmsKeyName;
            o.serviceOptions = serviceOptions;
            o.shuffleMode = shuffleMode;
            o.tempStoragePrefix = tempStoragePrefix;
            o.userAgent = userAgent;
            o.version = version;
            o.workerPools = workerPools;
            o.workerRegion = workerRegion;
            o.workerZone = workerZone;
            return o;
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy