Data Lineage API . projects . locations . processes . runs . lineageEvents

Instance Methods

close()

Close httplib2 connections.

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

Creates a new lineage event.

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

Deletes the lineage event with the specified name.

get(name, x__xgafv=None)

Gets details of a specified lineage event.

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

Lists lineage events in the given project and location. The list order is not defined.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, requestId=None, x__xgafv=None)
Creates a new lineage event.

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

{ # A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.
  "endTime": "A String", # Optional. The end of the transformation which resulted in this lineage event. For streaming scenarios, it should be the end of the period from which the lineage is being reported.
  "links": [ # Optional. List of source-target pairs. Can't contain more than 100 tuples.
    { # A lineage between source and target entities.
      "source": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the source entity
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
      "target": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the target entity
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
    },
  ],
  "name": "A String", # Immutable. The resource name of the lineage event. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported.
}

  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 event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.
  "endTime": "A String", # Optional. The end of the transformation which resulted in this lineage event. For streaming scenarios, it should be the end of the period from which the lineage is being reported.
  "links": [ # Optional. List of source-target pairs. Can't contain more than 100 tuples.
    { # A lineage between source and target entities.
      "source": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the source entity
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
      "target": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the target entity
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
    },
  ],
  "name": "A String", # Immutable. The resource name of the lineage event. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported.
}
delete(name, allowMissing=None, x__xgafv=None)
Deletes the lineage event with the specified name.

Args:
  name: string, Required. The name of the lineage event to delete. (required)
  allowMissing: boolean, If set to true and the lineage event 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:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets details of a specified lineage event.

Args:
  name: string, Required. The name of the lineage event 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 event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.
  "endTime": "A String", # Optional. The end of the transformation which resulted in this lineage event. For streaming scenarios, it should be the end of the period from which the lineage is being reported.
  "links": [ # Optional. List of source-target pairs. Can't contain more than 100 tuples.
    { # A lineage between source and target entities.
      "source": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the source entity
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
      "target": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the target entity
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
    },
  ],
  "name": "A String", # Immutable. The resource name of the lineage event. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
  "startTime": "A String", # Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists lineage events in the given project and location. The list order is not defined.

Args:
  parent: string, Required. The name of the run that owns the collection of lineage events to get. (required)
  pageSize: integer, The maximum number of lineage events to return. The service may return fewer events than this value. If unspecified, at most 50 events are returned. The maximum value is 100; values greater than 100 are cut to 100.
  pageToken: string, The page token received from a previous `ListLineageEvents` 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 ListLineageEvents.
  "lineageEvents": [ # Lineage events from the specified project and location.
    { # A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.
      "endTime": "A String", # Optional. The end of the transformation which resulted in this lineage event. For streaming scenarios, it should be the end of the period from which the lineage is being reported.
      "links": [ # Optional. List of source-target pairs. Can't contain more than 100 tuples.
        { # A lineage between source and target entities.
          "source": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the source entity
            "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
          },
          "target": { # The soft reference to everything you can attach a lineage event to. # Required. Reference to the target entity
            "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
          },
        },
      ],
      "name": "A String", # Immutable. The resource name of the lineage event. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
      "startTime": "A String", # Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported.
    },
  ],
  "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.
}
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.