configgrpc

Documentation

Index

• Constants
• Variables
• func RegisterConfigAPIServer(s grpc.ServiceRegistrar, srv ConfigAPIServer)
• type ConfigAPIClient
  • func NewConfigAPIClient(cc grpc.ClientConnInterface) ConfigAPIClient
• type ConfigAPIClientStub
  • func (c *ConfigAPIClientStub) ListApplications(ctx context.Context, req *ListApplicationsRequest, options ...grpc.CallOption) (*ListApplicationsResponse, error)
• type ConfigAPIServer
• type ListApplicationsRequest
  • func (*ListApplicationsRequest) Descriptor() ([]byte, []int)
  • func (*ListApplicationsRequest) ProtoMessage()
  • func (x *ListApplicationsRequest) ProtoReflect() protoreflect.Message
  • func (x *ListApplicationsRequest) Reset()
  • func (x *ListApplicationsRequest) String() string
• type ListApplicationsRequestBuilder
  • func NewListApplicationsRequestBuilder() *ListApplicationsRequestBuilder
  • func (b *ListApplicationsRequestBuilder) Build() *ListApplicationsRequest
  • func (b *ListApplicationsRequestBuilder) From(x *ListApplicationsRequest) *ListApplicationsRequestBuilder
• type ListApplicationsResponse
  • func (*ListApplicationsResponse) Descriptor() ([]byte, []int)
  • func (x *ListApplicationsResponse) GetApplications() []*configpb.Application
  • func (*ListApplicationsResponse) ProtoMessage()
  • func (x *ListApplicationsResponse) ProtoReflect() protoreflect.Message
  • func (x *ListApplicationsResponse) Reset()
  • func (x *ListApplicationsResponse) SetApplications(v []*configpb.Application)
  • func (x *ListApplicationsResponse) String() string
• type ListApplicationsResponseBuilder
  • func NewListApplicationsResponseBuilder() *ListApplicationsResponseBuilder
  • func (b *ListApplicationsResponseBuilder) Build() *ListApplicationsResponse
  • func (b *ListApplicationsResponseBuilder) From(x *ListApplicationsResponse) *ListApplicationsResponseBuilder
  • func (b *ListApplicationsResponseBuilder) WithApplications(v []*configpb.Application) *ListApplicationsResponseBuilder
• type UnimplementedConfigAPIServer
  • func (UnimplementedConfigAPIServer) ListApplications(context.Context, *ListApplicationsRequest) (*ListApplicationsResponse, error)
• type UnsafeConfigAPIServer

Constants

const (
	ConfigAPI_ListApplications_FullMethodName = "/dogma.config.v1.ConfigAPI/ListApplications"
)

Variables

var ConfigAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "dogma.config.v1.ConfigAPI",
	HandlerType: (*ConfigAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListApplications",
			Handler:    _ConfigAPI_ListApplications_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "github.com/dogmatiq/enginekit/grpc/configgrpc/config.proto",
}

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

var File_github_com_dogmatiq_enginekit_grpc_configgrpc_config_proto protoreflect.FileDescriptor

Functions

func RegisterConfigAPIServer

func RegisterConfigAPIServer(s grpc.ServiceRegistrar, srv ConfigAPIServer)

Types

type ConfigAPIClient

type ConfigAPIClient interface {
	// ListApplications returns the full configuration of all applications.
	ListApplications(ctx context.Context, in *ListApplicationsRequest, opts ...grpc.CallOption) (*ListApplicationsResponse, error)
}

ConfigAPIClient is the client API for ConfigAPI 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.

ConfigAPI is a service for inspecting the configuration of Dogma applications hosted by the engine on the server.

func NewConfigAPIClient

func NewConfigAPIClient(cc grpc.ClientConnInterface) ConfigAPIClient

type ConfigAPIClientStub

type ConfigAPIClientStub struct {
	// ListApplicationsFunc is a function that implements the ListApplications RPC method.
	ListApplicationsFunc func(ctx context.Context, req *ListApplicationsRequest, options ...grpc.CallOption) (*ListApplicationsResponse, error)
}

func (*ConfigAPIClientStub) ListApplications

func (c *ConfigAPIClientStub) ListApplications(ctx context.Context, req *ListApplicationsRequest, options ...grpc.CallOption) (*ListApplicationsResponse, error)

ListApplications calls c.ListApplicationsFunc if it is non-nil. Otherwise, it returns an error.

type ConfigAPIServer

type ConfigAPIServer interface {
	// ListApplications returns the full configuration of all applications.
	ListApplications(context.Context, *ListApplicationsRequest) (*ListApplicationsResponse, error)
}

ConfigAPIServer is the server API for ConfigAPI service. All implementations should embed UnimplementedConfigAPIServer for forward compatibility.

ConfigAPI is a service for inspecting the configuration of Dogma applications hosted by the engine on the server.

type ListApplicationsRequest

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

func (*ListApplicationsRequest) Descriptor

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

Deprecated: Use ListApplicationsRequest.ProtoReflect.Descriptor instead.

func (*ListApplicationsRequest) ProtoMessage

func (*ListApplicationsRequest) ProtoMessage()

func (*ListApplicationsRequest) ProtoReflect

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

func (*ListApplicationsRequest) Reset

func (x *ListApplicationsRequest) Reset()

func (*ListApplicationsRequest) String

func (x *ListApplicationsRequest) String() string

type ListApplicationsRequestBuilder

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

func NewListApplicationsRequestBuilder

func NewListApplicationsRequestBuilder() *ListApplicationsRequestBuilder

NewListApplicationsRequestBuilder returns a builder that constructs ListApplicationsRequest messages.

func (*ListApplicationsRequestBuilder) Build

func (b *ListApplicationsRequestBuilder) Build() *ListApplicationsRequest

Build returns a new ListApplicationsRequest containing the values configured via the builder.

Each call returns a new message, such that future changes to the builder do not modify previously constructed messages.

func (*ListApplicationsRequestBuilder) From

func (b *ListApplicationsRequestBuilder) From(x *ListApplicationsRequest) *ListApplicationsRequestBuilder

From configures the builder to use x as the prototype for new messages, then returns b.

It performs a shallow copy of x, such that any changes made via the builder do not modify x. It does not make a copy of the field values themselves.

type ListApplicationsResponse

type ListApplicationsResponse struct {
	Applications []*configpb.Application `protobuf:"bytes,1,rep,name=applications,proto3" json:"applications,omitempty"`
	// contains filtered or unexported fields
}

func (*ListApplicationsResponse) Descriptor

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

Deprecated: Use ListApplicationsResponse.ProtoReflect.Descriptor instead.

func (*ListApplicationsResponse) GetApplications

func (x *ListApplicationsResponse) GetApplications() []*configpb.Application

func (*ListApplicationsResponse) ProtoMessage

func (*ListApplicationsResponse) ProtoMessage()

func (*ListApplicationsResponse) ProtoReflect

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

func (*ListApplicationsResponse) Reset

func (x *ListApplicationsResponse) Reset()

func (*ListApplicationsResponse) SetApplications

func (x *ListApplicationsResponse) SetApplications(v []*configpb.Application)

SetApplications sets the x.Applications field to v, then returns x.

func (*ListApplicationsResponse) String

func (x *ListApplicationsResponse) String() string

type ListApplicationsResponseBuilder

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

func NewListApplicationsResponseBuilder

func NewListApplicationsResponseBuilder() *ListApplicationsResponseBuilder

NewListApplicationsResponseBuilder returns a builder that constructs ListApplicationsResponse messages.

func (*ListApplicationsResponseBuilder) Build

func (b *ListApplicationsResponseBuilder) Build() *ListApplicationsResponse

Build returns a new ListApplicationsResponse containing the values configured via the builder.

Each call returns a new message, such that future changes to the builder do not modify previously constructed messages.

func (*ListApplicationsResponseBuilder) From

func (b *ListApplicationsResponseBuilder) From(x *ListApplicationsResponse) *ListApplicationsResponseBuilder

From configures the builder to use x as the prototype for new messages, then returns b.

It performs a shallow copy of x, such that any changes made via the builder do not modify x. It does not make a copy of the field values themselves.

func (*ListApplicationsResponseBuilder) WithApplications

func (b *ListApplicationsResponseBuilder) WithApplications(v []*configpb.Application) *ListApplicationsResponseBuilder

WithApplications configures the builder to set the Applications field to v, then returns b.

type UnimplementedConfigAPIServer

type UnimplementedConfigAPIServer struct{}

UnimplementedConfigAPIServer 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 (UnimplementedConfigAPIServer) ListApplications

func (UnimplementedConfigAPIServer) ListApplications(context.Context, *ListApplicationsRequest) (*ListApplicationsResponse, error)

type UnsafeConfigAPIServer

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

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