Class: Google::Cloud::Dataflow::V1beta3::RuntimeEnvironment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/dataflow/v1beta3/templates.rb

Overview

The environment values to set at runtime.

Defined Under Namespace

Classes: AdditionalUserLabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#additional_experiments ⇒ ::Array<::String>

Returns Optional. Additional experiment flags for the job, specified with the --experiments option.

Returns:

  • (::Array<::String>) —

    Optional. Additional experiment flags for the job, specified with the --experiments option.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#additional_user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#bypass_temp_dir_validation ⇒ ::Boolean

Returns Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

Returns:

  • (::Boolean) —

    Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disk_size_gb ⇒ ::Integer

Returns Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.

Returns:

  • (::Integer) —

    Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enable_streaming_engine ⇒ ::Boolean

Returns Optional. Whether to enable Streaming Engine for the job.

Returns:

  • (::Boolean) —

    Optional. Whether to enable Streaming Engine for the job.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ip_configuration ⇒ ::Google::Cloud::Dataflow::V1beta3::WorkerIPAddressConfiguration

Returns Optional. Configuration for VM IPs.

Returns:



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kms_key_name ⇒ ::String

Returns Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/.

Returns:

  • (::String) —

    Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#machine_type ⇒ ::String

Returns Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

Returns:

  • (::String) —

    Optional. The machine type to use for the job. Defaults to the value from the template if not specified.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#max_workers ⇒ ::Integer

Returns Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.

Returns:

  • (::Integer) —

    Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#network ⇒ ::String

Returns Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

Returns:

  • (::String) —

    Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#num_workers ⇒ ::Integer

Returns Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

Returns:

  • (::Integer) —

    Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account_email ⇒ ::String

Returns Optional. The email address of the service account to run the job as.

Returns:

  • (::String) —

    Optional. The email address of the service account to run the job as.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#streaming_mode ⇒ ::Google::Cloud::Dataflow::V1beta3::StreamingMode

Returns 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.

Returns:

  • (::Google::Cloud::Dataflow::V1beta3::StreamingMode) —

    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.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#subnetwork ⇒ ::String

Returns Optional. 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.

Returns:



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#temp_location ⇒ ::String

Returns Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

Returns:

  • (::String) —

    Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#worker_region ⇒ ::String

Returns Required. 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.

Returns:



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#worker_zone ⇒ ::String

Returns Optional. 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.

Returns:

  • (::String) —

    Optional. 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.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#zone ⇒ ::String

Returns Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

Returns:

  • (::String) —

    Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 381

class RuntimeEnvironment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AdditionalUserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end