Package com.google.dataflow.v1beta3
Class FlexTemplateRuntimeEnvironment
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment
- All Implemented Interfaces:
FlexTemplateRuntimeEnvironmentOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class FlexTemplateRuntimeEnvironment
extends com.google.protobuf.GeneratedMessage
implements FlexTemplateRuntimeEnvironmentOrBuilder
The environment values to be set at runtime for flex template.Protobuf type
google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classThe environment values to be set at runtime for flex template.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanAdditional user labels to be specified for the job.booleangetAdditionalExperiments(int index) Additional experiment flags for the job.com.google.protobuf.ByteStringgetAdditionalExperimentsBytes(int index) Additional experiment flags for the job.intAdditional experiment flags for the job.com.google.protobuf.ProtocolStringListAdditional experiment flags for the job.getAdditionalPipelineOptions(int index) Optional.com.google.protobuf.ByteStringgetAdditionalPipelineOptionsBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.Deprecated.intAdditional user labels to be specified for the job.Additional user labels to be specified for the job.getAdditionalUserLabelsOrDefault(String key, String defaultValue) Additional user labels to be specified for the job.Additional user labels to be specified for the job.The algorithm to use for autoscalingintThe algorithm to use for autoscalingstatic final com.google.protobuf.Descriptors.DescriptorintWorker disk size, in gigabytes.booleanIf true, when processing time is spent almost entirely on garbage collection (GC), saves a heap dump before ending the thread or process.booleanIf true serial port logging will be enabled for the launcher VM.booleanWhether to enable Streaming Engine for the job.Set FlexRS goal for the job.intSet FlexRS goal for the job.Configuration for VM IPs.intConfiguration for VM IPs.Name for the Cloud KMS key for the job.com.google.protobuf.ByteStringName for the Cloud KMS key for the job.The machine type to use for launching the job.com.google.protobuf.ByteStringThe machine type to use for launching the job.The machine type to use for the job.com.google.protobuf.ByteStringThe machine type to use for the job.intThe maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.Network to which VMs will be assigned.com.google.protobuf.ByteStringNetwork to which VMs will be assigned.intThe initial number of Google Compute Engine instances for the job.com.google.protobuf.Parser<FlexTemplateRuntimeEnvironment>Cloud Storage bucket (directory) to upload heap dumps to.com.google.protobuf.ByteStringCloud Storage bucket (directory) to upload heap dumps to.Docker registry location of container image to use for the 'worker harness.com.google.protobuf.ByteStringDocker registry location of container image to use for the 'worker harness.intThe email address of the service account to run the job as.com.google.protobuf.ByteStringThe email address of the service account to run the job as.The Cloud Storage path for staging local files.com.google.protobuf.ByteStringThe Cloud Storage path for staging local files.Optional.intOptional.Subnetwork to which VMs will be assigned, if desired.com.google.protobuf.ByteStringSubnetwork to which VMs will be assigned, if desired.The Cloud Storage path to use for temporary files.com.google.protobuf.ByteStringThe Cloud Storage path to use for temporary files.The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.com.google.protobuf.ByteStringThe Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.com.google.protobuf.ByteStringThe Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.getZone()The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline.com.google.protobuf.ByteStringThe Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline.inthashCode()booleanOptional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleannewBuilder(FlexTemplateRuntimeEnvironment prototype) protected FlexTemplateRuntimeEnvironment.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<FlexTemplateRuntimeEnvironment>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NUM_WORKERS_FIELD_NUMBER
public static final int NUM_WORKERS_FIELD_NUMBER- See Also:
-
MAX_WORKERS_FIELD_NUMBER
public static final int MAX_WORKERS_FIELD_NUMBER- See Also:
-
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER- See Also:
-
SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER- See Also:
-
TEMP_LOCATION_FIELD_NUMBER
public static final int TEMP_LOCATION_FIELD_NUMBER- See Also:
-
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER- See Also:
-
ADDITIONAL_EXPERIMENTS_FIELD_NUMBER
public static final int ADDITIONAL_EXPERIMENTS_FIELD_NUMBER- See Also:
-
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER- See Also:
-
SUBNETWORK_FIELD_NUMBER
public static final int SUBNETWORK_FIELD_NUMBER- See Also:
-
ADDITIONAL_USER_LABELS_FIELD_NUMBER
public static final int ADDITIONAL_USER_LABELS_FIELD_NUMBER- See Also:
-
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER- See Also:
-
IP_CONFIGURATION_FIELD_NUMBER
public static final int IP_CONFIGURATION_FIELD_NUMBER- See Also:
-
WORKER_REGION_FIELD_NUMBER
public static final int WORKER_REGION_FIELD_NUMBER- See Also:
-
WORKER_ZONE_FIELD_NUMBER
public static final int WORKER_ZONE_FIELD_NUMBER- See Also:
-
ENABLE_STREAMING_ENGINE_FIELD_NUMBER
public static final int ENABLE_STREAMING_ENGINE_FIELD_NUMBER- See Also:
-
FLEXRS_GOAL_FIELD_NUMBER
public static final int FLEXRS_GOAL_FIELD_NUMBER- See Also:
-
STAGING_LOCATION_FIELD_NUMBER
public static final int STAGING_LOCATION_FIELD_NUMBER- See Also:
-
SDK_CONTAINER_IMAGE_FIELD_NUMBER
public static final int SDK_CONTAINER_IMAGE_FIELD_NUMBER- See Also:
-
DISK_SIZE_GB_FIELD_NUMBER
public static final int DISK_SIZE_GB_FIELD_NUMBER- See Also:
-
AUTOSCALING_ALGORITHM_FIELD_NUMBER
public static final int AUTOSCALING_ALGORITHM_FIELD_NUMBER- See Also:
-
DUMP_HEAP_ON_OOM_FIELD_NUMBER
public static final int DUMP_HEAP_ON_OOM_FIELD_NUMBER- See Also:
-
SAVE_HEAP_DUMPS_TO_GCS_PATH_FIELD_NUMBER
public static final int SAVE_HEAP_DUMPS_TO_GCS_PATH_FIELD_NUMBER- See Also:
-
LAUNCHER_MACHINE_TYPE_FIELD_NUMBER
public static final int LAUNCHER_MACHINE_TYPE_FIELD_NUMBER- See Also:
-
ENABLE_LAUNCHER_VM_SERIAL_PORT_LOGGING_FIELD_NUMBER
public static final int ENABLE_LAUNCHER_VM_SERIAL_PORT_LOGGING_FIELD_NUMBER- See Also:
-
STREAMING_MODE_FIELD_NUMBER
public static final int STREAMING_MODE_FIELD_NUMBER- See Also:
-
ADDITIONAL_PIPELINE_OPTIONS_FIELD_NUMBER
public static final int ADDITIONAL_PIPELINE_OPTIONS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getNumWorkers
public int getNumWorkers()The initial number of Google Compute Engine instances for the job.
int32 num_workers = 1;- Specified by:
getNumWorkersin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The numWorkers.
-
getMaxWorkers
public int getMaxWorkers()The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
int32 max_workers = 2;- Specified by:
getMaxWorkersin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The maxWorkers.
-
getZone
The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
string zone = 3;- Specified by:
getZonein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The zone.
-
getZoneBytes
public com.google.protobuf.ByteString getZoneBytes()The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
string zone = 3;- Specified by:
getZoneBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for zone.
-
getServiceAccountEmail
The email address of the service account to run the job as.
string service_account_email = 4;- Specified by:
getServiceAccountEmailin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The serviceAccountEmail.
-
getServiceAccountEmailBytes
public com.google.protobuf.ByteString getServiceAccountEmailBytes()The email address of the service account to run the job as.
string service_account_email = 4;- Specified by:
getServiceAccountEmailBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for serviceAccountEmail.
-
getTempLocation
The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
string temp_location = 5;- Specified by:
getTempLocationin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The tempLocation.
-
getTempLocationBytes
public com.google.protobuf.ByteString getTempLocationBytes()The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
string temp_location = 5;- Specified by:
getTempLocationBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for tempLocation.
-
getMachineType
The machine type to use for the job. Defaults to the value from the template if not specified.
string machine_type = 6;- Specified by:
getMachineTypein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The machineType.
-
getMachineTypeBytes
public com.google.protobuf.ByteString getMachineTypeBytes()The machine type to use for the job. Defaults to the value from the template if not specified.
string machine_type = 6;- Specified by:
getMachineTypeBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for machineType.
-
getAdditionalExperimentsList
public com.google.protobuf.ProtocolStringList getAdditionalExperimentsList()Additional experiment flags for the job.
repeated string additional_experiments = 7;- Specified by:
getAdditionalExperimentsListin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- A list containing the additionalExperiments.
-
getAdditionalExperimentsCount
public int getAdditionalExperimentsCount()Additional experiment flags for the job.
repeated string additional_experiments = 7;- Specified by:
getAdditionalExperimentsCountin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The count of additionalExperiments.
-
getAdditionalExperiments
Additional experiment flags for the job.
repeated string additional_experiments = 7;- Specified by:
getAdditionalExperimentsin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The additionalExperiments at the given index.
-
getAdditionalExperimentsBytes
public com.google.protobuf.ByteString getAdditionalExperimentsBytes(int index) Additional experiment flags for the job.
repeated string additional_experiments = 7;- Specified by:
getAdditionalExperimentsBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the additionalExperiments at the given index.
-
getNetwork
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
string network = 8;- Specified by:
getNetworkin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The network.
-
getNetworkBytes
public com.google.protobuf.ByteString getNetworkBytes()Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
string network = 8;- Specified by:
getNetworkBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for network.
-
getSubnetwork
Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
string subnetwork = 9;- Specified by:
getSubnetworkin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The subnetwork.
-
getSubnetworkBytes
public com.google.protobuf.ByteString getSubnetworkBytes()Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
string subnetwork = 9;- Specified by:
getSubnetworkBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for subnetwork.
-
getAdditionalUserLabelsCount
public int getAdditionalUserLabelsCount()Description copied from interface:FlexTemplateRuntimeEnvironmentOrBuilderAdditional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.map<string, string> additional_user_labels = 10;- Specified by:
getAdditionalUserLabelsCountin interfaceFlexTemplateRuntimeEnvironmentOrBuilder
-
containsAdditionalUserLabels
Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.map<string, string> additional_user_labels = 10;- Specified by:
containsAdditionalUserLabelsin interfaceFlexTemplateRuntimeEnvironmentOrBuilder
-
getAdditionalUserLabels
Deprecated.UsegetAdditionalUserLabelsMap()instead.- Specified by:
getAdditionalUserLabelsin interfaceFlexTemplateRuntimeEnvironmentOrBuilder
-
getAdditionalUserLabelsMap
Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.map<string, string> additional_user_labels = 10;- Specified by:
getAdditionalUserLabelsMapin interfaceFlexTemplateRuntimeEnvironmentOrBuilder
-
getAdditionalUserLabelsOrDefault
Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.map<string, string> additional_user_labels = 10;- Specified by:
getAdditionalUserLabelsOrDefaultin interfaceFlexTemplateRuntimeEnvironmentOrBuilder
-
getAdditionalUserLabelsOrThrow
Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.map<string, string> additional_user_labels = 10;- Specified by:
getAdditionalUserLabelsOrThrowin interfaceFlexTemplateRuntimeEnvironmentOrBuilder
-
getKmsKeyName
Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>
string kms_key_name = 11;- Specified by:
getKmsKeyNamein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The kmsKeyName.
-
getKmsKeyNameBytes
public com.google.protobuf.ByteString getKmsKeyNameBytes()Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>
string kms_key_name = 11;- Specified by:
getKmsKeyNameBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for kmsKeyName.
-
getIpConfigurationValue
public int getIpConfigurationValue()Configuration for VM IPs.
.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;- Specified by:
getIpConfigurationValuein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The enum numeric value on the wire for ipConfiguration.
-
getIpConfiguration
Configuration for VM IPs.
.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;- Specified by:
getIpConfigurationin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The ipConfiguration.
-
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;- Specified by:
getWorkerRegionin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The workerRegion.
-
getWorkerRegionBytes
public com.google.protobuf.ByteString getWorkerRegionBytes()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;- Specified by:
getWorkerRegionBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for workerRegion.
-
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. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
string worker_zone = 14;- Specified by:
getWorkerZonein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The workerZone.
-
getWorkerZoneBytes
public com.google.protobuf.ByteString getWorkerZoneBytes()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. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
string worker_zone = 14;- Specified by:
getWorkerZoneBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for workerZone.
-
getEnableStreamingEngine
public boolean getEnableStreamingEngine()Whether to enable Streaming Engine for the job.
bool enable_streaming_engine = 15;- Specified by:
getEnableStreamingEnginein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The enableStreamingEngine.
-
getFlexrsGoalValue
public int getFlexrsGoalValue()Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
.google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;- Specified by:
getFlexrsGoalValuein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The enum numeric value on the wire for flexrsGoal.
-
getFlexrsGoal
Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
.google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;- Specified by:
getFlexrsGoalin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The flexrsGoal.
-
getStagingLocation
The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`.
string staging_location = 17;- Specified by:
getStagingLocationin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The stagingLocation.
-
getStagingLocationBytes
public com.google.protobuf.ByteString getStagingLocationBytes()The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`.
string staging_location = 17;- Specified by:
getStagingLocationBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for stagingLocation.
-
getSdkContainerImage
Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.
string sdk_container_image = 18;- Specified by:
getSdkContainerImagein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The sdkContainerImage.
-
getSdkContainerImageBytes
public com.google.protobuf.ByteString getSdkContainerImageBytes()Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.
string sdk_container_image = 18;- Specified by:
getSdkContainerImageBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for sdkContainerImage.
-
getDiskSizeGb
public int getDiskSizeGb()Worker disk size, in gigabytes.
int32 disk_size_gb = 20;- Specified by:
getDiskSizeGbin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The diskSizeGb.
-
getAutoscalingAlgorithmValue
public int getAutoscalingAlgorithmValue()The algorithm to use for autoscaling
.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;- Specified by:
getAutoscalingAlgorithmValuein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The enum numeric value on the wire for autoscalingAlgorithm.
-
getAutoscalingAlgorithm
The algorithm to use for autoscaling
.google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;- Specified by:
getAutoscalingAlgorithmin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The autoscalingAlgorithm.
-
getDumpHeapOnOom
public boolean getDumpHeapOnOom()If true, when processing time is spent almost entirely on garbage collection (GC), saves a heap dump before ending the thread or process. If false, ends the thread or process without saving a heap dump. Does not save a heap dump when the Java Virtual Machine (JVM) has an out of memory error during processing. The location of the heap file is either echoed back to the user, or the user is given the opportunity to download the heap file.
bool dump_heap_on_oom = 22;- Specified by:
getDumpHeapOnOomin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The dumpHeapOnOom.
-
getSaveHeapDumpsToGcsPath
Cloud Storage bucket (directory) to upload heap dumps to. Enabling this field implies that `dump_heap_on_oom` is set to true.
string save_heap_dumps_to_gcs_path = 23;- Specified by:
getSaveHeapDumpsToGcsPathin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The saveHeapDumpsToGcsPath.
-
getSaveHeapDumpsToGcsPathBytes
public com.google.protobuf.ByteString getSaveHeapDumpsToGcsPathBytes()Cloud Storage bucket (directory) to upload heap dumps to. Enabling this field implies that `dump_heap_on_oom` is set to true.
string save_heap_dumps_to_gcs_path = 23;- Specified by:
getSaveHeapDumpsToGcsPathBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for saveHeapDumpsToGcsPath.
-
getLauncherMachineType
The machine type to use for launching the job. The default is n1-standard-1.
string launcher_machine_type = 24;- Specified by:
getLauncherMachineTypein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The launcherMachineType.
-
getLauncherMachineTypeBytes
public com.google.protobuf.ByteString getLauncherMachineTypeBytes()The machine type to use for launching the job. The default is n1-standard-1.
string launcher_machine_type = 24;- Specified by:
getLauncherMachineTypeBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The bytes for launcherMachineType.
-
getEnableLauncherVmSerialPortLogging
public boolean getEnableLauncherVmSerialPortLogging()If true serial port logging will be enabled for the launcher VM.
bool enable_launcher_vm_serial_port_logging = 25;- Specified by:
getEnableLauncherVmSerialPortLoggingin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The enableLauncherVmSerialPortLogging.
-
hasStreamingMode
public boolean hasStreamingMode()Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 26 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasStreamingModein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- Whether the streamingMode field is set.
-
getStreamingModeValue
public int getStreamingModeValue()Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 26 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getStreamingModeValuein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The enum numeric value on the wire for streamingMode.
-
getStreamingMode
Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
optional .google.dataflow.v1beta3.StreamingMode streaming_mode = 26 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getStreamingModein interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The streamingMode.
-
getAdditionalPipelineOptionsList
public com.google.protobuf.ProtocolStringList getAdditionalPipelineOptionsList()Optional. Additional pipeline option flags for the job.
repeated string additional_pipeline_options = 27 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAdditionalPipelineOptionsListin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- A list containing the additionalPipelineOptions.
-
getAdditionalPipelineOptionsCount
public int getAdditionalPipelineOptionsCount()Optional. Additional pipeline option flags for the job.
repeated string additional_pipeline_options = 27 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAdditionalPipelineOptionsCountin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Returns:
- The count of additionalPipelineOptions.
-
getAdditionalPipelineOptions
Optional. Additional pipeline option flags for the job.
repeated string additional_pipeline_options = 27 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAdditionalPipelineOptionsin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The additionalPipelineOptions at the given index.
-
getAdditionalPipelineOptionsBytes
public com.google.protobuf.ByteString getAdditionalPipelineOptionsBytes(int index) Optional. Additional pipeline option flags for the job.
repeated string additional_pipeline_options = 27 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAdditionalPipelineOptionsBytesin interfaceFlexTemplateRuntimeEnvironmentOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the additionalPipelineOptions at the given index.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static FlexTemplateRuntimeEnvironment parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static FlexTemplateRuntimeEnvironment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static FlexTemplateRuntimeEnvironment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static FlexTemplateRuntimeEnvironment.Builder newBuilder(FlexTemplateRuntimeEnvironment prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected FlexTemplateRuntimeEnvironment.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-