lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/workflow_templates.rb in google-cloud-dataproc-0.5.1 vs lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/workflow_templates.rb in google-cloud-dataproc-0.6.0
- old
+ new
@@ -18,20 +18,22 @@
module Dataproc
module V1
# A Cloud Dataproc workflow template resource.
# @!attribute [rw] id
# @return [String]
- # Required. The template id.
- #
- # The id must contain only letters (a-z, A-Z), numbers (0-9),
- # underscores (_), and hyphens (-). Cannot begin or end with underscore
- # or hyphen. Must consist of between 3 and 50 characters.
# @!attribute [rw] name
# @return [String]
- # Output only. The "resource name" of the template, as described
- # in https://cloud.google.com/apis/design/resource_names of the form
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
+ # Output only. The resource name of the workflow template, as described
+ # in https://cloud.google.com/apis/design/resource_names.
+ #
+ # * For `projects.regions.workflowTemplates`, the resource name of the
+ # template has the following format:
+ # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
+ #
+ # * For `projects.locations.workflowTemplates`, the resource name of the
+ # template has the following format:
+ # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
# @!attribute [rw] version
# @return [Integer]
# Optional. Used to perform a consistent read-modify-write.
#
# This field should be left blank for a `CreateWorkflowTemplate` request. It
@@ -67,21 +69,21 @@
# @!attribute [rw] jobs
# @return [Array<Google::Cloud::Dataproc::V1::OrderedJob>]
# Required. The Directed Acyclic Graph of Jobs to submit.
# @!attribute [rw] parameters
# @return [Array<Google::Cloud::Dataproc::V1::TemplateParameter>]
- # Optional. Template parameters whose values are substituted into the
+ # Optional. emplate parameters whose values are substituted into the
# template. Values for parameters must be provided when the template is
# instantiated.
class WorkflowTemplate; end
# Specifies workflow execution target.
#
# Either `managed_cluster` or `cluster_selector` is required.
# @!attribute [rw] managed_cluster
# @return [Google::Cloud::Dataproc::V1::ManagedCluster]
- # Optional. A cluster that is managed by the workflow.
+ # A cluster that is managed by the workflow.
# @!attribute [rw] cluster_selector
# @return [Google::Cloud::Dataproc::V1::ClusterSelector]
# Optional. A selector that chooses target cluster for jobs based
# on metadata.
#
@@ -190,11 +192,11 @@
# * Script variables
# * Main class (in HadoopJob and SparkJob)
# * Zone (in ClusterSelector)
# @!attribute [rw] name
# @return [String]
- # Required. Parameter name.
+ # Required. Parameter name.
# The parameter name is used as the key, and paired with the
# parameter value, which are passed to the template when the template
# is instantiated.
# The name must contain only capital letters (A-Z), numbers (0-9), and
# underscores (_), and must not start with a number. The maximum length is
@@ -278,11 +280,20 @@
class ValueValidation; end
# A Cloud Dataproc workflow template resource.
# @!attribute [rw] template
# @return [String]
- # Output only. The "resource name" of the template.
+ # Output only. The resource name of the workflow template as described
+ # in https://cloud.google.com/apis/design/resource_names.
+ #
+ # * For `projects.regions.workflowTemplates`, the resource name of the
+ # template has the following format:
+ # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
+ #
+ # * For `projects.locations.workflowTemplates`, the resource name of the
+ # template has the following format:
+ # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
# @!attribute [rw] version
# @return [Integer]
# Output only. The version of template at the time of
# workflow instantiation.
# @!attribute [rw] create_cluster
@@ -388,38 +399,59 @@
end
# A request to create a workflow template.
# @!attribute [rw] parent
# @return [String]
- # Required. The "resource name" of the region, as described
- # in https://cloud.google.com/apis/design/resource_names of the form
- # `projects/{project_id}/regions/{region}`
+ # Required. The resource name of the region or location, as described
+ # in https://cloud.google.com/apis/design/resource_names.
+ #
+ # * For `projects.regions.workflowTemplates,create`, the resource name of the
+ # region has the following format:
+ # `projects/{project_id}/regions/{region}`
+ #
+ # * For `projects.locations.workflowTemplates.create`, the resource name of
+ # the location has the following format:
+ # `projects/{project_id}/locations/{location}`
# @!attribute [rw] template
# @return [Google::Cloud::Dataproc::V1::WorkflowTemplate]
# Required. The Dataproc workflow template to create.
class CreateWorkflowTemplateRequest; end
# A request to fetch a workflow template.
# @!attribute [rw] name
# @return [String]
- # Required. The "resource name" of the workflow template, as described
- # in https://cloud.google.com/apis/design/resource_names of the form
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
+ # Required. The resource name of the workflow template, as described
+ # in https://cloud.google.com/apis/design/resource_names.
+ #
+ # * For `projects.regions.workflowTemplates.get`, the resource name of the
+ # template has the following format:
+ # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
+ #
+ # * For `projects.locations.workflowTemplates.get`, the resource name of the
+ # template has the following format:
+ # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
# @!attribute [rw] version
# @return [Integer]
# Optional. The version of workflow template to retrieve. Only previously
- # instatiated versions can be retrieved.
+ # instantiated versions can be retrieved.
#
# If unspecified, retrieves the current version.
class GetWorkflowTemplateRequest; end
# A request to instantiate a workflow template.
# @!attribute [rw] name
# @return [String]
- # Required. The "resource name" of the workflow template, as described
- # in https://cloud.google.com/apis/design/resource_names of the form
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
+ # 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}`
# @!attribute [rw] version
# @return [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.
@@ -444,13 +476,20 @@
class InstantiateWorkflowTemplateRequest; end
# A request to instantiate an inline workflow template.
# @!attribute [rw] parent
# @return [String]
- # Required. The "resource name" of the workflow template region, as described
- # in https://cloud.google.com/apis/design/resource_names of the form
- # `projects/{project_id}/regions/{region}`
+ # Required. The resource name of the region or location, as described
+ # in https://cloud.google.com/apis/design/resource_names.
+ #
+ # * For `projects.regions.workflowTemplates,instantiateinline`, the resource
+ # name of the region has the following format:
+ # `projects/{project_id}/regions/{region}`
+ #
+ # * For `projects.locations.workflowTemplates.instantiateinline`, the
+ # resource name of the location has the following format:
+ # `projects/{project_id}/locations/{location}`
# @!attribute [rw] template
# @return [Google::Cloud::Dataproc::V1::WorkflowTemplate]
# Required. The workflow template to instantiate.
# @!attribute [rw] request_id
# @return [String]
@@ -474,13 +513,20 @@
class UpdateWorkflowTemplateRequest; end
# A request to list workflow templates in a project.
# @!attribute [rw] parent
# @return [String]
- # Required. The "resource name" of the region, as described
- # in https://cloud.google.com/apis/design/resource_names of the form
- # `projects/{project_id}/regions/{region}`
+ # Required. The resource name of the region or location, as described
+ # in https://cloud.google.com/apis/design/resource_names.
+ #
+ # * For `projects.regions.workflowTemplates,list`, the resource
+ # name of the region has the following format:
+ # `projects/{project_id}/regions/{region}`
+ #
+ # * For `projects.locations.workflowTemplates.list`, the
+ # resource name of the location has the following format:
+ # `projects/{project_id}/locations/{location}`
# @!attribute [rw] page_size
# @return [Integer]
# Optional. The maximum number of results to return in each response.
# @!attribute [rw] page_token
# @return [String]
@@ -502,12 +548,19 @@
# A request to delete a workflow template.
#
# Currently started workflows will remain running.
# @!attribute [rw] name
# @return [String]
- # Required. The "resource name" of the workflow template, as described
- # in https://cloud.google.com/apis/design/resource_names of the form
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
+ # Required. The resource name of the workflow template, as described
+ # in https://cloud.google.com/apis/design/resource_names.
+ #
+ # * For `projects.regions.workflowTemplates.delete`, 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}`
# @!attribute [rw] version
# @return [Integer]
# Optional. The version of workflow template to delete. If specified,
# will only delete the template if the current server version matches
# specified version.
\ No newline at end of file