Package cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb (v1.26.0)

Variables

Run_State_name, Run_State_value

var (
	Run_State_name = map[int32]string{
		0: "UNKNOWN",
		1: "STARTED",
		2: "COMPLETED",
		3: "FAILED",
		4: "ABORTED",
	}
	Run_State_value = map[string]int32{
		"UNKNOWN":   0,
		"STARTED":   1,
		"COMPLETED": 2,
		"FAILED":    3,
		"ABORTED":   4,
	}
)

Enum value maps for Run_State.

OperationMetadata_State_name, OperationMetadata_State_value

var (
	OperationMetadata_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "RUNNING",
		3: "SUCCEEDED",
		4: "FAILED",
	}
	OperationMetadata_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"RUNNING":           2,
		"SUCCEEDED":         3,
		"FAILED":            4,
	}
)

Enum value maps for OperationMetadata_State.

OperationMetadata_Type_name, OperationMetadata_Type_value

var (
	OperationMetadata_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "DELETE",
		2: "CREATE",
	}
	OperationMetadata_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"DELETE":           1,
		"CREATE":           2,
	}
)

Enum value maps for OperationMetadata_Type.

Origin_SourceType_name, Origin_SourceType_value

var (
	Origin_SourceType_name = map[int32]string{
		0: "SOURCE_TYPE_UNSPECIFIED",
		1: "CUSTOM",
		2: "BIGQUERY",
		3: "DATA_FUSION",
		4: "COMPOSER",
		5: "LOOKER_STUDIO",
		6: "DATAPROC",
	}
	Origin_SourceType_value = map[string]int32{
		"SOURCE_TYPE_UNSPECIFIED": 0,
		"CUSTOM":                  1,
		"BIGQUERY":                2,
		"DATA_FUSION":             3,
		"COMPOSER":                4,
		"LOOKER_STUDIO":           5,
		"DATAPROC":                6,
	}
)

Enum value maps for Origin_SourceType.

File_google_cloud_datacatalog_lineage_v1_lineage_proto

var File_google_cloud_datacatalog_lineage_v1_lineage_proto protoreflect.FileDescriptor

Functions

func RegisterLineageServer

func RegisterLineageServer(s *grpc.Server, srv LineageServer)

BatchSearchLinkProcessesRequest

type BatchSearchLinkProcessesRequest struct {

	// Required. The project and location where you want to search.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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}`.
	Links []string `protobuf:"bytes,2,rep,name=links,proto3" json:"links,omitempty"`
	// The maximum number of processes to return in a single page of the response.
	// A page may contain fewer results than this value.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [BatchSearchLinkProcesses][google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses].

func (*BatchSearchLinkProcessesRequest) Descriptor

func (*BatchSearchLinkProcessesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchSearchLinkProcessesRequest.ProtoReflect.Descriptor instead.

func (x *BatchSearchLinkProcessesRequest) GetLinks() []string

func (*BatchSearchLinkProcessesRequest) GetPageSize

func (x *BatchSearchLinkProcessesRequest) GetPageSize() int32

func (*BatchSearchLinkProcessesRequest) GetPageToken

func (x *BatchSearchLinkProcessesRequest) GetPageToken() string

func (*BatchSearchLinkProcessesRequest) GetParent

func (x *BatchSearchLinkProcessesRequest) GetParent() string

func (*BatchSearchLinkProcessesRequest) ProtoMessage

func (*BatchSearchLinkProcessesRequest) ProtoMessage()

func (*BatchSearchLinkProcessesRequest) ProtoReflect

func (*BatchSearchLinkProcessesRequest) Reset

func (*BatchSearchLinkProcessesRequest) String

BatchSearchLinkProcessesResponse

type BatchSearchLinkProcessesResponse struct {

	// An array of processes associated with the specified links.
	ProcessLinks []*ProcessLinks `protobuf:"bytes,1,rep,name=process_links,json=processLinks,proto3" json:"process_links,omitempty"`
	// The token to specify as `page_token` in the subsequent call to get the next
	// page. Omitted if there are no more pages in the response.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [BatchSearchLinkProcesses][google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses].

func (*BatchSearchLinkProcessesResponse) Descriptor

func (*BatchSearchLinkProcessesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchSearchLinkProcessesResponse.ProtoReflect.Descriptor instead.

func (*BatchSearchLinkProcessesResponse) GetNextPageToken

func (x *BatchSearchLinkProcessesResponse) GetNextPageToken() string
func (x *BatchSearchLinkProcessesResponse) GetProcessLinks() []*ProcessLinks

func (*BatchSearchLinkProcessesResponse) ProtoMessage

func (*BatchSearchLinkProcessesResponse) ProtoMessage()

func (*BatchSearchLinkProcessesResponse) ProtoReflect

func (*BatchSearchLinkProcessesResponse) Reset

func (*BatchSearchLinkProcessesResponse) String

CreateLineageEventRequest

type CreateLineageEventRequest struct {

	// Required. The name of the run that should own the lineage event.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The lineage event to create.
	LineageEvent *LineageEvent `protobuf:"bytes,2,opt,name=lineage_event,json=lineageEvent,proto3" json:"lineage_event,omitempty"`
	// 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.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CreateLineageEvent][google.cloud.datacatalog.lineage.v1.CreateLineageEvent].

func (*CreateLineageEventRequest) Descriptor

func (*CreateLineageEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateLineageEventRequest.ProtoReflect.Descriptor instead.

func (*CreateLineageEventRequest) GetLineageEvent

func (x *CreateLineageEventRequest) GetLineageEvent() *LineageEvent

func (*CreateLineageEventRequest) GetParent

func (x *CreateLineageEventRequest) GetParent() string

func (*CreateLineageEventRequest) GetRequestId

func (x *CreateLineageEventRequest) GetRequestId() string

func (*CreateLineageEventRequest) ProtoMessage

func (*CreateLineageEventRequest) ProtoMessage()

func (*CreateLineageEventRequest) ProtoReflect

func (*CreateLineageEventRequest) Reset

func (x *CreateLineageEventRequest) Reset()

func (*CreateLineageEventRequest) String

func (x *CreateLineageEventRequest) String() string

CreateProcessRequest

type CreateProcessRequest struct {

	// Required. The name of the project and its location that should own the
	// process.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The process to create.
	Process *Process `protobuf:"bytes,2,opt,name=process,proto3" json:"process,omitempty"`
	// 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.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CreateProcess][google.cloud.datacatalog.lineage.v1.CreateProcess].

func (*CreateProcessRequest) Descriptor

func (*CreateProcessRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateProcessRequest.ProtoReflect.Descriptor instead.

func (*CreateProcessRequest) GetParent

func (x *CreateProcessRequest) GetParent() string

func (*CreateProcessRequest) GetProcess

func (x *CreateProcessRequest) GetProcess() *Process

func (*CreateProcessRequest) GetRequestId

func (x *CreateProcessRequest) GetRequestId() string

func (*CreateProcessRequest) ProtoMessage

func (*CreateProcessRequest) ProtoMessage()

func (*CreateProcessRequest) ProtoReflect

func (x *CreateProcessRequest) ProtoReflect() protoreflect.Message

func (*CreateProcessRequest) Reset

func (x *CreateProcessRequest) Reset()

func (*CreateProcessRequest) String

func (x *CreateProcessRequest) String() string

CreateRunRequest

type CreateRunRequest struct {

	// Required. The name of the process that should own the run.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The run to create.
	Run *Run `protobuf:"bytes,2,opt,name=run,proto3" json:"run,omitempty"`
	// 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.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CreateRun][google.cloud.datacatalog.lineage.v1.CreateRun].

func (*CreateRunRequest) Descriptor

func (*CreateRunRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateRunRequest.ProtoReflect.Descriptor instead.

func (*CreateRunRequest) GetParent

func (x *CreateRunRequest) GetParent() string

func (*CreateRunRequest) GetRequestId

func (x *CreateRunRequest) GetRequestId() string

func (*CreateRunRequest) GetRun

func (x *CreateRunRequest) GetRun() *Run

func (*CreateRunRequest) ProtoMessage

func (*CreateRunRequest) ProtoMessage()

func (*CreateRunRequest) ProtoReflect

func (x *CreateRunRequest) ProtoReflect() protoreflect.Message

func (*CreateRunRequest) Reset

func (x *CreateRunRequest) Reset()

func (*CreateRunRequest) String

func (x *CreateRunRequest) String() string

DeleteLineageEventRequest

type DeleteLineageEventRequest struct {

	// Required. The name of the lineage event to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true and the lineage event is not found, the request
	// succeeds but the server doesn't perform any actions.
	AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DeleteLineageEvent][google.cloud.datacatalog.lineage.v1.DeleteLineageEvent].

func (*DeleteLineageEventRequest) Descriptor

func (*DeleteLineageEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteLineageEventRequest.ProtoReflect.Descriptor instead.

func (*DeleteLineageEventRequest) GetAllowMissing

func (x *DeleteLineageEventRequest) GetAllowMissing() bool

func (*DeleteLineageEventRequest) GetName

func (x *DeleteLineageEventRequest) GetName() string

func (*DeleteLineageEventRequest) ProtoMessage

func (*DeleteLineageEventRequest) ProtoMessage()

func (*DeleteLineageEventRequest) ProtoReflect

func (*DeleteLineageEventRequest) Reset

func (x *DeleteLineageEventRequest) Reset()

func (*DeleteLineageEventRequest) String

func (x *DeleteLineageEventRequest) String() string

DeleteProcessRequest

type DeleteProcessRequest struct {

	// Required. The name of the process to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true and the process is not found, the request
	// succeeds but the server doesn't perform any actions.
	AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DeleteProcess][google.cloud.datacatalog.lineage.v1.DeleteProcess].

func (*DeleteProcessRequest) Descriptor

func (*DeleteProcessRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteProcessRequest.ProtoReflect.Descriptor instead.

func (*DeleteProcessRequest) GetAllowMissing

func (x *DeleteProcessRequest) GetAllowMissing() bool

func (*DeleteProcessRequest) GetName

func (x *DeleteProcessRequest) GetName() string

func (*DeleteProcessRequest) ProtoMessage

func (*DeleteProcessRequest) ProtoMessage()

func (*DeleteProcessRequest) ProtoReflect

func (x *DeleteProcessRequest) ProtoReflect() protoreflect.Message

func (*DeleteProcessRequest) Reset

func (x *DeleteProcessRequest) Reset()

func (*DeleteProcessRequest) String

func (x *DeleteProcessRequest) String() string

DeleteRunRequest

type DeleteRunRequest struct {

	// Required. The name of the run to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set to true and the run is not found, the request
	// succeeds but the server doesn't perform any actions.
	AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DeleteRun][google.cloud.datacatalog.lineage.v1.DeleteRun].

func (*DeleteRunRequest) Descriptor

func (*DeleteRunRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteRunRequest.ProtoReflect.Descriptor instead.

func (*DeleteRunRequest) GetAllowMissing

func (x *DeleteRunRequest) GetAllowMissing() bool

func (*DeleteRunRequest) GetName

func (x *DeleteRunRequest) GetName() string

func (*DeleteRunRequest) ProtoMessage

func (*DeleteRunRequest) ProtoMessage()

func (*DeleteRunRequest) ProtoReflect

func (x *DeleteRunRequest) ProtoReflect() protoreflect.Message

func (*DeleteRunRequest) Reset

func (x *DeleteRunRequest) Reset()

func (*DeleteRunRequest) String

func (x *DeleteRunRequest) String() string

EntityReference

type EntityReference struct {

	// Required. [Fully Qualified Name
	// (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names)
	// of the entity.
	FullyQualifiedName string `protobuf:"bytes,1,opt,name=fully_qualified_name,json=fullyQualifiedName,proto3" json:"fully_qualified_name,omitempty"`
	// contains filtered or unexported fields
}

The soft reference to everything you can attach a lineage event to.

func (*EntityReference) Descriptor

func (*EntityReference) Descriptor() ([]byte, []int)

Deprecated: Use EntityReference.ProtoReflect.Descriptor instead.

func (*EntityReference) GetFullyQualifiedName

func (x *EntityReference) GetFullyQualifiedName() string

func (*EntityReference) ProtoMessage

func (*EntityReference) ProtoMessage()

func (*EntityReference) ProtoReflect

func (x *EntityReference) ProtoReflect() protoreflect.Message

func (*EntityReference) Reset

func (x *EntityReference) Reset()

func (*EntityReference) String

func (x *EntityReference) String() string
type EventLink struct {

	// Required. Reference to the source entity
	Source *EntityReference `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	// Required. Reference to the target entity
	Target *EntityReference `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

A lineage between source and target entities.

func (*EventLink) Descriptor() ([]byte, []int)

Deprecated: Use EventLink.ProtoReflect.Descriptor instead.

func (x *EventLink) GetSource() *EntityReference
func (x *EventLink) GetTarget() *EntityReference
func (*EventLink) ProtoMessage()
func (x *EventLink) ProtoReflect() protoreflect.Message
func (x *EventLink) Reset()
func (x *EventLink) String() string

GetLineageEventRequest

type GetLineageEventRequest struct {

	// Required. The name of the lineage event to get.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GetLineageEvent][google.cloud.datacatalog.lineage.v1.GetLineageEvent].

func (*GetLineageEventRequest) Descriptor

func (*GetLineageEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetLineageEventRequest.ProtoReflect.Descriptor instead.

func (*GetLineageEventRequest) GetName

func (x *GetLineageEventRequest) GetName() string

func (*GetLineageEventRequest) ProtoMessage

func (*GetLineageEventRequest) ProtoMessage()

func (*GetLineageEventRequest) ProtoReflect

func (x *GetLineageEventRequest) ProtoReflect() protoreflect.Message

func (*GetLineageEventRequest) Reset

func (x *GetLineageEventRequest) Reset()

func (*GetLineageEventRequest) String

func (x *GetLineageEventRequest) String() string

GetProcessRequest

type GetProcessRequest struct {

	// Required. The name of the process to get.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GetProcess][google.cloud.datacatalog.lineage.v1.GetProcess].

func (*GetProcessRequest) Descriptor

func (*GetProcessRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetProcessRequest.ProtoReflect.Descriptor instead.

func (*GetProcessRequest) GetName

func (x *GetProcessRequest) GetName() string

func (*GetProcessRequest) ProtoMessage

func (*GetProcessRequest) ProtoMessage()

func (*GetProcessRequest) ProtoReflect

func (x *GetProcessRequest) ProtoReflect() protoreflect.Message

func (*GetProcessRequest) Reset

func (x *GetProcessRequest) Reset()

func (*GetProcessRequest) String

func (x *GetProcessRequest) String() string

GetRunRequest

type GetRunRequest struct {

	// Required. The name of the run to get.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GetRun][google.cloud.datacatalog.lineage.v1.GetRun].

func (*GetRunRequest) Descriptor

func (*GetRunRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRunRequest.ProtoReflect.Descriptor instead.

func (*GetRunRequest) GetName

func (x *GetRunRequest) GetName() string

func (*GetRunRequest) ProtoMessage

func (*GetRunRequest) ProtoMessage()

func (*GetRunRequest) ProtoReflect

func (x *GetRunRequest) ProtoReflect() protoreflect.Message

func (*GetRunRequest) Reset

func (x *GetRunRequest) Reset()

func (*GetRunRequest) String

func (x *GetRunRequest) String() string

LineageClient

type LineageClient interface {
	// 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.
	ProcessOpenLineageRunEvent(ctx context.Context, in *ProcessOpenLineageRunEventRequest, opts ...grpc.CallOption) (*ProcessOpenLineageRunEventResponse, error)
	// Creates a new process.
	CreateProcess(ctx context.Context, in *CreateProcessRequest, opts ...grpc.CallOption) (*Process, error)
	// Updates a process.
	UpdateProcess(ctx context.Context, in *UpdateProcessRequest, opts ...grpc.CallOption) (*Process, error)
	// Gets the details of the specified process.
	GetProcess(ctx context.Context, in *GetProcessRequest, opts ...grpc.CallOption) (*Process, error)
	// List processes in the given project and location. List order is descending
	// by insertion time.
	ListProcesses(ctx context.Context, in *ListProcessesRequest, opts ...grpc.CallOption) (*ListProcessesResponse, error)
	// Deletes the process with the specified name.
	DeleteProcess(ctx context.Context, in *DeleteProcessRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new run.
	CreateRun(ctx context.Context, in *CreateRunRequest, opts ...grpc.CallOption) (*Run, error)
	// Updates a run.
	UpdateRun(ctx context.Context, in *UpdateRunRequest, opts ...grpc.CallOption) (*Run, error)
	// Gets the details of the specified run.
	GetRun(ctx context.Context, in *GetRunRequest, opts ...grpc.CallOption) (*Run, error)
	// Lists runs in the given project and location. List order is descending by
	// `start_time`.
	ListRuns(ctx context.Context, in *ListRunsRequest, opts ...grpc.CallOption) (*ListRunsResponse, error)
	// Deletes the run with the specified name.
	DeleteRun(ctx context.Context, in *DeleteRunRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new lineage event.
	CreateLineageEvent(ctx context.Context, in *CreateLineageEventRequest, opts ...grpc.CallOption) (*LineageEvent, error)
	// Gets details of a specified lineage event.
	GetLineageEvent(ctx context.Context, in *GetLineageEventRequest, opts ...grpc.CallOption) (*LineageEvent, error)
	// Lists lineage events in the given project and location. The list order is
	// not defined.
	ListLineageEvents(ctx context.Context, in *ListLineageEventsRequest, opts ...grpc.CallOption) (*ListLineageEventsResponse, error)
	// Deletes the lineage event with the specified name.
	DeleteLineageEvent(ctx context.Context, in *DeleteLineageEventRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// 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.
	SearchLinks(ctx context.Context, in *SearchLinksRequest, opts ...grpc.CallOption) (*SearchLinksResponse, error)
	// 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][google.cloud.datacatalog.lineage.v1.Lineage.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.
	BatchSearchLinkProcesses(ctx context.Context, in *BatchSearchLinkProcessesRequest, opts ...grpc.CallOption) (*BatchSearchLinkProcessesResponse, error)
}

LineageClient is the client API for Lineage service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewLineageClient

func NewLineageClient(cc grpc.ClientConnInterface) LineageClient

LineageEvent

type LineageEvent struct {

	// Immutable. The resource name of the lineage event.
	// Format:
	// `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`.
	// Can be specified or auto-assigned.
	// {lineage_event} must be not longer than 200 characters and only
	// contain characters in a set: `a-zA-Z0-9_-:.`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. List of source-target pairs. Can't contain more than 100 tuples.
	Links []*EventLink `protobuf:"bytes,8,rep,name=links,proto3" json:"links,omitempty"`
	// Required. The beginning of the transformation which resulted in this
	// lineage event. For streaming scenarios, it should be the beginning of the
	// period from which the lineage is being reported.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Optional. The end of the transformation which resulted in this lineage
	// event.  For streaming scenarios, it should be the end of the period from
	// which the lineage is being reported.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.

func (*LineageEvent) Descriptor

func (*LineageEvent) Descriptor() ([]byte, []int)

Deprecated: Use LineageEvent.ProtoReflect.Descriptor instead.

func (*LineageEvent) GetEndTime

func (x *LineageEvent) GetEndTime() *timestamppb.Timestamp
func (x *LineageEvent) GetLinks() []*EventLink

func (*LineageEvent) GetName

func (x *LineageEvent) GetName() string

func (*LineageEvent) GetStartTime

func (x *LineageEvent) GetStartTime() *timestamppb.Timestamp

func (*LineageEvent) ProtoMessage

func (*LineageEvent) ProtoMessage()

func (*LineageEvent) ProtoReflect

func (x *LineageEvent) ProtoReflect() protoreflect.Message

func (*LineageEvent) Reset

func (x *LineageEvent) Reset()

func (*LineageEvent) String

func (x *LineageEvent) String() string

LineageServer

type LineageServer interface {
	// 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.
	ProcessOpenLineageRunEvent(context.Context, *ProcessOpenLineageRunEventRequest) (*ProcessOpenLineageRunEventResponse, error)
	// Creates a new process.
	CreateProcess(context.Context, *CreateProcessRequest) (*Process, error)
	// Updates a process.
	UpdateProcess(context.Context, *UpdateProcessRequest) (*Process, error)
	// Gets the details of the specified process.
	GetProcess(context.Context, *GetProcessRequest) (*Process, error)
	// List processes in the given project and location. List order is descending
	// by insertion time.
	ListProcesses(context.Context, *ListProcessesRequest) (*ListProcessesResponse, error)
	// Deletes the process with the specified name.
	DeleteProcess(context.Context, *DeleteProcessRequest) (*longrunningpb.Operation, error)
	// Creates a new run.
	CreateRun(context.Context, *CreateRunRequest) (*Run, error)
	// Updates a run.
	UpdateRun(context.Context, *UpdateRunRequest) (*Run, error)
	// Gets the details of the specified run.
	GetRun(context.Context, *GetRunRequest) (*Run, error)
	// Lists runs in the given project and location. List order is descending by
	// `start_time`.
	ListRuns(context.Context, *ListRunsRequest) (*ListRunsResponse, error)
	// Deletes the run with the specified name.
	DeleteRun(context.Context, *DeleteRunRequest) (*longrunningpb.Operation, error)
	// Creates a new lineage event.
	CreateLineageEvent(context.Context, *CreateLineageEventRequest) (*LineageEvent, error)
	// Gets details of a specified lineage event.
	GetLineageEvent(context.Context, *GetLineageEventRequest) (*LineageEvent, error)
	// Lists lineage events in the given project and location. The list order is
	// not defined.
	ListLineageEvents(context.Context, *ListLineageEventsRequest) (*ListLineageEventsResponse, error)
	// Deletes the lineage event with the specified name.
	DeleteLineageEvent(context.Context, *DeleteLineageEventRequest) (*emptypb.Empty, error)
	// 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.
	SearchLinks(context.Context, *SearchLinksRequest) (*SearchLinksResponse, error)
	// 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][google.cloud.datacatalog.lineage.v1.Lineage.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.
	BatchSearchLinkProcesses(context.Context, *BatchSearchLinkProcessesRequest) (*BatchSearchLinkProcessesResponse, error)
}

LineageServer is the server API for Lineage service.

type Link struct {

	// Output only. Immutable. The name of the link. Format:
	// `projects/{project}/locations/{location}/links/{link}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The pointer to the entity that is the **source** of this link.
	Source *EntityReference `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// The pointer to the entity that is the **target** of this link.
	Target *EntityReference `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// The start of the first event establishing this link.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The end of the last event establishing this link.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Links represent the data flow between source (upstream) and target (downstream) assets in transformation pipelines.

Links are created when LineageEvents record data transformation between related assets.

func (*Link) Descriptor() ([]byte, []int)

Deprecated: Use Link.ProtoReflect.Descriptor instead.

func (x *Link) GetEndTime() *timestamppb.Timestamp
func (x *Link) GetName() string
func (x *Link) GetSource() *EntityReference
func (x *Link) GetStartTime() *timestamppb.Timestamp
func (x *Link) GetTarget() *EntityReference
func (*Link) ProtoMessage()
func (x *Link) ProtoReflect() protoreflect.Message
func (x *Link) Reset()
func (x *Link) String() string

ListLineageEventsRequest

type ListLineageEventsRequest struct {

	// Required. The name of the run that owns the collection of lineage events to
	// get.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ListLineageEvents][google.cloud.datacatalog.lineage.v1.ListLineageEvents].

func (*ListLineageEventsRequest) Descriptor

func (*ListLineageEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListLineageEventsRequest.ProtoReflect.Descriptor instead.

func (*ListLineageEventsRequest) GetPageSize

func (x *ListLineageEventsRequest) GetPageSize() int32

func (*ListLineageEventsRequest) GetPageToken

func (x *ListLineageEventsRequest) GetPageToken() string

func (*ListLineageEventsRequest) GetParent

func (x *ListLineageEventsRequest) GetParent() string

func (*ListLineageEventsRequest) ProtoMessage

func (*ListLineageEventsRequest) ProtoMessage()

func (*ListLineageEventsRequest) ProtoReflect

func (x *ListLineageEventsRequest) ProtoReflect() protoreflect.Message

func (*ListLineageEventsRequest) Reset

func (x *ListLineageEventsRequest) Reset()

func (*ListLineageEventsRequest) String

func (x *ListLineageEventsRequest) String() string

ListLineageEventsResponse

type ListLineageEventsResponse struct {

	// Lineage events from the specified project and location.
	LineageEvents []*LineageEvent `protobuf:"bytes,1,rep,name=lineage_events,json=lineageEvents,proto3" json:"lineage_events,omitempty"`
	// The token to specify as `page_token` in the next call to get the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ListLineageEvents][google.cloud.datacatalog.lineage.v1.ListLineageEvents].

func (*ListLineageEventsResponse) Descriptor

func (*ListLineageEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListLineageEventsResponse.ProtoReflect.Descriptor instead.

func (*ListLineageEventsResponse) GetLineageEvents

func (x *ListLineageEventsResponse) GetLineageEvents() []*LineageEvent

func (*ListLineageEventsResponse) GetNextPageToken

func (x *ListLineageEventsResponse) GetNextPageToken() string

func (*ListLineageEventsResponse) ProtoMessage

func (*ListLineageEventsResponse) ProtoMessage()

func (*ListLineageEventsResponse) ProtoReflect

func (*ListLineageEventsResponse) Reset

func (x *ListLineageEventsResponse) Reset()

func (*ListLineageEventsResponse) String

func (x *ListLineageEventsResponse) String() string

ListProcessesRequest

type ListProcessesRequest struct {

	// Required. The name of the project and its location that owns this
	// collection of processes.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ListProcesses][google.cloud.datacatalog.lineage.v1.ListProcesses].

func (*ListProcessesRequest) Descriptor

func (*ListProcessesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListProcessesRequest.ProtoReflect.Descriptor instead.

func (*ListProcessesRequest) GetPageSize

func (x *ListProcessesRequest) GetPageSize() int32

func (*ListProcessesRequest) GetPageToken

func (x *ListProcessesRequest) GetPageToken() string

func (*ListProcessesRequest) GetParent

func (x *ListProcessesRequest) GetParent() string

func (*ListProcessesRequest) ProtoMessage

func (*ListProcessesRequest) ProtoMessage()

func (*ListProcessesRequest) ProtoReflect

func (x *ListProcessesRequest) ProtoReflect() protoreflect.Message

func (*ListProcessesRequest) Reset

func (x *ListProcessesRequest) Reset()

func (*ListProcessesRequest) String

func (x *ListProcessesRequest) String() string

ListProcessesResponse

type ListProcessesResponse struct {

	// The processes from the specified project and location.
	Processes []*Process `protobuf:"bytes,1,rep,name=processes,proto3" json:"processes,omitempty"`
	// The token to specify as `page_token` in the next call to get the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ListProcesses][google.cloud.datacatalog.lineage.v1.ListProcesses].

func (*ListProcessesResponse) Descriptor

func (*ListProcessesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListProcessesResponse.ProtoReflect.Descriptor instead.

func (*ListProcessesResponse) GetNextPageToken

func (x *ListProcessesResponse) GetNextPageToken() string

func (*ListProcessesResponse) GetProcesses

func (x *ListProcessesResponse) GetProcesses() []*Process

func (*ListProcessesResponse) ProtoMessage

func (*ListProcessesResponse) ProtoMessage()

func (*ListProcessesResponse) ProtoReflect

func (x *ListProcessesResponse) ProtoReflect() protoreflect.Message

func (*ListProcessesResponse) Reset

func (x *ListProcessesResponse) Reset()

func (*ListProcessesResponse) String

func (x *ListProcessesResponse) String() string

ListRunsRequest

type ListRunsRequest struct {

	// Required. The name of process that owns this collection of runs.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ListRuns][google.cloud.datacatalog.lineage.v1.ListRuns].

func (*ListRunsRequest) Descriptor

func (*ListRunsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRunsRequest.ProtoReflect.Descriptor instead.

func (*ListRunsRequest) GetPageSize

func (x *ListRunsRequest) GetPageSize() int32

func (*ListRunsRequest) GetPageToken

func (x *ListRunsRequest) GetPageToken() string

func (*ListRunsRequest) GetParent

func (x *ListRunsRequest) GetParent() string

func (*ListRunsRequest) ProtoMessage

func (*ListRunsRequest) ProtoMessage()

func (*ListRunsRequest) ProtoReflect

func (x *ListRunsRequest) ProtoReflect() protoreflect.Message

func (*ListRunsRequest) Reset

func (x *ListRunsRequest) Reset()

func (*ListRunsRequest) String

func (x *ListRunsRequest) String() string

ListRunsResponse

type ListRunsResponse struct {

	// The runs from the specified project and location.
	Runs []*Run `protobuf:"bytes,1,rep,name=runs,proto3" json:"runs,omitempty"`
	// The token to specify as `page_token` in the next call to get the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ListRuns][google.cloud.datacatalog.lineage.v1.ListRuns].

func (*ListRunsResponse) Descriptor

func (*ListRunsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListRunsResponse.ProtoReflect.Descriptor instead.

func (*ListRunsResponse) GetNextPageToken

func (x *ListRunsResponse) GetNextPageToken() string

func (*ListRunsResponse) GetRuns

func (x *ListRunsResponse) GetRuns() []*Run

func (*ListRunsResponse) ProtoMessage

func (*ListRunsResponse) ProtoMessage()

func (*ListRunsResponse) ProtoReflect

func (x *ListRunsResponse) ProtoReflect() protoreflect.Message

func (*ListRunsResponse) Reset

func (x *ListRunsResponse) Reset()

func (*ListRunsResponse) String

func (x *ListRunsResponse) String() string

OperationMetadata

type OperationMetadata struct {

	// Output only. The current operation state.
	State OperationMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.datacatalog.lineage.v1.OperationMetadata_State" json:"state,omitempty"`
	// Output only. The type of the operation being performed.
	OperationType OperationMetadata_Type `protobuf:"varint,2,opt,name=operation_type,json=operationType,proto3,enum=google.cloud.datacatalog.lineage.v1.OperationMetadata_Type" json:"operation_type,omitempty"`
	// Output only. The [relative name]
	// (https://cloud.google.com//apis/design/resource_names#relative_resource_name)
	// of the resource being operated on.
	Resource string `protobuf:"bytes,3,opt,name=resource,proto3" json:"resource,omitempty"`
	// Output only. The UUID of the resource being operated on.
	ResourceUuid string `protobuf:"bytes,4,opt,name=resource_uuid,json=resourceUuid,proto3" json:"resource_uuid,omitempty"`
	// Output only. The timestamp of the operation submission to the server.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp of the operation termination, regardless of its
	// success. This field is unset if the operation is still ongoing.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata describing the operation.

func (*OperationMetadata) Descriptor

func (*OperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetCreateTime

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndTime

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetOperationType

func (x *OperationMetadata) GetOperationType() OperationMetadata_Type

func (*OperationMetadata) GetResource

func (x *OperationMetadata) GetResource() string

func (*OperationMetadata) GetResourceUuid

func (x *OperationMetadata) GetResourceUuid() string

func (*OperationMetadata) GetState

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

func (x *OperationMetadata) ProtoReflect() protoreflect.Message

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

OperationMetadata_State

type OperationMetadata_State int32

An enum with the state of the operation.

OperationMetadata_STATE_UNSPECIFIED, OperationMetadata_PENDING, OperationMetadata_RUNNING, OperationMetadata_SUCCEEDED, OperationMetadata_FAILED

const (
	// Unused.
	OperationMetadata_STATE_UNSPECIFIED OperationMetadata_State = 0
	// The operation has been created but is not yet started.
	OperationMetadata_PENDING OperationMetadata_State = 1
	// The operation is underway.
	OperationMetadata_RUNNING OperationMetadata_State = 2
	// The operation completed successfully.
	OperationMetadata_SUCCEEDED OperationMetadata_State = 3
	// The operation is no longer running and did not succeed.
	OperationMetadata_FAILED OperationMetadata_State = 4
)

func (OperationMetadata_State) Descriptor

func (OperationMetadata_State) Enum

func (OperationMetadata_State) EnumDescriptor

func (OperationMetadata_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationMetadata_State.Descriptor instead.

func (OperationMetadata_State) Number

func (OperationMetadata_State) String

func (x OperationMetadata_State) String() string

func (OperationMetadata_State) Type

OperationMetadata_Type

type OperationMetadata_Type int32

Type of the long running operation.

OperationMetadata_TYPE_UNSPECIFIED, OperationMetadata_DELETE, OperationMetadata_CREATE

const (
	// Unused.
	OperationMetadata_TYPE_UNSPECIFIED OperationMetadata_Type = 0
	// The resource deletion operation.
	OperationMetadata_DELETE OperationMetadata_Type = 1
	// The resource creation operation.
	OperationMetadata_CREATE OperationMetadata_Type = 2
)

func (OperationMetadata_Type) Descriptor

func (OperationMetadata_Type) Enum

func (OperationMetadata_Type) EnumDescriptor

func (OperationMetadata_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationMetadata_Type.Descriptor instead.

func (OperationMetadata_Type) Number

func (OperationMetadata_Type) String

func (x OperationMetadata_Type) String() string

func (OperationMetadata_Type) Type

Origin

type Origin struct {

	// Type of the source.
	//
	// Use of a source_type other than `CUSTOM` for process creation
	// or updating is highly discouraged, and may be restricted in the future
	// without notice.
	SourceType Origin_SourceType `protobuf:"varint,1,opt,name=source_type,json=sourceType,proto3,enum=google.cloud.datacatalog.lineage.v1.Origin_SourceType" json:"source_type,omitempty"`
	// If the source_type isn't CUSTOM, the value of this field should be a GCP
	// resource name of the system, which reports lineage. The project and
	// location parts of the resource name must match the project and location of
	// the lineage resource being created. Examples:
	//
	//   - `{source_type: COMPOSER, name:
	//     "projects/foo/locations/us/environments/bar"}`
	//   - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}`
	//   - `{source_type: CUSTOM,   name: "myCustomIntegration"}`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Origin of a process.

func (*Origin) Descriptor

func (*Origin) Descriptor() ([]byte, []int)

Deprecated: Use Origin.ProtoReflect.Descriptor instead.

func (*Origin) GetName

func (x *Origin) GetName() string

func (*Origin) GetSourceType

func (x *Origin) GetSourceType() Origin_SourceType

func (*Origin) ProtoMessage

func (*Origin) ProtoMessage()

func (*Origin) ProtoReflect

func (x *Origin) ProtoReflect() protoreflect.Message

func (*Origin) Reset

func (x *Origin) Reset()

func (*Origin) String

func (x *Origin) String() string

Origin_SourceType

type Origin_SourceType int32

Type of the source of a process.

Origin_SOURCE_TYPE_UNSPECIFIED, Origin_CUSTOM, Origin_BIGQUERY, Origin_DATA_FUSION, Origin_COMPOSER, Origin_LOOKER_STUDIO, Origin_DATAPROC

const (
	// Source is Unspecified
	Origin_SOURCE_TYPE_UNSPECIFIED