datacatalog

package
v1.13.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 2, 2024 License: Apache-2.0 Imports: 11 Imported by: 11

Documentation

Index

Constants

View Source 
const (
	DataCatalog_CreateDataset_FullMethodName          = "/datacatalog.DataCatalog/CreateDataset"
	DataCatalog_GetDataset_FullMethodName             = "/datacatalog.DataCatalog/GetDataset"
	DataCatalog_CreateArtifact_FullMethodName         = "/datacatalog.DataCatalog/CreateArtifact"
	DataCatalog_GetArtifact_FullMethodName            = "/datacatalog.DataCatalog/GetArtifact"
	DataCatalog_AddTag_FullMethodName                 = "/datacatalog.DataCatalog/AddTag"
	DataCatalog_ListArtifacts_FullMethodName          = "/datacatalog.DataCatalog/ListArtifacts"
	DataCatalog_ListDatasets_FullMethodName           = "/datacatalog.DataCatalog/ListDatasets"
	DataCatalog_UpdateArtifact_FullMethodName         = "/datacatalog.DataCatalog/UpdateArtifact"
	DataCatalog_GetOrExtendReservation_FullMethodName = "/datacatalog.DataCatalog/GetOrExtendReservation"
	DataCatalog_ReleaseReservation_FullMethodName     = "/datacatalog.DataCatalog/ReleaseReservation"
)

Variables

View Source 
var (
	SinglePropertyFilter_ComparisonOperator_name = map[int32]string{
		0: "EQUALS",
	}
	SinglePropertyFilter_ComparisonOperator_value = map[string]int32{
		"EQUALS": 0,
	}
)

Enum value maps for SinglePropertyFilter_ComparisonOperator.

View Source 
var (
	PaginationOptions_SortOrder_name = map[int32]string{
		0: "DESCENDING",
		1: "ASCENDING",
	}
	PaginationOptions_SortOrder_value = map[string]int32{
		"DESCENDING": 0,
		"ASCENDING":  1,
	}
)

Enum value maps for PaginationOptions_SortOrder.

View Source 
var (
	PaginationOptions_SortKey_name = map[int32]string{
		0: "CREATION_TIME",
	}
	PaginationOptions_SortKey_value = map[string]int32{
		"CREATION_TIME": 0,
	}
)

Enum value maps for PaginationOptions_SortKey.

View Source 
var DataCatalog_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "datacatalog.DataCatalog",
	HandlerType: (*DataCatalogServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateDataset",
			Handler:    _DataCatalog_CreateDataset_Handler,
		},
		{
			MethodName: "GetDataset",
			Handler:    _DataCatalog_GetDataset_Handler,
		},
		{
			MethodName: "CreateArtifact",
			Handler:    _DataCatalog_CreateArtifact_Handler,
		},
		{
			MethodName: "GetArtifact",
			Handler:    _DataCatalog_GetArtifact_Handler,
		},
		{
			MethodName: "AddTag",
			Handler:    _DataCatalog_AddTag_Handler,
		},
		{
			MethodName: "ListArtifacts",
			Handler:    _DataCatalog_ListArtifacts_Handler,
		},
		{
			MethodName: "ListDatasets",
			Handler:    _DataCatalog_ListDatasets_Handler,
		},
		{
			MethodName: "UpdateArtifact",
			Handler:    _DataCatalog_UpdateArtifact_Handler,
		},
		{
			MethodName: "GetOrExtendReservation",
			Handler:    _DataCatalog_GetOrExtendReservation_Handler,
		},
		{
			MethodName: "ReleaseReservation",
			Handler:    _DataCatalog_ReleaseReservation_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "flyteidl/datacatalog/datacatalog.proto",
}

DataCatalog_ServiceDesc is the grpc.ServiceDesc for DataCatalog service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_flyteidl_datacatalog_datacatalog_proto protoreflect.FileDescriptor

Functions

func RegisterDataCatalogServer 

func RegisterDataCatalogServer(s grpc.ServiceRegistrar, srv DataCatalogServer)

Types

type AddTagRequest 

type AddTagRequest struct {
	Tag *Tag `protobuf:"bytes,1,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

Request message for tagging an Artifact.

func (*AddTagRequest) Descriptor deprecated 

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

Deprecated: Use AddTagRequest.ProtoReflect.Descriptor instead.

func (*AddTagRequest) GetTag 

func (x *AddTagRequest) GetTag() *Tag

func (*AddTagRequest) ProtoMessage 

func (*AddTagRequest) ProtoMessage()

func (*AddTagRequest) ProtoReflect added in v1.10.7 

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

func (*AddTagRequest) Reset 

func (x *AddTagRequest) Reset()

func (*AddTagRequest) String 

func (x *AddTagRequest) String() string

type AddTagResponse 

type AddTagResponse struct {
	// contains filtered or unexported fields
}

Response message for tagging an Artifact.

func (*AddTagResponse) Descriptor deprecated 

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

Deprecated: Use AddTagResponse.ProtoReflect.Descriptor instead.

func (*AddTagResponse) ProtoMessage 

func (*AddTagResponse) ProtoMessage()

func (*AddTagResponse) ProtoReflect added in v1.10.7 

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

func (*AddTagResponse) Reset 

func (x *AddTagResponse) Reset()

func (*AddTagResponse) String 

func (x *AddTagResponse) String() string

type Artifact 

type Artifact struct {
	Id         string                 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`             // The unique ID of the artifact
	Dataset    *DatasetID             `protobuf:"bytes,2,opt,name=dataset,proto3" json:"dataset,omitempty"`   // The Dataset that the artifact belongs to
	Data       []*ArtifactData        `protobuf:"bytes,3,rep,name=data,proto3" json:"data,omitempty"`         // A list of data that is associated with the artifact
	Metadata   *Metadata              `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"` // Free-form metadata associated with the artifact
	Partitions []*Partition           `protobuf:"bytes,5,rep,name=partitions,proto3" json:"partitions,omitempty"`
	Tags       []*Tag                 `protobuf:"bytes,6,rep,name=tags,proto3" json:"tags,omitempty"`
	CreatedAt  *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` // creation timestamp of artifact, autogenerated by service
	// contains filtered or unexported fields
}

Artifact message. It is composed of several string fields.

func (*Artifact) Descriptor deprecated 

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

Deprecated: Use Artifact.ProtoReflect.Descriptor instead.

func (*Artifact) GetCreatedAt 

func (x *Artifact) GetCreatedAt() *timestamppb.Timestamp

func (*Artifact) GetData 

func (x *Artifact) GetData() []*ArtifactData

func (*Artifact) GetDataset 

func (x *Artifact) GetDataset() *DatasetID

func (*Artifact) GetId 

func (x *Artifact) GetId() string

func (*Artifact) GetMetadata 

func (x *Artifact) GetMetadata() *Metadata

func (*Artifact) GetPartitions 

func (x *Artifact) GetPartitions() []*Partition

func (*Artifact) GetTags 

func (x *Artifact) GetTags() []*Tag

func (*Artifact) ProtoMessage 

func (*Artifact) ProtoMessage()

func (*Artifact) ProtoReflect added in v1.10.7 

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

func (*Artifact) Reset 

func (x *Artifact) Reset()

func (*Artifact) String 

func (x *Artifact) String() string

type ArtifactData 

type ArtifactData struct {
	Name  string        `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value *core.Literal `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

ArtifactData that belongs to an artifact

func (*ArtifactData) Descriptor deprecated 

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

Deprecated: Use ArtifactData.ProtoReflect.Descriptor instead.

func (*ArtifactData) GetName 

func (x *ArtifactData) GetName() string

func (*ArtifactData) GetValue 

func (x *ArtifactData) GetValue() *core.Literal

func (*ArtifactData) ProtoMessage 

func (*ArtifactData) ProtoMessage()

func (*ArtifactData) ProtoReflect added in v1.10.7 

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

func (*ArtifactData) Reset 

func (x *ArtifactData) Reset()

func (*ArtifactData) String 

func (x *ArtifactData) String() string

type ArtifactPropertyFilter 

type ArtifactPropertyFilter struct {

	// oneof because we can add more properties in the future
	//
	// Types that are assignable to Property:
	//
	//	*ArtifactPropertyFilter_ArtifactId
	Property isArtifactPropertyFilter_Property `protobuf_oneof:"property"`
	// contains filtered or unexported fields
}

Artifact properties we can filter by

func (*ArtifactPropertyFilter) Descriptor deprecated 

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

Deprecated: Use ArtifactPropertyFilter.ProtoReflect.Descriptor instead.

func (*ArtifactPropertyFilter) GetArtifactId 

func (x *ArtifactPropertyFilter) GetArtifactId() string

func (*ArtifactPropertyFilter) GetProperty 

func (m *ArtifactPropertyFilter) GetProperty() isArtifactPropertyFilter_Property

func (*ArtifactPropertyFilter) ProtoMessage 

func (*ArtifactPropertyFilter) ProtoMessage()

func (*ArtifactPropertyFilter) ProtoReflect added in v1.10.7 

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

func (*ArtifactPropertyFilter) Reset 

func (x *ArtifactPropertyFilter) Reset()

func (*ArtifactPropertyFilter) String 

func (x *ArtifactPropertyFilter) String() string

type ArtifactPropertyFilter_ArtifactId 

type ArtifactPropertyFilter_ArtifactId struct {
	ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3,oneof"`
}

type CreateArtifactRequest 

type CreateArtifactRequest struct {
	Artifact *Artifact `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// contains filtered or unexported fields
}

Request message for creating an Artifact and its associated artifact Data.

func (*CreateArtifactRequest) Descriptor deprecated 

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

Deprecated: Use CreateArtifactRequest.ProtoReflect.Descriptor instead.

func (*CreateArtifactRequest) GetArtifact 

func (x *CreateArtifactRequest) GetArtifact() *Artifact

func (*CreateArtifactRequest) ProtoMessage 

func (*CreateArtifactRequest) ProtoMessage()

func (*CreateArtifactRequest) ProtoReflect added in v1.10.7 

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

func (*CreateArtifactRequest) Reset 

func (x *CreateArtifactRequest) Reset()

func (*CreateArtifactRequest) String 

func (x *CreateArtifactRequest) String() string

type CreateArtifactResponse 

type CreateArtifactResponse struct {
	// contains filtered or unexported fields
}

Response message for creating an Artifact.

func (*CreateArtifactResponse) Descriptor deprecated 

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

Deprecated: Use CreateArtifactResponse.ProtoReflect.Descriptor instead.

func (*CreateArtifactResponse) ProtoMessage 

func (*CreateArtifactResponse) ProtoMessage()

func (*CreateArtifactResponse) ProtoReflect added in v1.10.7 

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

func (*CreateArtifactResponse) Reset 

func (x *CreateArtifactResponse) Reset()

func (*CreateArtifactResponse) String 

func (x *CreateArtifactResponse) String() string

type CreateDatasetRequest 

type CreateDatasetRequest struct {
	Dataset *Dataset `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// contains filtered or unexported fields
}

Request message for creating a Dataset.

func (*CreateDatasetRequest) Descriptor deprecated 

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

Deprecated: Use CreateDatasetRequest.ProtoReflect.Descriptor instead.

func (*CreateDatasetRequest) GetDataset 

func (x *CreateDatasetRequest) GetDataset() *Dataset

func (*CreateDatasetRequest) ProtoMessage 

func (*CreateDatasetRequest) ProtoMessage()

func (*CreateDatasetRequest) ProtoReflect added in v1.10.7 

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

func (*CreateDatasetRequest) Reset 

func (x *CreateDatasetRequest) Reset()

func (*CreateDatasetRequest) String 

func (x *CreateDatasetRequest) String() string

type CreateDatasetResponse 

type CreateDatasetResponse struct {
	// contains filtered or unexported fields
}

Response message for creating a Dataset

func (*CreateDatasetResponse) Descriptor deprecated 

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

Deprecated: Use CreateDatasetResponse.ProtoReflect.Descriptor instead.

func (*CreateDatasetResponse) ProtoMessage 

func (*CreateDatasetResponse) ProtoMessage()

func (*CreateDatasetResponse) ProtoReflect added in v1.10.7 

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

func (*CreateDatasetResponse) Reset 

func (x *CreateDatasetResponse) Reset()

func (*CreateDatasetResponse) String 

func (x *CreateDatasetResponse) String() string

type DataCatalogClient 

type DataCatalogClient interface {
	// Create a new Dataset. Datasets are unique based on the DatasetID. Datasets are logical groupings of artifacts.
	// Each dataset can have one or more artifacts
	CreateDataset(ctx context.Context, in *CreateDatasetRequest, opts ...grpc.CallOption) (*CreateDatasetResponse, error)
	// Get a Dataset by the DatasetID. This returns the Dataset with the associated metadata.
	GetDataset(ctx context.Context, in *GetDatasetRequest, opts ...grpc.CallOption) (*GetDatasetResponse, error)
	// Create an artifact and the artifact data associated with it. An artifact can be a hive partition or arbitrary
	// files or data values
	CreateArtifact(ctx context.Context, in *CreateArtifactRequest, opts ...grpc.CallOption) (*CreateArtifactResponse, error)
	// Retrieve an artifact by an identifying handle. This returns an artifact along with the artifact data.
	GetArtifact(ctx context.Context, in *GetArtifactRequest, opts ...grpc.CallOption) (*GetArtifactResponse, error)
	// Associate a tag with an artifact. Tags are unique within a Dataset.
	AddTag(ctx context.Context, in *AddTagRequest, opts ...grpc.CallOption) (*AddTagResponse, error)
	// Return a paginated list of artifacts
	ListArtifacts(ctx context.Context, in *ListArtifactsRequest, opts ...grpc.CallOption) (*ListArtifactsResponse, error)
	// Return a paginated list of datasets
	ListDatasets(ctx context.Context, in *ListDatasetsRequest, opts ...grpc.CallOption) (*ListDatasetsResponse, error)
	// Updates an existing artifact, overwriting the stored artifact data in the underlying blob storage.
	UpdateArtifact(ctx context.Context, in *UpdateArtifactRequest, opts ...grpc.CallOption) (*UpdateArtifactResponse, error)
	// Attempts to get or extend a reservation for the corresponding artifact. If one already exists
	// (ie. another entity owns the reservation) then that reservation is retrieved.
	// Once you acquire a reservation, you need to  periodically extend the reservation with an
	// identical call. If the reservation is not extended before the defined expiration, it may be
	// acquired by another task.
	// Note: We may have multiple concurrent tasks with the same signature and the same input that
	// try to populate the same artifact at the same time. Thus with reservation, only one task can
	// run at a time, until the reservation expires.
	// Note: If task A does not extend the reservation in time and the reservation expires, another
	// task B may take over the reservation, resulting in two tasks A and B running in parallel. So
	// a third task C may get the Artifact from A or B, whichever writes last.
	GetOrExtendReservation(ctx context.Context, in *GetOrExtendReservationRequest, opts ...grpc.CallOption) (*GetOrExtendReservationResponse, error)
	// Release the reservation when the task holding the spot fails so that the other tasks
	// can grab the spot.
	ReleaseReservation(ctx context.Context, in *ReleaseReservationRequest, opts ...grpc.CallOption) (*ReleaseReservationResponse, error)
}

DataCatalogClient is the client API for DataCatalog service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDataCatalogClient 

func NewDataCatalogClient(cc grpc.ClientConnInterface) DataCatalogClient

type DataCatalogServer 

type DataCatalogServer interface {
	// Create a new Dataset. Datasets are unique based on the DatasetID. Datasets are logical groupings of artifacts.
	// Each dataset can have one or more artifacts
	CreateDataset(context.Context, *CreateDatasetRequest) (*CreateDatasetResponse, error)
	// Get a Dataset by the DatasetID. This returns the Dataset with the associated metadata.
	GetDataset(context.Context, *GetDatasetRequest) (*GetDatasetResponse, error)
	// Create an artifact and the artifact data associated with it. An artifact can be a hive partition or arbitrary
	// files or data values
	CreateArtifact(context.Context, *CreateArtifactRequest) (*CreateArtifactResponse, error)
	// Retrieve an artifact by an identifying handle. This returns an artifact along with the artifact data.
	GetArtifact(context.Context, *GetArtifactRequest) (*GetArtifactResponse, error)
	// Associate a tag with an artifact. Tags are unique within a Dataset.
	AddTag(context.Context, *AddTagRequest) (*AddTagResponse, error)
	// Return a paginated list of artifacts
	ListArtifacts(context.Context, *ListArtifactsRequest) (*ListArtifactsResponse, error)
	// Return a paginated list of datasets
	ListDatasets(context.Context, *ListDatasetsRequest) (*ListDatasetsResponse, error)
	// Updates an existing artifact, overwriting the stored artifact data in the underlying blob storage.
	UpdateArtifact(context.Context, *UpdateArtifactRequest) (*UpdateArtifactResponse, error)
	// Attempts to get or extend a reservation for the corresponding artifact. If one already exists
	// (ie. another entity owns the reservation) then that reservation is retrieved.
	// Once you acquire a reservation, you need to  periodically extend the reservation with an
	// identical call. If the reservation is not extended before the defined expiration, it may be
	// acquired by another task.
	// Note: We may have multiple concurrent tasks with the same signature and the same input that
	// try to populate the same artifact at the same time. Thus with reservation, only one task can
	// run at a time, until the reservation expires.
	// Note: If task A does not extend the reservation in time and the reservation expires, another
	// task B may take over the reservation, resulting in two tasks A and B running in parallel. So
	// a third task C may get the Artifact from A or B, whichever writes last.
	GetOrExtendReservation(context.Context, *GetOrExtendReservationRequest) (*GetOrExtendReservationResponse, error)
	// Release the reservation when the task holding the spot fails so that the other tasks
	// can grab the spot.
	ReleaseReservation(context.Context, *ReleaseReservationRequest) (*ReleaseReservationResponse, error)
}

DataCatalogServer is the server API for DataCatalog service. All implementations should embed UnimplementedDataCatalogServer for forward compatibility

type Dataset 

type Dataset struct {
	Id            *DatasetID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Metadata      *Metadata  `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	PartitionKeys []string   `protobuf:"bytes,3,rep,name=partitionKeys,proto3" json:"partitionKeys,omitempty"`
	// contains filtered or unexported fields
}

Dataset message. It is uniquely identified by DatasetID.

func (*Dataset) Descriptor deprecated 

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

Deprecated: Use Dataset.ProtoReflect.Descriptor instead.

func (*Dataset) GetId 

func (x *Dataset) GetId() *DatasetID

func (*Dataset) GetMetadata 

func (x *Dataset) GetMetadata() *Metadata

func (*Dataset) GetPartitionKeys 

func (x *Dataset) GetPartitionKeys() []string

func (*Dataset) ProtoMessage 

func (*Dataset) ProtoMessage()

func (*Dataset) ProtoReflect added in v1.10.7 

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

func (*Dataset) Reset 

func (x *Dataset) Reset()

func (*Dataset) String 

func (x *Dataset) String() string

type DatasetID 

type DatasetID struct {
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // The name of the project
	Name    string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`       // The name of the dataset
	Domain  string `protobuf:"bytes,3,opt,name=domain,proto3" json:"domain,omitempty"`   // The domain (eg. environment)
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"` // Version of the data schema
	UUID    string `protobuf:"bytes,5,opt,name=UUID,proto3" json:"UUID,omitempty"`       // UUID for the dataset (if set the above fields are optional)
	// Optional, org key applied to the resource.
	Org string `protobuf:"bytes,6,opt,name=org,proto3" json:"org,omitempty"`
	// contains filtered or unexported fields
}

DatasetID message that is composed of several string fields.

func (*DatasetID) Descriptor deprecated 

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

Deprecated: Use DatasetID.ProtoReflect.Descriptor instead.

func (*DatasetID) GetDomain 

func (x *DatasetID) GetDomain() string

func (*DatasetID) GetName 

func (x *DatasetID) GetName() string

func (*DatasetID) GetOrg added in v1.10.7 

func (x *DatasetID) GetOrg() string

func (*DatasetID) GetProject 

func (x *DatasetID) GetProject() string

func (*DatasetID) GetUUID 

func (x *DatasetID) GetUUID() string

func (*DatasetID) GetVersion 

func (x *DatasetID) GetVersion() string

func (*DatasetID) ProtoMessage 

func (*DatasetID) ProtoMessage()

func (*DatasetID) ProtoReflect added in v1.10.7 

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

func (*DatasetID) Reset 

func (x *DatasetID) Reset()

func (*DatasetID) String 

func (x *DatasetID) String() string

type DatasetPropertyFilter 

type DatasetPropertyFilter struct {

	// Types that are assignable to Property:
	//
	//	*DatasetPropertyFilter_Project
	//	*DatasetPropertyFilter_Name
	//	*DatasetPropertyFilter_Domain
	//	*DatasetPropertyFilter_Version
	//	*DatasetPropertyFilter_Org
	Property isDatasetPropertyFilter_Property `protobuf_oneof:"property"`
	// contains filtered or unexported fields
}

Dataset properties we can filter by

func (*DatasetPropertyFilter) Descriptor deprecated 

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

Deprecated: Use DatasetPropertyFilter.ProtoReflect.Descriptor instead.

func (*DatasetPropertyFilter) GetDomain 

func (x *DatasetPropertyFilter) GetDomain() string

func (*DatasetPropertyFilter) GetName 

func (x *DatasetPropertyFilter) GetName() string

func (*DatasetPropertyFilter) GetOrg added in v1.10.7 

func (x *DatasetPropertyFilter) GetOrg() string

func (*DatasetPropertyFilter) GetProject 

func (x *DatasetPropertyFilter) GetProject() string

func (*DatasetPropertyFilter) GetProperty 

func (m *DatasetPropertyFilter) GetProperty() isDatasetPropertyFilter_Property

func (*DatasetPropertyFilter) GetVersion 

func (x *DatasetPropertyFilter) GetVersion() string

func (*DatasetPropertyFilter) ProtoMessage 

func (*DatasetPropertyFilter) ProtoMessage()

func (*DatasetPropertyFilter) ProtoReflect added in v1.10.7 

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

func (*DatasetPropertyFilter) Reset 

func (x *DatasetPropertyFilter) Reset()

func (*DatasetPropertyFilter) String 

func (x *DatasetPropertyFilter) String() string

type DatasetPropertyFilter_Domain 

type DatasetPropertyFilter_Domain struct {
	Domain string `protobuf:"bytes,3,opt,name=domain,proto3,oneof"`
}

type DatasetPropertyFilter_Name 

type DatasetPropertyFilter_Name struct {
	Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}

type DatasetPropertyFilter_Org added in v1.10.7 

type DatasetPropertyFilter_Org struct {
	// Optional, org key applied to the dataset.
	Org string `protobuf:"bytes,5,opt,name=org,proto3,oneof"`
}

type DatasetPropertyFilter_Project 

type DatasetPropertyFilter_Project struct {
	Project string `protobuf:"bytes,1,opt,name=project,proto3,oneof"`
}

type DatasetPropertyFilter_Version 

type DatasetPropertyFilter_Version struct {
	Version string `protobuf:"bytes,4,opt,name=version,proto3,oneof"`
}

type FilterExpression 

type FilterExpression struct {
	Filters []*SinglePropertyFilter `protobuf:"bytes,1,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Filter expression that is composed of a combination of single filters

func (*FilterExpression) Descriptor deprecated 

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

Deprecated: Use FilterExpression.ProtoReflect.Descriptor instead.

func (*FilterExpression) GetFilters 

func (x *FilterExpression) GetFilters() []*SinglePropertyFilter

func (*FilterExpression) ProtoMessage 

func (*FilterExpression) ProtoMessage()

func (*FilterExpression) ProtoReflect added in v1.10.7 

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

func (*FilterExpression) Reset 

func (x *FilterExpression) Reset()

func (*FilterExpression) String 

func (x *FilterExpression) String() string

type GetArtifactRequest 

type GetArtifactRequest struct {
	Dataset *DatasetID `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Types that are assignable to QueryHandle:
	//
	//	*GetArtifactRequest_ArtifactId
	//	*GetArtifactRequest_TagName
	QueryHandle isGetArtifactRequest_QueryHandle `protobuf_oneof:"query_handle"`
	// contains filtered or unexported fields
}

Request message for retrieving an Artifact. Retrieve an artifact based on a query handle that can be one of artifact_id or tag. The result returned will include the artifact data and metadata associated with the artifact.

func (*GetArtifactRequest) Descriptor deprecated 

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

Deprecated: Use GetArtifactRequest.ProtoReflect.Descriptor instead.

func (*GetArtifactRequest) GetArtifactId 

func (x *GetArtifactRequest) GetArtifactId() string

func (*GetArtifactRequest) GetDataset 

func (x *GetArtifactRequest) GetDataset() *DatasetID

func (*GetArtifactRequest) GetQueryHandle 

func (m *GetArtifactRequest) GetQueryHandle() isGetArtifactRequest_QueryHandle

func (*GetArtifactRequest) GetTagName 

func (x *GetArtifactRequest) GetTagName() string

func (*GetArtifactRequest) ProtoMessage 

func (*GetArtifactRequest) ProtoMessage()

func (*GetArtifactRequest) ProtoReflect added in v1.10.7 

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

func (*GetArtifactRequest) Reset 

func (x *GetArtifactRequest) Reset()

func (*GetArtifactRequest) String 

func (x *GetArtifactRequest) String() string

type GetArtifactRequest_ArtifactId 

type GetArtifactRequest_ArtifactId struct {
	ArtifactId string `protobuf:"bytes,2,opt,name=artifact_id,json=artifactId,proto3,oneof"`
}

type GetArtifactRequest_TagName 

type GetArtifactRequest_TagName struct {
	TagName string `protobuf:"bytes,3,opt,name=tag_name,json=tagName,proto3,oneof"`
}

type GetArtifactResponse 

type GetArtifactResponse struct {
	Artifact *Artifact `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// contains filtered or unexported fields
}

Response message for retrieving an Artifact. The result returned will include the artifact data and metadata associated with the artifact.

func (*GetArtifactResponse) Descriptor deprecated 

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

Deprecated: Use GetArtifactResponse.ProtoReflect.Descriptor instead.

func (*GetArtifactResponse) GetArtifact 

func (x *GetArtifactResponse) GetArtifact() *Artifact

func (*GetArtifactResponse) ProtoMessage 

func (*GetArtifactResponse) ProtoMessage()

func (*GetArtifactResponse) ProtoReflect added in v1.10.7 

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

func (*GetArtifactResponse) Reset 

func (x *GetArtifactResponse) Reset()

func (*GetArtifactResponse) String 

func (x *GetArtifactResponse) String() string

type GetDatasetRequest 

type GetDatasetRequest struct {
	Dataset *DatasetID `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// contains filtered or unexported fields
}

Request message for retrieving a Dataset. The Dataset is retrieved by it's unique identifier which is a combination of several fields.

func (*GetDatasetRequest) Descriptor deprecated 

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

Deprecated: Use GetDatasetRequest.ProtoReflect.Descriptor instead.

func (*GetDatasetRequest) GetDataset 

func (x *GetDatasetRequest) GetDataset() *DatasetID

func (*GetDatasetRequest) ProtoMessage 

func (*GetDatasetRequest) ProtoMessage()

func (*GetDatasetRequest) ProtoReflect added in v1.10.7 

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

func (*GetDatasetRequest) Reset 

func (x *GetDatasetRequest) Reset()

func (*GetDatasetRequest) String 

func (x *GetDatasetRequest) String() string

type GetDatasetResponse 

type GetDatasetResponse struct {
	Dataset *Dataset `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// contains filtered or unexported fields
}

Response message for retrieving a Dataset. The response will include the metadata for the Dataset.

func (*GetDatasetResponse) Descriptor deprecated 

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

Deprecated: Use GetDatasetResponse.ProtoReflect.Descriptor instead.

func (*GetDatasetResponse) GetDataset 

func (x *GetDatasetResponse) GetDataset() *Dataset

func (*GetDatasetResponse) ProtoMessage 

func (*GetDatasetResponse) ProtoMessage()

func (*GetDatasetResponse) ProtoReflect added in v1.10.7 

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

func (*GetDatasetResponse) Reset 

func (x *GetDatasetResponse) Reset()

func (*GetDatasetResponse) String 

func (x *GetDatasetResponse) String() string

type GetOrExtendReservationRequest 

type GetOrExtendReservationRequest struct {

	// The unique ID for the reservation
	ReservationId *ReservationID `protobuf:"bytes,1,opt,name=reservation_id,json=reservationId,proto3" json:"reservation_id,omitempty"`
	// The unique ID of the owner for the reservation
	OwnerId string `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// Requested reservation extension heartbeat interval
	HeartbeatInterval *durationpb.Duration `protobuf:"bytes,3,opt,name=heartbeat_interval,json=heartbeatInterval,proto3" json:"heartbeat_interval,omitempty"`
	// contains filtered or unexported fields
}

Try to acquire or extend an artifact reservation. If an active reservation exists, retrieve that instance.

func (*GetOrExtendReservationRequest) Descriptor deprecated 

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

Deprecated: Use GetOrExtendReservationRequest.ProtoReflect.Descriptor instead.

func (*GetOrExtendReservationRequest) GetHeartbeatInterval 

func (x *GetOrExtendReservationRequest) GetHeartbeatInterval() *durationpb.Duration

func (*GetOrExtendReservationRequest) GetOwnerId 

func (x *GetOrExtendReservationRequest) GetOwnerId() string

func (*GetOrExtendReservationRequest) GetReservationId 

func (x *GetOrExtendReservationRequest) GetReservationId() *ReservationID

func (*GetOrExtendReservationRequest) ProtoMessage 

func (*GetOrExtendReservationRequest) ProtoMessage()

func (*GetOrExtendReservationRequest) ProtoReflect added in v1.10.7 

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

func (*GetOrExtendReservationRequest) Reset 

func (x *GetOrExtendReservationRequest) Reset()

func (*GetOrExtendReservationRequest) String 

func (x *GetOrExtendReservationRequest) String() string

type GetOrExtendReservationResponse 

type GetOrExtendReservationResponse struct {

	// The reservation to be acquired or extended
	Reservation *Reservation `protobuf:"bytes,1,opt,name=reservation,proto3" json:"reservation,omitempty"`
	// contains filtered or unexported fields
}

Response including either a newly minted reservation or the existing reservation

func (*GetOrExtendReservationResponse) Descriptor deprecated 

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

Deprecated: Use GetOrExtendReservationResponse.ProtoReflect.Descriptor instead.

func (*GetOrExtendReservationResponse) GetReservation 

func (x *GetOrExtendReservationResponse) GetReservation() *Reservation

func (*GetOrExtendReservationResponse) ProtoMessage 

func (*GetOrExtendReservationResponse) ProtoMessage()

func (*GetOrExtendReservationResponse) ProtoReflect added in v1.10.7 

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

func (*GetOrExtendReservationResponse) Reset 

func (x *GetOrExtendReservationResponse) Reset()

func (*GetOrExtendReservationResponse) String 

func (x *GetOrExtendReservationResponse) String() string

type KeyValuePair 

type KeyValuePair struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*KeyValuePair) Descriptor deprecated 

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

Deprecated: Use KeyValuePair.ProtoReflect.Descriptor instead.

func (*KeyValuePair) GetKey 

func (x *KeyValuePair) GetKey() string

func (*KeyValuePair) GetValue 

func (x *KeyValuePair) GetValue() string

func (*KeyValuePair) ProtoMessage 

func (*KeyValuePair) ProtoMessage()

func (*KeyValuePair) ProtoReflect added in v1.10.7 

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

func (*KeyValuePair) Reset 

func (x *KeyValuePair) Reset()

func (*KeyValuePair) String 

func (x *KeyValuePair) String() string

type ListArtifactsRequest 

type ListArtifactsRequest struct {

	// Use a datasetID for which you want to retrieve the artifacts
	Dataset *DatasetID `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Apply the filter expression to this query
	Filter *FilterExpression `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Pagination options to get a page of artifacts
	Pagination *PaginationOptions `protobuf:"bytes,3,opt,name=pagination,proto3" json:"pagination,omitempty"`
	// contains filtered or unexported fields
}

List the artifacts that belong to the Dataset, optionally filtered using filtered expression.

func (*ListArtifactsRequest) Descriptor deprecated 

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

Deprecated: Use ListArtifactsRequest.ProtoReflect.Descriptor instead.

func (*ListArtifactsRequest) GetDataset 

func (x *ListArtifactsRequest) GetDataset() *DatasetID

func (*ListArtifactsRequest) GetFilter 

func (x *ListArtifactsRequest) GetFilter() *FilterExpression

func (*ListArtifactsRequest) GetPagination 

func (x *ListArtifactsRequest) GetPagination() *PaginationOptions

func (*ListArtifactsRequest) ProtoMessage 

func (*ListArtifactsRequest) ProtoMessage()

func (*ListArtifactsRequest) ProtoReflect added in v1.10.7 

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

func (*ListArtifactsRequest) Reset 

func (x *ListArtifactsRequest) Reset()

func (*ListArtifactsRequest) String 

func (x *ListArtifactsRequest) String() string

type ListArtifactsResponse 

type ListArtifactsResponse struct {

	// The list of artifacts
	Artifacts []*Artifact `protobuf:"bytes,1,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// Token to use to request the next page, pass this into the next requests PaginationOptions
	NextToken string `protobuf:"bytes,2,opt,name=next_token,json=nextToken,proto3" json:"next_token,omitempty"`
	// contains filtered or unexported fields
}

Response to list artifacts

func (*ListArtifactsResponse) Descriptor deprecated 

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

Deprecated: Use ListArtifactsResponse.ProtoReflect.Descriptor instead.

func (*ListArtifactsResponse) GetArtifacts 

func (x *ListArtifactsResponse) GetArtifacts() []*Artifact

func (*ListArtifactsResponse) GetNextToken 

func (x *ListArtifactsResponse) GetNextToken() string

func (*ListArtifactsResponse) ProtoMessage 

func (*ListArtifactsResponse) ProtoMessage()

func (*ListArtifactsResponse) ProtoReflect added in v1.10.7 

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

func (*ListArtifactsResponse) Reset 

func (x *ListArtifactsResponse) Reset()

func (*ListArtifactsResponse) String 

func (x *ListArtifactsResponse) String() string

type ListDatasetsRequest 

type ListDatasetsRequest struct {

	// Apply the filter expression to this query
	Filter *FilterExpression `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Pagination options to get a page of datasets
	Pagination *PaginationOptions `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"`
	// contains filtered or unexported fields
}

List the datasets for the given query

func (*ListDatasetsRequest) Descriptor deprecated 

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

Deprecated: Use ListDatasetsRequest.ProtoReflect.Descriptor instead.

func (*ListDatasetsRequest) GetFilter 

func (x *ListDatasetsRequest) GetFilter() *FilterExpression

func (*ListDatasetsRequest) GetPagination 

func (x *ListDatasetsRequest) GetPagination() *PaginationOptions

func (*ListDatasetsRequest) ProtoMessage 

func (*ListDatasetsRequest) ProtoMessage()

func (*ListDatasetsRequest) ProtoReflect added in v1.10.7 

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

func (*ListDatasetsRequest) Reset 

func (x *ListDatasetsRequest) Reset()

func (*ListDatasetsRequest) String 

func (x *ListDatasetsRequest) String() string

type ListDatasetsResponse 

type ListDatasetsResponse struct {

	// The list of datasets
	Datasets []*Dataset `protobuf:"bytes,1,rep,name=datasets,proto3" json:"datasets,omitempty"`
	// Token to use to request the next page, pass this into the next requests PaginationOptions
	NextToken string `protobuf:"bytes,2,opt,name=next_token,json=nextToken,proto3" json:"next_token,omitempty"`
	// contains filtered or unexported fields
}

List the datasets response with token for next pagination

func (*ListDatasetsResponse) Descriptor deprecated 

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

Deprecated: Use ListDatasetsResponse.ProtoReflect.Descriptor instead.

func (*ListDatasetsResponse) GetDatasets 

func (x *ListDatasetsResponse) GetDatasets() []*Dataset

func (*ListDatasetsResponse) GetNextToken 

func (x *ListDatasetsResponse) GetNextToken() string

func (*ListDatasetsResponse) ProtoMessage 

func (*ListDatasetsResponse) ProtoMessage()

func (*ListDatasetsResponse) ProtoReflect added in v1.10.7 

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

func (*ListDatasetsResponse) Reset 

func (x *ListDatasetsResponse) Reset()

func (*ListDatasetsResponse) String 

func (x *ListDatasetsResponse) String() string

type Metadata 

type Metadata struct {
	KeyMap map[string]string `` // key map is a dictionary of key/val strings that represent metadata
	/* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metadata representation for artifacts and datasets

func (*Metadata) Descriptor deprecated 

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

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetKeyMap 

func (x *Metadata) GetKeyMap() map[string]string

func (*Metadata) ProtoMessage 

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect added in v1.10.7 

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

func (*Metadata) Reset 

func (x *Metadata) Reset()

func (*Metadata) String 

func (x *Metadata) String() string

type PaginationOptions 

type PaginationOptions struct {

	// the max number of results to return
	Limit uint32 `protobuf:"varint,1,opt,name=limit,proto3" json:"limit,omitempty"`
	// the token to pass to fetch the next page
	Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	// the property that we want to sort the results by
	SortKey PaginationOptions_SortKey `protobuf:"varint,3,opt,name=sortKey,proto3,enum=datacatalog.PaginationOptions_SortKey" json:"sortKey,omitempty"`
	// the sort order of the results
	SortOrder PaginationOptions_SortOrder `protobuf:"varint,4,opt,name=sortOrder,proto3,enum=datacatalog.PaginationOptions_SortOrder" json:"sortOrder,omitempty"`
	// contains filtered or unexported fields
}

Pagination options for making list requests

func (*PaginationOptions) Descriptor deprecated 

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

Deprecated: Use PaginationOptions.ProtoReflect.Descriptor instead.

func (*PaginationOptions) GetLimit 

func (x *PaginationOptions) GetLimit() uint32

func (*PaginationOptions) GetSortKey 

func (x *PaginationOptions) GetSortKey() PaginationOptions_SortKey

func (*PaginationOptions) GetSortOrder 

func (x *PaginationOptions) GetSortOrder() PaginationOptions_SortOrder

func (*PaginationOptions) GetToken 

func (x *PaginationOptions) GetToken() string

func (*PaginationOptions) ProtoMessage 

func (*PaginationOptions) ProtoMessage()

func (*PaginationOptions) ProtoReflect added in v1.10.7 

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

func (*PaginationOptions) Reset 

func (x *PaginationOptions) Reset()

func (*PaginationOptions) String 

func (x *PaginationOptions) String() string

type PaginationOptions_SortKey 

type PaginationOptions_SortKey int32
const (
	PaginationOptions_CREATION_TIME PaginationOptions_SortKey = 0
)

func (PaginationOptions_SortKey) Descriptor added in v1.10.7 

func (PaginationOptions_SortKey) Descriptor() protoreflect.EnumDescriptor

func (PaginationOptions_SortKey) Enum added in v1.10.7 

func (x PaginationOptions_SortKey) Enum() *PaginationOptions_SortKey

func (PaginationOptions_SortKey) EnumDescriptor deprecated 

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

Deprecated: Use PaginationOptions_SortKey.Descriptor instead.

func (PaginationOptions_SortKey) Number added in v1.10.7 

func (x PaginationOptions_SortKey) Number() protoreflect.EnumNumber

func (PaginationOptions_SortKey) String 

func (x PaginationOptions_SortKey) String() string

func (PaginationOptions_SortKey) Type added in v1.10.7 

func (PaginationOptions_SortKey) Type() protoreflect.EnumType

type PaginationOptions_SortOrder 

type PaginationOptions_SortOrder int32
const (
	PaginationOptions_DESCENDING PaginationOptions_SortOrder = 0
	PaginationOptions_ASCENDING  PaginationOptions_SortOrder = 1
)

func (PaginationOptions_SortOrder) Descriptor added in v1.10.7 

func (PaginationOptions_SortOrder) Descriptor() protoreflect.EnumDescriptor

func (PaginationOptions_SortOrder) Enum added in v1.10.7 

func (x PaginationOptions_SortOrder) Enum() *PaginationOptions_SortOrder

func (PaginationOptions_SortOrder) EnumDescriptor deprecated 

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

Deprecated: Use PaginationOptions_SortOrder.Descriptor instead.

func (PaginationOptions_SortOrder) Number added in v1.10.7 

func (x PaginationOptions_SortOrder) Number() protoreflect.EnumNumber

func (PaginationOptions_SortOrder) String 

func (x PaginationOptions_SortOrder) String() string

func (PaginationOptions_SortOrder) Type added in v1.10.7 

func (PaginationOptions_SortOrder) Type() protoreflect.EnumType

type Partition 

type Partition struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

An artifact could have multiple partitions and each partition can have an arbitrary string key/value pair

func (*Partition) Descriptor deprecated 

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

Deprecated: Use Partition.ProtoReflect.Descriptor instead.

func (*Partition) GetKey 

func (x *Partition) GetKey() string

func (*Partition) GetValue 

func (x *Partition) GetValue() string

func (*Partition) ProtoMessage 

func (*Partition) ProtoMessage()

func (*Partition) ProtoReflect added in v1.10.7 

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

func (*Partition) Reset 

func (x *Partition) Reset()

func (*Partition) String 

func (x *Partition) String() string

type PartitionPropertyFilter 

type PartitionPropertyFilter struct {

	// Types that are assignable to Property:
	//
	//	*PartitionPropertyFilter_KeyVal
	Property isPartitionPropertyFilter_Property `protobuf_oneof:"property"`
	// contains filtered or unexported fields
}

Partition properties we can filter by

func (*PartitionPropertyFilter) Descriptor deprecated 

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

Deprecated: Use PartitionPropertyFilter.ProtoReflect.Descriptor instead.

func (*PartitionPropertyFilter) GetKeyVal 

func (x *PartitionPropertyFilter) GetKeyVal() *KeyValuePair

func (*PartitionPropertyFilter) GetProperty 

func (m *PartitionPropertyFilter) GetProperty() isPartitionPropertyFilter_Property

func (*PartitionPropertyFilter) ProtoMessage 

func (*PartitionPropertyFilter) ProtoMessage()

func (*PartitionPropertyFilter) ProtoReflect added in v1.10.7 

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

func (*PartitionPropertyFilter) Reset 

func (x *PartitionPropertyFilter) Reset()

func (*PartitionPropertyFilter) String 

func (x *PartitionPropertyFilter) String() string

type PartitionPropertyFilter_KeyVal 

type PartitionPropertyFilter_KeyVal struct {
	KeyVal *KeyValuePair `protobuf:"bytes,1,opt,name=key_val,json=keyVal,proto3,oneof"`
}

type ReleaseReservationRequest 

type ReleaseReservationRequest struct {

	// The unique ID for the reservation
	ReservationId *ReservationID `protobuf:"bytes,1,opt,name=reservation_id,json=reservationId,proto3" json:"reservation_id,omitempty"`
	// The unique ID of the owner for the reservation
	OwnerId string `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// contains filtered or unexported fields
}

Request to release reservation

func (*ReleaseReservationRequest) Descriptor deprecated 

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

Deprecated: Use ReleaseReservationRequest.ProtoReflect.Descriptor instead.

func (*ReleaseReservationRequest) GetOwnerId 

func (x *ReleaseReservationRequest) GetOwnerId() string

func (*ReleaseReservationRequest) GetReservationId 

func (x *ReleaseReservationRequest) GetReservationId() *ReservationID

func (*ReleaseReservationRequest) ProtoMessage 

func (*ReleaseReservationRequest) ProtoMessage()

func (*ReleaseReservationRequest) ProtoReflect added in v1.10.7 

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

func (*ReleaseReservationRequest) Reset 

func (x *ReleaseReservationRequest) Reset()

func (*ReleaseReservationRequest) String 

func (x *ReleaseReservationRequest) String() string

type ReleaseReservationResponse 

type ReleaseReservationResponse struct {
	// contains filtered or unexported fields
}

Response to release reservation

func (*ReleaseReservationResponse) Descriptor deprecated 

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

Deprecated: Use ReleaseReservationResponse.ProtoReflect.Descriptor instead.

func (*ReleaseReservationResponse) ProtoMessage 

func (*ReleaseReservationResponse) ProtoMessage()

func (*ReleaseReservationResponse) ProtoReflect added in v1.10.7 

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

func (*ReleaseReservationResponse) Reset 

func (x *ReleaseReservationResponse) Reset()

func (*ReleaseReservationResponse) String 

func (x *ReleaseReservationResponse) String() string

type Reservation 

type Reservation struct {

	// The unique ID for the reservation
	ReservationId *ReservationID `protobuf:"bytes,1,opt,name=reservation_id,json=reservationId,proto3" json:"reservation_id,omitempty"`
	// The unique ID of the owner for the reservation
	OwnerId string `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// Recommended heartbeat interval to extend reservation
	HeartbeatInterval *durationpb.Duration `protobuf:"bytes,3,opt,name=heartbeat_interval,json=heartbeatInterval,proto3" json:"heartbeat_interval,omitempty"`
	// Expiration timestamp of this reservation
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// Free-form metadata associated with the artifact
	Metadata *Metadata `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

A reservation including owner, heartbeat interval, expiration timestamp, and various metadata.

func (*Reservation) Descriptor deprecated 

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

Deprecated: Use Reservation.ProtoReflect.Descriptor instead.

func (*Reservation) GetExpiresAt 

func (x *Reservation) GetExpiresAt() *timestamppb.Timestamp

func (*Reservation) GetHeartbeatInterval 

func (x *Reservation) GetHeartbeatInterval() *durationpb.Duration

func (*Reservation) GetMetadata 

func (x *Reservation) GetMetadata() *Metadata

func (*Reservation) GetOwnerId 

func (x *Reservation) GetOwnerId() string

func (*Reservation) GetReservationId 

func (x *Reservation) GetReservationId() *ReservationID

func (*Reservation) ProtoMessage 

func (*Reservation) ProtoMessage()

func (*Reservation) ProtoReflect added in v1.10.7 

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

func (*Reservation) Reset 

func (x *Reservation) Reset()

func (*Reservation) String 

func (x *Reservation) String() string

type ReservationID 

type ReservationID struct {

	// The unique ID for the reserved dataset
	DatasetId *DatasetID `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// The specific artifact tag for the reservation
	TagName string `protobuf:"bytes,2,opt,name=tag_name,json=tagName,proto3" json:"tag_name,omitempty"`
	// contains filtered or unexported fields
}

ReservationID message that is composed of several string fields.

func (*ReservationID) Descriptor deprecated 

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

Deprecated: Use ReservationID.ProtoReflect.Descriptor instead.

func (*ReservationID) GetDatasetId 

func (x *ReservationID) GetDatasetId() *DatasetID

func (*ReservationID) GetTagName 

func (x *ReservationID) GetTagName() string

func (*ReservationID) ProtoMessage 

func (*ReservationID) ProtoMessage()

func (*ReservationID) ProtoReflect added in v1.10.7 

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

func (*ReservationID) Reset 

func (x *ReservationID) Reset()

func (*ReservationID) String 

func (x *ReservationID) String() string

type SinglePropertyFilter 

type SinglePropertyFilter struct {

	// Types that are assignable to PropertyFilter:
	//
	//	*SinglePropertyFilter_TagFilter
	//	*SinglePropertyFilter_PartitionFilter
	//	*SinglePropertyFilter_ArtifactFilter
	//	*SinglePropertyFilter_DatasetFilter
	PropertyFilter isSinglePropertyFilter_PropertyFilter   `protobuf_oneof:"property_filter"`
	Operator       SinglePropertyFilter_ComparisonOperator `` // field 10 in case we add more entities to query
	/* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

A single property to filter on.

func (*SinglePropertyFilter) Descriptor deprecated 

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

Deprecated: Use SinglePropertyFilter.ProtoReflect.Descriptor instead.

func (*SinglePropertyFilter) GetArtifactFilter 

func (x *SinglePropertyFilter) GetArtifactFilter() *ArtifactPropertyFilter

func (*SinglePropertyFilter) GetDatasetFilter 

func (x *SinglePropertyFilter) GetDatasetFilter() *DatasetPropertyFilter

func (*SinglePropertyFilter) GetOperator 

func (x *SinglePropertyFilter) GetOperator() SinglePropertyFilter_ComparisonOperator

func (*SinglePropertyFilter) GetPartitionFilter 

func (x *SinglePropertyFilter) GetPartitionFilter() *PartitionPropertyFilter

func (*SinglePropertyFilter) GetPropertyFilter 

func (m *SinglePropertyFilter) GetPropertyFilter() isSinglePropertyFilter_PropertyFilter

func (*SinglePropertyFilter) GetTagFilter 

func (x *SinglePropertyFilter) GetTagFilter() *TagPropertyFilter

func (*SinglePropertyFilter) ProtoMessage 

func (*SinglePropertyFilter) ProtoMessage()

func (*SinglePropertyFilter) ProtoReflect added in v1.10.7 

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

func (*SinglePropertyFilter) Reset 

func (x *SinglePropertyFilter) Reset()

func (*SinglePropertyFilter) String 

func (x *SinglePropertyFilter) String() string

type SinglePropertyFilter_ArtifactFilter 

type SinglePropertyFilter_ArtifactFilter struct {
	ArtifactFilter *ArtifactPropertyFilter `protobuf:"bytes,3,opt,name=artifact_filter,json=artifactFilter,proto3,oneof"`
}

type SinglePropertyFilter_ComparisonOperator 

type SinglePropertyFilter_ComparisonOperator int32

as use-cases come up we can add more operators, ex: gte, like, not eq etc. 

const (
	SinglePropertyFilter_EQUALS SinglePropertyFilter_ComparisonOperator = 0
)

func (SinglePropertyFilter_ComparisonOperator) Descriptor added in v1.10.7 

func (SinglePropertyFilter_ComparisonOperator) Descriptor() protoreflect.EnumDescriptor

func (SinglePropertyFilter_ComparisonOperator) Enum added in v1.10.7 

func (x SinglePropertyFilter_ComparisonOperator) Enum() *SinglePropertyFilter_ComparisonOperator

func (SinglePropertyFilter_ComparisonOperator) EnumDescriptor deprecated 

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

Deprecated: Use SinglePropertyFilter_ComparisonOperator.Descriptor instead.

func (SinglePropertyFilter_ComparisonOperator) Number added in v1.10.7 

func (x SinglePropertyFilter_ComparisonOperator) Number() protoreflect.EnumNumber

func (SinglePropertyFilter_ComparisonOperator) String 

func (x SinglePropertyFilter_ComparisonOperator) String() string

func (SinglePropertyFilter_ComparisonOperator) Type added in v1.10.7 

func (SinglePropertyFilter_ComparisonOperator) Type() protoreflect.EnumType

type SinglePropertyFilter_DatasetFilter 

type SinglePropertyFilter_DatasetFilter struct {
	DatasetFilter *DatasetPropertyFilter `protobuf:"bytes,4,opt,name=dataset_filter,json=datasetFilter,proto3,oneof"`
}

type SinglePropertyFilter_PartitionFilter 

type SinglePropertyFilter_PartitionFilter struct {
	PartitionFilter *PartitionPropertyFilter `protobuf:"bytes,2,opt,name=partition_filter,json=partitionFilter,proto3,oneof"`
}

type SinglePropertyFilter_TagFilter 

type SinglePropertyFilter_TagFilter struct {
	TagFilter *TagPropertyFilter `protobuf:"bytes,1,opt,name=tag_filter,json=tagFilter,proto3,oneof"`
}

type Tag 

type Tag struct {
	Name       string     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`                               // Name of tag
	ArtifactId string     `protobuf:"bytes,2,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"` // The tagged artifact
	Dataset    *DatasetID `protobuf:"bytes,3,opt,name=dataset,proto3" json:"dataset,omitempty"`                         // The Dataset that this tag belongs to
	// contains filtered or unexported fields
}

Tag message that is unique to a Dataset. It is associated to a single artifact and can be retrieved by name later.

func (*Tag) Descriptor deprecated 

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

Deprecated: Use Tag.ProtoReflect.Descriptor instead.

func (*Tag) GetArtifactId 

func (x *Tag) GetArtifactId() string

func (*Tag) GetDataset 

func (x *Tag) GetDataset() *DatasetID

func (*Tag) GetName 

func (x *Tag) GetName() string

func (*Tag) ProtoMessage 

func (*Tag) ProtoMessage()

func (*Tag) ProtoReflect added in v1.10.7 

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

func (*Tag) Reset 

func (x *Tag) Reset()

func (*Tag) String 

func (x *Tag) String() string

type TagPropertyFilter 

type TagPropertyFilter struct {

	// Types that are assignable to Property:
	//
	//	*TagPropertyFilter_TagName
	Property isTagPropertyFilter_Property `protobuf_oneof:"property"`
	// contains filtered or unexported fields
}

Tag properties we can filter by

func (*TagPropertyFilter) Descriptor deprecated 

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

Deprecated: Use TagPropertyFilter.ProtoReflect.Descriptor instead.

func (*TagPropertyFilter) GetProperty 

func (m *TagPropertyFilter) GetProperty() isTagPropertyFilter_Property

func (*TagPropertyFilter) GetTagName 

func (x *TagPropertyFilter) GetTagName() string

func (*TagPropertyFilter) ProtoMessage 

func (*TagPropertyFilter) ProtoMessage()

func (*TagPropertyFilter) ProtoReflect added in v1.10.7 

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

func (*TagPropertyFilter) Reset 

func (x *TagPropertyFilter) Reset()

func (*TagPropertyFilter) String 

func (x *TagPropertyFilter) String() string

type TagPropertyFilter_TagName 

type TagPropertyFilter_TagName struct {
	TagName string `protobuf:"bytes,1,opt,name=tag_name,json=tagName,proto3,oneof"`
}

type UnimplementedDataCatalogServer 

type UnimplementedDataCatalogServer struct {
}

UnimplementedDataCatalogServer should be embedded to have forward compatible implementations.

func (UnimplementedDataCatalogServer) AddTag 

func (UnimplementedDataCatalogServer) AddTag(context.Context, *AddTagRequest) (*AddTagResponse, error)

func (UnimplementedDataCatalogServer) CreateArtifact 

func (UnimplementedDataCatalogServer) CreateArtifact(context.Context, *CreateArtifactRequest) (*CreateArtifactResponse, error)

func (UnimplementedDataCatalogServer) CreateDataset 

func (UnimplementedDataCatalogServer) CreateDataset(context.Context, *CreateDatasetRequest) (*CreateDatasetResponse, error)

func (UnimplementedDataCatalogServer) GetArtifact 

func (UnimplementedDataCatalogServer) GetArtifact(context.Context, *GetArtifactRequest) (*GetArtifactResponse, error)

func (UnimplementedDataCatalogServer) GetDataset 

func (UnimplementedDataCatalogServer) GetDataset(context.Context, *GetDatasetRequest) (*GetDatasetResponse, error)

func (UnimplementedDataCatalogServer) GetOrExtendReservation 

func (UnimplementedDataCatalogServer) GetOrExtendReservation(context.Context, *GetOrExtendReservationRequest) (*GetOrExtendReservationResponse, error)

func (UnimplementedDataCatalogServer) ListArtifacts 

func (UnimplementedDataCatalogServer) ListArtifacts(context.Context, *ListArtifactsRequest) (*ListArtifactsResponse, error)

func (UnimplementedDataCatalogServer) ListDatasets 

func (UnimplementedDataCatalogServer) ListDatasets(context.Context, *ListDatasetsRequest) (*ListDatasetsResponse, error)

func (UnimplementedDataCatalogServer) ReleaseReservation 

func (UnimplementedDataCatalogServer) ReleaseReservation(context.Context, *ReleaseReservationRequest) (*ReleaseReservationResponse, error)

func (UnimplementedDataCatalogServer) UpdateArtifact 

func (UnimplementedDataCatalogServer) UpdateArtifact(context.Context, *UpdateArtifactRequest) (*UpdateArtifactResponse, error)

type UnsafeDataCatalogServer added in v1.10.7 

type UnsafeDataCatalogServer interface {
	// contains filtered or unexported methods
}

UnsafeDataCatalogServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DataCatalogServer will result in compilation errors.

type UpdateArtifactRequest 

type UpdateArtifactRequest struct {

	// ID of dataset the artifact is associated with
	Dataset *DatasetID `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Either ID of artifact or name of tag to retrieve existing artifact from
	//
	// Types that are assignable to QueryHandle:
	//
	//	*UpdateArtifactRequest_ArtifactId
	//	*UpdateArtifactRequest_TagName
	QueryHandle isUpdateArtifactRequest_QueryHandle `protobuf_oneof:"query_handle"`
	// List of data to overwrite stored artifact data with. Must contain ALL data for updated Artifact as any missing
	// ArtifactData entries will be removed from the underlying blob storage and database.
	Data []*ArtifactData `protobuf:"bytes,4,rep,name=data,proto3" json:"data,omitempty"`
	// Update execution metadata(including execution domain, name, node, project data) when overwriting cache
	Metadata *Metadata `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Request message for updating an Artifact and overwriting its associated ArtifactData.

func (*UpdateArtifactRequest) Descriptor deprecated 

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

Deprecated: Use UpdateArtifactRequest.ProtoReflect.Descriptor instead.

func (*UpdateArtifactRequest) GetArtifactId 

func (x *UpdateArtifactRequest) GetArtifactId() string

func (*UpdateArtifactRequest) GetData 

func (x *UpdateArtifactRequest) GetData() []*ArtifactData

func (*UpdateArtifactRequest) GetDataset 

func (x *UpdateArtifactRequest) GetDataset() *DatasetID

func (*UpdateArtifactRequest) GetMetadata added in v1.10.7 

func (x *UpdateArtifactRequest) GetMetadata() *Metadata

func (*UpdateArtifactRequest) GetQueryHandle 

func (m *UpdateArtifactRequest) GetQueryHandle() isUpdateArtifactRequest_QueryHandle

func (*UpdateArtifactRequest) GetTagName 

func (x *UpdateArtifactRequest) GetTagName() string

func (*UpdateArtifactRequest) ProtoMessage 

func (*UpdateArtifactRequest) ProtoMessage()

func (*UpdateArtifactRequest) ProtoReflect added in v1.10.7 

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

func (*UpdateArtifactRequest) Reset 

func (x *UpdateArtifactRequest) Reset()

func (*UpdateArtifactRequest) String 

func (x *UpdateArtifactRequest) String() string

type UpdateArtifactRequest_ArtifactId 

type UpdateArtifactRequest_ArtifactId struct {
	ArtifactId string `protobuf:"bytes,2,opt,name=artifact_id,json=artifactId,proto3,oneof"`
}

type UpdateArtifactRequest_TagName 

type UpdateArtifactRequest_TagName struct {
	TagName string `protobuf:"bytes,3,opt,name=tag_name,json=tagName,proto3,oneof"`
}

type UpdateArtifactResponse 

type UpdateArtifactResponse struct {

	// The unique ID of the artifact updated
	ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`
	// contains filtered or unexported fields
}

Response message for updating an Artifact.

func (*UpdateArtifactResponse) Descriptor deprecated 

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

Deprecated: Use UpdateArtifactResponse.ProtoReflect.Descriptor instead.

func (*UpdateArtifactResponse) GetArtifactId 

func (x *UpdateArtifactResponse) GetArtifactId() string

func (*UpdateArtifactResponse) ProtoMessage 

func (*UpdateArtifactResponse) ProtoMessage()

func (*UpdateArtifactResponse) ProtoReflect added in v1.10.7 

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

func (*UpdateArtifactResponse) Reset 

func (x *UpdateArtifactResponse) Reset()

func (*UpdateArtifactResponse) String 

func (x *UpdateArtifactResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.