togglev1

package
v0.0.0-...-58ae5d1 Latest Latest
Warning

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

Go to latest
Published: Jan 14, 2022 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package togglev1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var (
	ToggleErrorCode_name = map[int32]string{
		0: "TOGGLE_ERROR_CODE_UNSPECIFIED",
		1: "TOGGLE_ERROR_CODE_INTERNAL",
		2: "TOGGLE_ERROR_CODE_EMPTY_TOGGLE",
		3: "TOGGLE_ERROR_CODE_ALREADY_EXISTS",
		4: "TOGGLE_ERROR_CODE_INVALID_KEY",
		5: "TOGGLE_ERROR_CODE_INVALID_VALUE",
		6: "TOGGLE_ERROR_CODE_NOT_FOUND",
		7: "TOGGLE_ERROR_CODE_PROHIBITED_TO_DELETE",
	}
	ToggleErrorCode_value = map[string]int32{
		"TOGGLE_ERROR_CODE_UNSPECIFIED":          0,
		"TOGGLE_ERROR_CODE_INTERNAL":             1,
		"TOGGLE_ERROR_CODE_EMPTY_TOGGLE":         2,
		"TOGGLE_ERROR_CODE_ALREADY_EXISTS":       3,
		"TOGGLE_ERROR_CODE_INVALID_KEY":          4,
		"TOGGLE_ERROR_CODE_INVALID_VALUE":        5,
		"TOGGLE_ERROR_CODE_NOT_FOUND":            6,
		"TOGGLE_ERROR_CODE_PROHIBITED_TO_DELETE": 7,
	}
)

Enum value maps for ToggleErrorCode.

View Source
var (
	ToggleEventName_name = map[int32]string{
		0: "TOGGLE_EVENT_NAME_UNSPECIFIED",
		1: "TOGGLE_EVENT_NAME_CREATED",
		2: "TOGGLE_EVENT_NAME_ENABLED",
		3: "TOGGLE_EVENT_NAME_DISABLED",
		4: "TOGGLE_EVENT_NAME_DELETED",
	}
	ToggleEventName_value = map[string]int32{
		"TOGGLE_EVENT_NAME_UNSPECIFIED": 0,
		"TOGGLE_EVENT_NAME_CREATED":     1,
		"TOGGLE_EVENT_NAME_ENABLED":     2,
		"TOGGLE_EVENT_NAME_DISABLED":    3,
		"TOGGLE_EVENT_NAME_DELETED":     4,
	}
)

Enum value maps for ToggleEventName.

View Source
var File_proto_indrasaputra_toggle_v1_toggle_proto protoreflect.FileDescriptor
View Source
var ToggleCommandService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "proto.indrasaputra.toggle.v1.ToggleCommandService",
	HandlerType: (*ToggleCommandServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateToggle",
			Handler:    _ToggleCommandService_CreateToggle_Handler,
		},
		{
			MethodName: "EnableToggle",
			Handler:    _ToggleCommandService_EnableToggle_Handler,
		},
		{
			MethodName: "DisableToggle",
			Handler:    _ToggleCommandService_DisableToggle_Handler,
		},
		{
			MethodName: "DeleteToggle",
			Handler:    _ToggleCommandService_DeleteToggle_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/indrasaputra/toggle/v1/toggle.proto",
}

ToggleCommandService_ServiceDesc is the grpc.ServiceDesc for ToggleCommandService 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 ToggleQueryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "proto.indrasaputra.toggle.v1.ToggleQueryService",
	HandlerType: (*ToggleQueryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetToggleByKey",
			Handler:    _ToggleQueryService_GetToggleByKey_Handler,
		},
		{
			MethodName: "GetAllToggles",
			Handler:    _ToggleQueryService_GetAllToggles_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/indrasaputra/toggle/v1/toggle.proto",
}

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

Functions

func RegisterToggleCommandServiceHandler

func RegisterToggleCommandServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterToggleCommandServiceHandler registers the http handlers for service ToggleCommandService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterToggleCommandServiceHandlerClient

func RegisterToggleCommandServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ToggleCommandServiceClient) error

RegisterToggleCommandServiceHandlerClient registers the http handlers for service ToggleCommandService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ToggleCommandServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ToggleCommandServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ToggleCommandServiceClient" to call the correct interceptors.

func RegisterToggleCommandServiceHandlerFromEndpoint

func RegisterToggleCommandServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterToggleCommandServiceHandlerFromEndpoint is same as RegisterToggleCommandServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterToggleCommandServiceHandlerServer

func RegisterToggleCommandServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ToggleCommandServiceServer) error

RegisterToggleCommandServiceHandlerServer registers the http handlers for service ToggleCommandService to "mux". UnaryRPC :call ToggleCommandServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterToggleCommandServiceHandlerFromEndpoint instead.

func RegisterToggleCommandServiceServer

func RegisterToggleCommandServiceServer(s grpc.ServiceRegistrar, srv ToggleCommandServiceServer)

func RegisterToggleQueryServiceHandler

func RegisterToggleQueryServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterToggleQueryServiceHandler registers the http handlers for service ToggleQueryService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterToggleQueryServiceHandlerClient

func RegisterToggleQueryServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ToggleQueryServiceClient) error

RegisterToggleQueryServiceHandlerClient registers the http handlers for service ToggleQueryService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ToggleQueryServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ToggleQueryServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ToggleQueryServiceClient" to call the correct interceptors.

func RegisterToggleQueryServiceHandlerFromEndpoint

func RegisterToggleQueryServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterToggleQueryServiceHandlerFromEndpoint is same as RegisterToggleQueryServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterToggleQueryServiceHandlerServer

func RegisterToggleQueryServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ToggleQueryServiceServer) error

RegisterToggleQueryServiceHandlerServer registers the http handlers for service ToggleQueryService to "mux". UnaryRPC :call ToggleQueryServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterToggleQueryServiceHandlerFromEndpoint instead.

func RegisterToggleQueryServiceServer

func RegisterToggleQueryServiceServer(s grpc.ServiceRegistrar, srv ToggleQueryServiceServer)

Types

type CreateToggleRequest

type CreateToggleRequest struct {

	// toggle represents toggle data.
	Toggle *Toggle `protobuf:"bytes,1,opt,name=toggle,proto3" json:"toggle,omitempty"`
	// contains filtered or unexported fields
}

CreateToggleRequest represents request for create toggle.

func (*CreateToggleRequest) Descriptor deprecated

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

Deprecated: Use CreateToggleRequest.ProtoReflect.Descriptor instead.

func (*CreateToggleRequest) GetToggle

func (x *CreateToggleRequest) GetToggle() *Toggle

func (*CreateToggleRequest) ProtoMessage

func (*CreateToggleRequest) ProtoMessage()

func (*CreateToggleRequest) ProtoReflect

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

func (*CreateToggleRequest) Reset

func (x *CreateToggleRequest) Reset()

func (*CreateToggleRequest) String

func (x *CreateToggleRequest) String() string

type CreateToggleResponse

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

CreateToggleResponse represents response from create toggle.

func (*CreateToggleResponse) Descriptor deprecated

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

Deprecated: Use CreateToggleResponse.ProtoReflect.Descriptor instead.

func (*CreateToggleResponse) ProtoMessage

func (*CreateToggleResponse) ProtoMessage()

func (*CreateToggleResponse) ProtoReflect

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

func (*CreateToggleResponse) Reset

func (x *CreateToggleResponse) Reset()

func (*CreateToggleResponse) String

func (x *CreateToggleResponse) String() string

type DeleteToggleRequest

type DeleteToggleRequest struct {

	// key represents unique toggle's key.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

DeleteToggleRequest represents request for delete a toggle.

func (*DeleteToggleRequest) Descriptor deprecated

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

Deprecated: Use DeleteToggleRequest.ProtoReflect.Descriptor instead.

func (*DeleteToggleRequest) GetKey

func (x *DeleteToggleRequest) GetKey() string

func (*DeleteToggleRequest) ProtoMessage

func (*DeleteToggleRequest) ProtoMessage()

func (*DeleteToggleRequest) ProtoReflect

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

func (*DeleteToggleRequest) Reset

func (x *DeleteToggleRequest) Reset()

func (*DeleteToggleRequest) String

func (x *DeleteToggleRequest) String() string

type DeleteToggleResponse

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

DeleteToggleResponse represents request from delete a toggle.

func (*DeleteToggleResponse) Descriptor deprecated

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

Deprecated: Use DeleteToggleResponse.ProtoReflect.Descriptor instead.

func (*DeleteToggleResponse) ProtoMessage

func (*DeleteToggleResponse) ProtoMessage()

func (*DeleteToggleResponse) ProtoReflect

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

func (*DeleteToggleResponse) Reset

func (x *DeleteToggleResponse) Reset()

func (*DeleteToggleResponse) String

func (x *DeleteToggleResponse) String() string

type DisableToggleRequest

type DisableToggleRequest struct {

	// key represents unique toggle's key.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

DisableToggleRequest represents request for disable a toggle.

func (*DisableToggleRequest) Descriptor deprecated

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

Deprecated: Use DisableToggleRequest.ProtoReflect.Descriptor instead.

func (*DisableToggleRequest) GetKey

func (x *DisableToggleRequest) GetKey() string

func (*DisableToggleRequest) ProtoMessage

func (*DisableToggleRequest) ProtoMessage()

func (*DisableToggleRequest) ProtoReflect

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

func (*DisableToggleRequest) Reset

func (x *DisableToggleRequest) Reset()

func (*DisableToggleRequest) String

func (x *DisableToggleRequest) String() string

type DisableToggleResponse

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

DisableToggleResponse represents request from disable a toggle.

func (*DisableToggleResponse) Descriptor deprecated

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

Deprecated: Use DisableToggleResponse.ProtoReflect.Descriptor instead.

func (*DisableToggleResponse) ProtoMessage

func (*DisableToggleResponse) ProtoMessage()

func (*DisableToggleResponse) ProtoReflect

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

func (*DisableToggleResponse) Reset

func (x *DisableToggleResponse) Reset()

func (*DisableToggleResponse) String

func (x *DisableToggleResponse) String() string

type EnableToggleRequest

type EnableToggleRequest struct {

	// key represents unique toggle's key.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

EnableToggleRequest represents request for enable a toggle.

func (*EnableToggleRequest) Descriptor deprecated

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

Deprecated: Use EnableToggleRequest.ProtoReflect.Descriptor instead.

func (*EnableToggleRequest) GetKey

func (x *EnableToggleRequest) GetKey() string

func (*EnableToggleRequest) ProtoMessage

func (*EnableToggleRequest) ProtoMessage()

func (*EnableToggleRequest) ProtoReflect

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

func (*EnableToggleRequest) Reset

func (x *EnableToggleRequest) Reset()

func (*EnableToggleRequest) String

func (x *EnableToggleRequest) String() string

type EnableToggleResponse

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

EnableToggleResponse represents request from enable a toggle.

func (*EnableToggleResponse) Descriptor deprecated

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

Deprecated: Use EnableToggleResponse.ProtoReflect.Descriptor instead.

func (*EnableToggleResponse) ProtoMessage

func (*EnableToggleResponse) ProtoMessage()

func (*EnableToggleResponse) ProtoReflect

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

func (*EnableToggleResponse) Reset

func (x *EnableToggleResponse) Reset()

func (*EnableToggleResponse) String

func (x *EnableToggleResponse) String() string

type GetAllTogglesRequest

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

GetAllTogglesRequest represents request for get all toggles.

func (*GetAllTogglesRequest) Descriptor deprecated

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

Deprecated: Use GetAllTogglesRequest.ProtoReflect.Descriptor instead.

func (*GetAllTogglesRequest) ProtoMessage

func (*GetAllTogglesRequest) ProtoMessage()

func (*GetAllTogglesRequest) ProtoReflect

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

func (*GetAllTogglesRequest) Reset

func (x *GetAllTogglesRequest) Reset()

func (*GetAllTogglesRequest) String

func (x *GetAllTogglesRequest) String() string

type GetAllTogglesResponse

type GetAllTogglesResponse struct {

	// toggles represents an array of toggle data.
	Toggles []*Toggle `protobuf:"bytes,1,rep,name=toggles,proto3" json:"toggles,omitempty"`
	// contains filtered or unexported fields
}

GetAllTogglesResponse represents response from get all toggles.

func (*GetAllTogglesResponse) Descriptor deprecated

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

Deprecated: Use GetAllTogglesResponse.ProtoReflect.Descriptor instead.

func (*GetAllTogglesResponse) GetToggles

func (x *GetAllTogglesResponse) GetToggles() []*Toggle

func (*GetAllTogglesResponse) ProtoMessage

func (*GetAllTogglesResponse) ProtoMessage()

func (*GetAllTogglesResponse) ProtoReflect

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

func (*GetAllTogglesResponse) Reset

func (x *GetAllTogglesResponse) Reset()

func (*GetAllTogglesResponse) String

func (x *GetAllTogglesResponse) String() string

type GetToggleByKeyRequest

type GetToggleByKeyRequest struct {

	// key represents unique toggle's key.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

GetToggleByKeyRequest represents request for get toggle by key.

func (*GetToggleByKeyRequest) Descriptor deprecated

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

Deprecated: Use GetToggleByKeyRequest.ProtoReflect.Descriptor instead.

func (*GetToggleByKeyRequest) GetKey

func (x *GetToggleByKeyRequest) GetKey() string

func (*GetToggleByKeyRequest) ProtoMessage

func (*GetToggleByKeyRequest) ProtoMessage()

func (*GetToggleByKeyRequest) ProtoReflect

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

func (*GetToggleByKeyRequest) Reset

func (x *GetToggleByKeyRequest) Reset()

func (*GetToggleByKeyRequest) String

func (x *GetToggleByKeyRequest) String() string

type GetToggleByKeyResponse

type GetToggleByKeyResponse struct {

	// toggle represents toggle data.
	Toggle *Toggle `protobuf:"bytes,1,opt,name=toggle,proto3" json:"toggle,omitempty"`
	// contains filtered or unexported fields
}

GetToggleByKeyResponse represents response from get toggle by key.

func (*GetToggleByKeyResponse) Descriptor deprecated

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

Deprecated: Use GetToggleByKeyResponse.ProtoReflect.Descriptor instead.

func (*GetToggleByKeyResponse) GetToggle

func (x *GetToggleByKeyResponse) GetToggle() *Toggle

func (*GetToggleByKeyResponse) ProtoMessage

func (*GetToggleByKeyResponse) ProtoMessage()

func (*GetToggleByKeyResponse) ProtoReflect

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

func (*GetToggleByKeyResponse) Reset

func (x *GetToggleByKeyResponse) Reset()

func (*GetToggleByKeyResponse) String

func (x *GetToggleByKeyResponse) String() string

type Toggle

type Toggle struct {

	// key represents a unique identifier of a toggle.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// is_enabled represents the toggle's usability status.
	IsEnabled bool `protobuf:"varint,2,opt,name=is_enabled,json=isEnabled,proto3" json:"is_enabled,omitempty"`
	// description represents a concise description of a toggle.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// created_at represents when the toggle was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// updated_at represents when the toggle was last updated.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// contains filtered or unexported fields
}

Toggle represents a toggle data.

func (*Toggle) Descriptor deprecated

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

Deprecated: Use Toggle.ProtoReflect.Descriptor instead.

func (*Toggle) GetCreatedAt

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

func (*Toggle) GetDescription

func (x *Toggle) GetDescription() string

func (*Toggle) GetIsEnabled

func (x *Toggle) GetIsEnabled() bool

func (*Toggle) GetKey

func (x *Toggle) GetKey() string

func (*Toggle) GetUpdatedAt

func (x *Toggle) GetUpdatedAt() *timestamppb.Timestamp

func (*Toggle) ProtoMessage

func (*Toggle) ProtoMessage()

func (*Toggle) ProtoReflect

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

func (*Toggle) Reset

func (x *Toggle) Reset()

func (*Toggle) String

func (x *Toggle) String() string

type ToggleCommandServiceClient

type ToggleCommandServiceClient interface {
	// Create a new toggle.
	//
	// This endpoint creates a new toggle with provided key and description.
	// The description can be left empty, but the key must exists.
	// The key must be unique and it can only contain alphanumeric and dash.
	// The key will be converted to lower case.
	CreateToggle(ctx context.Context, in *CreateToggleRequest, opts ...grpc.CallOption) (*CreateToggleResponse, error)
	// Enable a toggle.
	//
	// This endpoint set toggle's usability to active.
	// Its *isEnabled* attribute will be set to true.
	EnableToggle(ctx context.Context, in *EnableToggleRequest, opts ...grpc.CallOption) (*EnableToggleResponse, error)
	// Disable a toggle.
	//
	// This endpoint set toggle's usability to inactive.
	// Its *isEnabled* attribute will be set to false.
	DisableToggle(ctx context.Context, in *DisableToggleRequest, opts ...grpc.CallOption) (*DisableToggleResponse, error)
	// Delete a toggle.
	//
	// This endpoint deletes a toggle by its key.
	// The operation is hard-delete, thus the toggle will be gone forever.
	DeleteToggle(ctx context.Context, in *DeleteToggleRequest, opts ...grpc.CallOption) (*DeleteToggleResponse, error)
}

ToggleCommandServiceClient is the client API for ToggleCommandService 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.

type ToggleCommandServiceServer

type ToggleCommandServiceServer interface {
	// Create a new toggle.
	//
	// This endpoint creates a new toggle with provided key and description.
	// The description can be left empty, but the key must exists.
	// The key must be unique and it can only contain alphanumeric and dash.
	// The key will be converted to lower case.
	CreateToggle(context.Context, *CreateToggleRequest) (*CreateToggleResponse, error)
	// Enable a toggle.
	//
	// This endpoint set toggle's usability to active.
	// Its *isEnabled* attribute will be set to true.
	EnableToggle(context.Context, *EnableToggleRequest) (*EnableToggleResponse, error)
	// Disable a toggle.
	//
	// This endpoint set toggle's usability to inactive.
	// Its *isEnabled* attribute will be set to false.
	DisableToggle(context.Context, *DisableToggleRequest) (*DisableToggleResponse, error)
	// Delete a toggle.
	//
	// This endpoint deletes a toggle by its key.
	// The operation is hard-delete, thus the toggle will be gone forever.
	DeleteToggle(context.Context, *DeleteToggleRequest) (*DeleteToggleResponse, error)
	// contains filtered or unexported methods
}

ToggleCommandServiceServer is the server API for ToggleCommandService service. All implementations must embed UnimplementedToggleCommandServiceServer for forward compatibility

type ToggleError

type ToggleError struct {

	// error_code represents specific and unique error code for toggle.
	ErrorCode ToggleErrorCode `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

ToggleError represents message for any error happening in toggle.

func (*ToggleError) Descriptor deprecated

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

Deprecated: Use ToggleError.ProtoReflect.Descriptor instead.

func (*ToggleError) GetErrorCode

func (x *ToggleError) GetErrorCode() ToggleErrorCode

func (*ToggleError) ProtoMessage

func (*ToggleError) ProtoMessage()

func (*ToggleError) ProtoReflect

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

func (*ToggleError) Reset

func (x *ToggleError) Reset()

func (*ToggleError) String

func (x *ToggleError) String() string

type ToggleErrorCode

type ToggleErrorCode int32

ToggleErrorCode enumerates toggle error code.

const (
	// Default enum code according to
	// https://medium.com/@akhaku/protobuf-definition-best-practices-87f281576f31.
	ToggleErrorCode_TOGGLE_ERROR_CODE_UNSPECIFIED ToggleErrorCode = 0
	// Unexpected behavior occured in system.
	ToggleErrorCode_TOGGLE_ERROR_CODE_INTERNAL ToggleErrorCode = 1
	// Toggle instance is empty or nil.
	ToggleErrorCode_TOGGLE_ERROR_CODE_EMPTY_TOGGLE ToggleErrorCode = 2
	// Toggle already exists.
	// The uniqueness of a toggle is represented by its key.
	ToggleErrorCode_TOGGLE_ERROR_CODE_ALREADY_EXISTS ToggleErrorCode = 3
	// Toggle's key is invalid.
	// It can be triggered when the key doesn't contain character other than alphanumeric and dash.
	ToggleErrorCode_TOGGLE_ERROR_CODE_INVALID_KEY ToggleErrorCode = 4
	// Toggle's value (is_enabled field) is invalid.
	// The value must be boolean.
	ToggleErrorCode_TOGGLE_ERROR_CODE_INVALID_VALUE ToggleErrorCode = 5
	// Toggle not found in system.
	ToggleErrorCode_TOGGLE_ERROR_CODE_NOT_FOUND ToggleErrorCode = 6
	// Toggle's value (is_enabled field) is true and it can't be deleted.
	// It must be disabled (is_enabled set to false) first before deletion.
	ToggleErrorCode_TOGGLE_ERROR_CODE_PROHIBITED_TO_DELETE ToggleErrorCode = 7
)

func (ToggleErrorCode) Descriptor

func (ToggleErrorCode) Enum

func (x ToggleErrorCode) Enum() *ToggleErrorCode

func (ToggleErrorCode) EnumDescriptor deprecated

func (ToggleErrorCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ToggleErrorCode.Descriptor instead.

func (ToggleErrorCode) Number

func (ToggleErrorCode) String

func (x ToggleErrorCode) String() string

func (ToggleErrorCode) Type

type ToggleEvent

type ToggleEvent struct {

	// name represents event's name.
	Name ToggleEventName `protobuf:"varint,1,opt,name=name,proto3,enum=proto.indrasaputra.toggle.v1.ToggleEventName" json:"name,omitempty"`
	// toggle represents the toggle in the event.
	Toggle *Toggle `protobuf:"bytes,2,opt,name=toggle,proto3" json:"toggle,omitempty"`
	// created_at represents when the event was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// contains filtered or unexported fields
}

ToggleEvent represents an event of a toggle.

func (*ToggleEvent) Descriptor deprecated

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

Deprecated: Use ToggleEvent.ProtoReflect.Descriptor instead.

func (*ToggleEvent) GetCreatedAt

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

func (*ToggleEvent) GetName

func (x *ToggleEvent) GetName() ToggleEventName

func (*ToggleEvent) GetToggle

func (x *ToggleEvent) GetToggle() *Toggle

func (*ToggleEvent) ProtoMessage

func (*ToggleEvent) ProtoMessage()

func (*ToggleEvent) ProtoReflect

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

func (*ToggleEvent) Reset

func (x *ToggleEvent) Reset()

func (*ToggleEvent) String

func (x *ToggleEvent) String() string

type ToggleEventName

type ToggleEventName int32

ToggleEventName enumerates toggle event name.

const (
	// Default enum code according to
	// https://medium.com/@akhaku/protobuf-definition-best-practices-87f281576f31.
	ToggleEventName_TOGGLE_EVENT_NAME_UNSPECIFIED ToggleEventName = 0
	// Occur when toggle is created.
	ToggleEventName_TOGGLE_EVENT_NAME_CREATED ToggleEventName = 1
	// Occur when toggle is enabled.
	ToggleEventName_TOGGLE_EVENT_NAME_ENABLED ToggleEventName = 2
	// Occur when toggle is disabled.
	ToggleEventName_TOGGLE_EVENT_NAME_DISABLED ToggleEventName = 3
	// Occur when toggle is deleted.
	ToggleEventName_TOGGLE_EVENT_NAME_DELETED ToggleEventName = 4
)

func (ToggleEventName) Descriptor

func (ToggleEventName) Enum

func (x ToggleEventName) Enum() *ToggleEventName

func (ToggleEventName) EnumDescriptor deprecated

func (ToggleEventName) EnumDescriptor() ([]byte, []int)

Deprecated: Use ToggleEventName.Descriptor instead.

func (ToggleEventName) Number

func (ToggleEventName) String

func (x ToggleEventName) String() string

func (ToggleEventName) Type

type ToggleQueryServiceClient

type ToggleQueryServiceClient interface {
	// Get a toggle.
	//
	// This endpoint gets a single toggle by its key.
	GetToggleByKey(ctx context.Context, in *GetToggleByKeyRequest, opts ...grpc.CallOption) (*GetToggleByKeyResponse, error)
	// Get many toggles.
	//
	// This endpoint gets all available toggles in the system.
	// Currently, it only retrieves 10 toggles at most.
	GetAllToggles(ctx context.Context, in *GetAllTogglesRequest, opts ...grpc.CallOption) (*GetAllTogglesResponse, error)
}

ToggleQueryServiceClient is the client API for ToggleQueryService 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.

type ToggleQueryServiceServer

type ToggleQueryServiceServer interface {
	// Get a toggle.
	//
	// This endpoint gets a single toggle by its key.
	GetToggleByKey(context.Context, *GetToggleByKeyRequest) (*GetToggleByKeyResponse, error)
	// Get many toggles.
	//
	// This endpoint gets all available toggles in the system.
	// Currently, it only retrieves 10 toggles at most.
	GetAllToggles(context.Context, *GetAllTogglesRequest) (*GetAllTogglesResponse, error)
	// contains filtered or unexported methods
}

ToggleQueryServiceServer is the server API for ToggleQueryService service. All implementations must embed UnimplementedToggleQueryServiceServer for forward compatibility

type UnimplementedToggleCommandServiceServer

type UnimplementedToggleCommandServiceServer struct {
}

UnimplementedToggleCommandServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedToggleCommandServiceServer) CreateToggle

func (UnimplementedToggleCommandServiceServer) DeleteToggle

func (UnimplementedToggleCommandServiceServer) DisableToggle

func (UnimplementedToggleCommandServiceServer) EnableToggle

type UnimplementedToggleQueryServiceServer

type UnimplementedToggleQueryServiceServer struct {
}

UnimplementedToggleQueryServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedToggleQueryServiceServer) GetAllToggles

func (UnimplementedToggleQueryServiceServer) GetToggleByKey

type UnsafeToggleCommandServiceServer

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

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

type UnsafeToggleQueryServiceServer

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

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

Jump to

Keyboard shortcuts

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