...
ActiveGo 1.8Package longrunning
Overview ▹
Index ▹
func RegisterOperationsServer ¶
func RegisterOperationsServer(s *grpc.Server, srv OperationsServer)
type CancelOperationRequest ¶
The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
type CancelOperationRequest struct {
// The name of the operation resource to be cancelled.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*CancelOperationRequest) Descriptor ¶
func (*CancelOperationRequest) Descriptor() ([]byte, []int)
func (*CancelOperationRequest) GetName ¶
func (m *CancelOperationRequest) GetName() string
func (*CancelOperationRequest) ProtoMessage ¶
func (*CancelOperationRequest) ProtoMessage()
func (*CancelOperationRequest) Reset ¶
func (m *CancelOperationRequest) Reset()
func (*CancelOperationRequest) String ¶
func (m *CancelOperationRequest) String() string
type DeleteOperationRequest ¶
The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
type DeleteOperationRequest struct {
// The name of the operation resource to be deleted.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*DeleteOperationRequest) Descriptor ¶
func (*DeleteOperationRequest) Descriptor() ([]byte, []int)
func (*DeleteOperationRequest) GetName ¶
func (m *DeleteOperationRequest) GetName() string
func (*DeleteOperationRequest) ProtoMessage ¶
func (*DeleteOperationRequest) ProtoMessage()
func (*DeleteOperationRequest) Reset ¶
func (m *DeleteOperationRequest) Reset()
func (*DeleteOperationRequest) String ¶
func (m *DeleteOperationRequest) String() string
type GetOperationRequest ¶
The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
type GetOperationRequest struct {
// The name of the operation resource.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*GetOperationRequest) Descriptor ¶
func (*GetOperationRequest) Descriptor() ([]byte, []int)
func (*GetOperationRequest) GetName ¶
func (m *GetOperationRequest) GetName() string
func (*GetOperationRequest) ProtoMessage ¶
func (*GetOperationRequest) ProtoMessage()
func (*GetOperationRequest) Reset ¶
func (m *GetOperationRequest) Reset()
func (*GetOperationRequest) String ¶
func (m *GetOperationRequest) String() string
type ListOperationsRequest ¶
The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
type ListOperationsRequest struct {
// The name of the operation collection.
Name string `protobuf:"bytes,4,opt,name=name" json:"name,omitempty"`
// The standard list filter.
Filter string `protobuf:"bytes,1,opt,name=filter" json:"filter,omitempty"`
// The standard list page size.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// The standard list page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListOperationsRequest) Descriptor ¶
func (*ListOperationsRequest) Descriptor() ([]byte, []int)
func (*ListOperationsRequest) GetFilter ¶
func (m *ListOperationsRequest) GetFilter() string
func (*ListOperationsRequest) GetName ¶
func (m *ListOperationsRequest) GetName() string
func (*ListOperationsRequest) GetPageSize ¶
func (m *ListOperationsRequest) GetPageSize() int32
func (*ListOperationsRequest) GetPageToken ¶
func (m *ListOperationsRequest) GetPageToken() string
func (*ListOperationsRequest) ProtoMessage ¶
func (*ListOperationsRequest) ProtoMessage()
func (*ListOperationsRequest) Reset ¶
func (m *ListOperationsRequest) Reset()
func (*ListOperationsRequest) String ¶
func (m *ListOperationsRequest) String() string
type ListOperationsResponse ¶
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
type ListOperationsResponse struct {
// A list of operations that matches the specified filter in the request.
Operations []*Operation `protobuf:"bytes,1,rep,name=operations" json:"operations,omitempty"`
// The standard List next-page token.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListOperationsResponse) Descriptor ¶
func (*ListOperationsResponse) Descriptor() ([]byte, []int)
func (*ListOperationsResponse) GetNextPageToken ¶
func (m *ListOperationsResponse) GetNextPageToken() string
func (*ListOperationsResponse) GetOperations ¶
func (m *ListOperationsResponse) GetOperations() []*Operation
func (*ListOperationsResponse) ProtoMessage ¶
func (*ListOperationsResponse) ProtoMessage()
func (*ListOperationsResponse) Reset ¶
func (m *ListOperationsResponse) Reset()
func (*ListOperationsResponse) String ¶
func (m *ListOperationsResponse) String() string
type Operation ¶
This resource represents a long-running operation that is the result of a network API call.
type Operation struct {
// The server-assigned name, which is only unique within the same service that
// originally returns it. If you use the default HTTP mapping, the
// `name` should have the format of `operations/some/unique/name`.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// Service-specific metadata associated with the operation. It typically
// contains progress information and common metadata such as create time.
// Some services might not provide such metadata. Any method that returns a
// long-running operation should document the metadata type, if any.
Metadata *google_protobuf1.Any `protobuf:"bytes,2,opt,name=metadata" json:"metadata,omitempty"`
// If the value is `false`, it means the operation is still in progress.
// If true, the operation is completed, and either `error` or `response` is
// available.
Done bool `protobuf:"varint,3,opt,name=done" json:"done,omitempty"`
// The operation result, which can be either an `error` or a valid `response`.
// If `done` == `false`, neither `error` nor `response` is set.
// If `done` == `true`, exactly one of `error` or `response` is set.
//
// Types that are valid to be assigned to Result:
// *Operation_Error
// *Operation_Response
Result isOperation_Result `protobuf_oneof:"result"`
}
func (*Operation) Descriptor ¶
func (*Operation) Descriptor() ([]byte, []int)
func (*Operation) GetDone ¶
func (m *Operation) GetDone() bool
func (*Operation) GetError ¶
func (m *Operation) GetError() *google_rpc.Status
func (*Operation) GetMetadata ¶
func (m *Operation) GetMetadata() *google_protobuf1.Any
func (*Operation) GetName ¶
func (m *Operation) GetName() string
func (*Operation) GetResponse ¶
func (m *Operation) GetResponse() *google_protobuf1.Any
func (*Operation) GetResult ¶
func (m *Operation) GetResult() isOperation_Result
func (*Operation) ProtoMessage ¶
func (*Operation) ProtoMessage()
func (*Operation) Reset ¶
func (m *Operation) Reset()
func (*Operation) String ¶
func (m *Operation) String() string
func (*Operation) XXX_OneofFuncs ¶
func (*Operation) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type Operation_Error ¶
type Operation_Error struct {
Error *google_rpc.Status `protobuf:"bytes,4,opt,name=error,oneof"`
}
type Operation_Response ¶
type Operation_Response struct {
Response *google_protobuf1.Any `protobuf:"bytes,5,opt,name=response,oneof"`
}
type OperationsClient ¶
type OperationsClient interface {
// Lists operations that match the specified filter in the request. If the
// server doesn't support this method, it returns `UNIMPLEMENTED`.
//
// NOTE: the `name` binding below allows API services to override the binding
// to use different resource name schemes, such as `users/*/operations`.
ListOperations(ctx context.Context, in *ListOperationsRequest, opts ...grpc.CallOption) (*ListOperationsResponse, error)
// Gets the latest state of a long-running operation. Clients can use this
// method to poll the operation result at intervals as recommended by the API
// service.
GetOperation(ctx context.Context, in *GetOperationRequest, opts ...grpc.CallOption) (*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. If the server doesn't support this method, it returns
// `google.rpc.Code.UNIMPLEMENTED`.
DeleteOperation(ctx context.Context, in *DeleteOperationRequest, opts ...grpc.CallOption) (*google_protobuf2.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. If the server doesn't support this method, it returns
// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
// other methods to check whether the cancellation succeeded or whether the
// operation completed despite cancellation. On successful cancellation,
// the operation is not deleted; instead, it becomes an operation with
// an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to `Code.CANCELLED`.
CancelOperation(ctx context.Context, in *CancelOperationRequest, opts ...grpc.CallOption) (*google_protobuf2.Empty, error)
}
func NewOperationsClient ¶
func NewOperationsClient(cc *grpc.ClientConn) OperationsClient
type OperationsServer ¶
type OperationsServer interface {
// Lists operations that match the specified filter in the request. If the
// server doesn't support this method, it returns `UNIMPLEMENTED`.
//
// NOTE: the `name` binding below allows API services to override the binding
// to use different resource name schemes, such as `users/*/operations`.
ListOperations(context.Context, *ListOperationsRequest) (*ListOperationsResponse, error)
// Gets the latest state of a long-running operation. Clients can use this
// method to poll the operation result at intervals as recommended by the API
// service.
GetOperation(context.Context, *GetOperationRequest) (*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. If the server doesn't support this method, it returns
// `google.rpc.Code.UNIMPLEMENTED`.
DeleteOperation(context.Context, *DeleteOperationRequest) (*google_protobuf2.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. If the server doesn't support this method, it returns
// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
// other methods to check whether the cancellation succeeded or whether the
// operation completed despite cancellation. On successful cancellation,
// the operation is not deleted; instead, it becomes an operation with
// an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to `Code.CANCELLED`.
CancelOperation(context.Context, *CancelOperationRequest) (*google_protobuf2.Empty, error)
}