Class: Google::Cloud::Dataflow::V1beta3::FlexTemplateRuntimeEnvironment

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 be set at runtime for flex template.

Defined Under Namespace

Classes: AdditionalUserLabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#additional_experiments ⇒ ::Array<::String>

Returns Additional experiment flags for the job.

Returns:

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

    Additional experiment flags for the job.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 Additional user labels to be specified for the job. Keys and values must 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}) —

    Additional user labels to be specified for the job. Keys and values must 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" }.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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

#autoscaling_algorithm ⇒ ::Google::Cloud::Dataflow::V1beta3::AutoscalingAlgorithm

Returns The algorithm to use for autoscaling.

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 Worker disk size, in gigabytes.

Returns:

  • (::Integer) —

    Worker disk size, in gigabytes.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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

#dump_heap_on_oom ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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_launcher_vm_serial_port_logging ⇒ ::Boolean

Returns If true serial port logging will be enabled for the launcher VM.

Returns:

  • (::Boolean) —

    If true serial port logging will be enabled for the launcher VM.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 Whether to enable Streaming Engine for the job.

Returns:

  • (::Boolean) —

    Whether to enable Streaming Engine for the job.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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

#flexrs_goal ⇒ ::Google::Cloud::Dataflow::V1beta3::FlexResourceSchedulingGoal

Returns Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs.

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 Configuration for VM IPs.

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/.

Returns:

  • (::String) —

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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

#launcher_machine_type ⇒ ::String

Returns The machine type to use for launching the job. The default is n1-standard-1.

Returns:

  • (::String) —

    The machine type to use for launching the job. The default is n1-standard-1.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 The machine type to use for the job. Defaults to the value from the template if not specified.

Returns:

  • (::String) —

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

Returns:

  • (::Integer) —

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

Returns:

  • (::String) —

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 The initial number of Google Compute Engine instances for the job.

Returns:

  • (::Integer) —

    The initial number of Google Compute Engine instances for the job.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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

#save_heap_dumps_to_gcs_path ⇒ ::String

Returns Cloud Storage bucket (directory) to upload heap dumps to. Enabling this field implies that dump_heap_on_oom is set to true.

Returns:

  • (::String) —

    Cloud Storage bucket (directory) to upload heap dumps to. Enabling this field implies that dump_heap_on_oom is set to true.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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

#sdk_container_image ⇒ ::String

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

Returns:

  • (::String) —

    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.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 The email address of the service account to run the job as.

Returns:

  • (::String) —

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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

#staging_location ⇒ ::String

Returns The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.

Returns:

  • (::String) —

    The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 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:



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

Returns:

  • (::String) —

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 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:



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 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) —

    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.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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 The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

Returns:

  • (::String) —

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 252

class FlexTemplateRuntimeEnvironment
  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