Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterStoreServiceServer(s grpc.ServiceRegistrar, srv StoreServiceServer)
- func RegisterSyncServiceServer(s grpc.ServiceRegistrar, srv SyncServiceServer)
- type BasicAuthCredentials
- func (*BasicAuthCredentials) Descriptor() ([]byte, []int)deprecated
- func (x *BasicAuthCredentials) GetPassword() string
- func (x *BasicAuthCredentials) GetUsername() string
- func (*BasicAuthCredentials) ProtoMessage()
- func (x *BasicAuthCredentials) ProtoReflect() protoreflect.Message
- func (x *BasicAuthCredentials) Reset()
- func (x *BasicAuthCredentials) String() string
- type CreateSyncRequest
- func (*CreateSyncRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateSyncRequest) GetCids() []string
- func (x *CreateSyncRequest) GetRemoteDirectoryUrl() string
- func (*CreateSyncRequest) ProtoMessage()
- func (x *CreateSyncRequest) ProtoReflect() protoreflect.Message
- func (x *CreateSyncRequest) Reset()
- func (x *CreateSyncRequest) String() string
- type CreateSyncResponse
- func (*CreateSyncResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateSyncResponse) GetSyncId() string
- func (*CreateSyncResponse) ProtoMessage()
- func (x *CreateSyncResponse) ProtoReflect() protoreflect.Message
- func (x *CreateSyncResponse) Reset()
- func (x *CreateSyncResponse) String() string
- type DeleteSyncRequest
- type DeleteSyncResponse
- type GetSyncRequest
- type GetSyncResponse
- func (*GetSyncResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetSyncResponse) GetCreatedTime() string
- func (x *GetSyncResponse) GetLastUpdateTime() string
- func (x *GetSyncResponse) GetRemoteDirectoryUrl() string
- func (x *GetSyncResponse) GetStatus() SyncStatus
- func (x *GetSyncResponse) GetSyncId() string
- func (*GetSyncResponse) ProtoMessage()
- func (x *GetSyncResponse) ProtoReflect() protoreflect.Message
- func (x *GetSyncResponse) Reset()
- func (x *GetSyncResponse) String() string
- type ListSyncsItem
- func (*ListSyncsItem) Descriptor() ([]byte, []int)deprecated
- func (x *ListSyncsItem) GetRemoteDirectoryUrl() string
- func (x *ListSyncsItem) GetStatus() SyncStatus
- func (x *ListSyncsItem) GetSyncId() string
- func (*ListSyncsItem) ProtoMessage()
- func (x *ListSyncsItem) ProtoReflect() protoreflect.Message
- func (x *ListSyncsItem) Reset()
- func (x *ListSyncsItem) String() string
- type ListSyncsRequest
- func (*ListSyncsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListSyncsRequest) GetLimit() uint32
- func (x *ListSyncsRequest) GetOffset() uint32
- func (*ListSyncsRequest) ProtoMessage()
- func (x *ListSyncsRequest) ProtoReflect() protoreflect.Message
- func (x *ListSyncsRequest) Reset()
- func (x *ListSyncsRequest) String() string
- type PullReferrerRequest
- func (*PullReferrerRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PullReferrerRequest) GetRecordRef() *v1.RecordRef
- func (x *PullReferrerRequest) GetReferrerType() string
- func (*PullReferrerRequest) ProtoMessage()
- func (x *PullReferrerRequest) ProtoReflect() protoreflect.Message
- func (x *PullReferrerRequest) Reset()
- func (x *PullReferrerRequest) String() string
- type PullReferrerResponse
- func (*PullReferrerResponse) Descriptor() ([]byte, []int)deprecated
- func (x *PullReferrerResponse) GetReferrer() *v1.RecordReferrer
- func (*PullReferrerResponse) ProtoMessage()
- func (x *PullReferrerResponse) ProtoReflect() protoreflect.Message
- func (x *PullReferrerResponse) Reset()
- func (x *PullReferrerResponse) String() string
- type PushReferrerRequest
- func (*PushReferrerRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PushReferrerRequest) GetRecordRef() *v1.RecordRef
- func (x *PushReferrerRequest) GetReferrer() *v1.RecordReferrer
- func (*PushReferrerRequest) ProtoMessage()
- func (x *PushReferrerRequest) ProtoReflect() protoreflect.Message
- func (x *PushReferrerRequest) Reset()
- func (x *PushReferrerRequest) String() string
- type PushReferrerResponse
- func (*PushReferrerResponse) Descriptor() ([]byte, []int)deprecated
- func (x *PushReferrerResponse) GetErrorMessage() string
- func (x *PushReferrerResponse) GetSuccess() bool
- func (*PushReferrerResponse) ProtoMessage()
- func (x *PushReferrerResponse) ProtoReflect() protoreflect.Message
- func (x *PushReferrerResponse) Reset()
- func (x *PushReferrerResponse) String() string
- type RequestRegistryCredentialsRequest
- func (*RequestRegistryCredentialsRequest) Descriptor() ([]byte, []int)deprecated
- func (*RequestRegistryCredentialsRequest) ProtoMessage()
- func (x *RequestRegistryCredentialsRequest) ProtoReflect() protoreflect.Message
- func (x *RequestRegistryCredentialsRequest) Reset()
- func (x *RequestRegistryCredentialsRequest) String() string
- type RequestRegistryCredentialsResponse
- func (*RequestRegistryCredentialsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RequestRegistryCredentialsResponse) GetBasicAuth() *BasicAuthCredentials
- func (x *RequestRegistryCredentialsResponse) GetCredentials() isRequestRegistryCredentialsResponse_Credentials
- func (x *RequestRegistryCredentialsResponse) GetErrorMessage() string
- func (x *RequestRegistryCredentialsResponse) GetInsecure() bool
- func (x *RequestRegistryCredentialsResponse) GetRegistryAddress() string
- func (x *RequestRegistryCredentialsResponse) GetRepositoryName() string
- func (x *RequestRegistryCredentialsResponse) GetSuccess() bool
- func (*RequestRegistryCredentialsResponse) ProtoMessage()
- func (x *RequestRegistryCredentialsResponse) ProtoReflect() protoreflect.Message
- func (x *RequestRegistryCredentialsResponse) Reset()
- func (x *RequestRegistryCredentialsResponse) String() string
- type RequestRegistryCredentialsResponse_BasicAuth
- type StoreServiceClient
- type StoreServiceServer
- type StoreService_DeleteClient
- type StoreService_DeleteServer
- type StoreService_LookupClient
- type StoreService_LookupServer
- type StoreService_PullClient
- type StoreService_PullReferrerClient
- type StoreService_PullReferrerServer
- type StoreService_PullServer
- type StoreService_PushClient
- type StoreService_PushReferrerClient
- type StoreService_PushReferrerServer
- type StoreService_PushServer
- type SyncServiceClient
- type SyncServiceServer
- type SyncService_ListSyncsClient
- type SyncService_ListSyncsServer
- type SyncStatus
- type UnimplementedStoreServiceServer
- func (UnimplementedStoreServiceServer) Delete(StoreService_DeleteServer) error
- func (UnimplementedStoreServiceServer) Lookup(StoreService_LookupServer) error
- func (UnimplementedStoreServiceServer) Pull(StoreService_PullServer) error
- func (UnimplementedStoreServiceServer) PullReferrer(StoreService_PullReferrerServer) error
- func (UnimplementedStoreServiceServer) Push(StoreService_PushServer) error
- func (UnimplementedStoreServiceServer) PushReferrer(StoreService_PushReferrerServer) error
- type UnimplementedSyncServiceServer
- func (UnimplementedSyncServiceServer) CreateSync(context.Context, *CreateSyncRequest) (*CreateSyncResponse, error)
- func (UnimplementedSyncServiceServer) DeleteSync(context.Context, *DeleteSyncRequest) (*DeleteSyncResponse, error)
- func (UnimplementedSyncServiceServer) GetSync(context.Context, *GetSyncRequest) (*GetSyncResponse, error)
- func (UnimplementedSyncServiceServer) ListSyncs(*ListSyncsRequest, SyncService_ListSyncsServer) error
- func (UnimplementedSyncServiceServer) RequestRegistryCredentials(context.Context, *RequestRegistryCredentialsRequest) (*RequestRegistryCredentialsResponse, error)
- type UnsafeStoreServiceServer
- type UnsafeSyncServiceServer
Constants ¶
const ( StoreService_Push_FullMethodName = "/agntcy.dir.store.v1.StoreService/Push" StoreService_Pull_FullMethodName = "/agntcy.dir.store.v1.StoreService/Pull" StoreService_Lookup_FullMethodName = "/agntcy.dir.store.v1.StoreService/Lookup" StoreService_Delete_FullMethodName = "/agntcy.dir.store.v1.StoreService/Delete" StoreService_PushReferrer_FullMethodName = "/agntcy.dir.store.v1.StoreService/PushReferrer" StoreService_PullReferrer_FullMethodName = "/agntcy.dir.store.v1.StoreService/PullReferrer" )
const ( SyncService_CreateSync_FullMethodName = "/agntcy.dir.store.v1.SyncService/CreateSync" SyncService_ListSyncs_FullMethodName = "/agntcy.dir.store.v1.SyncService/ListSyncs" SyncService_GetSync_FullMethodName = "/agntcy.dir.store.v1.SyncService/GetSync" SyncService_DeleteSync_FullMethodName = "/agntcy.dir.store.v1.SyncService/DeleteSync" SyncService_RequestRegistryCredentials_FullMethodName = "/agntcy.dir.store.v1.SyncService/RequestRegistryCredentials" )
Variables ¶
var ( SyncStatus_name = map[int32]string{ 0: "SYNC_STATUS_UNSPECIFIED", 1: "SYNC_STATUS_PENDING", 2: "SYNC_STATUS_IN_PROGRESS", 3: "SYNC_STATUS_FAILED", 4: "SYNC_STATUS_DELETE_PENDING", 5: "SYNC_STATUS_DELETED", 6: "SYNC_STATUS_COMPLETED", } SyncStatus_value = map[string]int32{ "SYNC_STATUS_UNSPECIFIED": 0, "SYNC_STATUS_PENDING": 1, "SYNC_STATUS_IN_PROGRESS": 2, "SYNC_STATUS_FAILED": 3, "SYNC_STATUS_DELETE_PENDING": 4, "SYNC_STATUS_DELETED": 5, "SYNC_STATUS_COMPLETED": 6, } )
Enum value maps for SyncStatus.
var File_agntcy_dir_store_v1_store_service_proto protoreflect.FileDescriptor
var File_agntcy_dir_store_v1_sync_service_proto protoreflect.FileDescriptor
var StoreService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "agntcy.dir.store.v1.StoreService", HandlerType: (*StoreServiceServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "Push", Handler: _StoreService_Push_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "Pull", Handler: _StoreService_Pull_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "Lookup", Handler: _StoreService_Lookup_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "Delete", Handler: _StoreService_Delete_Handler, ClientStreams: true, }, { StreamName: "PushReferrer", Handler: _StoreService_PushReferrer_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "PullReferrer", Handler: _StoreService_PullReferrer_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "agntcy/dir/store/v1/store_service.proto", }
StoreService_ServiceDesc is the grpc.ServiceDesc for StoreService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var SyncService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "agntcy.dir.store.v1.SyncService", HandlerType: (*SyncServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateSync", Handler: _SyncService_CreateSync_Handler, }, { MethodName: "GetSync", Handler: _SyncService_GetSync_Handler, }, { MethodName: "DeleteSync", Handler: _SyncService_DeleteSync_Handler, }, { MethodName: "RequestRegistryCredentials", Handler: _SyncService_RequestRegistryCredentials_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "ListSyncs", Handler: _SyncService_ListSyncs_Handler, ServerStreams: true, }, }, Metadata: "agntcy/dir/store/v1/sync_service.proto", }
SyncService_ServiceDesc is the grpc.ServiceDesc for SyncService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterStoreServiceServer ¶
func RegisterStoreServiceServer(s grpc.ServiceRegistrar, srv StoreServiceServer)
func RegisterSyncServiceServer ¶
func RegisterSyncServiceServer(s grpc.ServiceRegistrar, srv SyncServiceServer)
Types ¶
type BasicAuthCredentials ¶
type BasicAuthCredentials struct {
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
// contains filtered or unexported fields
}
Supporting credential type definitions
func (*BasicAuthCredentials) Descriptor
deprecated
func (*BasicAuthCredentials) Descriptor() ([]byte, []int)
Deprecated: Use BasicAuthCredentials.ProtoReflect.Descriptor instead.
func (*BasicAuthCredentials) GetPassword ¶
func (x *BasicAuthCredentials) GetPassword() string
func (*BasicAuthCredentials) GetUsername ¶
func (x *BasicAuthCredentials) GetUsername() string
func (*BasicAuthCredentials) ProtoMessage ¶
func (*BasicAuthCredentials) ProtoMessage()
func (*BasicAuthCredentials) ProtoReflect ¶
func (x *BasicAuthCredentials) ProtoReflect() protoreflect.Message
func (*BasicAuthCredentials) Reset ¶
func (x *BasicAuthCredentials) Reset()
func (*BasicAuthCredentials) String ¶
func (x *BasicAuthCredentials) String() string
type CreateSyncRequest ¶
type CreateSyncRequest struct {
// URL of the remote Registry to synchronize from.
//
// This should be a complete URL including protocol and port if non-standard.
// Examples:
// - "https://directory.example.com"
// - "http://localhost:8080"
// - "https://directory.example.com:9443"
RemoteDirectoryUrl string `protobuf:"bytes,1,opt,name=remote_directory_url,json=remoteDirectoryUrl,proto3" json:"remote_directory_url,omitempty"`
// List of CIDs to synchronize from the remote Directory.
// If empty, all objects will be synchronized.
Cids []string `protobuf:"bytes,2,rep,name=cids,proto3" json:"cids,omitempty"`
// contains filtered or unexported fields
}
CreateSyncRequest defines the parameters for creating a new synchronization operation.
Currently supports basic synchronization of all objects from a remote Directory. Future versions may include additional options for filtering and scheduling capabilities.
func (*CreateSyncRequest) Descriptor
deprecated
func (*CreateSyncRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSyncRequest.ProtoReflect.Descriptor instead.
func (*CreateSyncRequest) GetCids ¶
func (x *CreateSyncRequest) GetCids() []string
func (*CreateSyncRequest) GetRemoteDirectoryUrl ¶
func (x *CreateSyncRequest) GetRemoteDirectoryUrl() string
func (*CreateSyncRequest) ProtoMessage ¶
func (*CreateSyncRequest) ProtoMessage()
func (*CreateSyncRequest) ProtoReflect ¶
func (x *CreateSyncRequest) ProtoReflect() protoreflect.Message
func (*CreateSyncRequest) Reset ¶
func (x *CreateSyncRequest) Reset()
func (*CreateSyncRequest) String ¶
func (x *CreateSyncRequest) String() string
type CreateSyncResponse ¶
type CreateSyncResponse struct {
// Unique identifier for the created synchronization operation.
// This ID can be used with other SyncService RPCs to monitor and manage the sync.
SyncId string `protobuf:"bytes,1,opt,name=sync_id,json=syncId,proto3" json:"sync_id,omitempty"`
// contains filtered or unexported fields
}
CreateSyncResponse contains the result of creating a new synchronization operation.
func (*CreateSyncResponse) Descriptor
deprecated
func (*CreateSyncResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateSyncResponse.ProtoReflect.Descriptor instead.
func (*CreateSyncResponse) GetSyncId ¶
func (x *CreateSyncResponse) GetSyncId() string
func (*CreateSyncResponse) ProtoMessage ¶
func (*CreateSyncResponse) ProtoMessage()
func (*CreateSyncResponse) ProtoReflect ¶
func (x *CreateSyncResponse) ProtoReflect() protoreflect.Message
func (*CreateSyncResponse) Reset ¶
func (x *CreateSyncResponse) Reset()
func (*CreateSyncResponse) String ¶
func (x *CreateSyncResponse) String() string
type DeleteSyncRequest ¶
type DeleteSyncRequest struct {
// Unique identifier of the synchronization operation to delete.
SyncId string `protobuf:"bytes,1,opt,name=sync_id,json=syncId,proto3" json:"sync_id,omitempty"`
// contains filtered or unexported fields
}
DeleteSyncRequest specifies which synchronization to delete.
func (*DeleteSyncRequest) Descriptor
deprecated
func (*DeleteSyncRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSyncRequest.ProtoReflect.Descriptor instead.
func (*DeleteSyncRequest) GetSyncId ¶
func (x *DeleteSyncRequest) GetSyncId() string
func (*DeleteSyncRequest) ProtoMessage ¶
func (*DeleteSyncRequest) ProtoMessage()
func (*DeleteSyncRequest) ProtoReflect ¶
func (x *DeleteSyncRequest) ProtoReflect() protoreflect.Message
func (*DeleteSyncRequest) Reset ¶
func (x *DeleteSyncRequest) Reset()
func (*DeleteSyncRequest) String ¶
func (x *DeleteSyncRequest) String() string
type DeleteSyncResponse ¶
type DeleteSyncResponse struct {
// contains filtered or unexported fields
}
DeleteSyncResponse
func (*DeleteSyncResponse) Descriptor
deprecated
func (*DeleteSyncResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSyncResponse.ProtoReflect.Descriptor instead.
func (*DeleteSyncResponse) ProtoMessage ¶
func (*DeleteSyncResponse) ProtoMessage()
func (*DeleteSyncResponse) ProtoReflect ¶
func (x *DeleteSyncResponse) ProtoReflect() protoreflect.Message
func (*DeleteSyncResponse) Reset ¶
func (x *DeleteSyncResponse) Reset()
func (*DeleteSyncResponse) String ¶
func (x *DeleteSyncResponse) String() string
type GetSyncRequest ¶
type GetSyncRequest struct {
// Unique identifier of the synchronization operation to query.
SyncId string `protobuf:"bytes,1,opt,name=sync_id,json=syncId,proto3" json:"sync_id,omitempty"`
// contains filtered or unexported fields
}
GetSyncRequest specifies which synchronization status to retrieve.
func (*GetSyncRequest) Descriptor
deprecated
func (*GetSyncRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSyncRequest.ProtoReflect.Descriptor instead.
func (*GetSyncRequest) GetSyncId ¶
func (x *GetSyncRequest) GetSyncId() string
func (*GetSyncRequest) ProtoMessage ¶
func (*GetSyncRequest) ProtoMessage()
func (*GetSyncRequest) ProtoReflect ¶
func (x *GetSyncRequest) ProtoReflect() protoreflect.Message
func (*GetSyncRequest) Reset ¶
func (x *GetSyncRequest) Reset()
func (*GetSyncRequest) String ¶
func (x *GetSyncRequest) String() string
type GetSyncResponse ¶
type GetSyncResponse struct {
// Unique identifier of the synchronization operation.
SyncId string `protobuf:"bytes,1,opt,name=sync_id,json=syncId,proto3" json:"sync_id,omitempty"`
// Current status of the synchronization operation.
Status SyncStatus `protobuf:"varint,2,opt,name=status,proto3,enum=agntcy.dir.store.v1.SyncStatus" json:"status,omitempty"`
// URL of the remote Directory node being synchronized from.
RemoteDirectoryUrl string `protobuf:"bytes,3,opt,name=remote_directory_url,json=remoteDirectoryUrl,proto3" json:"remote_directory_url,omitempty"`
// Timestamp when the synchronization operation was created in the RFC3339 format.
// Specs: https://www.rfc-editor.org/rfc/rfc3339.html
CreatedTime string `protobuf:"bytes,4,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"`
// Timestamp of the most recent status update for this synchronization in the RFC3339 format.
LastUpdateTime string `protobuf:"bytes,5,opt,name=last_update_time,json=lastUpdateTime,proto3" json:"last_update_time,omitempty"`
// contains filtered or unexported fields
}
GetSyncResponse provides detailed information about a specific synchronization operation.
func (*GetSyncResponse) Descriptor
deprecated
func (*GetSyncResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetSyncResponse.ProtoReflect.Descriptor instead.
func (*GetSyncResponse) GetCreatedTime ¶
func (x *GetSyncResponse) GetCreatedTime() string
func (*GetSyncResponse) GetLastUpdateTime ¶
func (x *GetSyncResponse) GetLastUpdateTime() string
func (*GetSyncResponse) GetRemoteDirectoryUrl ¶
func (x *GetSyncResponse) GetRemoteDirectoryUrl() string
func (*GetSyncResponse) GetStatus ¶
func (x *GetSyncResponse) GetStatus() SyncStatus
func (*GetSyncResponse) GetSyncId ¶
func (x *GetSyncResponse) GetSyncId() string
func (*GetSyncResponse) ProtoMessage ¶
func (*GetSyncResponse) ProtoMessage()
func (*GetSyncResponse) ProtoReflect ¶
func (x *GetSyncResponse) ProtoReflect() protoreflect.Message
func (*GetSyncResponse) Reset ¶
func (x *GetSyncResponse) Reset()
func (*GetSyncResponse) String ¶
func (x *GetSyncResponse) String() string
type ListSyncsItem ¶
type ListSyncsItem struct {
// Unique identifier of the synchronization operation.
SyncId string `protobuf:"bytes,1,opt,name=sync_id,json=syncId,proto3" json:"sync_id,omitempty"`
// Current status of the synchronization operation.
Status SyncStatus `protobuf:"varint,2,opt,name=status,proto3,enum=agntcy.dir.store.v1.SyncStatus" json:"status,omitempty"`
// URL of the remote Directory being synchronized from.
RemoteDirectoryUrl string `protobuf:"bytes,3,opt,name=remote_directory_url,json=remoteDirectoryUrl,proto3" json:"remote_directory_url,omitempty"`
// contains filtered or unexported fields
}
ListSyncItem represents a single synchronization in the list of all syncs.
func (*ListSyncsItem) Descriptor
deprecated
func (*ListSyncsItem) Descriptor() ([]byte, []int)
Deprecated: Use ListSyncsItem.ProtoReflect.Descriptor instead.
func (*ListSyncsItem) GetRemoteDirectoryUrl ¶
func (x *ListSyncsItem) GetRemoteDirectoryUrl() string
func (*ListSyncsItem) GetStatus ¶
func (x *ListSyncsItem) GetStatus() SyncStatus
func (*ListSyncsItem) GetSyncId ¶
func (x *ListSyncsItem) GetSyncId() string
func (*ListSyncsItem) ProtoMessage ¶
func (*ListSyncsItem) ProtoMessage()
func (*ListSyncsItem) ProtoReflect ¶
func (x *ListSyncsItem) ProtoReflect() protoreflect.Message
func (*ListSyncsItem) Reset ¶
func (x *ListSyncsItem) Reset()
func (*ListSyncsItem) String ¶
func (x *ListSyncsItem) String() string
type ListSyncsRequest ¶
type ListSyncsRequest struct {
// Optional limit on the number of results to return.
Limit *uint32 `protobuf:"varint,2,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
// Optional offset for pagination of results.
Offset *uint32 `protobuf:"varint,3,opt,name=offset,proto3,oneof" json:"offset,omitempty"`
// contains filtered or unexported fields
}
ListSyncsRequest specifies parameters for listing synchronization operations.
func (*ListSyncsRequest) Descriptor
deprecated
func (*ListSyncsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSyncsRequest.ProtoReflect.Descriptor instead.
func (*ListSyncsRequest) GetLimit ¶
func (x *ListSyncsRequest) GetLimit() uint32
func (*ListSyncsRequest) GetOffset ¶
func (x *ListSyncsRequest) GetOffset() uint32
func (*ListSyncsRequest) ProtoMessage ¶
func (*ListSyncsRequest) ProtoMessage()
func (*ListSyncsRequest) ProtoReflect ¶
func (x *ListSyncsRequest) ProtoReflect() protoreflect.Message
func (*ListSyncsRequest) Reset ¶
func (x *ListSyncsRequest) Reset()
func (*ListSyncsRequest) String ¶
func (x *ListSyncsRequest) String() string
type PullReferrerRequest ¶
type PullReferrerRequest struct {
// Record reference
RecordRef *v1.RecordRef `protobuf:"bytes,1,opt,name=record_ref,json=recordRef,proto3" json:"record_ref,omitempty"`
// Record referrer type to be pulled
// If not provided, all referrers will be pulled
ReferrerType *string `protobuf:"bytes,2,opt,name=referrer_type,json=referrerType,proto3,oneof" json:"referrer_type,omitempty"`
// contains filtered or unexported fields
}
PullReferrerRequest represents a record with optional OCI artifacts for pull operations.
func (*PullReferrerRequest) Descriptor
deprecated
func (*PullReferrerRequest) Descriptor() ([]byte, []int)
Deprecated: Use PullReferrerRequest.ProtoReflect.Descriptor instead.
func (*PullReferrerRequest) GetRecordRef ¶
func (x *PullReferrerRequest) GetRecordRef() *v1.RecordRef
func (*PullReferrerRequest) GetReferrerType ¶
func (x *PullReferrerRequest) GetReferrerType() string
func (*PullReferrerRequest) ProtoMessage ¶
func (*PullReferrerRequest) ProtoMessage()
func (*PullReferrerRequest) ProtoReflect ¶
func (x *PullReferrerRequest) ProtoReflect() protoreflect.Message
func (*PullReferrerRequest) Reset ¶
func (x *PullReferrerRequest) Reset()
func (*PullReferrerRequest) String ¶
func (x *PullReferrerRequest) String() string
type PullReferrerResponse ¶
type PullReferrerResponse struct {
// RecordReferrer object associated with the record
Referrer *v1.RecordReferrer `protobuf:"bytes,1,opt,name=referrer,proto3" json:"referrer,omitempty"`
// contains filtered or unexported fields
}
PullReferrerResponse is returned after successfully fetching a record referrer.
func (*PullReferrerResponse) Descriptor
deprecated
func (*PullReferrerResponse) Descriptor() ([]byte, []int)
Deprecated: Use PullReferrerResponse.ProtoReflect.Descriptor instead.
func (*PullReferrerResponse) GetReferrer ¶
func (x *PullReferrerResponse) GetReferrer() *v1.RecordReferrer
func (*PullReferrerResponse) ProtoMessage ¶
func (*PullReferrerResponse) ProtoMessage()
func (*PullReferrerResponse) ProtoReflect ¶
func (x *PullReferrerResponse) ProtoReflect() protoreflect.Message
func (*PullReferrerResponse) Reset ¶
func (x *PullReferrerResponse) Reset()
func (*PullReferrerResponse) String ¶
func (x *PullReferrerResponse) String() string
type PushReferrerRequest ¶
type PushReferrerRequest struct {
// Record reference
RecordRef *v1.RecordRef `protobuf:"bytes,1,opt,name=record_ref,json=recordRef,proto3" json:"record_ref,omitempty"`
// RecordReferrer object to be stored for the record
Referrer *v1.RecordReferrer `protobuf:"bytes,2,opt,name=referrer,proto3" json:"referrer,omitempty"`
// contains filtered or unexported fields
}
PushReferrerRequest represents a record with optional OCI artifacts for push operations.
func (*PushReferrerRequest) Descriptor
deprecated
func (*PushReferrerRequest) Descriptor() ([]byte, []int)
Deprecated: Use PushReferrerRequest.ProtoReflect.Descriptor instead.
func (*PushReferrerRequest) GetRecordRef ¶
func (x *PushReferrerRequest) GetRecordRef() *v1.RecordRef
func (*PushReferrerRequest) GetReferrer ¶
func (x *PushReferrerRequest) GetReferrer() *v1.RecordReferrer
func (*PushReferrerRequest) ProtoMessage ¶
func (*PushReferrerRequest) ProtoMessage()
func (*PushReferrerRequest) ProtoReflect ¶
func (x *PushReferrerRequest) ProtoReflect() protoreflect.Message
func (*PushReferrerRequest) Reset ¶
func (x *PushReferrerRequest) Reset()
func (*PushReferrerRequest) String ¶
func (x *PushReferrerRequest) String() string
type PushReferrerResponse ¶
type PushReferrerResponse struct {
// The push process result
Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
// Optional error message if push failed
ErrorMessage *string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3,oneof" json:"error_message,omitempty"`
// contains filtered or unexported fields
}
PushReferrerResponse
func (*PushReferrerResponse) Descriptor
deprecated
func (*PushReferrerResponse) Descriptor() ([]byte, []int)
Deprecated: Use PushReferrerResponse.ProtoReflect.Descriptor instead.
func (*PushReferrerResponse) GetErrorMessage ¶
func (x *PushReferrerResponse) GetErrorMessage() string
func (*PushReferrerResponse) GetSuccess ¶
func (x *PushReferrerResponse) GetSuccess() bool
func (*PushReferrerResponse) ProtoMessage ¶
func (*PushReferrerResponse) ProtoMessage()
func (*PushReferrerResponse) ProtoReflect ¶
func (x *PushReferrerResponse) ProtoReflect() protoreflect.Message
func (*PushReferrerResponse) Reset ¶
func (x *PushReferrerResponse) Reset()
func (*PushReferrerResponse) String ¶
func (x *PushReferrerResponse) String() string
type RequestRegistryCredentialsRequest ¶
type RequestRegistryCredentialsRequest struct {
// contains filtered or unexported fields
}
func (*RequestRegistryCredentialsRequest) Descriptor
deprecated
func (*RequestRegistryCredentialsRequest) Descriptor() ([]byte, []int)
Deprecated: Use RequestRegistryCredentialsRequest.ProtoReflect.Descriptor instead.
func (*RequestRegistryCredentialsRequest) ProtoMessage ¶
func (*RequestRegistryCredentialsRequest) ProtoMessage()
func (*RequestRegistryCredentialsRequest) ProtoReflect ¶
func (x *RequestRegistryCredentialsRequest) ProtoReflect() protoreflect.Message
func (*RequestRegistryCredentialsRequest) Reset ¶
func (x *RequestRegistryCredentialsRequest) Reset()
func (*RequestRegistryCredentialsRequest) String ¶
func (x *RequestRegistryCredentialsRequest) String() string
type RequestRegistryCredentialsResponse ¶
type RequestRegistryCredentialsResponse struct {
// Success status of the credential negotiation
Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
// Error message if negotiation failed
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// Address of the remote Registry (e.g., "ghcr.io", "dir-zot.default.svc.cluster.local:5000")
RegistryAddress string `protobuf:"bytes,3,opt,name=registry_address,json=registryAddress,proto3" json:"registry_address,omitempty"`
// Repository name within the registry (e.g., "user/dir-test/dir", "dir")
RepositoryName string `protobuf:"bytes,6,opt,name=repository_name,json=repositoryName,proto3" json:"repository_name,omitempty"`
// Registry credentials (oneof based on credential type)
//
// Types that are valid to be assigned to Credentials:
//
// *RequestRegistryCredentialsResponse_BasicAuth
Credentials isRequestRegistryCredentialsResponse_Credentials `protobuf_oneof:"credentials"`
// Whether the registry uses plain HTTP (insecure) instead of HTTPS
// When true, TLS should be disabled for connections to this registry
Insecure bool `protobuf:"varint,7,opt,name=insecure,proto3" json:"insecure,omitempty"`
// contains filtered or unexported fields
}
func (*RequestRegistryCredentialsResponse) Descriptor
deprecated
func (*RequestRegistryCredentialsResponse) Descriptor() ([]byte, []int)
Deprecated: Use RequestRegistryCredentialsResponse.ProtoReflect.Descriptor instead.
func (*RequestRegistryCredentialsResponse) GetBasicAuth ¶
func (x *RequestRegistryCredentialsResponse) GetBasicAuth() *BasicAuthCredentials
func (*RequestRegistryCredentialsResponse) GetCredentials ¶
func (x *RequestRegistryCredentialsResponse) GetCredentials() isRequestRegistryCredentialsResponse_Credentials
func (*RequestRegistryCredentialsResponse) GetErrorMessage ¶
func (x *RequestRegistryCredentialsResponse) GetErrorMessage() string
func (*RequestRegistryCredentialsResponse) GetInsecure ¶ added in v1.0.0
func (x *RequestRegistryCredentialsResponse) GetInsecure() bool
func (*RequestRegistryCredentialsResponse) GetRegistryAddress ¶ added in v1.0.0
func (x *RequestRegistryCredentialsResponse) GetRegistryAddress() string
func (*RequestRegistryCredentialsResponse) GetRepositoryName ¶ added in v1.0.0
func (x *RequestRegistryCredentialsResponse) GetRepositoryName() string
func (*RequestRegistryCredentialsResponse) GetSuccess ¶
func (x *RequestRegistryCredentialsResponse) GetSuccess() bool
func (*RequestRegistryCredentialsResponse) ProtoMessage ¶
func (*RequestRegistryCredentialsResponse) ProtoMessage()
func (*RequestRegistryCredentialsResponse) ProtoReflect ¶
func (x *RequestRegistryCredentialsResponse) ProtoReflect() protoreflect.Message
func (*RequestRegistryCredentialsResponse) Reset ¶
func (x *RequestRegistryCredentialsResponse) Reset()
func (*RequestRegistryCredentialsResponse) String ¶
func (x *RequestRegistryCredentialsResponse) String() string
type RequestRegistryCredentialsResponse_BasicAuth ¶
type RequestRegistryCredentialsResponse_BasicAuth struct {
BasicAuth *BasicAuthCredentials `protobuf:"bytes,4,opt,name=basic_auth,json=basicAuth,proto3,oneof"` // CertificateCredentials certificate = 5;
}
type StoreServiceClient ¶
type StoreServiceClient interface {
// Push performs write operation for given records.
Push(ctx context.Context, opts ...grpc.CallOption) (StoreService_PushClient, error)
// Pull performs read operation for given records.
Pull(ctx context.Context, opts ...grpc.CallOption) (StoreService_PullClient, error)
// Lookup resolves basic metadata for the records.
Lookup(ctx context.Context, opts ...grpc.CallOption) (StoreService_LookupClient, error)
// Remove performs delete operation for the records.
Delete(ctx context.Context, opts ...grpc.CallOption) (StoreService_DeleteClient, error)
// PushReferrer performs write operation for record referrers.
PushReferrer(ctx context.Context, opts ...grpc.CallOption) (StoreService_PushReferrerClient, error)
// PullReferrer performs read operation for record referrers.
PullReferrer(ctx context.Context, opts ...grpc.CallOption) (StoreService_PullReferrerClient, error)
}
StoreServiceClient is the client API for StoreService 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.
Defines an interface for content-addressable storage service for objects.
Max object size: 4MB (to fully fit in a single request) Max metadata size: 100KB
Store service can be implemented by various storage backends, such as local file system, OCI registry, etc.
Middleware should be used to control who can perform these RPCs. Policies for the middleware can be handled via separate service.
Each operation is performed sequentially, meaning that for the N-th request, N-th response will be returned. If an error occurs, the stream will be cancelled.
func NewStoreServiceClient ¶
func NewStoreServiceClient(cc grpc.ClientConnInterface) StoreServiceClient
type StoreServiceServer ¶
type StoreServiceServer interface {
// Push performs write operation for given records.
Push(StoreService_PushServer) error
// Pull performs read operation for given records.
Pull(StoreService_PullServer) error
// Lookup resolves basic metadata for the records.
Lookup(StoreService_LookupServer) error
// Remove performs delete operation for the records.
Delete(StoreService_DeleteServer) error
// PushReferrer performs write operation for record referrers.
PushReferrer(StoreService_PushReferrerServer) error
// PullReferrer performs read operation for record referrers.
PullReferrer(StoreService_PullReferrerServer) error
}
StoreServiceServer is the server API for StoreService service. All implementations should embed UnimplementedStoreServiceServer for forward compatibility.
Defines an interface for content-addressable storage service for objects.
Max object size: 4MB (to fully fit in a single request) Max metadata size: 100KB
Store service can be implemented by various storage backends, such as local file system, OCI registry, etc.
Middleware should be used to control who can perform these RPCs. Policies for the middleware can be handled via separate service.
Each operation is performed sequentially, meaning that for the N-th request, N-th response will be returned. If an error occurs, the stream will be cancelled.
type StoreService_LookupClient ¶
type StoreService_LookupClient interface {
Send(*v1.RecordRef) error
Recv() (*v1.RecordMeta, error)
grpc.ClientStream
}
type StoreService_LookupServer ¶
type StoreService_LookupServer interface {
Send(*v1.RecordMeta) error
Recv() (*v1.RecordRef, error)
grpc.ServerStream
}
type StoreService_PullClient ¶
type StoreService_PullReferrerClient ¶
type StoreService_PullReferrerClient interface {
Send(*PullReferrerRequest) error
Recv() (*PullReferrerResponse, error)
grpc.ClientStream
}
type StoreService_PullReferrerServer ¶
type StoreService_PullReferrerServer interface {
Send(*PullReferrerResponse) error
Recv() (*PullReferrerRequest, error)
grpc.ServerStream
}
type StoreService_PullServer ¶
type StoreService_PushClient ¶
type StoreService_PushReferrerClient ¶
type StoreService_PushReferrerClient interface {
Send(*PushReferrerRequest) error
Recv() (*PushReferrerResponse, error)
grpc.ClientStream
}
type StoreService_PushReferrerServer ¶
type StoreService_PushReferrerServer interface {
Send(*PushReferrerResponse) error
Recv() (*PushReferrerRequest, error)
grpc.ServerStream
}
type StoreService_PushServer ¶
type SyncServiceClient ¶
type SyncServiceClient interface {
// CreateSync initiates a new synchronization operation from a remote Directory node.
//
// The operation is non-blocking and returns immediately with a sync ID that can be used
// to track progress and manage the sync operation.
CreateSync(ctx context.Context, in *CreateSyncRequest, opts ...grpc.CallOption) (*CreateSyncResponse, error)
// ListSyncs returns a stream of all sync operations known to the system.
//
// This includes active, completed, and failed synchronizations.
ListSyncs(ctx context.Context, in *ListSyncsRequest, opts ...grpc.CallOption) (SyncService_ListSyncsClient, error)
// GetSync retrieves detailed status information for a specific synchronization.
GetSync(ctx context.Context, in *GetSyncRequest, opts ...grpc.CallOption) (*GetSyncResponse, error)
// DeleteSync removes a synchronization operation from the system.
DeleteSync(ctx context.Context, in *DeleteSyncRequest, opts ...grpc.CallOption) (*DeleteSyncResponse, error)
// RequestRegistryCredentials requests registry credentials between two Directory nodes.
//
// This RPC allows a requesting node to authenticate with this node and obtain
// temporary registry credentials for secure Zot-based synchronization.
RequestRegistryCredentials(ctx context.Context, in *RequestRegistryCredentialsRequest, opts ...grpc.CallOption) (*RequestRegistryCredentialsResponse, error)
}
SyncServiceClient is the client API for SyncService 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.
SyncService provides functionality for synchronizing objects between Directory nodes.
This service enables one-way synchronization from a remote Directory node to the local node, allowing distributed Directory instances to share and replicate objects. The service supports both on-demand synchronization and tracking of sync operations through their lifecycle.
func NewSyncServiceClient ¶
func NewSyncServiceClient(cc grpc.ClientConnInterface) SyncServiceClient
type SyncServiceServer ¶
type SyncServiceServer interface {
// CreateSync initiates a new synchronization operation from a remote Directory node.
//
// The operation is non-blocking and returns immediately with a sync ID that can be used
// to track progress and manage the sync operation.
CreateSync(context.Context, *CreateSyncRequest) (*CreateSyncResponse, error)
// ListSyncs returns a stream of all sync operations known to the system.
//
// This includes active, completed, and failed synchronizations.
ListSyncs(*ListSyncsRequest, SyncService_ListSyncsServer) error
// GetSync retrieves detailed status information for a specific synchronization.
GetSync(context.Context, *GetSyncRequest) (*GetSyncResponse, error)
// DeleteSync removes a synchronization operation from the system.
DeleteSync(context.Context, *DeleteSyncRequest) (*DeleteSyncResponse, error)
// RequestRegistryCredentials requests registry credentials between two Directory nodes.
//
// This RPC allows a requesting node to authenticate with this node and obtain
// temporary registry credentials for secure Zot-based synchronization.
RequestRegistryCredentials(context.Context, *RequestRegistryCredentialsRequest) (*RequestRegistryCredentialsResponse, error)
}
SyncServiceServer is the server API for SyncService service. All implementations should embed UnimplementedSyncServiceServer for forward compatibility.
SyncService provides functionality for synchronizing objects between Directory nodes.
This service enables one-way synchronization from a remote Directory node to the local node, allowing distributed Directory instances to share and replicate objects. The service supports both on-demand synchronization and tracking of sync operations through their lifecycle.
type SyncService_ListSyncsClient ¶
type SyncService_ListSyncsClient interface {
Recv() (*ListSyncsItem, error)
grpc.ClientStream
}
type SyncService_ListSyncsServer ¶
type SyncService_ListSyncsServer interface {
Send(*ListSyncsItem) error
grpc.ServerStream
}
type SyncStatus ¶
type SyncStatus int32
SyncStatus enumeration defines the possible states of a synchronization operation.
const ( // Default/unset status - should not be used in practice SyncStatus_SYNC_STATUS_UNSPECIFIED SyncStatus = 0 // Sync operation has been created but not yet started SyncStatus_SYNC_STATUS_PENDING SyncStatus = 1 // Sync operation is actively discovering and transferring objects SyncStatus_SYNC_STATUS_IN_PROGRESS SyncStatus = 2 // Sync operation encountered an error and stopped SyncStatus_SYNC_STATUS_FAILED SyncStatus = 3 // Sync operation has been marked for deletion but cleanup not yet started SyncStatus_SYNC_STATUS_DELETE_PENDING SyncStatus = 4 // Sync operation has been successfully deleted and cleaned up SyncStatus_SYNC_STATUS_DELETED SyncStatus = 5 // Sync operation has completed successfully SyncStatus_SYNC_STATUS_COMPLETED SyncStatus = 6 )
func (SyncStatus) Descriptor ¶
func (SyncStatus) Descriptor() protoreflect.EnumDescriptor
func (SyncStatus) Enum ¶
func (x SyncStatus) Enum() *SyncStatus
func (SyncStatus) EnumDescriptor
deprecated
func (SyncStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use SyncStatus.Descriptor instead.
func (SyncStatus) Number ¶
func (x SyncStatus) Number() protoreflect.EnumNumber
func (SyncStatus) String ¶
func (x SyncStatus) String() string
func (SyncStatus) Type ¶
func (SyncStatus) Type() protoreflect.EnumType
type UnimplementedStoreServiceServer ¶
type UnimplementedStoreServiceServer struct{}
UnimplementedStoreServiceServer should be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedStoreServiceServer) Delete ¶
func (UnimplementedStoreServiceServer) Delete(StoreService_DeleteServer) error
func (UnimplementedStoreServiceServer) Lookup ¶
func (UnimplementedStoreServiceServer) Lookup(StoreService_LookupServer) error
func (UnimplementedStoreServiceServer) Pull ¶
func (UnimplementedStoreServiceServer) Pull(StoreService_PullServer) error
func (UnimplementedStoreServiceServer) PullReferrer ¶
func (UnimplementedStoreServiceServer) PullReferrer(StoreService_PullReferrerServer) error
func (UnimplementedStoreServiceServer) Push ¶
func (UnimplementedStoreServiceServer) Push(StoreService_PushServer) error
func (UnimplementedStoreServiceServer) PushReferrer ¶
func (UnimplementedStoreServiceServer) PushReferrer(StoreService_PushReferrerServer) error
type UnimplementedSyncServiceServer ¶
type UnimplementedSyncServiceServer struct{}
UnimplementedSyncServiceServer should be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedSyncServiceServer) CreateSync ¶
func (UnimplementedSyncServiceServer) CreateSync(context.Context, *CreateSyncRequest) (*CreateSyncResponse, error)
func (UnimplementedSyncServiceServer) DeleteSync ¶
func (UnimplementedSyncServiceServer) DeleteSync(context.Context, *DeleteSyncRequest) (*DeleteSyncResponse, error)
func (UnimplementedSyncServiceServer) GetSync ¶
func (UnimplementedSyncServiceServer) GetSync(context.Context, *GetSyncRequest) (*GetSyncResponse, error)
func (UnimplementedSyncServiceServer) ListSyncs ¶
func (UnimplementedSyncServiceServer) ListSyncs(*ListSyncsRequest, SyncService_ListSyncsServer) error
func (UnimplementedSyncServiceServer) RequestRegistryCredentials ¶
func (UnimplementedSyncServiceServer) RequestRegistryCredentials(context.Context, *RequestRegistryCredentialsRequest) (*RequestRegistryCredentialsResponse, error)
type UnsafeStoreServiceServer ¶
type UnsafeStoreServiceServer interface {
// contains filtered or unexported methods
}
UnsafeStoreServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StoreServiceServer will result in compilation errors.
type UnsafeSyncServiceServer ¶
type UnsafeSyncServiceServer interface {
// contains filtered or unexported methods
}
UnsafeSyncServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SyncServiceServer will result in compilation errors.