Method: googleapis.aiplatform.v1beta1.projects.locations.metadataStores.executions.create

Creates an Execution associated with a MetadataStore.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
parent

string

Required. The resource name of the MetadataStore where the Execution should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

executionId

string

The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)

region

string

Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.

body

object (GoogleCloudAiplatformV1beta1Execution)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
OperationError If the long-running operation finished unsuccessfully.
ResponseTypeError If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of GoogleCloudAiplatformV1beta1Execution.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- create:
    call: googleapis.aiplatform.v1beta1.projects.locations.metadataStores.executions.create
    args:
        parent: ...
        executionId: ...
        region: ...
        body:
            description: ...
            displayName: ...
            etag: ...
            labels: ...
            metadata: ...
            schemaTitle: ...
            schemaVersion: ...
            state: ...
    result: createResult

JSON

[
  {
    "create": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.metadataStores.executions.create",
      "args": {
        "parent": "...",
        "executionId": "...",
        "region": "...",
        "body": {
          "description": "...",
          "displayName": "...",
          "etag": "...",
          "labels": "...",
          "metadata": "...",
          "schemaTitle": "...",
          "schemaVersion": "...",
          "state": "..."
        }
      },
      "result": "createResult"
    }
  }
]