Class: Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters

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

Overview

Parameters to provide to the template being launched. Note that the metadata in the pipeline code determines which runtime parameters are valid.

Defined Under Namespace

Classes: ParametersEntry, TransformNameMappingEntry

Instance Attribute Summary collapse

Instance Attribute Details

#environment ⇒ ::Google::Cloud::Dataflow::V1beta3::RuntimeEnvironment

Returns The runtime environment for the job.

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 666

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

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

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

#job_name ⇒ ::String

Returns Required. The job name to use for the created job.

The name must match the regular expression [a-z]([-a-z0-9]{0,1022}[a-z0-9])?.

Returns:

  • (::String) —

    Required. The job name to use for the created job.

    The name must match the regular expression [a-z]([-a-z0-9]{0,1022}[a-z0-9])?



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 666

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

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

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

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

Returns The runtime parameters to pass to the job.

Returns:

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

    The runtime parameters to pass to the job.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 666

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

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

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

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

Returns Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

Returns:

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

    Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 666

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

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

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

#update ⇒ ::Boolean

Returns If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

Returns:

  • (::Boolean) —

    If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'proto_docs/google/dataflow/v1beta3/templates.rb', line 666

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

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

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