Package com.google.dataflow.v1beta3

Class RuntimeEnvironment

  • All Implemented Interfaces:
    RuntimeEnvironmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RuntimeEnvironment
extends com.google.protobuf.GeneratedMessageV3
implements RuntimeEnvironmentOrBuilder
     The environment values to set at runtime.
    Protobuf type google.dataflow.v1beta3.RuntimeEnvironment
    See Also:
    Serialized Form

    • Field Detail

      • NUM_WORKERS_FIELD_NUMBER

        public static final int NUM_WORKERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_WORKERS_FIELD_NUMBER

        public static final int MAX_WORKERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEMP_LOCATION_FIELD_NUMBER

        public static final int TEMP_LOCATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BYPASS_TEMP_DIR_VALIDATION_FIELD_NUMBER

        public static final int BYPASS_TEMP_DIR_VALIDATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MACHINE_TYPE_FIELD_NUMBER

        public static final int MACHINE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDITIONAL_EXPERIMENTS_FIELD_NUMBER

        public static final int ADDITIONAL_EXPERIMENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUBNETWORK_FIELD_NUMBER

        public static final int SUBNETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDITIONAL_USER_LABELS_FIELD_NUMBER

        public static final int ADDITIONAL_USER_LABELS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KMS_KEY_NAME_FIELD_NUMBER

        public static final int KMS_KEY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IP_CONFIGURATION_FIELD_NUMBER

        public static final int IP_CONFIGURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKER_REGION_FIELD_NUMBER

        public static final int WORKER_REGION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKER_ZONE_FIELD_NUMBER

        public static final int WORKER_ZONE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_STREAMING_ENGINE_FIELD_NUMBER

        public static final int ENABLE_STREAMING_ENGINE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getNumWorkers

        public int getNumWorkers()
         The initial number of Google Compute Engine instnaces for the job.
        int32 num_workers = 11;
        Specified by:
        getNumWorkers in interface RuntimeEnvironmentOrBuilder
        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 = 1;
        Specified by:
        getMaxWorkers in interface RuntimeEnvironmentOrBuilder
        Returns:
        The maxWorkers.

      • getZone

        public String 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 = 2;
        Specified by:
        getZone in interface RuntimeEnvironmentOrBuilder
        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 = 2;
        Specified by:
        getZoneBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for zone.

      • getServiceAccountEmailBytes

        public com.google.protobuf.ByteString getServiceAccountEmailBytes()
         The email address of the service account to run the job as.
        string service_account_email = 3;
        Specified by:
        getServiceAccountEmailBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for serviceAccountEmail.

      • getTempLocation

        public String getTempLocation()
         The Cloud Storage path to use for temporary files.
 Must be a valid Cloud Storage URL, beginning with `gs://`.
        string temp_location = 4;
        Specified by:
        getTempLocation in interface RuntimeEnvironmentOrBuilder
        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 = 4;
        Specified by:
        getTempLocationBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for tempLocation.

      • getBypassTempDirValidation

        public boolean getBypassTempDirValidation()
         Whether to bypass the safety checks for the job's temporary directory.
 Use with caution.
        bool bypass_temp_dir_validation = 5;
        Specified by:
        getBypassTempDirValidation in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bypassTempDirValidation.

      • getMachineType

        public String 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:
        getMachineType in interface RuntimeEnvironmentOrBuilder
        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:
        getMachineTypeBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for machineType.

      • getAdditionalExperimentsList

        public com.google.protobuf.ProtocolStringList getAdditionalExperimentsList()
         Additional experiment flags for the job, specified with the
 `--experiments` option.
        repeated string additional_experiments = 7;
        Specified by:
        getAdditionalExperimentsList in interface RuntimeEnvironmentOrBuilder
        Returns:
        A list containing the additionalExperiments.

      • getAdditionalExperimentsCount

        public int getAdditionalExperimentsCount()
         Additional experiment flags for the job, specified with the
 `--experiments` option.
        repeated string additional_experiments = 7;
        Specified by:
        getAdditionalExperimentsCount in interface RuntimeEnvironmentOrBuilder
        Returns:
        The count of additionalExperiments.

      • getAdditionalExperiments

        public String getAdditionalExperiments​(int index)
         Additional experiment flags for the job, specified with the
 `--experiments` option.
        repeated string additional_experiments = 7;
        Specified by:
        getAdditionalExperiments in interface RuntimeEnvironmentOrBuilder
        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, specified with the
 `--experiments` option.
        repeated string additional_experiments = 7;
        Specified by:
        getAdditionalExperimentsBytes in interface RuntimeEnvironmentOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the additionalExperiments at the given index.

      • getNetwork

        public String getNetwork()
         Network to which VMs will be assigned.  If empty or unspecified,
 the service will use the network "default".
        string network = 8;
        Specified by:
        getNetwork in interface RuntimeEnvironmentOrBuilder
        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:
        getNetworkBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for network.

      • getSubnetwork

        public String 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:
        getSubnetwork in interface RuntimeEnvironmentOrBuilder
        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:
        getSubnetworkBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for subnetwork.

      • getAdditionalUserLabelsCount

        public int getAdditionalUserLabelsCount()
        Description copied from interface: RuntimeEnvironmentOrBuilder
         Additional user labels to be specified for the job.
 Keys and values should 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:
        getAdditionalUserLabelsCount in interface RuntimeEnvironmentOrBuilder

      • containsAdditionalUserLabels

        public boolean containsAdditionalUserLabels​(String key)
         Additional user labels to be specified for the job.
 Keys and values should 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:
        containsAdditionalUserLabels in interface RuntimeEnvironmentOrBuilder

      • getAdditionalUserLabelsMap

        public Map<String,​String> getAdditionalUserLabelsMap()
         Additional user labels to be specified for the job.
 Keys and values should 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:
        getAdditionalUserLabelsMap in interface RuntimeEnvironmentOrBuilder

      • getAdditionalUserLabelsOrDefault

        public String getAdditionalUserLabelsOrDefault​(String key,
                                               String defaultValue)
         Additional user labels to be specified for the job.
 Keys and values should 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:
        getAdditionalUserLabelsOrDefault in interface RuntimeEnvironmentOrBuilder

      • getAdditionalUserLabelsOrThrow

        public String getAdditionalUserLabelsOrThrow​(String key)
         Additional user labels to be specified for the job.
 Keys and values should 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:
        getAdditionalUserLabelsOrThrow in interface RuntimeEnvironmentOrBuilder

      • getKmsKeyName

        public String 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 = 12;
        Specified by:
        getKmsKeyName in interface RuntimeEnvironmentOrBuilder
        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 = 12;
        Specified by:
        getKmsKeyNameBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for kmsKeyName.

      • getIpConfigurationValue

        public int getIpConfigurationValue()
         Configuration for VM IPs.
        .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 14;
        Specified by:
        getIpConfigurationValue in interface RuntimeEnvironmentOrBuilder
        Returns:
        The enum numeric value on the wire for ipConfiguration.

      • getWorkerRegion

        public 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 = 15;
        Specified by:
        getWorkerRegion in interface RuntimeEnvironmentOrBuilder
        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 = 15;
        Specified by:
        getWorkerRegionBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for workerRegion.

      • getWorkerZone

        public 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.
 If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
        string worker_zone = 16;
        Specified by:
        getWorkerZone in interface RuntimeEnvironmentOrBuilder
        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 = 16;
        Specified by:
        getWorkerZoneBytes in interface RuntimeEnvironmentOrBuilder
        Returns:
        The bytes for workerZone.

      • getEnableStreamingEngine

        public boolean getEnableStreamingEngine()
         Whether to enable Streaming Engine for the job.
        bool enable_streaming_engine = 17;
        Specified by:
        getEnableStreamingEngine in interface RuntimeEnvironmentOrBuilder
        Returns:
        The enableStreamingEngine.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RuntimeEnvironment parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeEnvironment parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeEnvironment parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeEnvironment parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeEnvironment parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeEnvironment parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeEnvironment parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public RuntimeEnvironment.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public RuntimeEnvironment.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RuntimeEnvironment.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<RuntimeEnvironment> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public RuntimeEnvironment getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder