Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: workflowexecutions1 --scope <scope> projects locations-workflows-executions-create ...

Required Scalar Argument

• <parent> (string)
  • Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Execution:
  argument: string
  call-log-level: string
  create-time: string
  disable-concurrency-quota-overflow-buffering: boolean
  duration: string
  end-time: string
  error:
    context: string
    payload: string
  labels: { string: string }
  name: string
  result: string
  start-time: string
  state: string
  state-error:
    details: string
    type: string
  workflow-revision-id: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . argument=et
  • Input parameters of the execution represented as a JSON string. The size limit is 32KB. Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'
• call-log-level=magna
  • The call logging level associated to this execution.
• create-time=no
  • Output only. Marks the creation of the execution.
• disable-concurrency-quota-overflow-buffering=true
  • Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available.
• duration=voluptua.
  • Output only. Measures the duration of the execution.
• end-time=at
  • Output only. Marks the end of execution, successful or not.
• error context=sanctus
  • Human-readable stack trace string.

• payload=sed

  • Error message and data returned represented as a JSON string.

• .. labels=key=amet.

  • Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution.
  • the value will be associated with the given key
• name=takimata
  • Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
• result=amet.
  • Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.
• start-time=duo
  • Output only. Marks the beginning of execution.
• state=ipsum
  • Output only. Current state of the execution.
• state-error details=gubergren
  • Provides specifics about the error.

• type=lorem

  • The type of this state error.

• .. workflow-revision-id=gubergren

  • Output only. Revision of the workflow this execution is using.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").