Class InstantiateWorkflowTemplateRequest (2.0.2)

InstantiateWorkflowTemplateRequest(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

A request to instantiate a workflow template.

Attributes

NameDescription
name str
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}
version int
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.
instance_id str
Deprecated. Please use request_id field instead.
request_id str
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.
parameters Sequence[.workflow_templates.InstantiateWorkflowTemplateRequest.ParametersEntry]
Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters.

Classes

ParametersEntry

ParametersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.