cacheservice

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: 0

Documentation

Index

Constants

View Source 
const (
	CacheService_Get_FullMethodName                    = "/flyteidl.cacheservice.CacheService/Get"
	CacheService_Put_FullMethodName                    = "/flyteidl.cacheservice.CacheService/Put"
	CacheService_Delete_FullMethodName                 = "/flyteidl.cacheservice.CacheService/Delete"
	CacheService_GetOrExtendReservation_FullMethodName = "/flyteidl.cacheservice.CacheService/GetOrExtendReservation"
	CacheService_ReleaseReservation_FullMethodName     = "/flyteidl.cacheservice.CacheService/ReleaseReservation"
)

Variables

View Source 
var CacheService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "flyteidl.cacheservice.CacheService",
	HandlerType: (*CacheServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Get",
			Handler:    _CacheService_Get_Handler,
		},
		{
			MethodName: "Put",
			Handler:    _CacheService_Put_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _CacheService_Delete_Handler,
		},
		{
			MethodName: "GetOrExtendReservation",
			Handler:    _CacheService_GetOrExtendReservation_Handler,
		},
		{
			MethodName: "ReleaseReservation",
			Handler:    _CacheService_ReleaseReservation_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "flyteidl/cacheservice/cacheservice.proto",
}

CacheService_ServiceDesc is the grpc.ServiceDesc for CacheService 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_cacheservice_cacheservice_proto protoreflect.FileDescriptor

Functions

func RegisterCacheServiceServer 

func RegisterCacheServiceServer(s grpc.ServiceRegistrar, srv CacheServiceServer)

Types

type CacheServiceClient 

type CacheServiceClient interface {
	// Retrieves cached data by key.
	Get(ctx context.Context, in *GetCacheRequest, opts ...grpc.CallOption) (*GetCacheResponse, error)
	// Stores or updates cached data by key.
	Put(ctx context.Context, in *PutCacheRequest, opts ...grpc.CallOption) (*PutCacheResponse, error)
	// Deletes cached data by key.
	Delete(ctx context.Context, in *DeleteCacheRequest, opts ...grpc.CallOption) (*DeleteCacheResponse, error)
	// Get or extend a reservation for a cache key
	GetOrExtendReservation(ctx context.Context, in *GetOrExtendReservationRequest, opts ...grpc.CallOption) (*GetOrExtendReservationResponse, error)
	// Release the reservation for a cache key
	ReleaseReservation(ctx context.Context, in *ReleaseReservationRequest, opts ...grpc.CallOption) (*ReleaseReservationResponse, error)
}

CacheServiceClient is the client API for CacheService 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 NewCacheServiceClient 

func NewCacheServiceClient(cc grpc.ClientConnInterface) CacheServiceClient

type CacheServiceServer 

type CacheServiceServer interface {
	// Retrieves cached data by key.
	Get(context.Context, *GetCacheRequest) (*GetCacheResponse, error)
	// Stores or updates cached data by key.
	Put(context.Context, *PutCacheRequest) (*PutCacheResponse, error)
	// Deletes cached data by key.
	Delete(context.Context, *DeleteCacheRequest) (*DeleteCacheResponse, error)
	// Get or extend a reservation for a cache key
	GetOrExtendReservation(context.Context, *GetOrExtendReservationRequest) (*GetOrExtendReservationResponse, error)
	// Release the reservation for a cache key
	ReleaseReservation(context.Context, *ReleaseReservationRequest) (*ReleaseReservationResponse, error)
}

CacheServiceServer is the server API for CacheService service. All implementations should embed UnimplementedCacheServiceServer for forward compatibility

type CachedOutput 

type CachedOutput struct {

	// Types that are assignable to Output:
	//
	//	*CachedOutput_OutputLiterals
	//	*CachedOutput_OutputUri
	Output   isCachedOutput_Output `protobuf_oneof:"output"`
	Metadata *Metadata             `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"` // Associated metadata
	// contains filtered or unexported fields
}

Represents cached output, either as literals or an URI, with associated metadata.

func (*CachedOutput) Descriptor deprecated 

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

Deprecated: Use CachedOutput.ProtoReflect.Descriptor instead.

func (*CachedOutput) GetMetadata 

func (x *CachedOutput) GetMetadata() *Metadata

func (*CachedOutput) GetOutput 

func (m *CachedOutput) GetOutput() isCachedOutput_Output

func (*CachedOutput) GetOutputLiterals 

func (x *CachedOutput) GetOutputLiterals() *core.LiteralMap

func (*CachedOutput) GetOutputUri 

func (x *CachedOutput) GetOutputUri() string

func (*CachedOutput) ProtoMessage 

func (*CachedOutput) ProtoMessage()

func (*CachedOutput) ProtoReflect 

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

func (*CachedOutput) Reset 

func (x *CachedOutput) Reset()

func (*CachedOutput) String 

func (x *CachedOutput) String() string

type CachedOutput_OutputLiterals 

type CachedOutput_OutputLiterals struct {
	OutputLiterals *core.LiteralMap `protobuf:"bytes,1,opt,name=output_literals,json=outputLiterals,proto3,oneof"` // Output literals
}

type CachedOutput_OutputUri 

type CachedOutput_OutputUri struct {
	OutputUri string `protobuf:"bytes,2,opt,name=output_uri,json=outputUri,proto3,oneof"` // URI to output data
}

type DeleteCacheRequest 

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

Request to delete cached data by key.

func (*DeleteCacheRequest) Descriptor deprecated 

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

Deprecated: Use DeleteCacheRequest.ProtoReflect.Descriptor instead.

func (*DeleteCacheRequest) GetKey 

func (x *DeleteCacheRequest) GetKey() string

func (*DeleteCacheRequest) ProtoMessage 

func (*DeleteCacheRequest) ProtoMessage()

func (*DeleteCacheRequest) ProtoReflect 

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

func (*DeleteCacheRequest) Reset 

func (x *DeleteCacheRequest) Reset()

func (*DeleteCacheRequest) String 

func (x *DeleteCacheRequest) String() string

type DeleteCacheResponse 

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

Response message of cache deletion operation.

func (*DeleteCacheResponse) Descriptor deprecated 

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

Deprecated: Use DeleteCacheResponse.ProtoReflect.Descriptor instead.

func (*DeleteCacheResponse) ProtoMessage 

func (*DeleteCacheResponse) ProtoMessage()

func (*DeleteCacheResponse) ProtoReflect 

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

func (*DeleteCacheResponse) Reset 

func (x *DeleteCacheResponse) Reset()

func (*DeleteCacheResponse) String 

func (x *DeleteCacheResponse) String() string

type GetCacheRequest 

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

Request to retrieve cached data by key.

func (*GetCacheRequest) Descriptor deprecated 

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

Deprecated: Use GetCacheRequest.ProtoReflect.Descriptor instead.

func (*GetCacheRequest) GetKey 

func (x *GetCacheRequest) GetKey() string

func (*GetCacheRequest) ProtoMessage 

func (*GetCacheRequest) ProtoMessage()

func (*GetCacheRequest) ProtoReflect 

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

func (*GetCacheRequest) Reset 

func (x *GetCacheRequest) Reset()

func (*GetCacheRequest) String 

func (x *GetCacheRequest) String() string

type GetCacheResponse 

type GetCacheResponse struct {
	Output *CachedOutput `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"` // Cached output
	// contains filtered or unexported fields
}

Response with cached data for a given key.

func (*GetCacheResponse) Descriptor deprecated 

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

Deprecated: Use GetCacheResponse.ProtoReflect.Descriptor instead.

func (*GetCacheResponse) GetOutput 

func (x *GetCacheResponse) GetOutput() *CachedOutput

func (*GetCacheResponse) ProtoMessage 

func (*GetCacheResponse) ProtoMessage()

func (*GetCacheResponse) ProtoReflect 

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

func (*GetCacheResponse) Reset 

func (x *GetCacheResponse) Reset()

func (*GetCacheResponse) String 

func (x *GetCacheResponse) String() string

type GetOrExtendReservationRequest 

type GetOrExtendReservationRequest struct {
	Key               string               `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`                                                      // The unique ID for the reservation - same as the cache key
	OwnerId           string               `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`                               // The unique ID of the owner for the reservation
	HeartbeatInterval *durationpb.Duration `protobuf:"bytes,3,opt,name=heartbeat_interval,json=heartbeatInterval,proto3" json:"heartbeat_interval,omitempty"` // Requested reservation extension heartbeat interval
	// contains filtered or unexported fields
}

Request to get or extend a reservation for a cache key

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

func (x *GetOrExtendReservationRequest) GetKey() string

func (*GetOrExtendReservationRequest) GetOwnerId 

func (x *GetOrExtendReservationRequest) GetOwnerId() string

func (*GetOrExtendReservationRequest) ProtoMessage 

func (*GetOrExtendReservationRequest) ProtoMessage()

func (*GetOrExtendReservationRequest) ProtoReflect 

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 {
	Reservation *Reservation `protobuf:"bytes,1,opt,name=reservation,proto3" json:"reservation,omitempty"` // The reservation that was created or extended
	// contains filtered or unexported fields
}

Request to get or extend a reservation for a cache key

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 

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

func (*GetOrExtendReservationResponse) Reset 

func (x *GetOrExtendReservationResponse) Reset()

func (*GetOrExtendReservationResponse) String 

func (x *GetOrExtendReservationResponse) String() string

type KeyMapMetadata 

type KeyMapMetadata struct {
	Values map[string]string `` // Additional metadata as key-value pairs
	/* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Additional metadata as key-value pairs

func (*KeyMapMetadata) Descriptor deprecated 

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

Deprecated: Use KeyMapMetadata.ProtoReflect.Descriptor instead.

func (*KeyMapMetadata) GetValues 

func (x *KeyMapMetadata) GetValues() map[string]string

func (*KeyMapMetadata) ProtoMessage 

func (*KeyMapMetadata) ProtoMessage()

func (*KeyMapMetadata) ProtoReflect 

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

func (*KeyMapMetadata) Reset 

func (x *KeyMapMetadata) Reset()

func (*KeyMapMetadata) String 

func (x *KeyMapMetadata) String() string

type Metadata 

type Metadata struct {
	SourceIdentifier *core.Identifier       `protobuf:"bytes,1,opt,name=source_identifier,json=sourceIdentifier,proto3" json:"source_identifier,omitempty"` // Source task or workflow identifier
	KeyMap           *KeyMapMetadata        `protobuf:"bytes,2,opt,name=key_map,json=keyMap,proto3" json:"key_map,omitempty"`                               // Additional metadata as key-value pairs
	CreatedAt        *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`                      // Creation timestamp
	LastUpdatedAt    *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_updated_at,json=lastUpdatedAt,proto3" json:"last_updated_at,omitempty"`        // Last update timestamp
	// contains filtered or unexported fields
}

Metadata for cached outputs, including the source identifier and timestamps.

func (*Metadata) Descriptor deprecated 

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

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetCreatedAt 

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

func (*Metadata) GetKeyMap 

func (x *Metadata) GetKeyMap() *KeyMapMetadata

func (*Metadata) GetLastUpdatedAt 

func (x *Metadata) GetLastUpdatedAt() *timestamppb.Timestamp

func (*Metadata) GetSourceIdentifier 

func (x *Metadata) GetSourceIdentifier() *core.Identifier

func (*Metadata) ProtoMessage 

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect 

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

func (*Metadata) Reset 

func (x *Metadata) Reset()

func (*Metadata) String 

func (x *Metadata) String() string

type PutCacheRequest 

type PutCacheRequest struct {
	Key       string        `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`              // Cache key
	Output    *CachedOutput `protobuf:"bytes,2,opt,name=output,proto3" json:"output,omitempty"`        // Output to cache
	Overwrite bool          `protobuf:"varint,3,opt,name=overwrite,proto3" json:"overwrite,omitempty"` // Overwrite flag
	// contains filtered or unexported fields
}

Request to store/update cached data by key.

func (*PutCacheRequest) Descriptor deprecated 

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

Deprecated: Use PutCacheRequest.ProtoReflect.Descriptor instead.

func (*PutCacheRequest) GetKey 

func (x *PutCacheRequest) GetKey() string

func (*PutCacheRequest) GetOutput 

func (x *PutCacheRequest) GetOutput() *CachedOutput

func (*PutCacheRequest) GetOverwrite 

func (x *PutCacheRequest) GetOverwrite() bool

func (*PutCacheRequest) ProtoMessage 

func (*PutCacheRequest) ProtoMessage()

func (*PutCacheRequest) ProtoReflect 

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

func (*PutCacheRequest) Reset 

func (x *PutCacheRequest) Reset()

func (*PutCacheRequest) String 

func (x *PutCacheRequest) String() string

type PutCacheResponse 

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

Response message of cache store/update operation.

func (*PutCacheResponse) Descriptor deprecated 

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

Deprecated: Use PutCacheResponse.ProtoReflect.Descriptor instead.

func (*PutCacheResponse) ProtoMessage 

func (*PutCacheResponse) ProtoMessage()

func (*PutCacheResponse) ProtoReflect 

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

func (*PutCacheResponse) Reset 

func (x *PutCacheResponse) Reset()

func (*PutCacheResponse) String 

func (x *PutCacheResponse) String() string

type ReleaseReservationRequest 

type ReleaseReservationRequest struct {
	Key     string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`                        // The unique ID for the reservation - same as the cache key
	OwnerId string `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"` // The unique ID of the owner for the reservation
	// contains filtered or unexported fields
}

Request to release the reservation for a cache key

func (*ReleaseReservationRequest) Descriptor deprecated 

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

Deprecated: Use ReleaseReservationRequest.ProtoReflect.Descriptor instead.

func (*ReleaseReservationRequest) GetKey 

func (x *ReleaseReservationRequest) GetKey() string

func (*ReleaseReservationRequest) GetOwnerId 

func (x *ReleaseReservationRequest) GetOwnerId() string

func (*ReleaseReservationRequest) ProtoMessage 

func (*ReleaseReservationRequest) ProtoMessage()

func (*ReleaseReservationRequest) ProtoReflect 

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 message of release reservation operation.

func (*ReleaseReservationResponse) Descriptor deprecated 

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

Deprecated: Use ReleaseReservationResponse.ProtoReflect.Descriptor instead.

func (*ReleaseReservationResponse) ProtoMessage 

func (*ReleaseReservationResponse) ProtoMessage()

func (*ReleaseReservationResponse) ProtoReflect 

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 {
	Key               string                 `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`                                                      // The unique ID for the reservation - same as the cache key
	OwnerId           string                 `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`                               // The unique ID of the owner for the reservation
	HeartbeatInterval *durationpb.Duration   `protobuf:"bytes,3,opt,name=heartbeat_interval,json=heartbeatInterval,proto3" json:"heartbeat_interval,omitempty"` // Requested reservation extension heartbeat interval
	ExpiresAt         *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`                         // Expiration timestamp of this reservation
	// 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) GetKey 

func (x *Reservation) GetKey() string

func (*Reservation) GetOwnerId 

func (x *Reservation) GetOwnerId() string

func (*Reservation) ProtoMessage 

func (*Reservation) ProtoMessage()

func (*Reservation) ProtoReflect 

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

func (*Reservation) Reset 

func (x *Reservation) Reset()

func (*Reservation) String 

func (x *Reservation) String() string

type UnimplementedCacheServiceServer 

type UnimplementedCacheServiceServer struct {
}

UnimplementedCacheServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedCacheServiceServer) Delete 

func (UnimplementedCacheServiceServer) Delete(context.Context, *DeleteCacheRequest) (*DeleteCacheResponse, error)

func (UnimplementedCacheServiceServer) Get 

func (UnimplementedCacheServiceServer) Get(context.Context, *GetCacheRequest) (*GetCacheResponse, error)

func (UnimplementedCacheServiceServer) GetOrExtendReservation 

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

func (UnimplementedCacheServiceServer) Put 

func (UnimplementedCacheServiceServer) Put(context.Context, *PutCacheRequest) (*PutCacheResponse, error)

func (UnimplementedCacheServiceServer) ReleaseReservation 

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

type UnsafeCacheServiceServer 

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

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

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.