Class: Google::Cloud::Dataproc::V1::InstantiateWorkflowTemplateRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataproc/v1/workflow_templates.rb

Overview

A request to instantiate a workflow template.

Defined Under Namespace

Classes: ParametersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ ::String

Returns Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

  • For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}.

Returns:

  • (::String) —

    Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

    • For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

    • For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}



677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 677

class InstantiateWorkflowTemplateRequest
  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
end

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

Returns Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.

Returns:

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

    Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.



677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 677

class InstantiateWorkflowTemplateRequest
  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
end

#request_id ⇒ ::String

Returns Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.

It is recommended to always set this value to a UUID.

The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Returns:

  • (::String) —

    Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.

    It is recommended to always set this value to a UUID.

    The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.



677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 677

class InstantiateWorkflowTemplateRequest
  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
end

#version ⇒ ::Integer

Returns Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.

This option cannot be used to instantiate a previous version of workflow template.

Returns:

  • (::Integer) —

    Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.

    This option cannot be used to instantiate a previous version of workflow template.



677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'proto_docs/google/cloud/dataproc/v1/workflow_templates.rb', line 677

class InstantiateWorkflowTemplateRequest
  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
end