com.google.events.cloud.dataflow.v1beta3.EnvironmentOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloudevent-types Show documentation
Show all versions of google-cloudevent-types Show documentation
Types in Java for CloudEvents issued by Google.
/*
* Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/events/cloud/dataflow/v1beta3/data.proto
package com.google.events.cloud.dataflow.v1beta3;
public interface EnvironmentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.events.cloud.dataflow.v1beta3.Environment)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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}
*
*
* string temp_storage_prefix = 1;
*
* @return The tempStoragePrefix.
*/
java.lang.String getTempStoragePrefix();
/**
*
*
*
* 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}
*
*
* string temp_storage_prefix = 1;
*
* @return The bytes for tempStoragePrefix.
*/
com.google.protobuf.ByteString getTempStoragePrefixBytes();
/**
*
*
*
* 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".
*
*
* string cluster_manager_api_service = 2;
*
* @return The clusterManagerApiService.
*/
java.lang.String getClusterManagerApiService();
/**
*
*
*
* 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".
*
*
* string cluster_manager_api_service = 2;
*
* @return The bytes for clusterManagerApiService.
*/
com.google.protobuf.ByteString getClusterManagerApiServiceBytes();
/**
*
*
*
* 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.
*
*
* repeated string experiments = 3;
*
* @return A list containing the experiments.
*/
java.util.List getExperimentsList();
/**
*
*
*
* 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.
*
*
* repeated string experiments = 3;
*
* @return The count of experiments.
*/
int getExperimentsCount();
/**
*
*
*
* 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.
*
*
* repeated string experiments = 3;
*
* @param index The index of the element to return.
* @return The experiments at the given index.
*/
java.lang.String getExperiments(int index);
/**
*
*
*
* 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.
*
*
* repeated string experiments = 3;
*
* @param index The index of the value to return.
* @return The bytes of the experiments at the given index.
*/
com.google.protobuf.ByteString getExperimentsBytes(int index);
/**
*
*
*
* 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).
*
*
* repeated string service_options = 16;
*
* @return A list containing the serviceOptions.
*/
java.util.List getServiceOptionsList();
/**
*
*
*
* 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).
*
*
* repeated string service_options = 16;
*
* @return The count of serviceOptions.
*/
int getServiceOptionsCount();
/**
*
*
*
* 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).
*
*
* repeated string service_options = 16;
*
* @param index The index of the element to return.
* @return The serviceOptions at the given index.
*/
java.lang.String getServiceOptions(int index);
/**
*
*
*
* 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).
*
*
* repeated string service_options = 16;
*
* @param index The index of the value to return.
* @return The bytes of the serviceOptions at the given index.
*/
com.google.protobuf.ByteString getServiceOptionsBytes(int index);
/**
*
*
*
* 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
*
*
* string service_kms_key_name = 12;
*
* @return The serviceKmsKeyName.
*/
java.lang.String getServiceKmsKeyName();
/**
*
*
*
* 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
*
*
* string service_kms_key_name = 12;
*
* @return The bytes for serviceKmsKeyName.
*/
com.google.protobuf.ByteString getServiceKmsKeyNameBytes();
/**
*
*
*
* The worker pools. At least one "harness" worker pool must be
* specified in order for the job to have workers.
*
*
* repeated .google.events.cloud.dataflow.v1beta3.WorkerPool worker_pools = 4;
*/
java.util.List getWorkerPoolsList();
/**
*
*
*
* The worker pools. At least one "harness" worker pool must be
* specified in order for the job to have workers.
*
*
* repeated .google.events.cloud.dataflow.v1beta3.WorkerPool worker_pools = 4;
*/
com.google.events.cloud.dataflow.v1beta3.WorkerPool getWorkerPools(int index);
/**
*
*
*
* The worker pools. At least one "harness" worker pool must be
* specified in order for the job to have workers.
*
*
* repeated .google.events.cloud.dataflow.v1beta3.WorkerPool worker_pools = 4;
*/
int getWorkerPoolsCount();
/**
*
*
*
* The worker pools. At least one "harness" worker pool must be
* specified in order for the job to have workers.
*
*
* repeated .google.events.cloud.dataflow.v1beta3.WorkerPool worker_pools = 4;
*/
java.util.List
getWorkerPoolsOrBuilderList();
/**
*
*
*
* The worker pools. At least one "harness" worker pool must be
* specified in order for the job to have workers.
*
*
* repeated .google.events.cloud.dataflow.v1beta3.WorkerPool worker_pools = 4;
*/
com.google.events.cloud.dataflow.v1beta3.WorkerPoolOrBuilder getWorkerPoolsOrBuilder(int index);
/**
*
*
*
* A description of the process that generated the request.
*
*
* .google.protobuf.Struct user_agent = 5;
*
* @return Whether the userAgent field is set.
*/
boolean hasUserAgent();
/**
*
*
*
* A description of the process that generated the request.
*
*
* .google.protobuf.Struct user_agent = 5;
*
* @return The userAgent.
*/
com.google.protobuf.Struct getUserAgent();
/**
*
*
*
* A description of the process that generated the request.
*
*
* .google.protobuf.Struct user_agent = 5;
*/
com.google.protobuf.StructOrBuilder getUserAgentOrBuilder();
/**
*
*
*
* A structure describing which components and their versions of the service
* are required in order to run the job.
*
*
* .google.protobuf.Struct version = 6;
*
* @return Whether the version field is set.
*/
boolean hasVersion();
/**
*
*
*
* A structure describing which components and their versions of the service
* are required in order to run the job.
*
*
* .google.protobuf.Struct version = 6;
*
* @return The version.
*/
com.google.protobuf.Struct getVersion();
/**
*
*
*
* A structure describing which components and their versions of the service
* are required in order to run the job.
*
*
* .google.protobuf.Struct version = 6;
*/
com.google.protobuf.StructOrBuilder getVersionOrBuilder();
/**
*
*
*
* The dataset for the current project where various workflow
* related tables are stored.
* The supported resource type is:
* Google BigQuery:
* bigquery.googleapis.com/{dataset}
*
*
* string dataset = 7;
*
* @return The dataset.
*/
java.lang.String getDataset();
/**
*
*
*
* The dataset for the current project where various workflow
* related tables are stored.
* The supported resource type is:
* Google BigQuery:
* bigquery.googleapis.com/{dataset}
*
*
* string dataset = 7;
*
* @return The bytes for dataset.
*/
com.google.protobuf.ByteString getDatasetBytes();
/**
*
*
*
* 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.
*
*
* .google.protobuf.Struct sdk_pipeline_options = 8;
*
* @return Whether the sdkPipelineOptions field is set.
*/
boolean hasSdkPipelineOptions();
/**
*
*
*
* 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.
*
*
* .google.protobuf.Struct sdk_pipeline_options = 8;
*
* @return The sdkPipelineOptions.
*/
com.google.protobuf.Struct getSdkPipelineOptions();
/**
*
*
*
* 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.
*
*
* .google.protobuf.Struct sdk_pipeline_options = 8;
*/
com.google.protobuf.StructOrBuilder getSdkPipelineOptionsOrBuilder();
/**
*
*
*
* Identity to run virtual machines as. Defaults to the default account.
*
*
* string service_account_email = 10;
*
* @return The serviceAccountEmail.
*/
java.lang.String getServiceAccountEmail();
/**
*
*
*
* Identity to run virtual machines as. Defaults to the default account.
*
*
* string service_account_email = 10;
*
* @return The bytes for serviceAccountEmail.
*/
com.google.protobuf.ByteString getServiceAccountEmailBytes();
/**
*
*
*
* Which Flexible Resource Scheduling mode to run in.
*
*
*
* .google.events.cloud.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;
*
*
* @return The enum numeric value on the wire for flexResourceSchedulingGoal.
*/
int getFlexResourceSchedulingGoalValue();
/**
*
*
*
* Which Flexible Resource Scheduling mode to run in.
*
*
*
* .google.events.cloud.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;
*
*
* @return The flexResourceSchedulingGoal.
*/
com.google.events.cloud.dataflow.v1beta3.FlexResourceSchedulingGoal
getFlexResourceSchedulingGoal();
/**
*
*
*
* 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.
*
*
* string worker_region = 13;
*
* @return The workerRegion.
*/
java.lang.String getWorkerRegion();
/**
*
*
*
* 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.
*
*
* string worker_region = 13;
*
* @return The bytes for workerRegion.
*/
com.google.protobuf.ByteString getWorkerRegionBytes();
/**
*
*
*
* 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.
*
*
* string worker_zone = 14;
*
* @return The workerZone.
*/
java.lang.String getWorkerZone();
/**
*
*
*
* 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.
*
*
* string worker_zone = 14;
*
* @return The bytes for workerZone.
*/
com.google.protobuf.ByteString getWorkerZoneBytes();
/**
*
*
*
* Output only. The shuffle mode used for the job.
*
*
* .google.events.cloud.dataflow.v1beta3.ShuffleMode shuffle_mode = 15;
*
* @return The enum numeric value on the wire for shuffleMode.
*/
int getShuffleModeValue();
/**
*
*
*
* Output only. The shuffle mode used for the job.
*
*
* .google.events.cloud.dataflow.v1beta3.ShuffleMode shuffle_mode = 15;
*
* @return The shuffleMode.
*/
com.google.events.cloud.dataflow.v1beta3.ShuffleMode getShuffleMode();
/**
*
*
*
* Any debugging options to be supplied to the job.
*
*
* .google.events.cloud.dataflow.v1beta3.DebugOptions debug_options = 17;
*
* @return Whether the debugOptions field is set.
*/
boolean hasDebugOptions();
/**
*
*
*
* Any debugging options to be supplied to the job.
*
*
* .google.events.cloud.dataflow.v1beta3.DebugOptions debug_options = 17;
*
* @return The debugOptions.
*/
com.google.events.cloud.dataflow.v1beta3.DebugOptions getDebugOptions();
/**
*
*
*
* Any debugging options to be supplied to the job.
*
*
* .google.events.cloud.dataflow.v1beta3.DebugOptions debug_options = 17;
*/
com.google.events.cloud.dataflow.v1beta3.DebugOptionsOrBuilder getDebugOptionsOrBuilder();
}