v1connect

package
v0.5.8 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// AdminServiceSignUpProcedure is the fully-qualified name of the AdminService's SignUp RPC.
	AdminServiceSignUpProcedure = "/yorkie.v1.AdminService/SignUp"
	// AdminServiceLogInProcedure is the fully-qualified name of the AdminService's LogIn RPC.
	AdminServiceLogInProcedure = "/yorkie.v1.AdminService/LogIn"
	// AdminServiceDeleteAccountProcedure is the fully-qualified name of the AdminService's
	// DeleteAccount RPC.
	AdminServiceDeleteAccountProcedure = "/yorkie.v1.AdminService/DeleteAccount"
	// AdminServiceChangePasswordProcedure is the fully-qualified name of the AdminService's
	// ChangePassword RPC.
	AdminServiceChangePasswordProcedure = "/yorkie.v1.AdminService/ChangePassword"
	// AdminServiceCreateProjectProcedure is the fully-qualified name of the AdminService's
	// CreateProject RPC.
	AdminServiceCreateProjectProcedure = "/yorkie.v1.AdminService/CreateProject"
	// AdminServiceListProjectsProcedure is the fully-qualified name of the AdminService's ListProjects
	// RPC.
	AdminServiceListProjectsProcedure = "/yorkie.v1.AdminService/ListProjects"
	// AdminServiceGetProjectProcedure is the fully-qualified name of the AdminService's GetProject RPC.
	AdminServiceGetProjectProcedure = "/yorkie.v1.AdminService/GetProject"
	// AdminServiceUpdateProjectProcedure is the fully-qualified name of the AdminService's
	// UpdateProject RPC.
	AdminServiceUpdateProjectProcedure = "/yorkie.v1.AdminService/UpdateProject"
	// AdminServiceListDocumentsProcedure is the fully-qualified name of the AdminService's
	// ListDocuments RPC.
	AdminServiceListDocumentsProcedure = "/yorkie.v1.AdminService/ListDocuments"
	// AdminServiceGetDocumentProcedure is the fully-qualified name of the AdminService's GetDocument
	// RPC.
	AdminServiceGetDocumentProcedure = "/yorkie.v1.AdminService/GetDocument"
	// AdminServiceGetDocumentsProcedure is the fully-qualified name of the AdminService's GetDocuments
	// RPC.
	AdminServiceGetDocumentsProcedure = "/yorkie.v1.AdminService/GetDocuments"
	// AdminServiceRemoveDocumentByAdminProcedure is the fully-qualified name of the AdminService's
	// RemoveDocumentByAdmin RPC.
	AdminServiceRemoveDocumentByAdminProcedure = "/yorkie.v1.AdminService/RemoveDocumentByAdmin"
	// AdminServiceGetSnapshotMetaProcedure is the fully-qualified name of the AdminService's
	// GetSnapshotMeta RPC.
	AdminServiceGetSnapshotMetaProcedure = "/yorkie.v1.AdminService/GetSnapshotMeta"
	// AdminServiceSearchDocumentsProcedure is the fully-qualified name of the AdminService's
	// SearchDocuments RPC.
	AdminServiceSearchDocumentsProcedure = "/yorkie.v1.AdminService/SearchDocuments"
	// AdminServiceListChangesProcedure is the fully-qualified name of the AdminService's ListChanges
	// RPC.
	AdminServiceListChangesProcedure = "/yorkie.v1.AdminService/ListChanges"
	// AdminServiceGetServerVersionProcedure is the fully-qualified name of the AdminService's
	// GetServerVersion RPC.
	AdminServiceGetServerVersionProcedure = "/yorkie.v1.AdminService/GetServerVersion"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// YorkieServiceActivateClientProcedure is the fully-qualified name of the YorkieService's
	// ActivateClient RPC.
	YorkieServiceActivateClientProcedure = "/yorkie.v1.YorkieService/ActivateClient"
	// YorkieServiceDeactivateClientProcedure is the fully-qualified name of the YorkieService's
	// DeactivateClient RPC.
	YorkieServiceDeactivateClientProcedure = "/yorkie.v1.YorkieService/DeactivateClient"
	// YorkieServiceAttachDocumentProcedure is the fully-qualified name of the YorkieService's
	// AttachDocument RPC.
	YorkieServiceAttachDocumentProcedure = "/yorkie.v1.YorkieService/AttachDocument"
	// YorkieServiceDetachDocumentProcedure is the fully-qualified name of the YorkieService's
	// DetachDocument RPC.
	YorkieServiceDetachDocumentProcedure = "/yorkie.v1.YorkieService/DetachDocument"
	// YorkieServiceRemoveDocumentProcedure is the fully-qualified name of the YorkieService's
	// RemoveDocument RPC.
	YorkieServiceRemoveDocumentProcedure = "/yorkie.v1.YorkieService/RemoveDocument"
	// YorkieServicePushPullChangesProcedure is the fully-qualified name of the YorkieService's
	// PushPullChanges RPC.
	YorkieServicePushPullChangesProcedure = "/yorkie.v1.YorkieService/PushPullChanges"
	// YorkieServiceWatchDocumentProcedure is the fully-qualified name of the YorkieService's
	// WatchDocument RPC.
	YorkieServiceWatchDocumentProcedure = "/yorkie.v1.YorkieService/WatchDocument"
	// YorkieServiceBroadcastProcedure is the fully-qualified name of the YorkieService's Broadcast RPC.
	YorkieServiceBroadcastProcedure = "/yorkie.v1.YorkieService/Broadcast"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// AdminServiceName is the fully-qualified name of the AdminService service.
	AdminServiceName = "yorkie.v1.AdminService"
)
View Source
const (
	// ClusterServiceDetachDocumentProcedure is the fully-qualified name of the ClusterService's
	// DetachDocument RPC.
	ClusterServiceDetachDocumentProcedure = "/yorkie.v1.ClusterService/DetachDocument"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// ClusterServiceName is the fully-qualified name of the ClusterService service.
	ClusterServiceName = "yorkie.v1.ClusterService"
)
View Source
const (
	// YorkieServiceName is the fully-qualified name of the YorkieService service.
	YorkieServiceName = "yorkie.v1.YorkieService"
)

Variables

This section is empty.

Functions

func NewAdminServiceHandler

func NewAdminServiceHandler(svc AdminServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewAdminServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewClusterServiceHandler added in v0.5.2

func NewClusterServiceHandler(svc ClusterServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewClusterServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewYorkieServiceHandler

func NewYorkieServiceHandler(svc YorkieServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewYorkieServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type AdminServiceClient

type AdminServiceClient interface {
	SignUp(context.Context, *connect.Request[v1.SignUpRequest]) (*connect.Response[v1.SignUpResponse], error)
	LogIn(context.Context, *connect.Request[v1.LogInRequest]) (*connect.Response[v1.LogInResponse], error)
	DeleteAccount(context.Context, *connect.Request[v1.DeleteAccountRequest]) (*connect.Response[v1.DeleteAccountResponse], error)
	ChangePassword(context.Context, *connect.Request[v1.ChangePasswordRequest]) (*connect.Response[v1.ChangePasswordResponse], error)
	CreateProject(context.Context, *connect.Request[v1.CreateProjectRequest]) (*connect.Response[v1.CreateProjectResponse], error)
	ListProjects(context.Context, *connect.Request[v1.ListProjectsRequest]) (*connect.Response[v1.ListProjectsResponse], error)
	GetProject(context.Context, *connect.Request[v1.GetProjectRequest]) (*connect.Response[v1.GetProjectResponse], error)
	UpdateProject(context.Context, *connect.Request[v1.UpdateProjectRequest]) (*connect.Response[v1.UpdateProjectResponse], error)
	ListDocuments(context.Context, *connect.Request[v1.ListDocumentsRequest]) (*connect.Response[v1.ListDocumentsResponse], error)
	GetDocument(context.Context, *connect.Request[v1.GetDocumentRequest]) (*connect.Response[v1.GetDocumentResponse], error)
	GetDocuments(context.Context, *connect.Request[v1.GetDocumentsRequest]) (*connect.Response[v1.GetDocumentsResponse], error)
	RemoveDocumentByAdmin(context.Context, *connect.Request[v1.RemoveDocumentByAdminRequest]) (*connect.Response[v1.RemoveDocumentByAdminResponse], error)
	GetSnapshotMeta(context.Context, *connect.Request[v1.GetSnapshotMetaRequest]) (*connect.Response[v1.GetSnapshotMetaResponse], error)
	SearchDocuments(context.Context, *connect.Request[v1.SearchDocumentsRequest]) (*connect.Response[v1.SearchDocumentsResponse], error)
	ListChanges(context.Context, *connect.Request[v1.ListChangesRequest]) (*connect.Response[v1.ListChangesResponse], error)
	GetServerVersion(context.Context, *connect.Request[v1.GetServerVersionRequest]) (*connect.Response[v1.GetServerVersionResponse], error)
}

AdminServiceClient is a client for the yorkie.v1.AdminService service.

func NewAdminServiceClient

func NewAdminServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AdminServiceClient

NewAdminServiceClient constructs a client for the yorkie.v1.AdminService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type AdminServiceHandler

type AdminServiceHandler interface {
	SignUp(context.Context, *connect.Request[v1.SignUpRequest]) (*connect.Response[v1.SignUpResponse], error)
	LogIn(context.Context, *connect.Request[v1.LogInRequest]) (*connect.Response[v1.LogInResponse], error)
	DeleteAccount(context.Context, *connect.Request[v1.DeleteAccountRequest]) (*connect.Response[v1.DeleteAccountResponse], error)
	ChangePassword(context.Context, *connect.Request[v1.ChangePasswordRequest]) (*connect.Response[v1.ChangePasswordResponse], error)
	CreateProject(context.Context, *connect.Request[v1.CreateProjectRequest]) (*connect.Response[v1.CreateProjectResponse], error)
	ListProjects(context.Context, *connect.Request[v1.ListProjectsRequest]) (*connect.Response[v1.ListProjectsResponse], error)
	GetProject(context.Context, *connect.Request[v1.GetProjectRequest]) (*connect.Response[v1.GetProjectResponse], error)
	UpdateProject(context.Context, *connect.Request[v1.UpdateProjectRequest]) (*connect.Response[v1.UpdateProjectResponse], error)
	ListDocuments(context.Context, *connect.Request[v1.ListDocumentsRequest]) (*connect.Response[v1.ListDocumentsResponse], error)
	GetDocument(context.Context, *connect.Request[v1.GetDocumentRequest]) (*connect.Response[v1.GetDocumentResponse], error)
	GetDocuments(context.Context, *connect.Request[v1.GetDocumentsRequest]) (*connect.Response[v1.GetDocumentsResponse], error)
	RemoveDocumentByAdmin(context.Context, *connect.Request[v1.RemoveDocumentByAdminRequest]) (*connect.Response[v1.RemoveDocumentByAdminResponse], error)
	GetSnapshotMeta(context.Context, *connect.Request[v1.GetSnapshotMetaRequest]) (*connect.Response[v1.GetSnapshotMetaResponse], error)
	SearchDocuments(context.Context, *connect.Request[v1.SearchDocumentsRequest]) (*connect.Response[v1.SearchDocumentsResponse], error)
	ListChanges(context.Context, *connect.Request[v1.ListChangesRequest]) (*connect.Response[v1.ListChangesResponse], error)
	GetServerVersion(context.Context, *connect.Request[v1.GetServerVersionRequest]) (*connect.Response[v1.GetServerVersionResponse], error)
}

AdminServiceHandler is an implementation of the yorkie.v1.AdminService service.

type ClusterServiceClient added in v0.5.2

ClusterServiceClient is a client for the yorkie.v1.ClusterService service.

func NewClusterServiceClient added in v0.5.2

func NewClusterServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ClusterServiceClient

NewClusterServiceClient constructs a client for the yorkie.v1.ClusterService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type ClusterServiceHandler added in v0.5.2

ClusterServiceHandler is an implementation of the yorkie.v1.ClusterService service.

type UnimplementedAdminServiceHandler

type UnimplementedAdminServiceHandler struct{}

UnimplementedAdminServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedAdminServiceHandler) ChangePassword added in v0.4.29

func (UnimplementedAdminServiceHandler) DeleteAccount added in v0.4.29

func (UnimplementedAdminServiceHandler) GetDocuments added in v0.4.25

func (UnimplementedAdminServiceHandler) GetServerVersion added in v0.4.30

type UnimplementedClusterServiceHandler added in v0.5.2

type UnimplementedClusterServiceHandler struct{}

UnimplementedClusterServiceHandler returns CodeUnimplemented from all methods.

type UnimplementedYorkieServiceHandler

type UnimplementedYorkieServiceHandler struct{}

UnimplementedYorkieServiceHandler returns CodeUnimplemented from all methods.

type YorkieServiceClient

YorkieServiceClient is a client for the yorkie.v1.YorkieService service.

func NewYorkieServiceClient

func NewYorkieServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) YorkieServiceClient

NewYorkieServiceClient constructs a client for the yorkie.v1.YorkieService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL