Package lineage is an auto-generated package for the Data Lineage API.
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
ctx := context . Background () // 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. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := lineage . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () // 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. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := lineage . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & lineagepb . CreateProcessRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#CreateProcessRequest. } resp , err := c . CreateProcess ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
CreateProcess
[]
gax
.
CallOption
UpdateProcess
[]
gax
.
CallOption
GetProcess
[]
gax
.
CallOption
ListProcesses
[]
gax
.
CallOption
DeleteProcess
[]
gax
.
CallOption
CreateRun
[]
gax
.
CallOption
UpdateRun
[]
gax
.
CallOption
GetRun
[]
gax
.
CallOption
ListRuns
[]
gax
.
CallOption
DeleteRun
[]
gax
.
CallOption
CreateLineageEvent
[]
gax
.
CallOption
GetLineageEvent
[]
gax
.
CallOption
ListLineageEvents
[]
gax
.
CallOption
DeleteLineageEvent
[]
gax
.
CallOption
SearchLinks
[]
gax
.
CallOption
BatchSearchLinkProcesses
[]
gax
.
CallOption
CancelOperation
[]
gax
.
CallOption
DeleteOperation
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
Client is a client for interacting with Data Lineage API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
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.
func NewClient
NewClient creates a new lineage client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
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.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new lineage rest client.
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.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) BatchSearchLinkProcesses
func
(
c
*
Client
)
BatchSearchLinkProcesses
(
ctx
context
.
Context
,
req
*
lineagepb
.
BatchSearchLinkProcessesRequest
,
opts
...
gax
.
CallOption
)
*
ProcessLinksIterator
BatchSearchLinkProcesses 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 SearchLinks 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.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
BatchSearchLinkProcessesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#BatchSearchLinkProcessesRequest.
}
it
:=
c
.
BatchSearchLinkProcesses
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) CancelOperation
func
(
c
*
Client
)
CancelOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
CancelOperationRequest
,
opts
...
gax
.
CallOption
)
error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
CancelOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err
=
c
.
CancelOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) CreateLineageEvent
func
(
c
*
Client
)
CreateLineageEvent
(
ctx
context
.
Context
,
req
*
lineagepb
.
CreateLineageEventRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
LineageEvent
,
error
)
CreateLineageEvent creates a new lineage event.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
CreateLineageEventRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#CreateLineageEventRequest.
}
resp
,
err
:=
c
.
CreateLineageEvent
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) CreateProcess
func
(
c
*
Client
)
CreateProcess
(
ctx
context
.
Context
,
req
*
lineagepb
.
CreateProcessRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
Process
,
error
)
CreateProcess creates a new process.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
CreateProcessRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#CreateProcessRequest.
}
resp
,
err
:=
c
.
CreateProcess
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) CreateRun
func
(
c
*
Client
)
CreateRun
(
ctx
context
.
Context
,
req
*
lineagepb
.
CreateRunRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
Run
,
error
)
CreateRun creates a new run.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
CreateRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#CreateRunRequest.
}
resp
,
err
:=
c
.
CreateRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DeleteLineageEvent
func
(
c
*
Client
)
DeleteLineageEvent
(
ctx
context
.
Context
,
req
*
lineagepb
.
DeleteLineageEventRequest
,
opts
...
gax
.
CallOption
)
error
DeleteLineageEvent deletes the lineage event with the specified name.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
DeleteLineageEventRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#DeleteLineageEventRequest.
}
err
=
c
.
DeleteLineageEvent
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteOperation
func
(
c
*
Client
)
DeleteOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
DeleteOperationRequest
,
opts
...
gax
.
CallOption
)
error
DeleteOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
DeleteOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.
}
err
=
c
.
DeleteOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteProcess
func
(
c
*
Client
)
DeleteProcess
(
ctx
context
.
Context
,
req
*
lineagepb
.
DeleteProcessRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteProcessOperation
,
error
)
DeleteProcess deletes the process with the specified name.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
DeleteProcessRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#DeleteProcessRequest.
}
op
,
err
:=
c
.
DeleteProcess
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteProcessOperation
func
(
c
*
Client
)
DeleteProcessOperation
(
name
string
)
*
DeleteProcessOperation
DeleteProcessOperation returns a new DeleteProcessOperation from a given name. The name must be that of a previously created DeleteProcessOperation, possibly from a different process.
func (*Client) DeleteRun
func
(
c
*
Client
)
DeleteRun
(
ctx
context
.
Context
,
req
*
lineagepb
.
DeleteRunRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteRunOperation
,
error
)
DeleteRun deletes the run with the specified name.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
DeleteRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#DeleteRunRequest.
}
op
,
err
:=
c
.
DeleteRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteRunOperation
func
(
c
*
Client
)
DeleteRunOperation
(
name
string
)
*
DeleteRunOperation
DeleteRunOperation returns a new DeleteRunOperation from a given name. The name must be that of a previously created DeleteRunOperation, possibly from a different process.
func (*Client) GetLineageEvent
func
(
c
*
Client
)
GetLineageEvent
(
ctx
context
.
Context
,
req
*
lineagepb
.
GetLineageEventRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
LineageEvent
,
error
)
GetLineageEvent gets details of a specified lineage event.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
GetLineageEventRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#GetLineageEventRequest.
}
resp
,
err
:=
c
.
GetLineageEvent
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetOperation
func
(
c
*
Client
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
GetOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetProcess
func
(
c
*
Client
)
GetProcess
(
ctx
context
.
Context
,
req
*
lineagepb
.
GetProcessRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
Process
,
error
)
GetProcess gets the details of the specified process.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
GetProcessRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#GetProcessRequest.
}
resp
,
err
:=
c
.
GetProcess
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetRun
func
(
c
*
Client
)
GetRun
(
ctx
context
.
Context
,
req
*
lineagepb
.
GetRunRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
Run
,
error
)
GetRun gets the details of the specified run.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
GetRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#GetRunRequest.
}
resp
,
err
:=
c
.
GetRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListLineageEvents
func
(
c
*
Client
)
ListLineageEvents
(
ctx
context
.
Context
,
req
*
lineagepb
.
ListLineageEventsRequest
,
opts
...
gax
.
CallOption
)
*
LineageEventIterator
ListLineageEvents lists lineage events in the given project and location. The list order is not defined.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
ListLineageEventsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#ListLineageEventsRequest.
}
it
:=
c
.
ListLineageEvents
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListOperations
func
(
c
*
Client
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it
:=
c
.
ListOperations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListProcesses
func
(
c
*
Client
)
ListProcesses
(
ctx
context
.
Context
,
req
*
lineagepb
.
ListProcessesRequest
,
opts
...
gax
.
CallOption
)
*
ProcessIterator
ListProcesses list processes in the given project and location. List order is descending by insertion time.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
ListProcessesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#ListProcessesRequest.
}
it
:=
c
.
ListProcesses
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListRuns
func
(
c
*
Client
)
ListRuns
(
ctx
context
.
Context
,
req
*
lineagepb
.
ListRunsRequest
,
opts
...
gax
.
CallOption
)
*
RunIterator
ListRuns lists runs in the given project and location. List order is descending by start_time.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
ListRunsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#ListRunsRequest.
}
it
:=
c
.
ListRuns
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) SearchLinks
func
(
c
*
Client
)
SearchLinks
(
ctx
context
.
Context
,
req
*
lineagepb
.
SearchLinksRequest
,
opts
...
gax
.
CallOption
)
*
LinkIterator
SearchLinks 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.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
SearchLinksRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#SearchLinksRequest.
}
it
:=
c
.
SearchLinks
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) UpdateProcess
func
(
c
*
Client
)
UpdateProcess
(
ctx
context
.
Context
,
req
*
lineagepb
.
UpdateProcessRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
Process
,
error
)
UpdateProcess updates a process.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
UpdateProcessRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#UpdateProcessRequest.
}
resp
,
err
:=
c
.
UpdateProcess
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateRun
func
(
c
*
Client
)
UpdateRun
(
ctx
context
.
Context
,
req
*
lineagepb
.
UpdateRunRequest
,
opts
...
gax
.
CallOption
)
(
*
lineagepb
.
Run
,
error
)
UpdateRun updates a run.
Example
package
main
import
(
"context"
lineage
"cloud.google.com/go/datacatalog/lineage/apiv1"
lineagepb
"cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
lineage
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& lineagepb
.
UpdateRunRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb#UpdateRunRequest.
}
resp
,
err
:=
c
.
UpdateRun
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
DeleteProcessOperation
type
DeleteProcessOperation
struct
{
// contains filtered or unexported fields
}
DeleteProcessOperation manages a long-running operation from DeleteProcess.
func (*DeleteProcessOperation) Done
func
(
op
*
DeleteProcessOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteProcessOperation) Metadata
func
(
op
*
DeleteProcessOperation
)
Metadata
()
(
*
lineagepb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteProcessOperation) Name
func
(
op
*
DeleteProcessOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteProcessOperation) Poll
func
(
op
*
DeleteProcessOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteProcessOperation) Wait
func
(
op
*
DeleteProcessOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteRunOperation
type
DeleteRunOperation
struct
{
// contains filtered or unexported fields
}
DeleteRunOperation manages a long-running operation from DeleteRun.
func (*DeleteRunOperation) Done
func
(
op
*
DeleteRunOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteRunOperation) Metadata
func
(
op
*
DeleteRunOperation
)
Metadata
()
(
*
lineagepb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteRunOperation) Name
func
(
op
*
DeleteRunOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteRunOperation) Poll
func
(
op
*
DeleteRunOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteRunOperation) Wait
func
(
op
*
DeleteRunOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
LineageEventIterator
type
LineageEventIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
lineagepb
.
LineageEvent
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LineageEventIterator manages a stream of *lineagepb.LineageEvent.
func (*LineageEventIterator) Next
func
(
it
*
LineageEventIterator
)
Next
()
(
*
lineagepb
.
LineageEvent
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LineageEventIterator) PageInfo
func
(
it
*
LineageEventIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
LinkIterator
type
LinkIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
lineagepb
.
Link
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LinkIterator manages a stream of *lineagepb.Link.
func (*LinkIterator) Next
func
(
it
*
LinkIterator
)
Next
()
(
*
lineagepb
.
Link
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LinkIterator) PageInfo
func
(
it
*
LinkIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
OperationIterator
type
OperationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
longrunningpb
.
Operation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) Next
func
(
it
*
OperationIterator
)
Next
()
(
*
longrunningpb
.
Operation
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func
(
it
*
OperationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ProcessIterator
type
ProcessIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
lineagepb
.
Process
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ProcessIterator manages a stream of *lineagepb.Process.
func (*ProcessIterator) Next
func
(
it
*
ProcessIterator
)
Next
()
(
*
lineagepb
.
Process
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ProcessIterator) PageInfo
func
(
it
*
ProcessIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ProcessLinksIterator
type
ProcessLinksIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
lineagepb
.
ProcessLinks
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ProcessLinksIterator manages a stream of *lineagepb.ProcessLinks.
func (*ProcessLinksIterator) Next
func
(
it
*
ProcessLinksIterator
)
Next
()
(
*
lineagepb
.
ProcessLinks
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ProcessLinksIterator) PageInfo
func
(
it
*
ProcessLinksIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
RunIterator
type
RunIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
lineagepb
.
Run
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
RunIterator manages a stream of *lineagepb.Run.
func (*RunIterator) Next
func
(
it
*
RunIterator
)
Next
()
(
*
lineagepb
.
Run
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*RunIterator) PageInfo
func
(
it
*
RunIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
