Lists runs in the given project and location. List order is descending by `start_time`.

Method Details

close()

Close httplib2 connections.

create(parent, body=None, requestId=None, x__xgafv=None)

Creates a new run.

Args:
  parent: string, Required. The name of the process that should own the run. (required)
  body: object, The request body.
    The object takes the form of:

{ # A lineage run represents an execution of a process that creates lineage events.
  "attributes": { # Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    "a_key": "",
  },
  "displayName": "A String", # Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`
  "endTime": "A String", # Optional. The timestamp of the end of the run.
  "name": "A String", # Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The timestamp of the start of the run.
  "state": "A String", # Required. The state of the run.
}

  requestId: string, A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a `request_id` is provided.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A lineage run represents an execution of a process that creates lineage events.
  "attributes": { # Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    "a_key": "",
  },
  "displayName": "A String", # Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`
  "endTime": "A String", # Optional. The timestamp of the end of the run.
  "name": "A String", # Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The timestamp of the start of the run.
  "state": "A String", # Required. The state of the run.
}

delete(name, allowMissing=None, x__xgafv=None)

Deletes the run with the specified name.

Args:
name: string, Required. The name of the run to delete. (required)
allowMissing: boolean, If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets the details of the specified run.

Args:
  name: string, Required. The name of the run to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A lineage run represents an execution of a process that creates lineage events.
  "attributes": { # Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    "a_key": "",
  },
  "displayName": "A String", # Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`
  "endTime": "A String", # Optional. The timestamp of the end of the run.
  "name": "A String", # Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The timestamp of the start of the run.
  "state": "A String", # Required. The state of the run.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists runs in the given project and location. List order is descending by `start_time`.

Args:
parent: string, Required. The name of process that owns this collection of runs. (required)
pageSize: integer, The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs are returned. The maximum value is 100; values greater than 100 are cut to 100.
pageToken: string, The page token received from a previous `ListRuns` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for ListRuns.
"nextPageToken": "A String", # The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages.
"runs": [ # The runs from the specified project and location.
{ # A lineage run represents an execution of a process that creates lineage events.
"attributes": { # Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
"a_key": "",
},
"displayName": "A String", # Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`
"endTime": "A String", # Optional. The timestamp of the end of the run.
"name": "A String", # Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
"startTime": "A String", # Required. The timestamp of the start of the run.
"state": "A String", # Required. The state of the run.
},
],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)

Updates a run.

Args:
  name: string, Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` (required)
  body: object, The request body.
    The object takes the form of:

{ # A lineage run represents an execution of a process that creates lineage events.
  "attributes": { # Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    "a_key": "",
  },
  "displayName": "A String", # Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`
  "endTime": "A String", # Optional. The timestamp of the end of the run.
  "name": "A String", # Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The timestamp of the start of the run.
  "state": "A String", # Required. The state of the run.
}

  allowMissing: boolean, If set to true and the run is not found, the request creates it.
  updateMask: string, The list of fields to update. Currently not used. The whole message is updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A lineage run represents an execution of a process that creates lineage events.
  "attributes": { # Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    "a_key": "",
  },
  "displayName": "A String", # Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`
  "endTime": "A String", # Optional. The timestamp of the end of the run.
  "name": "A String", # Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The timestamp of the start of the run.
  "state": "A String", # Required. The state of the run.
}

Data Lineage API . projects . locations . processes . runs

Instance Methods

Method Details