datacatalog

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

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

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
}

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
}

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
}

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

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

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

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

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

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)
}

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)
}

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
}

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
}

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
}

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

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

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

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

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

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

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
}

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

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

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

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

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

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

type PaginationOptions_SortKey int32

type PaginationOptions_SortOrder int32

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
}

type PartitionPropertyFilter struct {

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

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

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
}

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

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
}

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
}

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
}

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

type SinglePropertyFilter_ComparisonOperator int32

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

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

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

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
}

type TagPropertyFilter struct {

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

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

type UnimplementedDataCatalogServer struct {
}

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

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
}

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

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

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
}