| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="datalineage_v1.html">Data Lineage API</a> . <a href="datalineage_v1.projects.html">projects</a> . <a href="datalineage_v1.projects.locations.html">locations</a> . <a href="datalineage_v1.projects.locations.processes.html">processes</a> . <a href="datalineage_v1.projects.locations.processes.runs.html">runs</a> . <a href="datalineage_v1.projects.locations.processes.runs.lineageEvents.html">lineageEvents</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new lineage event.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, allowMissing=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the lineage event with the specified name.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a specified lineage event.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists lineage events in the given project and location. The list order is not defined.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>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/dataplex/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/dataplex/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, Optional. 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/dataplex/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/dataplex/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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, allowMissing=None, x__xgafv=None)</code> |
| <pre>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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>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/dataplex/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/dataplex/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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>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/dataplex/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/dataplex/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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
