Documentation
¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterRunBookServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterRunBookServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client RunBookServiceClient) error
- func RegisterRunBookServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterRunBookServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server RunBookServiceServer) error
- func RegisterRunBookServiceServer(s grpc.ServiceRegistrar, srv RunBookServiceServer)
- type CreateRunBookRequest
- func (*CreateRunBookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateRunBookRequest) GetRunbook() *v1alpha1.RunBook
- func (*CreateRunBookRequest) ProtoMessage()
- func (x *CreateRunBookRequest) ProtoReflect() protoreflect.Message
- func (x *CreateRunBookRequest) Reset()
- func (x *CreateRunBookRequest) String() string
- type CreateRunBookResponse
- type DeleteRunBookRequest
- func (*DeleteRunBookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteRunBookRequest) GetName() string
- func (x *DeleteRunBookRequest) GetNamespace() string
- func (*DeleteRunBookRequest) ProtoMessage()
- func (x *DeleteRunBookRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteRunBookRequest) Reset()
- func (x *DeleteRunBookRequest) String() string
- type DeleteRunBookResponse
- type GetRunBookRequest
- func (*GetRunBookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetRunBookRequest) GetName() string
- func (x *GetRunBookRequest) GetNamespace() string
- func (*GetRunBookRequest) ProtoMessage()
- func (x *GetRunBookRequest) ProtoReflect() protoreflect.Message
- func (x *GetRunBookRequest) Reset()
- func (x *GetRunBookRequest) String() string
- type GetRunBookResponse
- func (*GetRunBookResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetRunBookResponse) GetRunbook() *v1alpha1.RunBook
- func (x *GetRunBookResponse) GetYaml() string
- func (*GetRunBookResponse) ProtoMessage()
- func (x *GetRunBookResponse) ProtoReflect() protoreflect.Message
- func (x *GetRunBookResponse) Reset()
- func (x *GetRunBookResponse) String() string
- type ListRunBooksRequest
- func (*ListRunBooksRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListRunBooksRequest) GetLabels() map[string]string
- func (x *ListRunBooksRequest) GetNamespace() string
- func (x *ListRunBooksRequest) GetOrderBy() string
- func (x *ListRunBooksRequest) GetPageSize() int32
- func (x *ListRunBooksRequest) GetPageToken() string
- func (*ListRunBooksRequest) ProtoMessage()
- func (x *ListRunBooksRequest) ProtoReflect() protoreflect.Message
- func (x *ListRunBooksRequest) Reset()
- func (x *ListRunBooksRequest) String() string
- type ListRunBooksResponse
- func (*ListRunBooksResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListRunBooksResponse) GetNextPageToken() string
- func (x *ListRunBooksResponse) GetRunbooks() *v1alpha1.RunBookList
- func (*ListRunBooksResponse) ProtoMessage()
- func (x *ListRunBooksResponse) ProtoReflect() protoreflect.Message
- func (x *ListRunBooksResponse) Reset()
- func (x *ListRunBooksResponse) String() string
- type RunBookServiceClient
- type RunBookServiceServer
- type UnimplementedRunBookServiceServer
- func (UnimplementedRunBookServiceServer) CreateRunBook(context.Context, *CreateRunBookRequest) (*CreateRunBookResponse, error)
- func (UnimplementedRunBookServiceServer) DeleteRunBook(context.Context, *DeleteRunBookRequest) (*DeleteRunBookResponse, error)
- func (UnimplementedRunBookServiceServer) GetRunBook(context.Context, *GetRunBookRequest) (*GetRunBookResponse, error)
- func (UnimplementedRunBookServiceServer) ListRunBooks(context.Context, *ListRunBooksRequest) (*ListRunBooksResponse, error)
- func (UnimplementedRunBookServiceServer) UpdateRunBook(context.Context, *UpdateRunBookRequest) (*UpdateRunBookResponse, error)
- type UnsafeRunBookServiceServer
- type UpdateRunBookRequest
- func (*UpdateRunBookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateRunBookRequest) GetFieldMask() *field_mask.FieldMask
- func (x *UpdateRunBookRequest) GetRunbook() *v1alpha1.RunBook
- func (*UpdateRunBookRequest) ProtoMessage()
- func (x *UpdateRunBookRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateRunBookRequest) Reset()
- func (x *UpdateRunBookRequest) String() string
- type UpdateRunBookResponse
Constants ¶
This section is empty.
Variables ¶
var File_github_com_metaprov_modelaapi_services_runbook_v1_runbook_proto protoreflect.FileDescriptor
var RunBookService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "github.com.metaprov.modelaapi.services.runbook.v1.RunBookService", HandlerType: (*RunBookServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListRunBooks", Handler: _RunBookService_ListRunBooks_Handler, }, { MethodName: "CreateRunBook", Handler: _RunBookService_CreateRunBook_Handler, }, { MethodName: "GetRunBook", Handler: _RunBookService_GetRunBook_Handler, }, { MethodName: "UpdateRunBook", Handler: _RunBookService_UpdateRunBook_Handler, }, { MethodName: "DeleteRunBook", Handler: _RunBookService_DeleteRunBook_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/metaprov/modelaapi/services/runbook/v1/runbook.proto", }
RunBookService_ServiceDesc is the grpc.ServiceDesc for RunBookService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterRunBookServiceHandler ¶ added in v0.4.687
func RegisterRunBookServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterRunBookServiceHandler registers the http handlers for service RunBookService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterRunBookServiceHandlerClient ¶ added in v0.4.687
func RegisterRunBookServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client RunBookServiceClient) error
RegisterRunBookServiceHandlerClient registers the http handlers for service RunBookService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "RunBookServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "RunBookServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "RunBookServiceClient" to call the correct interceptors.
func RegisterRunBookServiceHandlerFromEndpoint ¶ added in v0.4.687
func RegisterRunBookServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterRunBookServiceHandlerFromEndpoint is same as RegisterRunBookServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterRunBookServiceHandlerServer ¶ added in v0.4.687
func RegisterRunBookServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server RunBookServiceServer) error
RegisterRunBookServiceHandlerServer registers the http handlers for service RunBookService to "mux". UnaryRPC :call RunBookServiceServer 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 RegisterRunBookServiceHandlerFromEndpoint instead.
func RegisterRunBookServiceServer ¶
func RegisterRunBookServiceServer(s grpc.ServiceRegistrar, srv RunBookServiceServer)
Types ¶
type CreateRunBookRequest ¶
type CreateRunBookRequest struct { Runbook *v1alpha1.RunBook `protobuf:"bytes,1,opt,name=runbook,proto3" json:"runbook,omitempty"` // contains filtered or unexported fields }
func (*CreateRunBookRequest) Descriptor
deprecated
func (*CreateRunBookRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRunBookRequest.ProtoReflect.Descriptor instead.
func (*CreateRunBookRequest) GetRunbook ¶ added in v0.4.472
func (x *CreateRunBookRequest) GetRunbook() *v1alpha1.RunBook
func (*CreateRunBookRequest) ProtoMessage ¶
func (*CreateRunBookRequest) ProtoMessage()
func (*CreateRunBookRequest) ProtoReflect ¶
func (x *CreateRunBookRequest) ProtoReflect() protoreflect.Message
func (*CreateRunBookRequest) Reset ¶
func (x *CreateRunBookRequest) Reset()
func (*CreateRunBookRequest) String ¶
func (x *CreateRunBookRequest) String() string
type CreateRunBookResponse ¶
type CreateRunBookResponse struct {
// contains filtered or unexported fields
}
func (*CreateRunBookResponse) Descriptor
deprecated
func (*CreateRunBookResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateRunBookResponse.ProtoReflect.Descriptor instead.
func (*CreateRunBookResponse) ProtoMessage ¶
func (*CreateRunBookResponse) ProtoMessage()
func (*CreateRunBookResponse) ProtoReflect ¶
func (x *CreateRunBookResponse) ProtoReflect() protoreflect.Message
func (*CreateRunBookResponse) Reset ¶
func (x *CreateRunBookResponse) Reset()
func (*CreateRunBookResponse) String ¶
func (x *CreateRunBookResponse) String() string
type DeleteRunBookRequest ¶
type DeleteRunBookRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*DeleteRunBookRequest) Descriptor
deprecated
func (*DeleteRunBookRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRunBookRequest.ProtoReflect.Descriptor instead.
func (*DeleteRunBookRequest) GetName ¶
func (x *DeleteRunBookRequest) GetName() string
func (*DeleteRunBookRequest) GetNamespace ¶
func (x *DeleteRunBookRequest) GetNamespace() string
func (*DeleteRunBookRequest) ProtoMessage ¶
func (*DeleteRunBookRequest) ProtoMessage()
func (*DeleteRunBookRequest) ProtoReflect ¶
func (x *DeleteRunBookRequest) ProtoReflect() protoreflect.Message
func (*DeleteRunBookRequest) Reset ¶
func (x *DeleteRunBookRequest) Reset()
func (*DeleteRunBookRequest) String ¶
func (x *DeleteRunBookRequest) String() string
type DeleteRunBookResponse ¶
type DeleteRunBookResponse struct {
// contains filtered or unexported fields
}
func (*DeleteRunBookResponse) Descriptor
deprecated
func (*DeleteRunBookResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRunBookResponse.ProtoReflect.Descriptor instead.
func (*DeleteRunBookResponse) ProtoMessage ¶
func (*DeleteRunBookResponse) ProtoMessage()
func (*DeleteRunBookResponse) ProtoReflect ¶
func (x *DeleteRunBookResponse) ProtoReflect() protoreflect.Message
func (*DeleteRunBookResponse) Reset ¶
func (x *DeleteRunBookResponse) Reset()
func (*DeleteRunBookResponse) String ¶
func (x *DeleteRunBookResponse) String() string
type GetRunBookRequest ¶
type GetRunBookRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*GetRunBookRequest) Descriptor
deprecated
func (*GetRunBookRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRunBookRequest.ProtoReflect.Descriptor instead.
func (*GetRunBookRequest) GetName ¶
func (x *GetRunBookRequest) GetName() string
func (*GetRunBookRequest) GetNamespace ¶
func (x *GetRunBookRequest) GetNamespace() string
func (*GetRunBookRequest) ProtoMessage ¶
func (*GetRunBookRequest) ProtoMessage()
func (*GetRunBookRequest) ProtoReflect ¶
func (x *GetRunBookRequest) ProtoReflect() protoreflect.Message
func (*GetRunBookRequest) Reset ¶
func (x *GetRunBookRequest) Reset()
func (*GetRunBookRequest) String ¶
func (x *GetRunBookRequest) String() string
type GetRunBookResponse ¶
type GetRunBookResponse struct { Runbook *v1alpha1.RunBook `protobuf:"bytes,1,opt,name=runbook,proto3" json:"runbook,omitempty"` Yaml string `protobuf:"bytes,2,opt,name=yaml,proto3" json:"yaml,omitempty"` // contains filtered or unexported fields }
func (*GetRunBookResponse) Descriptor
deprecated
func (*GetRunBookResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetRunBookResponse.ProtoReflect.Descriptor instead.
func (*GetRunBookResponse) GetRunbook ¶ added in v0.4.472
func (x *GetRunBookResponse) GetRunbook() *v1alpha1.RunBook
func (*GetRunBookResponse) GetYaml ¶
func (x *GetRunBookResponse) GetYaml() string
func (*GetRunBookResponse) ProtoMessage ¶
func (*GetRunBookResponse) ProtoMessage()
func (*GetRunBookResponse) ProtoReflect ¶
func (x *GetRunBookResponse) ProtoReflect() protoreflect.Message
func (*GetRunBookResponse) Reset ¶
func (x *GetRunBookResponse) Reset()
func (*GetRunBookResponse) String ¶
func (x *GetRunBookResponse) String() string
type ListRunBooksRequest ¶
type ListRunBooksRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Labels map[string]string `` /* 153-byte string literal not displayed */ PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"` // contains filtered or unexported fields }
func (*ListRunBooksRequest) Descriptor
deprecated
func (*ListRunBooksRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRunBooksRequest.ProtoReflect.Descriptor instead.
func (*ListRunBooksRequest) GetLabels ¶
func (x *ListRunBooksRequest) GetLabels() map[string]string
func (*ListRunBooksRequest) GetNamespace ¶
func (x *ListRunBooksRequest) GetNamespace() string
func (*ListRunBooksRequest) GetOrderBy ¶ added in v0.4.414
func (x *ListRunBooksRequest) GetOrderBy() string
func (*ListRunBooksRequest) GetPageSize ¶ added in v0.4.414
func (x *ListRunBooksRequest) GetPageSize() int32
func (*ListRunBooksRequest) GetPageToken ¶ added in v0.4.414
func (x *ListRunBooksRequest) GetPageToken() string
func (*ListRunBooksRequest) ProtoMessage ¶
func (*ListRunBooksRequest) ProtoMessage()
func (*ListRunBooksRequest) ProtoReflect ¶
func (x *ListRunBooksRequest) ProtoReflect() protoreflect.Message
func (*ListRunBooksRequest) Reset ¶
func (x *ListRunBooksRequest) Reset()
func (*ListRunBooksRequest) String ¶
func (x *ListRunBooksRequest) String() string
type ListRunBooksResponse ¶
type ListRunBooksResponse struct { Runbooks *v1alpha1.RunBookList `protobuf:"bytes,1,opt,name=runbooks,proto3" json:"runbooks,omitempty"` NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
func (*ListRunBooksResponse) Descriptor
deprecated
func (*ListRunBooksResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRunBooksResponse.ProtoReflect.Descriptor instead.
func (*ListRunBooksResponse) GetNextPageToken ¶ added in v0.4.472
func (x *ListRunBooksResponse) GetNextPageToken() string
func (*ListRunBooksResponse) GetRunbooks ¶ added in v0.4.472
func (x *ListRunBooksResponse) GetRunbooks() *v1alpha1.RunBookList
func (*ListRunBooksResponse) ProtoMessage ¶
func (*ListRunBooksResponse) ProtoMessage()
func (*ListRunBooksResponse) ProtoReflect ¶
func (x *ListRunBooksResponse) ProtoReflect() protoreflect.Message
func (*ListRunBooksResponse) Reset ¶
func (x *ListRunBooksResponse) Reset()
func (*ListRunBooksResponse) String ¶
func (x *ListRunBooksResponse) String() string
type RunBookServiceClient ¶
type RunBookServiceClient interface { ListRunBooks(ctx context.Context, in *ListRunBooksRequest, opts ...grpc.CallOption) (*ListRunBooksResponse, error) CreateRunBook(ctx context.Context, in *CreateRunBookRequest, opts ...grpc.CallOption) (*CreateRunBookResponse, error) GetRunBook(ctx context.Context, in *GetRunBookRequest, opts ...grpc.CallOption) (*GetRunBookResponse, error) UpdateRunBook(ctx context.Context, in *UpdateRunBookRequest, opts ...grpc.CallOption) (*UpdateRunBookResponse, error) DeleteRunBook(ctx context.Context, in *DeleteRunBookRequest, opts ...grpc.CallOption) (*DeleteRunBookResponse, error) }
RunBookServiceClient is the client API for RunBookService 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 NewRunBookServiceClient ¶
func NewRunBookServiceClient(cc grpc.ClientConnInterface) RunBookServiceClient
type RunBookServiceServer ¶
type RunBookServiceServer interface { ListRunBooks(context.Context, *ListRunBooksRequest) (*ListRunBooksResponse, error) CreateRunBook(context.Context, *CreateRunBookRequest) (*CreateRunBookResponse, error) GetRunBook(context.Context, *GetRunBookRequest) (*GetRunBookResponse, error) UpdateRunBook(context.Context, *UpdateRunBookRequest) (*UpdateRunBookResponse, error) DeleteRunBook(context.Context, *DeleteRunBookRequest) (*DeleteRunBookResponse, error) // contains filtered or unexported methods }
RunBookServiceServer is the server API for RunBookService service. All implementations must embed UnimplementedRunBookServiceServer for forward compatibility
type UnimplementedRunBookServiceServer ¶
type UnimplementedRunBookServiceServer struct { }
UnimplementedRunBookServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedRunBookServiceServer) CreateRunBook ¶
func (UnimplementedRunBookServiceServer) CreateRunBook(context.Context, *CreateRunBookRequest) (*CreateRunBookResponse, error)
func (UnimplementedRunBookServiceServer) DeleteRunBook ¶
func (UnimplementedRunBookServiceServer) DeleteRunBook(context.Context, *DeleteRunBookRequest) (*DeleteRunBookResponse, error)
func (UnimplementedRunBookServiceServer) GetRunBook ¶
func (UnimplementedRunBookServiceServer) GetRunBook(context.Context, *GetRunBookRequest) (*GetRunBookResponse, error)
func (UnimplementedRunBookServiceServer) ListRunBooks ¶
func (UnimplementedRunBookServiceServer) ListRunBooks(context.Context, *ListRunBooksRequest) (*ListRunBooksResponse, error)
func (UnimplementedRunBookServiceServer) UpdateRunBook ¶
func (UnimplementedRunBookServiceServer) UpdateRunBook(context.Context, *UpdateRunBookRequest) (*UpdateRunBookResponse, error)
type UnsafeRunBookServiceServer ¶ added in v0.4.687
type UnsafeRunBookServiceServer interface {
// contains filtered or unexported methods
}
UnsafeRunBookServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RunBookServiceServer will result in compilation errors.
type UpdateRunBookRequest ¶
type UpdateRunBookRequest struct { Runbook *v1alpha1.RunBook `protobuf:"bytes,1,opt,name=runbook,proto3" json:"runbook,omitempty"` FieldMask *field_mask.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"` // contains filtered or unexported fields }
func (*UpdateRunBookRequest) Descriptor
deprecated
func (*UpdateRunBookRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateRunBookRequest.ProtoReflect.Descriptor instead.
func (*UpdateRunBookRequest) GetFieldMask ¶ added in v0.4.422
func (x *UpdateRunBookRequest) GetFieldMask() *field_mask.FieldMask
func (*UpdateRunBookRequest) GetRunbook ¶ added in v0.4.475
func (x *UpdateRunBookRequest) GetRunbook() *v1alpha1.RunBook
func (*UpdateRunBookRequest) ProtoMessage ¶
func (*UpdateRunBookRequest) ProtoMessage()
func (*UpdateRunBookRequest) ProtoReflect ¶
func (x *UpdateRunBookRequest) ProtoReflect() protoreflect.Message
func (*UpdateRunBookRequest) Reset ¶
func (x *UpdateRunBookRequest) Reset()
func (*UpdateRunBookRequest) String ¶
func (x *UpdateRunBookRequest) String() string
type UpdateRunBookResponse ¶
type UpdateRunBookResponse struct {
// contains filtered or unexported fields
}
func (*UpdateRunBookResponse) Descriptor
deprecated
func (*UpdateRunBookResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateRunBookResponse.ProtoReflect.Descriptor instead.
func (*UpdateRunBookResponse) ProtoMessage ¶
func (*UpdateRunBookResponse) ProtoMessage()
func (*UpdateRunBookResponse) ProtoReflect ¶
func (x *UpdateRunBookResponse) ProtoReflect() protoreflect.Message
func (*UpdateRunBookResponse) Reset ¶
func (x *UpdateRunBookResponse) Reset()
func (*UpdateRunBookResponse) String ¶
func (x *UpdateRunBookResponse) String() string