operations

package
v0.71.94 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2024 License: Apache-2.0 Imports: 21 Imported by: 2

Documentation

Overview

Package operations is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Operations_ListOperations_FullMethodName  = "/blueapi.operations.v1.Operations/ListOperations"
	Operations_GetOperation_FullMethodName    = "/blueapi.operations.v1.Operations/GetOperation"
	Operations_DeleteOperation_FullMethodName = "/blueapi.operations.v1.Operations/DeleteOperation"
	Operations_CancelOperation_FullMethodName = "/blueapi.operations.v1.Operations/CancelOperation"
	Operations_WaitOperation_FullMethodName   = "/blueapi.operations.v1.Operations/WaitOperation"
)

Variables

View Source 
var File_operations_v1_operations_proto protoreflect.FileDescriptor
View Source 
var Operations_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "blueapi.operations.v1.Operations",
	HandlerType: (*OperationsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetOperation",
			Handler:    _Operations_GetOperation_Handler,
		},
		{
			MethodName: "DeleteOperation",
			Handler:    _Operations_DeleteOperation_Handler,
		},
		{
			MethodName: "CancelOperation",
			Handler:    _Operations_CancelOperation_Handler,
		},
		{
			MethodName: "WaitOperation",
			Handler:    _Operations_WaitOperation_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListOperations",
			Handler:       _Operations_ListOperations_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "operations/v1/operations.proto",
}

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

Functions

func RegisterOperationsHandler 

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

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

func RegisterOperationsHandlerClient 

func RegisterOperationsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OperationsClient) error

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

func RegisterOperationsHandlerFromEndpoint 

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

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

func RegisterOperationsHandlerServer 

func RegisterOperationsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OperationsServer) error

RegisterOperationsHandlerServer registers the http handlers for service Operations to "mux". UnaryRPC :call OperationsServer 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 RegisterOperationsHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterOperationsServer 

func RegisterOperationsServer(s grpc.ServiceRegistrar, srv OperationsServer)

Types

type CancelOperationRequest 

type CancelOperationRequest struct {

	// The name of the operation resource to be cancelled.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Operations.CancelOperation rpc.

func (*CancelOperationRequest) Descriptor deprecated 

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

Deprecated: Use CancelOperationRequest.ProtoReflect.Descriptor instead.

func (*CancelOperationRequest) GetName 

func (x *CancelOperationRequest) GetName() string

func (*CancelOperationRequest) ProtoMessage 

func (*CancelOperationRequest) ProtoMessage()

func (*CancelOperationRequest) ProtoReflect 

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

func (*CancelOperationRequest) Reset 

func (x *CancelOperationRequest) Reset()

func (*CancelOperationRequest) String 

func (x *CancelOperationRequest) String() string

type ClientOptions added in v0.6.10 

type ClientOptions struct {
	Conn *conn.GrpcClientConn
}

ClientOptions represents the optional options to NewClient.

type DeleteOperationRequest 

type DeleteOperationRequest struct {

	// The name of the operation resource to be deleted.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Operations.DeleteOperation rpc.

func (*DeleteOperationRequest) Descriptor deprecated 

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

Deprecated: Use DeleteOperationRequest.ProtoReflect.Descriptor instead.

func (*DeleteOperationRequest) GetName 

func (x *DeleteOperationRequest) GetName() string

func (*DeleteOperationRequest) ProtoMessage 

func (*DeleteOperationRequest) ProtoMessage()

func (*DeleteOperationRequest) ProtoReflect 

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

func (*DeleteOperationRequest) Reset 

func (x *DeleteOperationRequest) Reset()

func (*DeleteOperationRequest) String 

func (x *DeleteOperationRequest) String() string

type GetOperationRequest 

type GetOperationRequest struct {

	// The name of the operation resource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Operations.GetOperation rpc.

func (*GetOperationRequest) Descriptor deprecated 

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

Deprecated: Use GetOperationRequest.ProtoReflect.Descriptor instead.

func (*GetOperationRequest) GetName 

func (x *GetOperationRequest) GetName() string

func (*GetOperationRequest) ProtoMessage 

func (*GetOperationRequest) ProtoMessage()

func (*GetOperationRequest) ProtoReflect 

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

func (*GetOperationRequest) Reset 

func (x *GetOperationRequest) Reset()

func (*GetOperationRequest) String 

func (x *GetOperationRequest) String() string

type GrpcClient added in v0.6.7 

type GrpcClient struct {
	OperationsClient
	// contains filtered or unexported fields
}

func NewClient added in v0.6.7 

func NewClient(ctx context.Context, opts ...*ClientOptions) (*GrpcClient, error)

NewClient returns a client connection to the 'operations' service.

func (*GrpcClient) Close added in v0.6.7 

func (c *GrpcClient) Close()

type ListOperationsRequest 

type ListOperationsRequest struct {

	// Optional. The name of the operation's parent resource. Not used at the moment.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. List operations on and after this date. Format is yyyymmdd. For example,
	// if you want to list all operations starting from June 01, 2021, set to `20210601`.
	// If not set, defaults to the first day of the current UTC month.
	AsOf string `protobuf:"bytes,2,opt,name=asOf,proto3" json:"asOf,omitempty"`
	// Optional. If true, include all operations that are marked as done. Exclude by
	// default.
	IncludeDone bool `protobuf:"varint,3,opt,name=includeDone,proto3" json:"includeDone,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Operations.ListOperations rpc.

func (*ListOperationsRequest) Descriptor deprecated 

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

Deprecated: Use ListOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListOperationsRequest) GetAsOf added in v0.34.2 

func (x *ListOperationsRequest) GetAsOf() string

func (*ListOperationsRequest) GetIncludeDone added in v0.34.2 

func (x *ListOperationsRequest) GetIncludeDone() bool

func (*ListOperationsRequest) GetParent added in v0.12.0 

func (x *ListOperationsRequest) GetParent() string

func (*ListOperationsRequest) ProtoMessage 

func (*ListOperationsRequest) ProtoMessage()

func (*ListOperationsRequest) ProtoReflect 

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

func (*ListOperationsRequest) Reset 

func (x *ListOperationsRequest) Reset()

func (*ListOperationsRequest) String 

func (x *ListOperationsRequest) String() string

type OperationsClient 

type OperationsClient interface {
	// Lists long-running operations.
	ListOperations(ctx context.Context, in *ListOperationsRequest, opts ...grpc.CallOption) (Operations_ListOperationsClient, error)
	// Gets the latest state of a long-running operation. You can use this method to
	// poll the operation result at intervals.
	GetOperation(ctx context.Context, in *GetOperationRequest, opts ...grpc.CallOption) (*protos.Operation, error)
	// Deletes a long-running operation. This method indicates that the client is no
	// longer interested in the operation result. It does not cancel the operation.
	DeleteOperation(ctx context.Context, in *DeleteOperationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Starts asynchronous cancellation on a long-running operation. The server makes
	// a best effort to cancel the operation, but success is not guaranteed. On successful
	// cancellation, the operation is not deleted; instead, it becomes an operation with
	// a value of [google.rpc.Status.code][google.rpc.Status.code] 1, corresponding
	// to `Code.CANCELLED`.
	CancelOperation(ctx context.Context, in *CancelOperationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Waits for the specified long-running operation until it is done or reaches
	// at most a specified timeout, returning the latest state. If the operation
	// is already done, the latest state is immediately returned. If the timeout
	// specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
	// timeout is used. If the server does not support this method, it returns
	// `google.rpc.Code.UNIMPLEMENTED`.
	// Note that this method is on a best-effort basis. It may return the latest
	// state before the specified timeout (including immediately), meaning, even an
	// immediate response is no guarantee that the operation is done.
	// At the moment, Blue's default RPC timeout is around one hour.
	WaitOperation(ctx context.Context, in *WaitOperationRequest, opts ...grpc.CallOption) (*protos.Operation, error)
}

OperationsClient is the client API for Operations 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.

Manages long-running operations with an API service.

When an API method normally takes long time to complete, it can be designed to return [Operation][google.longrunning.Operation] to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the `Operations` interface so developers can have a consistent client experience.

func NewOperationsClient 

func NewOperationsClient(cc grpc.ClientConnInterface) OperationsClient

type OperationsServer 

type OperationsServer interface {
	// Lists long-running operations.
	ListOperations(*ListOperationsRequest, Operations_ListOperationsServer) error
	// Gets the latest state of a long-running operation. You can use this method to
	// poll the operation result at intervals.
	GetOperation(context.Context, *GetOperationRequest) (*protos.Operation, error)
	// Deletes a long-running operation. This method indicates that the client is no
	// longer interested in the operation result. It does not cancel the operation.
	DeleteOperation(context.Context, *DeleteOperationRequest) (*emptypb.Empty, error)
	// Starts asynchronous cancellation on a long-running operation. The server makes
	// a best effort to cancel the operation, but success is not guaranteed. On successful
	// cancellation, the operation is not deleted; instead, it becomes an operation with
	// a value of [google.rpc.Status.code][google.rpc.Status.code] 1, corresponding
	// to `Code.CANCELLED`.
	CancelOperation(context.Context, *CancelOperationRequest) (*emptypb.Empty, error)
	// Waits for the specified long-running operation until it is done or reaches
	// at most a specified timeout, returning the latest state. If the operation
	// is already done, the latest state is immediately returned. If the timeout
	// specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
	// timeout is used. If the server does not support this method, it returns
	// `google.rpc.Code.UNIMPLEMENTED`.
	// Note that this method is on a best-effort basis. It may return the latest
	// state before the specified timeout (including immediately), meaning, even an
	// immediate response is no guarantee that the operation is done.
	// At the moment, Blue's default RPC timeout is around one hour.
	WaitOperation(context.Context, *WaitOperationRequest) (*protos.Operation, error)
	// contains filtered or unexported methods
}

OperationsServer is the server API for Operations service. All implementations must embed UnimplementedOperationsServer for forward compatibility

Manages long-running operations with an API service.

When an API method normally takes long time to complete, it can be designed to return [Operation][google.longrunning.Operation] to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the `Operations` interface so developers can have a consistent client experience.

type Operations_ListOperationsClient added in v0.10.0 

type Operations_ListOperationsClient interface {
	Recv() (*protos.Operation, error)
	grpc.ClientStream
}

type Operations_ListOperationsServer added in v0.10.0 

type Operations_ListOperationsServer interface {
	Send(*protos.Operation) error
	grpc.ServerStream
}

type UnimplementedOperationsServer 

type UnimplementedOperationsServer struct {
}

UnimplementedOperationsServer must be embedded to have forward compatible implementations.

func (UnimplementedOperationsServer) CancelOperation 

func (UnimplementedOperationsServer) CancelOperation(context.Context, *CancelOperationRequest) (*emptypb.Empty, error)

func (UnimplementedOperationsServer) DeleteOperation 

func (UnimplementedOperationsServer) DeleteOperation(context.Context, *DeleteOperationRequest) (*emptypb.Empty, error)

func (UnimplementedOperationsServer) GetOperation 

func (UnimplementedOperationsServer) GetOperation(context.Context, *GetOperationRequest) (*protos.Operation, error)

func (UnimplementedOperationsServer) ListOperations 

func (UnimplementedOperationsServer) ListOperations(*ListOperationsRequest, Operations_ListOperationsServer) error

func (UnimplementedOperationsServer) WaitOperation 

func (UnimplementedOperationsServer) WaitOperation(context.Context, *WaitOperationRequest) (*protos.Operation, error)

type UnsafeOperationsServer 

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

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

type WaitOperationRequest 

type WaitOperationRequest struct {

	// The name of the operation resource to wait on.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The maximum duration to wait before timing out. If left blank, the wait
	// will be at most the time permitted by the underlying HTTP/RPC protocol.
	// If RPC context deadline is also specified, the shorter one will be used.
	Timeout *durationpb.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

The request message for the Operations.WaitOperation rpc.

func (*WaitOperationRequest) Descriptor deprecated 

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

Deprecated: Use WaitOperationRequest.ProtoReflect.Descriptor instead.

func (*WaitOperationRequest) GetName 

func (x *WaitOperationRequest) GetName() string

func (*WaitOperationRequest) GetTimeout 

func (x *WaitOperationRequest) GetTimeout() *durationpb.Duration

func (*WaitOperationRequest) ProtoMessage 

func (*WaitOperationRequest) ProtoMessage()

func (*WaitOperationRequest) ProtoReflect 

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

func (*WaitOperationRequest) Reset 

func (x *WaitOperationRequest) Reset()

func (*WaitOperationRequest) String 

func (x *WaitOperationRequest) String() string

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.