v3alpha

package
v3.3.2 Latest Latest
Warning

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

 Go to latest Published: Dec 18, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	ExampleService_Healthz_FullMethodName   = "/zitadel.go.example.api.v3alpha.ExampleService/Healthz"
	ExampleService_ListTasks_FullMethodName = "/zitadel.go.example.api.v3alpha.ExampleService/ListTasks"
	ExampleService_AddTask_FullMethodName   = "/zitadel.go.example.api.v3alpha.ExampleService/AddTask"
	ExampleService_AddTasks_FullMethodName  = "/zitadel.go.example.api.v3alpha.ExampleService/AddTasks"
)

Variables

View Source 
var ExampleService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "zitadel.go.example.api.v3alpha.ExampleService",
	HandlerType: (*ExampleServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Healthz",
			Handler:    _ExampleService_Healthz_Handler,
		},
		{
			MethodName: "ListTasks",
			Handler:    _ExampleService_ListTasks_Handler,
		},
		{
			MethodName: "AddTask",
			Handler:    _ExampleService_AddTask_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "AddTasks",
			Handler:       _ExampleService_AddTasks_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "api.proto",
}

ExampleService_ServiceDesc is the grpc.ServiceDesc for ExampleService 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_api_proto protoreflect.FileDescriptor

Functions

func RegisterExampleServiceServer 

func RegisterExampleServiceServer(s grpc.ServiceRegistrar, srv ExampleServiceServer)

Types

type AddTaskRequest 

type AddTaskRequest struct {

	// the new task to be added
	Task string `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTaskRequest) Descriptor deprecated 

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

Deprecated: Use AddTaskRequest.ProtoReflect.Descriptor instead.

func (*AddTaskRequest) GetTask 

func (x *AddTaskRequest) GetTask() string

func (*AddTaskRequest) ProtoMessage 

func (*AddTaskRequest) ProtoMessage()

func (*AddTaskRequest) ProtoReflect 

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

func (*AddTaskRequest) Reset 

func (x *AddTaskRequest) Reset()

func (*AddTaskRequest) String 

func (x *AddTaskRequest) String() string

type AddTaskResponse 

type AddTaskResponse struct {

	// confirmation of the added task by this call
	Added string `protobuf:"bytes,1,opt,name=added,proto3" json:"added,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTaskResponse) Descriptor deprecated 

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

Deprecated: Use AddTaskResponse.ProtoReflect.Descriptor instead.

func (*AddTaskResponse) GetAdded 

func (x *AddTaskResponse) GetAdded() string

func (*AddTaskResponse) ProtoMessage 

func (*AddTaskResponse) ProtoMessage()

func (*AddTaskResponse) ProtoReflect 

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

func (*AddTaskResponse) Reset 

func (x *AddTaskResponse) Reset()

func (*AddTaskResponse) String 

func (x *AddTaskResponse) String() string

type AddTasksRequest 

type AddTasksRequest struct {

	// the new task to be added
	Task string `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTasksRequest) Descriptor deprecated 

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

Deprecated: Use AddTasksRequest.ProtoReflect.Descriptor instead.

func (*AddTasksRequest) GetTask 

func (x *AddTasksRequest) GetTask() string

func (*AddTasksRequest) ProtoMessage 

func (*AddTasksRequest) ProtoMessage()

func (*AddTasksRequest) ProtoReflect 

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

func (*AddTasksRequest) Reset 

func (x *AddTasksRequest) Reset()

func (*AddTasksRequest) String 

func (x *AddTasksRequest) String() string

type AddTasksResponse 

type AddTasksResponse struct {

	// amount of added task by this call
	Added uint32 `protobuf:"varint,1,opt,name=added,proto3" json:"added,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTasksResponse) Descriptor deprecated 

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

Deprecated: Use AddTasksResponse.ProtoReflect.Descriptor instead.

func (*AddTasksResponse) GetAdded 

func (x *AddTasksResponse) GetAdded() uint32

func (*AddTasksResponse) ProtoMessage 

func (*AddTasksResponse) ProtoMessage()

func (*AddTasksResponse) ProtoReflect 

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

func (*AddTasksResponse) Reset 

func (x *AddTasksResponse) Reset()

func (*AddTasksResponse) String 

func (x *AddTasksResponse) String() string

type ExampleServiceClient 

type ExampleServiceClient interface {
	// Healthz is accessible by anyone and will always return "OK" to indicate the API is running
	Healthz(ctx context.Context, in *HealthzRequest, opts ...grpc.CallOption) (*HealthzResponse, error)
	// ListTasks is only accessible with a valid authorization (in this case a valid access_token / PAT).
	// It will list all stored tasks. In case the user is granted the `admin` role it will add a separate task telling him
	// to add a new task.
	ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error)
	// AddTask is only accessible with a valid authorization, which was granted the `admin` role (in any organization).
	// It will add the provided task to the list of existing ones.
	AddTask(ctx context.Context, in *AddTaskRequest, opts ...grpc.CallOption) (*AddTaskResponse, error)
	// AddTasks is only accessible with a valid authorization, which was granted the `admin` role (in any organization).
	// It demonstrates that GRPC client Stream can be used the same way a standard RPC methods.
	// It will also add the provided task(s) to the list of existing ones.
	AddTasks(ctx context.Context, opts ...grpc.CallOption) (ExampleService_AddTasksClient, error)
}

ExampleServiceClient is the client API for ExampleService 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 NewExampleServiceClient 

func NewExampleServiceClient(cc grpc.ClientConnInterface) ExampleServiceClient

type ExampleServiceServer 

type ExampleServiceServer interface {
	// Healthz is accessible by anyone and will always return "OK" to indicate the API is running
	Healthz(context.Context, *HealthzRequest) (*HealthzResponse, error)
	// ListTasks is only accessible with a valid authorization (in this case a valid access_token / PAT).
	// It will list all stored tasks. In case the user is granted the `admin` role it will add a separate task telling him
	// to add a new task.
	ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
	// AddTask is only accessible with a valid authorization, which was granted the `admin` role (in any organization).
	// It will add the provided task to the list of existing ones.
	AddTask(context.Context, *AddTaskRequest) (*AddTaskResponse, error)
	// AddTasks is only accessible with a valid authorization, which was granted the `admin` role (in any organization).
	// It demonstrates that GRPC client Stream can be used the same way a standard RPC methods.
	// It will also add the provided task(s) to the list of existing ones.
	AddTasks(ExampleService_AddTasksServer) error
	// contains filtered or unexported methods
}

ExampleServiceServer is the server API for ExampleService service. All implementations must embed UnimplementedExampleServiceServer for forward compatibility

type ExampleService_AddTasksClient 

type ExampleService_AddTasksClient interface {
	Send(*AddTasksRequest) error
	CloseAndRecv() (*AddTasksResponse, error)
	grpc.ClientStream
}

type ExampleService_AddTasksServer 

type ExampleService_AddTasksServer interface {
	SendAndClose(*AddTasksResponse) error
	Recv() (*AddTasksRequest, error)
	grpc.ServerStream
}

type HealthzRequest 

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

func (*HealthzRequest) Descriptor deprecated 

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

Deprecated: Use HealthzRequest.ProtoReflect.Descriptor instead.

func (*HealthzRequest) ProtoMessage 

func (*HealthzRequest) ProtoMessage()

func (*HealthzRequest) ProtoReflect 

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

func (*HealthzRequest) Reset 

func (x *HealthzRequest) Reset()

func (*HealthzRequest) String 

func (x *HealthzRequest) String() string

type HealthzResponse 

type HealthzResponse struct {
	Health string `protobuf:"bytes,1,opt,name=health,proto3" json:"health,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthzResponse) Descriptor deprecated 

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

Deprecated: Use HealthzResponse.ProtoReflect.Descriptor instead.

func (*HealthzResponse) GetHealth 

func (x *HealthzResponse) GetHealth() string

func (*HealthzResponse) ProtoMessage 

func (*HealthzResponse) ProtoMessage()

func (*HealthzResponse) ProtoReflect 

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

func (*HealthzResponse) Reset 

func (x *HealthzResponse) Reset()

func (*HealthzResponse) String 

func (x *HealthzResponse) String() string

type ListTasksRequest 

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

func (*ListTasksRequest) Descriptor deprecated 

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

Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.

func (*ListTasksRequest) ProtoMessage 

func (*ListTasksRequest) ProtoMessage()

func (*ListTasksRequest) ProtoReflect 

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

func (*ListTasksRequest) Reset 

func (x *ListTasksRequest) Reset()

func (*ListTasksRequest) String 

func (x *ListTasksRequest) String() string

type ListTasksResponse 

type ListTasksResponse struct {

	// current tasks stored on the server
	Tasks []string `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTasksResponse) Descriptor deprecated 

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

Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.

func (*ListTasksResponse) GetTasks 

func (x *ListTasksResponse) GetTasks() []string

func (*ListTasksResponse) ProtoMessage 

func (*ListTasksResponse) ProtoMessage()

func (*ListTasksResponse) ProtoReflect 

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

func (*ListTasksResponse) Reset 

func (x *ListTasksResponse) Reset()

func (*ListTasksResponse) String 

func (x *ListTasksResponse) String() string

type UnimplementedExampleServiceServer 

type UnimplementedExampleServiceServer struct {
}

UnimplementedExampleServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedExampleServiceServer) AddTask 

func (UnimplementedExampleServiceServer) AddTask(context.Context, *AddTaskRequest) (*AddTaskResponse, error)

func (UnimplementedExampleServiceServer) AddTasks 

func (UnimplementedExampleServiceServer) AddTasks(ExampleService_AddTasksServer) error

func (UnimplementedExampleServiceServer) Healthz 

func (UnimplementedExampleServiceServer) Healthz(context.Context, *HealthzRequest) (*HealthzResponse, error)

func (UnimplementedExampleServiceServer) ListTasks 

func (UnimplementedExampleServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)

type UnsafeExampleServiceServer 

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

UnsafeExampleServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExampleServiceServer 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.