Documentation ¶
Overview ¶
Package api is a generated protocol buffer package.
It is generated from these files:
control.proto objects.proto specs.proto types.proto
It has these top-level messages:
ListRoomsRequest ListRoomsResponse CreateRoomRequest CreateRoomResponse UpdateRoomRequest UpdateRoomResponse DeleteRoomRequest DeleteRoomResponse Room RoomSpec UpdateStatus
Package api is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterGipfeliRoomServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterGipfeliRoomServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterGipfeliRoomServiceServer(s *grpc.Server, srv GipfeliRoomServiceServer)
- type CreateRoomRequest
- type CreateRoomResponse
- type DeleteRoomRequest
- type DeleteRoomResponse
- type GipfeliRoomServiceClient
- type GipfeliRoomServiceServer
- type ListRoomsRequest
- type ListRoomsRequest_Filters
- func (*ListRoomsRequest_Filters) Descriptor() ([]byte, []int)
- func (m *ListRoomsRequest_Filters) GetCatalogs() []string
- func (m *ListRoomsRequest_Filters) GetIds() []string
- func (m *ListRoomsRequest_Filters) GetNames() []string
- func (*ListRoomsRequest_Filters) ProtoMessage()
- func (m *ListRoomsRequest_Filters) Reset()
- func (m *ListRoomsRequest_Filters) String() string
- type ListRoomsResponse
- type Room
- type RoomSpec
- type UpdateRoomRequest
- type UpdateRoomResponse
- type UpdateStatus
- type UpdateStatus_UpdateState
Constants ¶
This section is empty.
Variables ¶
View Source
var UpdateStatus_UpdateState_name = map[int32]string{
0: "UNKNOWN",
1: "UPDATING",
2: "PAUSED",
3: "COMPLETED",
}
View Source
var UpdateStatus_UpdateState_value = map[string]int32{
"UNKNOWN": 0,
"UPDATING": 1,
"PAUSED": 2,
"COMPLETED": 3,
}
Functions ¶
func RegisterGipfeliRoomServiceHandler ¶
func RegisterGipfeliRoomServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterGipfeliRoomServiceHandler registers the http handlers for service GipfeliRoomService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterGipfeliRoomServiceHandlerFromEndpoint ¶
func RegisterGipfeliRoomServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterGipfeliRoomServiceHandlerFromEndpoint is same as RegisterGipfeliRoomServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterGipfeliRoomServiceServer ¶
func RegisterGipfeliRoomServiceServer(s *grpc.Server, srv GipfeliRoomServiceServer)
Types ¶
type CreateRoomRequest ¶
type CreateRoomRequest struct {
RoomSpec *RoomSpec `protobuf:"bytes,1,opt,name=room_spec,json=roomSpec" json:"room_spec,omitempty"`
}
func (*CreateRoomRequest) Descriptor ¶
func (*CreateRoomRequest) Descriptor() ([]byte, []int)
func (*CreateRoomRequest) GetRoomSpec ¶
func (m *CreateRoomRequest) GetRoomSpec() *RoomSpec
func (*CreateRoomRequest) ProtoMessage ¶
func (*CreateRoomRequest) ProtoMessage()
func (*CreateRoomRequest) Reset ¶
func (m *CreateRoomRequest) Reset()
func (*CreateRoomRequest) String ¶
func (m *CreateRoomRequest) String() string
type CreateRoomResponse ¶
type CreateRoomResponse struct {
Room *Room `protobuf:"bytes,1,opt,name=room" json:"room,omitempty"`
}
func (*CreateRoomResponse) Descriptor ¶
func (*CreateRoomResponse) Descriptor() ([]byte, []int)
func (*CreateRoomResponse) GetRoom ¶
func (m *CreateRoomResponse) GetRoom() *Room
func (*CreateRoomResponse) ProtoMessage ¶
func (*CreateRoomResponse) ProtoMessage()
func (*CreateRoomResponse) Reset ¶
func (m *CreateRoomResponse) Reset()
func (*CreateRoomResponse) String ¶
func (m *CreateRoomResponse) String() string
type DeleteRoomRequest ¶
type DeleteRoomRequest struct {
RoomId string `protobuf:"bytes,1,opt,name=room_id,json=roomId" json:"room_id,omitempty"`
}
func (*DeleteRoomRequest) Descriptor ¶
func (*DeleteRoomRequest) Descriptor() ([]byte, []int)
func (*DeleteRoomRequest) GetRoomId ¶
func (m *DeleteRoomRequest) GetRoomId() string
func (*DeleteRoomRequest) ProtoMessage ¶
func (*DeleteRoomRequest) ProtoMessage()
func (*DeleteRoomRequest) Reset ¶
func (m *DeleteRoomRequest) Reset()
func (*DeleteRoomRequest) String ¶
func (m *DeleteRoomRequest) String() string
type DeleteRoomResponse ¶
type DeleteRoomResponse struct {
Room *Room `protobuf:"bytes,1,opt,name=room" json:"room,omitempty"`
}
func (*DeleteRoomResponse) Descriptor ¶
func (*DeleteRoomResponse) Descriptor() ([]byte, []int)
func (*DeleteRoomResponse) GetRoom ¶
func (m *DeleteRoomResponse) GetRoom() *Room
func (*DeleteRoomResponse) ProtoMessage ¶
func (*DeleteRoomResponse) ProtoMessage()
func (*DeleteRoomResponse) Reset ¶
func (m *DeleteRoomResponse) Reset()
func (*DeleteRoomResponse) String ¶
func (m *DeleteRoomResponse) String() string
type GipfeliRoomServiceClient ¶
type GipfeliRoomServiceClient interface { ListRooms(ctx context.Context, in *ListRoomsRequest, opts ...grpc.CallOption) (*ListRoomsResponse, error) CreateRoom(ctx context.Context, in *CreateRoomRequest, opts ...grpc.CallOption) (*CreateRoomResponse, error) UpdateRoom(ctx context.Context, in *UpdateRoomRequest, opts ...grpc.CallOption) (*UpdateRoomResponse, error) DeleteRoom(ctx context.Context, in *DeleteRoomRequest, opts ...grpc.CallOption) (*DeleteRoomResponse, error) }
func NewGipfeliRoomServiceClient ¶
func NewGipfeliRoomServiceClient(cc *grpc.ClientConn) GipfeliRoomServiceClient
type GipfeliRoomServiceServer ¶
type GipfeliRoomServiceServer interface { ListRooms(context.Context, *ListRoomsRequest) (*ListRoomsResponse, error) CreateRoom(context.Context, *CreateRoomRequest) (*CreateRoomResponse, error) UpdateRoom(context.Context, *UpdateRoomRequest) (*UpdateRoomResponse, error) DeleteRoom(context.Context, *DeleteRoomRequest) (*DeleteRoomResponse, error) }
type ListRoomsRequest ¶
type ListRoomsRequest struct {
Filters *ListRoomsRequest_Filters `protobuf:"bytes,1,opt,name=filters" json:"filters,omitempty"`
}
func (*ListRoomsRequest) Descriptor ¶
func (*ListRoomsRequest) Descriptor() ([]byte, []int)
func (*ListRoomsRequest) GetFilters ¶
func (m *ListRoomsRequest) GetFilters() *ListRoomsRequest_Filters
func (*ListRoomsRequest) ProtoMessage ¶
func (*ListRoomsRequest) ProtoMessage()
func (*ListRoomsRequest) Reset ¶
func (m *ListRoomsRequest) Reset()
func (*ListRoomsRequest) String ¶
func (m *ListRoomsRequest) String() string
type ListRoomsRequest_Filters ¶
type ListRoomsRequest_Filters struct { Names []string `protobuf:"bytes,1,rep,name=names" json:"names,omitempty"` Ids []string `protobuf:"bytes,2,rep,name=ids" json:"ids,omitempty"` Catalogs []string `protobuf:"bytes,3,rep,name=catalogs" json:"catalogs,omitempty"` }
func (*ListRoomsRequest_Filters) Descriptor ¶
func (*ListRoomsRequest_Filters) Descriptor() ([]byte, []int)
func (*ListRoomsRequest_Filters) GetCatalogs ¶
func (m *ListRoomsRequest_Filters) GetCatalogs() []string
func (*ListRoomsRequest_Filters) GetIds ¶
func (m *ListRoomsRequest_Filters) GetIds() []string
func (*ListRoomsRequest_Filters) GetNames ¶
func (m *ListRoomsRequest_Filters) GetNames() []string
func (*ListRoomsRequest_Filters) ProtoMessage ¶
func (*ListRoomsRequest_Filters) ProtoMessage()
func (*ListRoomsRequest_Filters) Reset ¶
func (m *ListRoomsRequest_Filters) Reset()
func (*ListRoomsRequest_Filters) String ¶
func (m *ListRoomsRequest_Filters) String() string
type ListRoomsResponse ¶
type ListRoomsResponse struct {
Room []*Room `protobuf:"bytes,1,rep,name=room" json:"room,omitempty"`
}
func (*ListRoomsResponse) Descriptor ¶
func (*ListRoomsResponse) Descriptor() ([]byte, []int)
func (*ListRoomsResponse) GetRoom ¶
func (m *ListRoomsResponse) GetRoom() []*Room
func (*ListRoomsResponse) ProtoMessage ¶
func (*ListRoomsResponse) ProtoMessage()
func (*ListRoomsResponse) Reset ¶
func (m *ListRoomsResponse) Reset()
func (*ListRoomsResponse) String ¶
func (m *ListRoomsResponse) String() string
type Room ¶
type Room struct { Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` Spec *RoomSpec `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"` UpdateStatus *UpdateStatus `protobuf:"bytes,3,opt,name=update_status,json=updateStatus" json:"update_status,omitempty"` }
func (*Room) Descriptor ¶
func (*Room) GetUpdateStatus ¶
func (m *Room) GetUpdateStatus() *UpdateStatus
func (*Room) ProtoMessage ¶
func (*Room) ProtoMessage()
type RoomSpec ¶
type RoomSpec struct { Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` Catalog string `protobuf:"bytes,2,opt,name=catalog" json:"catalog,omitempty"` }
func (*RoomSpec) Descriptor ¶
func (*RoomSpec) GetCatalog ¶
func (*RoomSpec) ProtoMessage ¶
func (*RoomSpec) ProtoMessage()
type UpdateRoomRequest ¶
type UpdateRoomRequest struct { RoomId string `protobuf:"bytes,1,opt,name=room_id,json=roomId" json:"room_id,omitempty"` RoomSpec *RoomSpec `protobuf:"bytes,2,opt,name=room_spec,json=roomSpec" json:"room_spec,omitempty"` }
func (*UpdateRoomRequest) Descriptor ¶
func (*UpdateRoomRequest) Descriptor() ([]byte, []int)
func (*UpdateRoomRequest) GetRoomId ¶
func (m *UpdateRoomRequest) GetRoomId() string
func (*UpdateRoomRequest) GetRoomSpec ¶
func (m *UpdateRoomRequest) GetRoomSpec() *RoomSpec
func (*UpdateRoomRequest) ProtoMessage ¶
func (*UpdateRoomRequest) ProtoMessage()
func (*UpdateRoomRequest) Reset ¶
func (m *UpdateRoomRequest) Reset()
func (*UpdateRoomRequest) String ¶
func (m *UpdateRoomRequest) String() string
type UpdateRoomResponse ¶
type UpdateRoomResponse struct {
Room *Room `protobuf:"bytes,1,opt,name=room" json:"room,omitempty"`
}
func (*UpdateRoomResponse) Descriptor ¶
func (*UpdateRoomResponse) Descriptor() ([]byte, []int)
func (*UpdateRoomResponse) GetRoom ¶
func (m *UpdateRoomResponse) GetRoom() *Room
func (*UpdateRoomResponse) ProtoMessage ¶
func (*UpdateRoomResponse) ProtoMessage()
func (*UpdateRoomResponse) Reset ¶
func (m *UpdateRoomResponse) Reset()
func (*UpdateRoomResponse) String ¶
func (m *UpdateRoomResponse) String() string
type UpdateStatus ¶
type UpdateStatus struct { // State is the state of this update. It indicates whether the // update is in progress, completed, or is paused. State UpdateStatus_UpdateState `protobuf:"varint,1,opt,name=state,enum=api.UpdateStatus_UpdateState" json:"state,omitempty"` Message string `protobuf:"bytes,4,opt,name=message" json:"message,omitempty"` }
func (*UpdateStatus) Descriptor ¶
func (*UpdateStatus) Descriptor() ([]byte, []int)
func (*UpdateStatus) GetMessage ¶
func (m *UpdateStatus) GetMessage() string
func (*UpdateStatus) GetState ¶
func (m *UpdateStatus) GetState() UpdateStatus_UpdateState
func (*UpdateStatus) ProtoMessage ¶
func (*UpdateStatus) ProtoMessage()
func (*UpdateStatus) Reset ¶
func (m *UpdateStatus) Reset()
func (*UpdateStatus) String ¶
func (m *UpdateStatus) String() string
type UpdateStatus_UpdateState ¶
type UpdateStatus_UpdateState int32
const ( UpdateStatus_UNKNOWN UpdateStatus_UpdateState = 0 UpdateStatus_UPDATING UpdateStatus_UpdateState = 1 UpdateStatus_PAUSED UpdateStatus_UpdateState = 2 UpdateStatus_COMPLETED UpdateStatus_UpdateState = 3 )
func (UpdateStatus_UpdateState) EnumDescriptor ¶
func (UpdateStatus_UpdateState) EnumDescriptor() ([]byte, []int)
func (UpdateStatus_UpdateState) String ¶
func (x UpdateStatus_UpdateState) String() string
Click to show internal directories.
Click to hide internal directories.