Lineage is used to track data flows between assets over time. You can create LineageEvents to record lineage between multiple sources and a single target, for example, when table data is based on data from multiple tables. v1
Package
@google-cloud/lineageConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of LineageClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new LineageClient({fallback: true}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
lineageStub
lineageStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
batchSearchLinkProcesses(request, options)
batchSearchLinkProcesses
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessLinks
[],
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
|
null
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesResponse
]>;
Retrieve information about LineageProcesses associated with specific links. LineageProcesses are transformation pipelines that result in data flowing from **source** to **target** assets. Links between assets represent this operation.
If you have specific link names, you can use this method to verify which LineageProcesses contribute to creating those links. See the method for more information on how to retrieve link name.
You can retrieve the LineageProcess information in every project where you have the datalineage.events.get
permission. The project provided in the URL is used for Billing and Quota.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IProcessLinks
[], protos.google.cloud.datacatalog.lineage.v1.IBatchSearchLinkProcessesRequest
| null, protos.google.cloud.datacatalog.lineage.v1.IBatchSearchLinkProcessesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of ProcessLinks
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using batchSearchLinkProcessesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
batchSearchLinkProcesses(request, options, callback)
batchSearchLinkProcesses
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessLinks
> )
:
void
;
request
options
CallOptions
callback
void
batchSearchLinkProcesses(request, callback)
batchSearchLinkProcesses
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessLinks
> )
:
void
;
request
callback
void
batchSearchLinkProcessesAsync(request, options)
batchSearchLinkProcessesAsync
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessLinks
> ;
Equivalent to batchSearchLinkProcesses
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.datacatalog.lineage.v1.IProcessLinks
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing ProcessLinks . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The project and location where you want to search.
*/
// const parent = 'abc123'
/**
* Required. An array of links to check for their associated LineageProcesses.
* The maximum number of items in this array is 100.
* If the request contains more than 100 links, it returns the
* `INVALID_ARGUMENT` error.
* Format: `projects/{project}/locations/{location}/links/{link}`.
*/
// const links = ['abc','def']
/**
* The maximum number of processes to return in a single page of the response.
* A page may contain fewer results than this value.
*/
// const pageSize = 1234
/**
* The page token received from a previous `BatchSearchLinkProcesses` call.
* Use it to get the next page.
* When requesting subsequent pages of a response, remember that
* all parameters must match the values you provided
* in the original request.
*/
// const pageToken = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callBatchSearchLinkProcesses
()
{
// Construct request
const
request
=
{
parent
,
links
,
};
// Run request
const
iterable
=
await
lineageClient
.
batchSearchLinkProcessesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callBatchSearchLinkProcesses
();
batchSearchLinkProcessesStream(request, options)
batchSearchLinkProcessesStream
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IBatchSearchLinkProcessesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing ProcessLinks
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using batchSearchLinkProcessesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkDeleteProcessProgress(name)
checkDeleteProcessProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteProcess()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.datacatalog.lineage.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the process to delete.
*/
// const name = 'abc123'
/**
* If set to true and the process is not found, the request
* succeeds but the server doesn't perform any actions.
*/
// const allowMissing = true
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callDeleteProcess
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
lineageClient
.
deleteProcess
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteProcess
();
checkDeleteRunProgress(name)
checkDeleteRunProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteRun()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.datacatalog.lineage.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the run to delete.
*/
// const name = 'abc123'
/**
* If set to true and the run is not found, the request
* succeeds but the server doesn't perform any actions.
*/
// const allowMissing = true
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callDeleteRun
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
lineageClient
.
deleteRun
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteRun
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createLineageEvent(request, options)
createLineageEvent
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateLineageEventRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
,
(
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateLineageEventRequest
|
undefined
),
{}
|
undefined
]>;
Creates a new lineage event.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
,
( protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing LineageEvent . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the run that should own the lineage event.
*/
// const parent = 'abc123'
/**
* Required. The lineage event to create.
*/
// const lineageEvent = {}
/**
* 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.
*/
// const requestId = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callCreateLineageEvent
()
{
// Construct request
const
request
=
{
parent
,
lineageEvent
,
};
// Run request
const
response
=
await
lineageClient
.
createLineageEvent
(
request
);
console
.
log
(
response
);
}
callCreateLineageEvent
();
createLineageEvent(request, options, callback)
createLineageEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateLineageEventRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateLineageEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
, protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest
| null | undefined, {} | null | undefined>
void
createLineageEvent(request, callback)
createLineageEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateLineageEventRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateLineageEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
, protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest
| null | undefined, {} | null | undefined>
void
createProcess(request, options)
createProcess
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateProcessRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
(
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateProcessRequest
|
undefined
),
{}
|
undefined
]>;
Creates a new process.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IProcess
,
( protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Process . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the project and its location that should own the
* process.
*/
// const parent = 'abc123'
/**
* Required. The process to create.
*/
// const process = {}
/**
* 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.
*/
// const requestId = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callCreateProcess
()
{
// Construct request
const
request
=
{
parent
,
process
,
};
// Run request
const
response
=
await
lineageClient
.
createProcess
(
request
);
console
.
log
(
response
);
}
callCreateProcess
();
createProcess(request, options, callback)
createProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateProcessRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateProcessRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcess
, protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest
| null | undefined, {} | null | undefined>
void
createProcess(request, callback)
createProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateProcessRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateProcessRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcess
, protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest
| null | undefined, {} | null | undefined>
void
createRun(request, options)
createRun
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateRunRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateRunRequest
|
undefined
,
{}
|
undefined
]>;
Creates a new run.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the process that should own the run.
*/
// const parent = 'abc123'
/**
* Required. The run to create.
*/
// const run = {}
/**
* 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.
*/
// const requestId = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callCreateRun
()
{
// Construct request
const
request
=
{
parent
,
run
,
};
// Run request
const
response
=
await
lineageClient
.
createRun
(
request
);
console
.
log
(
response
);
}
callCreateRun
();
createRun(request, options, callback)
createRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateRunRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest
| null | undefined, {} | null | undefined>
void
createRun(request, callback)
createRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateRunRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ICreateRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest
| null | undefined, {} | null | undefined>
void
deleteLineageEvent(request, options)
deleteLineageEvent
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteLineageEventRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
(
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteLineageEventRequest
|
undefined
),
{}
|
undefined
]>;
Deletes the lineage event with the specified name.
request
options
Promise
<[ protos.google.protobuf.IEmpty
,
( protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the lineage event to delete.
*/
// const name = 'abc123'
/**
* If set to true and the lineage event is not found, the request
* succeeds but the server doesn't perform any actions.
*/
// const allowMissing = true
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callDeleteLineageEvent
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
lineageClient
.
deleteLineageEvent
(
request
);
console
.
log
(
response
);
}
callDeleteLineageEvent
();
deleteLineageEvent(request, options, callback)
deleteLineageEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteLineageEventRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteLineageEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest
| null | undefined, {} | null | undefined>
void
deleteLineageEvent(request, callback)
deleteLineageEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteLineageEventRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteLineageEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
request
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
deleteProcess(request, options)
deleteProcess
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteProcessRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes the process with the specified name.
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the process to delete.
*/
// const name = 'abc123'
/**
* If set to true and the process is not found, the request
* succeeds but the server doesn't perform any actions.
*/
// const allowMissing = true
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callDeleteProcess
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
lineageClient
.
deleteProcess
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteProcess
();
deleteProcess(request, options, callback)
deleteProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteProcessRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteProcess(request, callback)
deleteProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteProcessRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteRun(request, options)
deleteRun
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteRunRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes the run with the specified name.
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the run to delete.
*/
// const name = 'abc123'
/**
* If set to true and the run is not found, the request
* succeeds but the server doesn't perform any actions.
*/
// const allowMissing = true
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callDeleteRun
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
lineageClient
.
deleteRun
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteRun
();
deleteRun(request, options, callback)
deleteRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteRunRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteRun(request, callback)
deleteRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IDeleteRunRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
getLineageEvent(request, options)
getLineageEvent
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetLineageEventRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
,
(
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetLineageEventRequest
|
undefined
),
{}
|
undefined
]>;
Gets details of a specified lineage event.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
,
( protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing LineageEvent . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the lineage event to get.
*/
// const name = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callGetLineageEvent
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
lineageClient
.
getLineageEvent
(
request
);
console
.
log
(
response
);
}
callGetLineageEvent
();
getLineageEvent(request, options, callback)
getLineageEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetLineageEventRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetLineageEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
, protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest
| null | undefined, {} | null | undefined>
void
getLineageEvent(request, callback)
getLineageEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetLineageEventRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetLineageEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
, protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest
| null | undefined, {} | null | undefined>
void
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
options
CallOptions
| Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProcess(request, options)
getProcess
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetProcessRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetProcessRequest
|
undefined
,
{}
|
undefined
]>;
Gets the details of the specified process.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IProcess
, protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Process . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the process to get.
*/
// const name = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callGetProcess
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
lineageClient
.
getProcess
(
request
);
console
.
log
(
response
);
}
callGetProcess
();
getProcess(request, options, callback)
getProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetProcessRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetProcessRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcess
, protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest
| null | undefined, {} | null | undefined>
void
getProcess(request, callback)
getProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetProcessRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetProcessRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcess
, protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getRun(request, options)
getRun
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetRunRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetRunRequest
|
undefined
,
{}
|
undefined
]>;
Gets the details of the specified run.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the run to get.
*/
// const name = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callGetRun
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
lineageClient
.
getRun
(
request
);
console
.
log
(
response
);
}
callGetRun
();
getRun(request, options, callback)
getRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetRunRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest
| null | undefined, {} | null | undefined>
void
getRun(request, callback)
getRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetRunRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IGetRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest
| null | undefined, {} | null | undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
lineageEventPath(project, location, process, run, lineageEvent)
lineageEventPath
(
project
:
string
,
location
:
string
,
process
:
string
,
run
:
string
,
lineageEvent
:
string
)
:
string
;
Return a fully-qualified lineageEvent resource name string.
project
string
location
string
process
string
run
string
lineageEvent
string
string
{string} Resource name string.
listLineageEvents(request, options)
listLineageEvents
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
[],
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
|
null
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsResponse
]>;
Lists lineage events in the given project and location. The list order is not defined.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
[], protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsRequest
| null, protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of LineageEvent
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listLineageEventsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listLineageEvents(request, options, callback)
listLineageEvents
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
> )
:
void
;
request
options
CallOptions
callback
void
listLineageEvents(request, callback)
listLineageEvents
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
> )
:
void
;
request
callback
void
listLineageEventsAsync(request, options)
listLineageEventsAsync
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILineageEvent
> ;
Equivalent to listLineageEvents
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.datacatalog.lineage.v1.ILineageEvent
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing LineageEvent . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the run that owns the collection of lineage events to
* get.
*/
// const parent = 'abc123'
/**
* 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.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callListLineageEvents
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
lineageClient
.
listLineageEventsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListLineageEvents
();
listLineageEventsStream(request, options)
listLineageEventsStream
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListLineageEventsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing LineageEvent
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listLineageEventsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
options
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
< protos.google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
listProcesses(request, options)
listProcesses
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
[],
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
|
null
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesResponse
]>;
List processes in the given project and location. List order is descending by insertion time.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IProcess
[], protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest
| null, protos.google.cloud.datacatalog.lineage.v1.IListProcessesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Process
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listProcessesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listProcesses(request, options, callback)
listProcesses
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest
, protos.google.cloud.datacatalog.lineage.v1.IListProcessesResponse
| null | undefined, protos.google.cloud.datacatalog.lineage.v1.IProcess
>
void
listProcesses(request, callback)
listProcesses
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest
, protos.google.cloud.datacatalog.lineage.v1.IListProcessesResponse
| null | undefined, protos.google.cloud.datacatalog.lineage.v1.IProcess
>
void
listProcessesAsync(request, options)
listProcessesAsync
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
> ;
Equivalent to listProcesses
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.datacatalog.lineage.v1.IProcess
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Process . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the project and its location that owns this
* collection of processes.
*/
// const parent = 'abc123'
/**
* The maximum number of processes to return. The service may return
* fewer than this value. If unspecified, at most 50 processes are
* returned. The maximum value is 100; values greater than 100 are cut to
* 100.
*/
// const pageSize = 1234
/**
* The page token received from a previous `ListProcesses` 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.
*/
// const pageToken = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callListProcesses
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
lineageClient
.
listProcessesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListProcesses
();
listProcessesStream(request, options)
listProcessesStream
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListProcessesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Process
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listProcessesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listRuns(request, options)
listRuns
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
[],
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
|
null
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsResponse
]>;
Lists runs in the given project and location. List order is descending by start_time
.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IRun
[], protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest
| null, protos.google.cloud.datacatalog.lineage.v1.IListRunsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listRunsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listRuns(request, options, callback)
listRuns
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest
, protos.google.cloud.datacatalog.lineage.v1.IListRunsResponse
| null | undefined, protos.google.cloud.datacatalog.lineage.v1.IRun
>
void
listRuns(request, callback)
listRuns
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest
, protos.google.cloud.datacatalog.lineage.v1.IListRunsResponse
| null | undefined, protos.google.cloud.datacatalog.lineage.v1.IRun
>
void
listRunsAsync(request, options)
listRunsAsync
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
> ;
Equivalent to listRuns
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.datacatalog.lineage.v1.IRun
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of process that owns this collection of runs.
*/
// const parent = 'abc123'
/**
* 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.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callListRuns
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
lineageClient
.
listRunsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListRuns
();
listRunsStream(request, options)
listRunsStream
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IListRunsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRunsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchLineageEventFromLineageEventName(lineageEventName)
matchLineageEventFromLineageEventName
(
lineageEventName
:
string
)
:
string
|
number
;
Parse the lineage_event from LineageEvent resource.
lineageEventName
string
A fully-qualified path representing LineageEvent resource.
string | number
{string} A string representing the lineage_event.
matchLocationFromLineageEventName(lineageEventName)
matchLocationFromLineageEventName
(
lineageEventName
:
string
)
:
string
|
number
;
Parse the location from LineageEvent resource.
lineageEventName
string
A fully-qualified path representing LineageEvent resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromProcessName(processName)
matchLocationFromProcessName
(
processName
:
string
)
:
string
|
number
;
Parse the location from Process resource.
processName
string
A fully-qualified path representing Process resource.
string | number
{string} A string representing the location.
matchLocationFromRunName(runName)
matchLocationFromRunName
(
runName
:
string
)
:
string
|
number
;
Parse the location from Run resource.
runName
string
A fully-qualified path representing Run resource.
string | number
{string} A string representing the location.
matchProcessFromLineageEventName(lineageEventName)
matchProcessFromLineageEventName
(
lineageEventName
:
string
)
:
string
|
number
;
Parse the process from LineageEvent resource.
lineageEventName
string
A fully-qualified path representing LineageEvent resource.
string | number
{string} A string representing the process.
matchProcessFromProcessName(processName)
matchProcessFromProcessName
(
processName
:
string
)
:
string
|
number
;
Parse the process from Process resource.
processName
string
A fully-qualified path representing Process resource.
string | number
{string} A string representing the process.
matchProcessFromRunName(runName)
matchProcessFromRunName
(
runName
:
string
)
:
string
|
number
;
Parse the process from Run resource.
runName
string
A fully-qualified path representing Run resource.
string | number
{string} A string representing the process.
matchProjectFromLineageEventName(lineageEventName)
matchProjectFromLineageEventName
(
lineageEventName
:
string
)
:
string
|
number
;
Parse the project from LineageEvent resource.
lineageEventName
string
A fully-qualified path representing LineageEvent resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromProcessName(processName)
matchProjectFromProcessName
(
processName
:
string
)
:
string
|
number
;
Parse the project from Process resource.
processName
string
A fully-qualified path representing Process resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromRunName(runName)
matchProjectFromRunName
(
runName
:
string
)
:
string
|
number
;
Parse the project from Run resource.
runName
string
A fully-qualified path representing Run resource.
string | number
{string} A string representing the project.
matchRunFromLineageEventName(lineageEventName)
matchRunFromLineageEventName
(
lineageEventName
:
string
)
:
string
|
number
;
Parse the run from LineageEvent resource.
lineageEventName
string
A fully-qualified path representing LineageEvent resource.
string | number
{string} A string representing the run.
matchRunFromRunName(runName)
matchRunFromRunName
(
runName
:
string
)
:
string
|
number
;
Parse the run from Run resource.
runName
string
A fully-qualified path representing Run resource.
string | number
{string} A string representing the run.
processOpenLineageRunEvent(request, options)
processOpenLineageRunEvent
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventResponse
,
(
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventRequest
|
undefined
),
{}
|
undefined
]>;
Creates new lineage events together with their parents: process and run. Updates the process and run if they already exist. Mapped from Open Lineage specification: https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json .
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventResponse
,
( protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing ProcessOpenLineageRunEventResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the project and its location that should own the
* process, run, and lineage event.
*/
// const parent = 'abc123'
/**
* Required. OpenLineage message following OpenLineage format:
* https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json
*/
// const openLineage = {}
/**
* 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.
*/
// const requestId = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callProcessOpenLineageRunEvent
()
{
// Construct request
const
request
=
{
parent
,
openLineage
,
};
// Run request
const
response
=
await
lineageClient
.
processOpenLineageRunEvent
(
request
);
console
.
log
(
response
);
}
callProcessOpenLineageRunEvent
();
processOpenLineageRunEvent(request, options, callback)
processOpenLineageRunEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventResponse
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventResponse
, protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest
| null | undefined, {} | null | undefined>
void
processOpenLineageRunEvent(request, callback)
processOpenLineageRunEvent
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventResponse
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcessOpenLineageRunEventRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventResponse
, protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest
| null | undefined, {} | null | undefined>
void
processPath(project, location, process)
processPath
(
project
:
string
,
location
:
string
,
process
:
string
)
:
string
;
Return a fully-qualified process resource name string.
project
string
location
string
process
string
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
runPath(project, location, process, run)
runPath
(
project
:
string
,
location
:
string
,
process
:
string
,
run
:
string
)
:
string
;
Return a fully-qualified run resource name string.
project
string
location
string
process
string
run
string
string
{string} Resource name string.
searchLinks(request, options)
searchLinks
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILink
[],
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
|
null
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksResponse
]>;
Retrieve a list of links connected to a specific asset. Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them.
You can retrieve links in every project where you have the datalineage.events.get
permission. The project provided in the URL is used for Billing and Quota.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.ILink
[], protos.google.cloud.datacatalog.lineage.v1.ISearchLinksRequest
| null, protos.google.cloud.datacatalog.lineage.v1.ISearchLinksResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Link
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using searchLinksAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
searchLinks(request, options, callback)
searchLinks
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILink
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.datacatalog.lineage.v1.ISearchLinksRequest
, protos.google.cloud.datacatalog.lineage.v1.ISearchLinksResponse
| null | undefined, protos.google.cloud.datacatalog.lineage.v1.ILink
>
void
searchLinks(request, callback)
searchLinks
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILink
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.datacatalog.lineage.v1.ISearchLinksRequest
, protos.google.cloud.datacatalog.lineage.v1.ISearchLinksResponse
| null | undefined, protos.google.cloud.datacatalog.lineage.v1.ILink
>
void
searchLinksAsync(request, options)
searchLinksAsync
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ILink
> ;
Equivalent to searchLinks
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.datacatalog.lineage.v1.ILink
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Link . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The project and location you want search in.
*/
// const parent = 'abc123'
/**
* Optional. Send asset information in the **source** field to retrieve all
* links that lead from the specified asset to downstream assets.
*/
// const source = {}
/**
* Optional. Send asset information in the **target** field to retrieve all
* links that lead from upstream assets to the specified asset.
*/
// const target = {}
/**
* Optional. The maximum number of links to return in a single page of the
* response. A page may contain fewer links than this value. If unspecified,
* at most 10 links are returned.
* Maximum value is 100; values greater than 100 are reduced to 100.
*/
// const pageSize = 1234
/**
* Optional. The page token received from a previous `SearchLinksRequest`
* call. Use it to get the next page.
* When requesting subsequent pages of a response, remember that
* all parameters must match the values you provided
* in the original request.
*/
// const pageToken = 'abc123'
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callSearchLinks
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
lineageClient
.
searchLinksAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callSearchLinks
();
searchLinksStream(request, options)
searchLinksStream
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
ISearchLinksRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Link
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using searchLinksAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
updateProcess(request, options)
updateProcess
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateProcessRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
(
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateProcessRequest
|
undefined
),
{}
|
undefined
]>;
Updates a process.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IProcess
,
( protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Process . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The lineage process to update.
* The process's `name` field is used to identify the process to update.
*/
// const process = {}
/**
* The list of fields to update. Currently not used. The whole message is
* updated.
*/
// const updateMask = {}
/**
* If set to true and the process is not found, the request inserts it.
*/
// const allowMissing = true
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callUpdateProcess
()
{
// Construct request
const
request
=
{
process
,
};
// Run request
const
response
=
await
lineageClient
.
updateProcess
(
request
);
console
.
log
(
response
);
}
callUpdateProcess
();
updateProcess(request, options, callback)
updateProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateProcessRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateProcessRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcess
, protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest
| null | undefined, {} | null | undefined>
void
updateProcess(request, callback)
updateProcess
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateProcessRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IProcess
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateProcessRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IProcess
, protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest
| null | undefined, {} | null | undefined>
void
updateRun(request, options)
updateRun
(
request
?:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateRunRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateRunRequest
|
undefined
,
{}
|
undefined
]>;
Updates a run.
request
options
Promise
<[ protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The lineage run to update.
* The run's `name` field is used to identify the run to update.
* Format:
* `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
*/
// const run = {}
/**
* The list of fields to update. Currently not used. The whole message is
* updated.
*/
// const updateMask = {}
/**
* If set to true and the run is not found, the request creates it.
*/
// const allowMissing = true
// Imports the Lineage library
const
{
LineageClient
}
=
require
(
' @google-cloud/lineage
'
).
v1
;
// Instantiates a client
const
lineageClient
=
new
LineageClient
();
async
function
callUpdateRun
()
{
// Construct request
const
request
=
{
run
,
};
// Run request
const
response
=
await
lineageClient
.
updateRun
(
request
);
console
.
log
(
response
);
}
callUpdateRun
();
updateRun(request, options, callback)
updateRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateRunRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest
| null | undefined, {} | null | undefined>
void
updateRun(request, callback)
updateRun
(
request
:
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateRunRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IRun
,
protos
.
google
.
cloud
.
datacatalog
.
lineage
.
v1
.
IUpdateRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.datacatalog.lineage.v1.IRun
, protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest
| null | undefined, {} | null | undefined>
void
