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 Additional experiment flags for the job.

Returns:

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

    Additional experiment flags for the job.



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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 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}) —

    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" }.



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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 Whether to bypass the safety checks for the job's temporary directory. Use with caution.

Returns:

  • (::Boolean) —

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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

Returns:

  • (::Boolean) —

    Whether to enable Streaming Engine for the job.



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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 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/



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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

Returns:

  • (::Integer) —

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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 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&quot; or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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 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://.



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 317

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