longrunning

package
v1.4.1 Latest Latest
Warning

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

Go to latest
Published: Mar 10, 2021 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthOperations        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowOperations          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupOperations = fmt.Errorf("proto: unexpected end of group")
)
View Source
var E_OperationInfo = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.MethodOptions)(nil),
	ExtensionType: (*OperationInfo)(nil),
	Field:         1049,
	Name:          "google.longrunning.operation_info",
	Tag:           "bytes,1049,opt,name=operation_info",
	Filename:      "google/longrunning/operations.proto",
}

Functions

func RegisterOperationsServer

func RegisterOperationsServer(s *grpc.Server, 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].

func NewPopulatedCancelOperationRequest

func NewPopulatedCancelOperationRequest(r randyOperations, easy bool) *CancelOperationRequest

func (*CancelOperationRequest) Descriptor

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

func (*CancelOperationRequest) Equal

func (this *CancelOperationRequest) Equal(that interface{}) bool

func (*CancelOperationRequest) GetName

func (m *CancelOperationRequest) GetName() string

func (*CancelOperationRequest) GoString

func (this *CancelOperationRequest) GoString() string

func (*CancelOperationRequest) Marshal

func (m *CancelOperationRequest) Marshal() (dAtA []byte, err error)

func (*CancelOperationRequest) MarshalTo

func (m *CancelOperationRequest) MarshalTo(dAtA []byte) (int, error)

func (*CancelOperationRequest) MarshalToSizedBuffer

func (m *CancelOperationRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CancelOperationRequest) ProtoMessage

func (*CancelOperationRequest) ProtoMessage()

func (*CancelOperationRequest) Reset

func (m *CancelOperationRequest) Reset()

func (*CancelOperationRequest) Size

func (m *CancelOperationRequest) Size() (n int)

func (*CancelOperationRequest) String

func (this *CancelOperationRequest) String() string

func (*CancelOperationRequest) Unmarshal

func (m *CancelOperationRequest) Unmarshal(dAtA []byte) error

func (*CancelOperationRequest) XXX_DiscardUnknown

func (m *CancelOperationRequest) XXX_DiscardUnknown()

func (*CancelOperationRequest) XXX_Marshal

func (m *CancelOperationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CancelOperationRequest) XXX_Merge

func (m *CancelOperationRequest) XXX_Merge(src proto.Message)

func (*CancelOperationRequest) XXX_MessageName

func (*CancelOperationRequest) XXX_MessageName() string

func (*CancelOperationRequest) XXX_Size

func (m *CancelOperationRequest) XXX_Size() int

func (*CancelOperationRequest) XXX_Unmarshal

func (m *CancelOperationRequest) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].

func NewPopulatedDeleteOperationRequest

func NewPopulatedDeleteOperationRequest(r randyOperations, easy bool) *DeleteOperationRequest

func (*DeleteOperationRequest) Descriptor

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

func (*DeleteOperationRequest) Equal

func (this *DeleteOperationRequest) Equal(that interface{}) bool

func (*DeleteOperationRequest) GetName

func (m *DeleteOperationRequest) GetName() string

func (*DeleteOperationRequest) GoString

func (this *DeleteOperationRequest) GoString() string

func (*DeleteOperationRequest) Marshal

func (m *DeleteOperationRequest) Marshal() (dAtA []byte, err error)

func (*DeleteOperationRequest) MarshalTo

func (m *DeleteOperationRequest) MarshalTo(dAtA []byte) (int, error)

func (*DeleteOperationRequest) MarshalToSizedBuffer

func (m *DeleteOperationRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeleteOperationRequest) ProtoMessage

func (*DeleteOperationRequest) ProtoMessage()

func (*DeleteOperationRequest) Reset

func (m *DeleteOperationRequest) Reset()

func (*DeleteOperationRequest) Size

func (m *DeleteOperationRequest) Size() (n int)

func (*DeleteOperationRequest) String

func (this *DeleteOperationRequest) String() string

func (*DeleteOperationRequest) Unmarshal

func (m *DeleteOperationRequest) Unmarshal(dAtA []byte) error

func (*DeleteOperationRequest) XXX_DiscardUnknown

func (m *DeleteOperationRequest) XXX_DiscardUnknown()

func (*DeleteOperationRequest) XXX_Marshal

func (m *DeleteOperationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteOperationRequest) XXX_Merge

func (m *DeleteOperationRequest) XXX_Merge(src proto.Message)

func (*DeleteOperationRequest) XXX_MessageName

func (*DeleteOperationRequest) XXX_MessageName() string

func (*DeleteOperationRequest) XXX_Size

func (m *DeleteOperationRequest) XXX_Size() int

func (*DeleteOperationRequest) XXX_Unmarshal

func (m *DeleteOperationRequest) XXX_Unmarshal(b []byte) error

type GetOperationRequest

type GetOperationRequest struct {
	// The name of the operation resource.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].

func NewPopulatedGetOperationRequest

func NewPopulatedGetOperationRequest(r randyOperations, easy bool) *GetOperationRequest

func (*GetOperationRequest) Descriptor

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

func (*GetOperationRequest) Equal

func (this *GetOperationRequest) Equal(that interface{}) bool

func (*GetOperationRequest) GetName

func (m *GetOperationRequest) GetName() string

func (*GetOperationRequest) GoString

func (this *GetOperationRequest) GoString() string

func (*GetOperationRequest) Marshal

func (m *GetOperationRequest) Marshal() (dAtA []byte, err error)

func (*GetOperationRequest) MarshalTo

func (m *GetOperationRequest) MarshalTo(dAtA []byte) (int, error)

func (*GetOperationRequest) MarshalToSizedBuffer

func (m *GetOperationRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetOperationRequest) ProtoMessage

func (*GetOperationRequest) ProtoMessage()

func (*GetOperationRequest) Reset

func (m *GetOperationRequest) Reset()

func (*GetOperationRequest) Size

func (m *GetOperationRequest) Size() (n int)

func (*GetOperationRequest) String

func (this *GetOperationRequest) String() string

func (*GetOperationRequest) Unmarshal

func (m *GetOperationRequest) Unmarshal(dAtA []byte) error

func (*GetOperationRequest) XXX_DiscardUnknown

func (m *GetOperationRequest) XXX_DiscardUnknown()

func (*GetOperationRequest) XXX_Marshal

func (m *GetOperationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetOperationRequest) XXX_Merge

func (m *GetOperationRequest) XXX_Merge(src proto.Message)

func (*GetOperationRequest) XXX_MessageName

func (*GetOperationRequest) XXX_MessageName() string

func (*GetOperationRequest) XXX_Size

func (m *GetOperationRequest) XXX_Size() int

func (*GetOperationRequest) XXX_Unmarshal

func (m *GetOperationRequest) XXX_Unmarshal(b []byte) error

type ListOperationsRequest

type ListOperationsRequest struct {
	// The name of the operation's parent resource.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// The standard list filter.
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// The standard list page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The standard list page token.
	PageToken            string   `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

func NewPopulatedListOperationsRequest

func NewPopulatedListOperationsRequest(r randyOperations, easy bool) *ListOperationsRequest

func (*ListOperationsRequest) Descriptor

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

func (*ListOperationsRequest) Equal

func (this *ListOperationsRequest) Equal(that interface{}) bool

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) GoString

func (this *ListOperationsRequest) GoString() string

func (*ListOperationsRequest) Marshal

func (m *ListOperationsRequest) Marshal() (dAtA []byte, err error)

func (*ListOperationsRequest) MarshalTo

func (m *ListOperationsRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListOperationsRequest) MarshalToSizedBuffer

func (m *ListOperationsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListOperationsRequest) ProtoMessage

func (*ListOperationsRequest) ProtoMessage()

func (*ListOperationsRequest) Reset

func (m *ListOperationsRequest) Reset()

func (*ListOperationsRequest) Size

func (m *ListOperationsRequest) Size() (n int)

func (*ListOperationsRequest) String

func (this *ListOperationsRequest) String() string

func (*ListOperationsRequest) Unmarshal

func (m *ListOperationsRequest) Unmarshal(dAtA []byte) error

func (*ListOperationsRequest) XXX_DiscardUnknown

func (m *ListOperationsRequest) XXX_DiscardUnknown()

func (*ListOperationsRequest) XXX_Marshal

func (m *ListOperationsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListOperationsRequest) XXX_Merge

func (m *ListOperationsRequest) XXX_Merge(src proto.Message)

func (*ListOperationsRequest) XXX_MessageName

func (*ListOperationsRequest) XXX_MessageName() string

func (*ListOperationsRequest) XXX_Size

func (m *ListOperationsRequest) XXX_Size() int

func (*ListOperationsRequest) XXX_Unmarshal

func (m *ListOperationsRequest) XXX_Unmarshal(b []byte) error

type ListOperationsResponse

type ListOperationsResponse struct {
	// A list of operations that matches the specified filter in the request.
	Operations []*Operation `protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`
	// The standard List next-page token.
	NextPageToken        string   `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

func NewPopulatedListOperationsResponse

func NewPopulatedListOperationsResponse(r randyOperations, easy bool) *ListOperationsResponse

func (*ListOperationsResponse) Descriptor

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

func (*ListOperationsResponse) Equal

func (this *ListOperationsResponse) Equal(that interface{}) bool

func (*ListOperationsResponse) GetNextPageToken

func (m *ListOperationsResponse) GetNextPageToken() string

func (*ListOperationsResponse) GetOperations

func (m *ListOperationsResponse) GetOperations() []*Operation

func (*ListOperationsResponse) GoString

func (this *ListOperationsResponse) GoString() string

func (*ListOperationsResponse) Marshal

func (m *ListOperationsResponse) Marshal() (dAtA []byte, err error)

func (*ListOperationsResponse) MarshalTo

func (m *ListOperationsResponse) MarshalTo(dAtA []byte) (int, error)

func (*ListOperationsResponse) MarshalToSizedBuffer

func (m *ListOperationsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListOperationsResponse) ProtoMessage

func (*ListOperationsResponse) ProtoMessage()

func (*ListOperationsResponse) Reset

func (m *ListOperationsResponse) Reset()

func (*ListOperationsResponse) Size

func (m *ListOperationsResponse) Size() (n int)

func (*ListOperationsResponse) String

func (this *ListOperationsResponse) String() string

func (*ListOperationsResponse) Unmarshal

func (m *ListOperationsResponse) Unmarshal(dAtA []byte) error

func (*ListOperationsResponse) XXX_DiscardUnknown

func (m *ListOperationsResponse) XXX_DiscardUnknown()

func (*ListOperationsResponse) XXX_Marshal

func (m *ListOperationsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListOperationsResponse) XXX_Merge

func (m *ListOperationsResponse) XXX_Merge(src proto.Message)

func (*ListOperationsResponse) XXX_MessageName

func (*ListOperationsResponse) XXX_MessageName() string

func (*ListOperationsResponse) XXX_Size

func (m *ListOperationsResponse) XXX_Size() int

func (*ListOperationsResponse) XXX_Unmarshal

func (m *ListOperationsResponse) XXX_Unmarshal(b []byte) error

type Operation

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 be a resource name ending with `operations/{unique_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" 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 *types.Any `protobuf:"bytes,2,opt,name=metadata,proto3" 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,proto3" 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"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

This resource represents a long-running operation that is the result of a network API call.

func NewPopulatedOperation

func NewPopulatedOperation(r randyOperations, easy bool) *Operation

func (*Operation) Descriptor

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

func (*Operation) Equal

func (this *Operation) Equal(that interface{}) bool

func (*Operation) GetDone

func (m *Operation) GetDone() bool

func (*Operation) GetError

func (m *Operation) GetError() *rpc.Status

func (*Operation) GetMetadata

func (m *Operation) GetMetadata() *types.Any

func (*Operation) GetName

func (m *Operation) GetName() string

func (*Operation) GetResponse

func (m *Operation) GetResponse() *types.Any

func (*Operation) GetResult

func (m *Operation) GetResult() isOperation_Result

func (*Operation) GoString

func (this *Operation) GoString() string

func (*Operation) Marshal

func (m *Operation) Marshal() (dAtA []byte, err error)

func (*Operation) MarshalTo

func (m *Operation) MarshalTo(dAtA []byte) (int, error)

func (*Operation) MarshalToSizedBuffer

func (m *Operation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Operation) ProtoMessage

func (*Operation) ProtoMessage()

func (*Operation) Reset

func (m *Operation) Reset()

func (*Operation) Size

func (m *Operation) Size() (n int)

func (*Operation) String

func (this *Operation) String() string

func (*Operation) Unmarshal

func (m *Operation) Unmarshal(dAtA []byte) error

func (*Operation) XXX_DiscardUnknown

func (m *Operation) XXX_DiscardUnknown()

func (*Operation) XXX_Marshal

func (m *Operation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Operation) XXX_Merge

func (m *Operation) XXX_Merge(src proto.Message)

func (*Operation) XXX_MessageName

func (*Operation) XXX_MessageName() string

func (*Operation) XXX_OneofWrappers

func (*Operation) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Operation) XXX_Size

func (m *Operation) XXX_Size() int

func (*Operation) XXX_Unmarshal

func (m *Operation) XXX_Unmarshal(b []byte) error

type OperationInfo

type OperationInfo struct {
	// Required. The message name of the primary return type for this
	// long-running operation.
	// This type will be used to deserialize the LRO's response.
	//
	// If the response is in a different package from the rpc, a fully-qualified
	// message name must be used (e.g. `google.protobuf.Struct`).
	//
	// Note: Altering this value constitutes a breaking change.
	ResponseType string `protobuf:"bytes,1,opt,name=response_type,json=responseType,proto3" json:"response_type,omitempty"`
	// Required. The message name of the metadata type for this long-running
	// operation.
	//
	// If the response is in a different package from the rpc, a fully-qualified
	// message name must be used (e.g. `google.protobuf.Struct`).
	//
	// Note: Altering this value constitutes a breaking change.
	MetadataType         string   `protobuf:"bytes,2,opt,name=metadata_type,json=metadataType,proto3" json:"metadata_type,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A message representing the message types used by a long-running operation.

Example:

rpc LongRunningRecognize(LongRunningRecognizeRequest)
    returns (google.longrunning.Operation) {
  option (google.longrunning.operation_info) = {
    response_type: "LongRunningRecognizeResponse"
    metadata_type: "LongRunningRecognizeMetadata"
  };
}

func NewPopulatedOperationInfo

func NewPopulatedOperationInfo(r randyOperations, easy bool) *OperationInfo

func (*OperationInfo) Descriptor

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

func (*OperationInfo) Equal

func (this *OperationInfo) Equal(that interface{}) bool

func (*OperationInfo) GetMetadataType

func (m *OperationInfo) GetMetadataType() string

func (*OperationInfo) GetResponseType

func (m *OperationInfo) GetResponseType() string

func (*OperationInfo) GoString

func (this *OperationInfo) GoString() string

func (*OperationInfo) Marshal

func (m *OperationInfo) Marshal() (dAtA []byte, err error)

func (*OperationInfo) MarshalTo

func (m *OperationInfo) MarshalTo(dAtA []byte) (int, error)

func (*OperationInfo) MarshalToSizedBuffer

func (m *OperationInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*OperationInfo) ProtoMessage

func (*OperationInfo) ProtoMessage()

func (*OperationInfo) Reset

func (m *OperationInfo) Reset()

func (*OperationInfo) Size

func (m *OperationInfo) Size() (n int)

func (*OperationInfo) String

func (this *OperationInfo) String() string

func (*OperationInfo) Unmarshal

func (m *OperationInfo) Unmarshal(dAtA []byte) error

func (*OperationInfo) XXX_DiscardUnknown

func (m *OperationInfo) XXX_DiscardUnknown()

func (*OperationInfo) XXX_Marshal

func (m *OperationInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OperationInfo) XXX_Merge

func (m *OperationInfo) XXX_Merge(src proto.Message)

func (*OperationInfo) XXX_MessageName

func (*OperationInfo) XXX_MessageName() string

func (*OperationInfo) XXX_Size

func (m *OperationInfo) XXX_Size() int

func (*OperationInfo) XXX_Unmarshal

func (m *OperationInfo) XXX_Unmarshal(b []byte) error

type Operation_Error

type Operation_Error struct {
	Error *rpc.Status `protobuf:"bytes,4,opt,name=error,proto3,oneof" json:"error,omitempty"`
}

func NewPopulatedOperation_Error

func NewPopulatedOperation_Error(r randyOperations, easy bool) *Operation_Error

func (*Operation_Error) Equal

func (this *Operation_Error) Equal(that interface{}) bool

func (*Operation_Error) GoString

func (this *Operation_Error) GoString() string

func (*Operation_Error) MarshalTo

func (m *Operation_Error) MarshalTo(dAtA []byte) (int, error)

func (*Operation_Error) MarshalToSizedBuffer

func (m *Operation_Error) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Operation_Error) Size

func (m *Operation_Error) Size() (n int)

func (*Operation_Error) String

func (this *Operation_Error) String() string

type Operation_Response

type Operation_Response struct {
	Response *types.Any `protobuf:"bytes,5,opt,name=response,proto3,oneof" json:"response,omitempty"`
}

func NewPopulatedOperation_Response

func NewPopulatedOperation_Response(r randyOperations, easy bool) *Operation_Response

func (*Operation_Response) Equal

func (this *Operation_Response) Equal(that interface{}) bool

func (*Operation_Response) GoString

func (this *Operation_Response) GoString() string

func (*Operation_Response) MarshalTo

func (m *Operation_Response) MarshalTo(dAtA []byte) (int, error)

func (*Operation_Response) MarshalToSizedBuffer

func (m *Operation_Response) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Operation_Response) Size

func (m *Operation_Response) Size() (n int)

func (*Operation_Response) String

func (this *Operation_Response) String() string

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 allows API services to override the binding
	// to use different resource name schemes, such as `users/*/operations`. To
	// override the binding, API services can add a binding such as
	// `"/v1/{name=users/*}/operations"` to their service configuration.
	// For backwards compatibility, the default name includes the operations
	// collection id, however overriding users must ensure the name binding
	// is the parent resource, without the operations collection id.
	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) (*types.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) (*types.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.
	WaitOperation(ctx context.Context, in *WaitOperationRequest, opts ...grpc.CallOption) (*Operation, error)
}

OperationsClient is the client API for Operations service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

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 allows API services to override the binding
	// to use different resource name schemes, such as `users/*/operations`. To
	// override the binding, API services can add a binding such as
	// `"/v1/{name=users/*}/operations"` to their service configuration.
	// For backwards compatibility, the default name includes the operations
	// collection id, however overriding users must ensure the name binding
	// is the parent resource, without the operations collection id.
	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) (*types.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) (*types.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.
	WaitOperation(context.Context, *WaitOperationRequest) (*Operation, error)
}

OperationsServer is the server API for Operations service.

type UnimplementedOperationsServer

type UnimplementedOperationsServer struct {
}

UnimplementedOperationsServer can be embedded to have forward compatible implementations.

func (*UnimplementedOperationsServer) CancelOperation

func (*UnimplementedOperationsServer) DeleteOperation

func (*UnimplementedOperationsServer) GetOperation

func (*UnimplementedOperationsServer) ListOperations

func (*UnimplementedOperationsServer) WaitOperation

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              *types.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].

func NewPopulatedWaitOperationRequest

func NewPopulatedWaitOperationRequest(r randyOperations, easy bool) *WaitOperationRequest

func (*WaitOperationRequest) Descriptor

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

func (*WaitOperationRequest) Equal

func (this *WaitOperationRequest) Equal(that interface{}) bool

func (*WaitOperationRequest) GetName

func (m *WaitOperationRequest) GetName() string

func (*WaitOperationRequest) GetTimeout

func (m *WaitOperationRequest) GetTimeout() *types.Duration

func (*WaitOperationRequest) GoString

func (this *WaitOperationRequest) GoString() string

func (*WaitOperationRequest) Marshal

func (m *WaitOperationRequest) Marshal() (dAtA []byte, err error)

func (*WaitOperationRequest) MarshalTo

func (m *WaitOperationRequest) MarshalTo(dAtA []byte) (int, error)

func (*WaitOperationRequest) MarshalToSizedBuffer

func (m *WaitOperationRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*WaitOperationRequest) ProtoMessage

func (*WaitOperationRequest) ProtoMessage()

func (*WaitOperationRequest) Reset

func (m *WaitOperationRequest) Reset()

func (*WaitOperationRequest) Size

func (m *WaitOperationRequest) Size() (n int)

func (*WaitOperationRequest) String

func (this *WaitOperationRequest) String() string

func (*WaitOperationRequest) Unmarshal

func (m *WaitOperationRequest) Unmarshal(dAtA []byte) error

func (*WaitOperationRequest) XXX_DiscardUnknown

func (m *WaitOperationRequest) XXX_DiscardUnknown()

func (*WaitOperationRequest) XXX_Marshal

func (m *WaitOperationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WaitOperationRequest) XXX_Merge

func (m *WaitOperationRequest) XXX_Merge(src proto.Message)

func (*WaitOperationRequest) XXX_MessageName

func (*WaitOperationRequest) XXX_MessageName() string

func (*WaitOperationRequest) XXX_Size

func (m *WaitOperationRequest) XXX_Size() int

func (*WaitOperationRequest) XXX_Unmarshal

func (m *WaitOperationRequest) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL