Documentation
¶
Overview ¶
Package semaphore_dashboards_v1alpha is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterDashboardsApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterDashboardsApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DashboardsApiClient) error
- func RegisterDashboardsApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterDashboardsApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DashboardsApiServer) error
- func RegisterDashboardsApiServer(s grpc.ServiceRegistrar, srv DashboardsApiServer)
- type Dashboard
- func (*Dashboard) Descriptor() ([]byte, []int)deprecated
- func (x *Dashboard) GetMetadata() *Dashboard_Metadata
- func (x *Dashboard) GetSpec() *Dashboard_Spec
- func (*Dashboard) ProtoMessage()
- func (x *Dashboard) ProtoReflect() protoreflect.Message
- func (x *Dashboard) Reset()
- func (x *Dashboard) String() string
- type Dashboard_Metadata
- func (*Dashboard_Metadata) Descriptor() ([]byte, []int)deprecated
- func (x *Dashboard_Metadata) GetCreateTime() int64
- func (x *Dashboard_Metadata) GetId() string
- func (x *Dashboard_Metadata) GetName() string
- func (x *Dashboard_Metadata) GetTitle() string
- func (x *Dashboard_Metadata) GetUpdateTime() int64
- func (*Dashboard_Metadata) ProtoMessage()
- func (x *Dashboard_Metadata) ProtoReflect() protoreflect.Message
- func (x *Dashboard_Metadata) Reset()
- func (x *Dashboard_Metadata) String() string
- type Dashboard_Spec
- type Dashboard_Spec_Widget
- func (*Dashboard_Spec_Widget) Descriptor() ([]byte, []int)deprecated
- func (x *Dashboard_Spec_Widget) GetFilters() map[string]string
- func (x *Dashboard_Spec_Widget) GetName() string
- func (x *Dashboard_Spec_Widget) GetType() string
- func (*Dashboard_Spec_Widget) ProtoMessage()
- func (x *Dashboard_Spec_Widget) ProtoReflect() protoreflect.Message
- func (x *Dashboard_Spec_Widget) Reset()
- func (x *Dashboard_Spec_Widget) String() string
- type DashboardsApiClient
- type DashboardsApiServer
- type DeleteDashboardRequest
- func (*DeleteDashboardRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteDashboardRequest) GetIdOrName() string
- func (*DeleteDashboardRequest) ProtoMessage()
- func (x *DeleteDashboardRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteDashboardRequest) Reset()
- func (x *DeleteDashboardRequest) String() string
- type Empty
- type GetDashboardRequest
- func (*GetDashboardRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetDashboardRequest) GetIdOrName() string
- func (*GetDashboardRequest) ProtoMessage()
- func (x *GetDashboardRequest) ProtoReflect() protoreflect.Message
- func (x *GetDashboardRequest) Reset()
- func (x *GetDashboardRequest) String() string
- type ListDashboardsRequest
- func (*ListDashboardsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListDashboardsRequest) GetPageSize() int32
- func (x *ListDashboardsRequest) GetPageToken() string
- func (*ListDashboardsRequest) ProtoMessage()
- func (x *ListDashboardsRequest) ProtoReflect() protoreflect.Message
- func (x *ListDashboardsRequest) Reset()
- func (x *ListDashboardsRequest) String() string
- type ListDashboardsResponse
- func (*ListDashboardsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListDashboardsResponse) GetDashboards() []*Dashboard
- func (x *ListDashboardsResponse) GetNextPageToken() string
- func (x *ListDashboardsResponse) GetTotalSize() int32
- func (*ListDashboardsResponse) ProtoMessage()
- func (x *ListDashboardsResponse) ProtoReflect() protoreflect.Message
- func (x *ListDashboardsResponse) Reset()
- func (x *ListDashboardsResponse) String() string
- type UnimplementedDashboardsApiServer
- func (UnimplementedDashboardsApiServer) CreateDashboard(context.Context, *Dashboard) (*Dashboard, error)
- func (UnimplementedDashboardsApiServer) DeleteDashboard(context.Context, *DeleteDashboardRequest) (*Empty, error)
- func (UnimplementedDashboardsApiServer) GetDashboard(context.Context, *GetDashboardRequest) (*Dashboard, error)
- func (UnimplementedDashboardsApiServer) ListDashboards(context.Context, *ListDashboardsRequest) (*ListDashboardsResponse, error)
- func (UnimplementedDashboardsApiServer) UpdateDashboard(context.Context, *UpdateDashboardRequest) (*Dashboard, error)
- type UnsafeDashboardsApiServer
- type UpdateDashboardRequest
- func (*UpdateDashboardRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateDashboardRequest) GetDashboard() *Dashboard
- func (x *UpdateDashboardRequest) GetIdOrName() string
- func (*UpdateDashboardRequest) ProtoMessage()
- func (x *UpdateDashboardRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateDashboardRequest) Reset()
- func (x *UpdateDashboardRequest) String() string
Constants ¶
const ( DashboardsApi_ListDashboards_FullMethodName = "/semaphore.dashboards.v1alpha.DashboardsApi/ListDashboards" DashboardsApi_GetDashboard_FullMethodName = "/semaphore.dashboards.v1alpha.DashboardsApi/GetDashboard" DashboardsApi_CreateDashboard_FullMethodName = "/semaphore.dashboards.v1alpha.DashboardsApi/CreateDashboard" DashboardsApi_UpdateDashboard_FullMethodName = "/semaphore.dashboards.v1alpha.DashboardsApi/UpdateDashboard" DashboardsApi_DeleteDashboard_FullMethodName = "/semaphore.dashboards.v1alpha.DashboardsApi/DeleteDashboard" )
Variables ¶
var DashboardsApi_ServiceDesc = grpc.ServiceDesc{ ServiceName: "semaphore.dashboards.v1alpha.DashboardsApi", HandlerType: (*DashboardsApiServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListDashboards", Handler: _DashboardsApi_ListDashboards_Handler, }, { MethodName: "GetDashboard", Handler: _DashboardsApi_GetDashboard_Handler, }, { MethodName: "CreateDashboard", Handler: _DashboardsApi_CreateDashboard_Handler, }, { MethodName: "UpdateDashboard", Handler: _DashboardsApi_UpdateDashboard_Handler, }, { MethodName: "DeleteDashboard", Handler: _DashboardsApi_DeleteDashboard_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "semaphore/dashboards.v1alpha.proto", }
DashboardsApi_ServiceDesc is the grpc.ServiceDesc for DashboardsApi service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_semaphore_dashboards_v1alpha_proto protoreflect.FileDescriptor
Functions ¶
func RegisterDashboardsApiHandler ¶
func RegisterDashboardsApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterDashboardsApiHandler registers the http handlers for service DashboardsApi to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterDashboardsApiHandlerClient ¶
func RegisterDashboardsApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DashboardsApiClient) error
RegisterDashboardsApiHandlerClient registers the http handlers for service DashboardsApi to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "DashboardsApiClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "DashboardsApiClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "DashboardsApiClient" to call the correct interceptors.
func RegisterDashboardsApiHandlerFromEndpoint ¶
func RegisterDashboardsApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterDashboardsApiHandlerFromEndpoint is same as RegisterDashboardsApiHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterDashboardsApiHandlerServer ¶
func RegisterDashboardsApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DashboardsApiServer) error
RegisterDashboardsApiHandlerServer registers the http handlers for service DashboardsApi to "mux". UnaryRPC :call DashboardsApiServer 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 RegisterDashboardsApiHandlerFromEndpoint instead.
func RegisterDashboardsApiServer ¶
func RegisterDashboardsApiServer(s grpc.ServiceRegistrar, srv DashboardsApiServer)
Types ¶
type Dashboard ¶
type Dashboard struct { Metadata *Dashboard_Metadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"` Spec *Dashboard_Spec `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"` // contains filtered or unexported fields }
func (*Dashboard) Descriptor
deprecated
func (*Dashboard) GetMetadata ¶
func (x *Dashboard) GetMetadata() *Dashboard_Metadata
func (*Dashboard) GetSpec ¶
func (x *Dashboard) GetSpec() *Dashboard_Spec
func (*Dashboard) ProtoMessage ¶
func (*Dashboard) ProtoMessage()
func (*Dashboard) ProtoReflect ¶
func (x *Dashboard) ProtoReflect() protoreflect.Message
type Dashboard_Metadata ¶
type Dashboard_Metadata struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"` Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"` CreateTime int64 `protobuf:"varint,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // unix timestamp of dashboard creation UpdateTime int64 `protobuf:"varint,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // unix timestamp of last update // contains filtered or unexported fields }
func (*Dashboard_Metadata) Descriptor
deprecated
func (*Dashboard_Metadata) Descriptor() ([]byte, []int)
Deprecated: Use Dashboard_Metadata.ProtoReflect.Descriptor instead.
func (*Dashboard_Metadata) GetCreateTime ¶
func (x *Dashboard_Metadata) GetCreateTime() int64
func (*Dashboard_Metadata) GetId ¶
func (x *Dashboard_Metadata) GetId() string
func (*Dashboard_Metadata) GetName ¶
func (x *Dashboard_Metadata) GetName() string
func (*Dashboard_Metadata) GetTitle ¶
func (x *Dashboard_Metadata) GetTitle() string
func (*Dashboard_Metadata) GetUpdateTime ¶
func (x *Dashboard_Metadata) GetUpdateTime() int64
func (*Dashboard_Metadata) ProtoMessage ¶
func (*Dashboard_Metadata) ProtoMessage()
func (*Dashboard_Metadata) ProtoReflect ¶
func (x *Dashboard_Metadata) ProtoReflect() protoreflect.Message
func (*Dashboard_Metadata) Reset ¶
func (x *Dashboard_Metadata) Reset()
func (*Dashboard_Metadata) String ¶
func (x *Dashboard_Metadata) String() string
type Dashboard_Spec ¶
type Dashboard_Spec struct { Widgets []*Dashboard_Spec_Widget `protobuf:"bytes,2,rep,name=widgets,proto3" json:"widgets,omitempty"` // contains filtered or unexported fields }
func (*Dashboard_Spec) Descriptor
deprecated
func (*Dashboard_Spec) Descriptor() ([]byte, []int)
Deprecated: Use Dashboard_Spec.ProtoReflect.Descriptor instead.
func (*Dashboard_Spec) GetWidgets ¶
func (x *Dashboard_Spec) GetWidgets() []*Dashboard_Spec_Widget
func (*Dashboard_Spec) ProtoMessage ¶
func (*Dashboard_Spec) ProtoMessage()
func (*Dashboard_Spec) ProtoReflect ¶
func (x *Dashboard_Spec) ProtoReflect() protoreflect.Message
func (*Dashboard_Spec) Reset ¶
func (x *Dashboard_Spec) Reset()
func (*Dashboard_Spec) String ¶
func (x *Dashboard_Spec) String() string
type Dashboard_Spec_Widget ¶
type Dashboard_Spec_Widget struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` Filters map[string]string `` /* 155-byte string literal not displayed */ // contains filtered or unexported fields }
func (*Dashboard_Spec_Widget) Descriptor
deprecated
func (*Dashboard_Spec_Widget) Descriptor() ([]byte, []int)
Deprecated: Use Dashboard_Spec_Widget.ProtoReflect.Descriptor instead.
func (*Dashboard_Spec_Widget) GetFilters ¶
func (x *Dashboard_Spec_Widget) GetFilters() map[string]string
func (*Dashboard_Spec_Widget) GetName ¶
func (x *Dashboard_Spec_Widget) GetName() string
func (*Dashboard_Spec_Widget) GetType ¶
func (x *Dashboard_Spec_Widget) GetType() string
func (*Dashboard_Spec_Widget) ProtoMessage ¶
func (*Dashboard_Spec_Widget) ProtoMessage()
func (*Dashboard_Spec_Widget) ProtoReflect ¶
func (x *Dashboard_Spec_Widget) ProtoReflect() protoreflect.Message
func (*Dashboard_Spec_Widget) Reset ¶
func (x *Dashboard_Spec_Widget) Reset()
func (*Dashboard_Spec_Widget) String ¶
func (x *Dashboard_Spec_Widget) String() string
type DashboardsApiClient ¶
type DashboardsApiClient interface { ListDashboards(ctx context.Context, in *ListDashboardsRequest, opts ...grpc.CallOption) (*ListDashboardsResponse, error) GetDashboard(ctx context.Context, in *GetDashboardRequest, opts ...grpc.CallOption) (*Dashboard, error) CreateDashboard(ctx context.Context, in *Dashboard, opts ...grpc.CallOption) (*Dashboard, error) UpdateDashboard(ctx context.Context, in *UpdateDashboardRequest, opts ...grpc.CallOption) (*Dashboard, error) DeleteDashboard(ctx context.Context, in *DeleteDashboardRequest, opts ...grpc.CallOption) (*Empty, error) }
DashboardsApiClient is the client API for DashboardsApi 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 NewDashboardsApiClient ¶
func NewDashboardsApiClient(cc grpc.ClientConnInterface) DashboardsApiClient
type DashboardsApiServer ¶
type DashboardsApiServer interface { ListDashboards(context.Context, *ListDashboardsRequest) (*ListDashboardsResponse, error) GetDashboard(context.Context, *GetDashboardRequest) (*Dashboard, error) CreateDashboard(context.Context, *Dashboard) (*Dashboard, error) UpdateDashboard(context.Context, *UpdateDashboardRequest) (*Dashboard, error) DeleteDashboard(context.Context, *DeleteDashboardRequest) (*Empty, error) }
DashboardsApiServer is the server API for DashboardsApi service. All implementations should embed UnimplementedDashboardsApiServer for forward compatibility
type DeleteDashboardRequest ¶
type DeleteDashboardRequest struct { IdOrName string `protobuf:"bytes,1,opt,name=id_or_name,json=idOrName,proto3" json:"id_or_name,omitempty"` // contains filtered or unexported fields }
func (*DeleteDashboardRequest) Descriptor
deprecated
func (*DeleteDashboardRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDashboardRequest.ProtoReflect.Descriptor instead.
func (*DeleteDashboardRequest) GetIdOrName ¶
func (x *DeleteDashboardRequest) GetIdOrName() string
func (*DeleteDashboardRequest) ProtoMessage ¶
func (*DeleteDashboardRequest) ProtoMessage()
func (*DeleteDashboardRequest) ProtoReflect ¶
func (x *DeleteDashboardRequest) ProtoReflect() protoreflect.Message
func (*DeleteDashboardRequest) Reset ¶
func (x *DeleteDashboardRequest) Reset()
func (*DeleteDashboardRequest) String ¶
func (x *DeleteDashboardRequest) String() string
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
func (*Empty) Descriptor
deprecated
func (*Empty) ProtoMessage ¶
func (*Empty) ProtoMessage()
func (*Empty) ProtoReflect ¶
func (x *Empty) ProtoReflect() protoreflect.Message
type GetDashboardRequest ¶
type GetDashboardRequest struct { IdOrName string `protobuf:"bytes,1,opt,name=id_or_name,json=idOrName,proto3" json:"id_or_name,omitempty"` // contains filtered or unexported fields }
func (*GetDashboardRequest) Descriptor
deprecated
func (*GetDashboardRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDashboardRequest.ProtoReflect.Descriptor instead.
func (*GetDashboardRequest) GetIdOrName ¶
func (x *GetDashboardRequest) GetIdOrName() string
func (*GetDashboardRequest) ProtoMessage ¶
func (*GetDashboardRequest) ProtoMessage()
func (*GetDashboardRequest) ProtoReflect ¶
func (x *GetDashboardRequest) ProtoReflect() protoreflect.Message
func (*GetDashboardRequest) Reset ¶
func (x *GetDashboardRequest) Reset()
func (*GetDashboardRequest) String ¶
func (x *GetDashboardRequest) String() string
type ListDashboardsRequest ¶
type ListDashboardsRequest struct { PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // contains filtered or unexported fields }
func (*ListDashboardsRequest) Descriptor
deprecated
func (*ListDashboardsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDashboardsRequest.ProtoReflect.Descriptor instead.
func (*ListDashboardsRequest) GetPageSize ¶
func (x *ListDashboardsRequest) GetPageSize() int32
func (*ListDashboardsRequest) GetPageToken ¶
func (x *ListDashboardsRequest) GetPageToken() string
func (*ListDashboardsRequest) ProtoMessage ¶
func (*ListDashboardsRequest) ProtoMessage()
func (*ListDashboardsRequest) ProtoReflect ¶
func (x *ListDashboardsRequest) ProtoReflect() protoreflect.Message
func (*ListDashboardsRequest) Reset ¶
func (x *ListDashboardsRequest) Reset()
func (*ListDashboardsRequest) String ¶
func (x *ListDashboardsRequest) String() string
type ListDashboardsResponse ¶
type ListDashboardsResponse struct { Dashboards []*Dashboard `protobuf:"bytes,1,rep,name=dashboards,proto3" json:"dashboards,omitempty"` NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"` // contains filtered or unexported fields }
func (*ListDashboardsResponse) Descriptor
deprecated
func (*ListDashboardsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDashboardsResponse.ProtoReflect.Descriptor instead.
func (*ListDashboardsResponse) GetDashboards ¶
func (x *ListDashboardsResponse) GetDashboards() []*Dashboard
func (*ListDashboardsResponse) GetNextPageToken ¶
func (x *ListDashboardsResponse) GetNextPageToken() string
func (*ListDashboardsResponse) GetTotalSize ¶
func (x *ListDashboardsResponse) GetTotalSize() int32
func (*ListDashboardsResponse) ProtoMessage ¶
func (*ListDashboardsResponse) ProtoMessage()
func (*ListDashboardsResponse) ProtoReflect ¶
func (x *ListDashboardsResponse) ProtoReflect() protoreflect.Message
func (*ListDashboardsResponse) Reset ¶
func (x *ListDashboardsResponse) Reset()
func (*ListDashboardsResponse) String ¶
func (x *ListDashboardsResponse) String() string
type UnimplementedDashboardsApiServer ¶
type UnimplementedDashboardsApiServer struct { }
UnimplementedDashboardsApiServer should be embedded to have forward compatible implementations.
func (UnimplementedDashboardsApiServer) CreateDashboard ¶
func (UnimplementedDashboardsApiServer) DeleteDashboard ¶
func (UnimplementedDashboardsApiServer) DeleteDashboard(context.Context, *DeleteDashboardRequest) (*Empty, error)
func (UnimplementedDashboardsApiServer) GetDashboard ¶
func (UnimplementedDashboardsApiServer) GetDashboard(context.Context, *GetDashboardRequest) (*Dashboard, error)
func (UnimplementedDashboardsApiServer) ListDashboards ¶
func (UnimplementedDashboardsApiServer) ListDashboards(context.Context, *ListDashboardsRequest) (*ListDashboardsResponse, error)
func (UnimplementedDashboardsApiServer) UpdateDashboard ¶
func (UnimplementedDashboardsApiServer) UpdateDashboard(context.Context, *UpdateDashboardRequest) (*Dashboard, error)
type UnsafeDashboardsApiServer ¶
type UnsafeDashboardsApiServer interface {
// contains filtered or unexported methods
}
UnsafeDashboardsApiServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DashboardsApiServer will result in compilation errors.
type UpdateDashboardRequest ¶
type UpdateDashboardRequest struct { IdOrName string `protobuf:"bytes,1,opt,name=id_or_name,json=idOrName,proto3" json:"id_or_name,omitempty"` Dashboard *Dashboard `protobuf:"bytes,2,opt,name=dashboard,proto3" json:"dashboard,omitempty"` // contains filtered or unexported fields }
func (*UpdateDashboardRequest) Descriptor
deprecated
func (*UpdateDashboardRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDashboardRequest.ProtoReflect.Descriptor instead.
func (*UpdateDashboardRequest) GetDashboard ¶
func (x *UpdateDashboardRequest) GetDashboard() *Dashboard
func (*UpdateDashboardRequest) GetIdOrName ¶
func (x *UpdateDashboardRequest) GetIdOrName() string
func (*UpdateDashboardRequest) ProtoMessage ¶
func (*UpdateDashboardRequest) ProtoMessage()
func (*UpdateDashboardRequest) ProtoReflect ¶
func (x *UpdateDashboardRequest) ProtoReflect() protoreflect.Message
func (*UpdateDashboardRequest) Reset ¶
func (x *UpdateDashboardRequest) Reset()
func (*UpdateDashboardRequest) String ¶
func (x *UpdateDashboardRequest) String() string