longrunning

package
v0.0.3 Latest Latest
Warning

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

 Go to latest Published: Oct 22, 2024 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Index

Constants

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

Variables

View Source 
var (
	// Additional information regarding long-running operations.
	// In particular, this specifies the types that are returned from
	// long-running operations.
	//
	// Required for methods that return `google.longrunning.Operation`; invalid
	// otherwise.
	//
	// optional google.longrunning.OperationInfo operation_info = 1049;
	E_OperationInfo = &file_google_longrunning_operations_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

View Source 
var File_google_longrunning_operations_proto protoreflect.FileDescriptor
View Source 
var Operations_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.longrunning.Operations",
	HandlerType: (*OperationsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListOperations",
			Handler:    _Operations_ListOperations_Handler,
		},
		{
			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{},
	Metadata: "google/longrunning/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 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
}

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

func (*CancelOperationRequest) CloneMessageVT 

func (m *CancelOperationRequest) CloneMessageVT() proto.Message

func (*CancelOperationRequest) CloneVT 

func (m *CancelOperationRequest) CloneVT() *CancelOperationRequest

func (*CancelOperationRequest) Descriptor deprecated 

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

Deprecated: Use CancelOperationRequest.ProtoReflect.Descriptor instead.

func (*CancelOperationRequest) EqualMessageVT 

func (this *CancelOperationRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*CancelOperationRequest) EqualVT 

func (this *CancelOperationRequest) EqualVT(that *CancelOperationRequest) bool

func (*CancelOperationRequest) GetName 

func (x *CancelOperationRequest) GetName() string

func (*CancelOperationRequest) MarshalToSizedBufferVT 

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

func (*CancelOperationRequest) MarshalToVT 

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

func (*CancelOperationRequest) MarshalVT 

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

func (*CancelOperationRequest) ProtoMessage 

func (*CancelOperationRequest) ProtoMessage()

func (*CancelOperationRequest) ProtoReflect 

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

func (*CancelOperationRequest) Reset 

func (x *CancelOperationRequest) Reset()

func (*CancelOperationRequest) SizeVT 

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

func (*CancelOperationRequest) String 

func (x *CancelOperationRequest) String() string

func (*CancelOperationRequest) UnmarshalVT 

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

func (*CancelOperationRequest) Validate 

func (m *CancelOperationRequest) Validate() error

Validate checks the field values on CancelOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CancelOperationRequest) ValidateAll 

func (m *CancelOperationRequest) ValidateAll() error

ValidateAll checks the field values on CancelOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CancelOperationRequestMultiError, or nil if none found.

type CancelOperationRequestMultiError 

type CancelOperationRequestMultiError []error

CancelOperationRequestMultiError is an error wrapping multiple validation errors returned by CancelOperationRequest.ValidateAll() if the designated constraints aren't met.

func (CancelOperationRequestMultiError) AllErrors 

func (m CancelOperationRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CancelOperationRequestMultiError) Error 

func (m CancelOperationRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type CancelOperationRequestValidationError 

type CancelOperationRequestValidationError struct {
	// contains filtered or unexported fields
}

CancelOperationRequestValidationError is the validation error returned by CancelOperationRequest.Validate if the designated constraints aren't met.

func (CancelOperationRequestValidationError) Cause 

func (e CancelOperationRequestValidationError) Cause() error

Cause function returns cause value.

func (CancelOperationRequestValidationError) Error 

func (e CancelOperationRequestValidationError) Error() string

Error satisfies the builtin error interface

func (CancelOperationRequestValidationError) ErrorName 

func (e CancelOperationRequestValidationError) ErrorName() string

ErrorName returns error name.

func (CancelOperationRequestValidationError) Field 

func (e CancelOperationRequestValidationError) Field() string

Field function returns field value.

func (CancelOperationRequestValidationError) Key 

func (e CancelOperationRequestValidationError) Key() bool

Key function returns key value.

func (CancelOperationRequestValidationError) Reason 

func (e CancelOperationRequestValidationError) Reason() string

Reason function returns reason value.

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
}

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

func (*DeleteOperationRequest) CloneMessageVT 

func (m *DeleteOperationRequest) CloneMessageVT() proto.Message

func (*DeleteOperationRequest) CloneVT 

func (m *DeleteOperationRequest) CloneVT() *DeleteOperationRequest

func (*DeleteOperationRequest) Descriptor deprecated 

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

Deprecated: Use DeleteOperationRequest.ProtoReflect.Descriptor instead.

func (*DeleteOperationRequest) EqualMessageVT 

func (this *DeleteOperationRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*DeleteOperationRequest) EqualVT 

func (this *DeleteOperationRequest) EqualVT(that *DeleteOperationRequest) bool

func (*DeleteOperationRequest) GetName 

func (x *DeleteOperationRequest) GetName() string

func (*DeleteOperationRequest) MarshalToSizedBufferVT 

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

func (*DeleteOperationRequest) MarshalToVT 

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

func (*DeleteOperationRequest) MarshalVT 

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

func (*DeleteOperationRequest) ProtoMessage 

func (*DeleteOperationRequest) ProtoMessage()

func (*DeleteOperationRequest) ProtoReflect 

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

func (*DeleteOperationRequest) Reset 

func (x *DeleteOperationRequest) Reset()

func (*DeleteOperationRequest) SizeVT 

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

func (*DeleteOperationRequest) String 

func (x *DeleteOperationRequest) String() string

func (*DeleteOperationRequest) UnmarshalVT 

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

func (*DeleteOperationRequest) Validate 

func (m *DeleteOperationRequest) Validate() error

Validate checks the field values on DeleteOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DeleteOperationRequest) ValidateAll 

func (m *DeleteOperationRequest) ValidateAll() error

ValidateAll checks the field values on DeleteOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DeleteOperationRequestMultiError, or nil if none found.

type DeleteOperationRequestMultiError 

type DeleteOperationRequestMultiError []error

DeleteOperationRequestMultiError is an error wrapping multiple validation errors returned by DeleteOperationRequest.ValidateAll() if the designated constraints aren't met.

func (DeleteOperationRequestMultiError) AllErrors 

func (m DeleteOperationRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DeleteOperationRequestMultiError) Error 

func (m DeleteOperationRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type DeleteOperationRequestValidationError 

type DeleteOperationRequestValidationError struct {
	// contains filtered or unexported fields
}

DeleteOperationRequestValidationError is the validation error returned by DeleteOperationRequest.Validate if the designated constraints aren't met.

func (DeleteOperationRequestValidationError) Cause 

func (e DeleteOperationRequestValidationError) Cause() error

Cause function returns cause value.

func (DeleteOperationRequestValidationError) Error 

func (e DeleteOperationRequestValidationError) Error() string

Error satisfies the builtin error interface

func (DeleteOperationRequestValidationError) ErrorName 

func (e DeleteOperationRequestValidationError) ErrorName() string

ErrorName returns error name.

func (DeleteOperationRequestValidationError) Field 

func (e DeleteOperationRequestValidationError) Field() string

Field function returns field value.

func (DeleteOperationRequestValidationError) Key 

func (e DeleteOperationRequestValidationError) Key() bool

Key function returns key value.

func (DeleteOperationRequestValidationError) Reason 

func (e DeleteOperationRequestValidationError) Reason() string

Reason function returns reason value.

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
}

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

func (*GetOperationRequest) CloneMessageVT 

func (m *GetOperationRequest) CloneMessageVT() proto.Message

func (*GetOperationRequest) CloneVT 

func (m *GetOperationRequest) CloneVT() *GetOperationRequest

func (*GetOperationRequest) Descriptor deprecated 

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

Deprecated: Use GetOperationRequest.ProtoReflect.Descriptor instead.

func (*GetOperationRequest) EqualMessageVT 

func (this *GetOperationRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*GetOperationRequest) EqualVT 

func (this *GetOperationRequest) EqualVT(that *GetOperationRequest) bool

func (*GetOperationRequest) GetName 

func (x *GetOperationRequest) GetName() string

func (*GetOperationRequest) MarshalToSizedBufferVT 

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

func (*GetOperationRequest) MarshalToVT 

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

func (*GetOperationRequest) MarshalVT 

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

func (*GetOperationRequest) ProtoMessage 

func (*GetOperationRequest) ProtoMessage()

func (*GetOperationRequest) ProtoReflect 

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

func (*GetOperationRequest) Reset 

func (x *GetOperationRequest) Reset()

func (*GetOperationRequest) SizeVT 

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

func (*GetOperationRequest) String 

func (x *GetOperationRequest) String() string

func (*GetOperationRequest) UnmarshalVT 

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

func (*GetOperationRequest) Validate 

func (m *GetOperationRequest) Validate() error

Validate checks the field values on GetOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GetOperationRequest) ValidateAll 

func (m *GetOperationRequest) ValidateAll() error

ValidateAll checks the field values on GetOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GetOperationRequestMultiError, or nil if none found.

type GetOperationRequestMultiError 

type GetOperationRequestMultiError []error

GetOperationRequestMultiError is an error wrapping multiple validation errors returned by GetOperationRequest.ValidateAll() if the designated constraints aren't met.

func (GetOperationRequestMultiError) AllErrors 

func (m GetOperationRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GetOperationRequestMultiError) Error 

func (m GetOperationRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GetOperationRequestValidationError 

type GetOperationRequestValidationError struct {
	// contains filtered or unexported fields
}

GetOperationRequestValidationError is the validation error returned by GetOperationRequest.Validate if the designated constraints aren't met.

func (GetOperationRequestValidationError) Cause 

func (e GetOperationRequestValidationError) Cause() error

Cause function returns cause value.

func (GetOperationRequestValidationError) Error 

func (e GetOperationRequestValidationError) Error() string

Error satisfies the builtin error interface

func (GetOperationRequestValidationError) ErrorName 

func (e GetOperationRequestValidationError) ErrorName() string

ErrorName returns error name.

func (GetOperationRequestValidationError) Field 

func (e GetOperationRequestValidationError) Field() string

Field function returns field value.

func (GetOperationRequestValidationError) Key 

func (e GetOperationRequestValidationError) Key() bool

Key function returns key value.

func (GetOperationRequestValidationError) Reason 

func (e GetOperationRequestValidationError) Reason() string

Reason function returns reason value.

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"`
	// contains filtered or unexported fields
}

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

func (*ListOperationsRequest) CloneMessageVT 

func (m *ListOperationsRequest) CloneMessageVT() proto.Message

func (*ListOperationsRequest) CloneVT 

func (m *ListOperationsRequest) CloneVT() *ListOperationsRequest

func (*ListOperationsRequest) Descriptor deprecated 

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

Deprecated: Use ListOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListOperationsRequest) EqualMessageVT 

func (this *ListOperationsRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*ListOperationsRequest) EqualVT 

func (this *ListOperationsRequest) EqualVT(that *ListOperationsRequest) bool

func (*ListOperationsRequest) GetFilter 

func (x *ListOperationsRequest) GetFilter() string

func (*ListOperationsRequest) GetName 

func (x *ListOperationsRequest) GetName() string

func (*ListOperationsRequest) GetPageSize 

func (x *ListOperationsRequest) GetPageSize() int32

func (*ListOperationsRequest) GetPageToken 

func (x *ListOperationsRequest) GetPageToken() string

func (*ListOperationsRequest) MarshalToSizedBufferVT 

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

func (*ListOperationsRequest) MarshalToVT 

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

func (*ListOperationsRequest) MarshalVT 

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

func (*ListOperationsRequest) ProtoMessage 

func (*ListOperationsRequest) ProtoMessage()

func (*ListOperationsRequest) ProtoReflect 

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

func (*ListOperationsRequest) Reset 

func (x *ListOperationsRequest) Reset()

func (*ListOperationsRequest) SizeVT 

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

func (*ListOperationsRequest) String 

func (x *ListOperationsRequest) String() string

func (*ListOperationsRequest) UnmarshalVT 

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

func (*ListOperationsRequest) Validate 

func (m *ListOperationsRequest) Validate() error

Validate checks the field values on ListOperationsRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ListOperationsRequest) ValidateAll 

func (m *ListOperationsRequest) ValidateAll() error

ValidateAll checks the field values on ListOperationsRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ListOperationsRequestMultiError, or nil if none found.

type ListOperationsRequestMultiError 

type ListOperationsRequestMultiError []error

ListOperationsRequestMultiError is an error wrapping multiple validation errors returned by ListOperationsRequest.ValidateAll() if the designated constraints aren't met.

func (ListOperationsRequestMultiError) AllErrors 

func (m ListOperationsRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ListOperationsRequestMultiError) Error 

func (m ListOperationsRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ListOperationsRequestValidationError 

type ListOperationsRequestValidationError struct {
	// contains filtered or unexported fields
}

ListOperationsRequestValidationError is the validation error returned by ListOperationsRequest.Validate if the designated constraints aren't met.

func (ListOperationsRequestValidationError) Cause 

func (e ListOperationsRequestValidationError) Cause() error

Cause function returns cause value.

func (ListOperationsRequestValidationError) Error 

func (e ListOperationsRequestValidationError) Error() string

Error satisfies the builtin error interface

func (ListOperationsRequestValidationError) ErrorName 

func (e ListOperationsRequestValidationError) ErrorName() string

ErrorName returns error name.

func (ListOperationsRequestValidationError) Field 

func (e ListOperationsRequestValidationError) Field() string

Field function returns field value.

func (ListOperationsRequestValidationError) Key 

func (e ListOperationsRequestValidationError) Key() bool

Key function returns key value.

func (ListOperationsRequestValidationError) Reason 

func (e ListOperationsRequestValidationError) Reason() string

Reason function returns reason value.

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"`
	// contains filtered or unexported fields
}

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

func (*ListOperationsResponse) CloneMessageVT 

func (m *ListOperationsResponse) CloneMessageVT() proto.Message

func (*ListOperationsResponse) CloneVT 

func (m *ListOperationsResponse) CloneVT() *ListOperationsResponse

func (*ListOperationsResponse) Descriptor deprecated 

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

Deprecated: Use ListOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListOperationsResponse) EqualMessageVT 

func (this *ListOperationsResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*ListOperationsResponse) EqualVT 

func (this *ListOperationsResponse) EqualVT(that *ListOperationsResponse) bool

func (*ListOperationsResponse) GetNextPageToken 

func (x *ListOperationsResponse) GetNextPageToken() string

func (*ListOperationsResponse) GetOperations 

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

func (*ListOperationsResponse) MarshalToSizedBufferVT 

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

func (*ListOperationsResponse) MarshalToVT 

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

func (*ListOperationsResponse) MarshalVT 

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

func (*ListOperationsResponse) ProtoMessage 

func (*ListOperationsResponse) ProtoMessage()

func (*ListOperationsResponse) ProtoReflect 

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

func (*ListOperationsResponse) Reset 

func (x *ListOperationsResponse) Reset()

func (*ListOperationsResponse) SizeVT 

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

func (*ListOperationsResponse) String 

func (x *ListOperationsResponse) String() string

func (*ListOperationsResponse) UnmarshalVT 

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

func (*ListOperationsResponse) Validate 

func (m *ListOperationsResponse) Validate() error

Validate checks the field values on ListOperationsResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ListOperationsResponse) ValidateAll 

func (m *ListOperationsResponse) ValidateAll() error

ValidateAll checks the field values on ListOperationsResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ListOperationsResponseMultiError, or nil if none found.

type ListOperationsResponseMultiError 

type ListOperationsResponseMultiError []error

ListOperationsResponseMultiError is an error wrapping multiple validation errors returned by ListOperationsResponse.ValidateAll() if the designated constraints aren't met.

func (ListOperationsResponseMultiError) AllErrors 

func (m ListOperationsResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ListOperationsResponseMultiError) Error 

func (m ListOperationsResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ListOperationsResponseValidationError 

type ListOperationsResponseValidationError struct {
	// contains filtered or unexported fields
}

ListOperationsResponseValidationError is the validation error returned by ListOperationsResponse.Validate if the designated constraints aren't met.

func (ListOperationsResponseValidationError) Cause 

func (e ListOperationsResponseValidationError) Cause() error

Cause function returns cause value.

func (ListOperationsResponseValidationError) Error 

func (e ListOperationsResponseValidationError) Error() string

Error satisfies the builtin error interface

func (ListOperationsResponseValidationError) ErrorName 

func (e ListOperationsResponseValidationError) ErrorName() string

ErrorName returns error name.

func (ListOperationsResponseValidationError) Field 

func (e ListOperationsResponseValidationError) Field() string

Field function returns field value.

func (ListOperationsResponseValidationError) Key 

func (e ListOperationsResponseValidationError) Key() bool

Key function returns key value.

func (ListOperationsResponseValidationError) Reason 

func (e ListOperationsResponseValidationError) Reason() string

Reason function returns reason value.

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 *anypb.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 assignable to Result:
	//
	//	*Operation_Error
	//	*Operation_Response
	Result isOperation_Result `protobuf_oneof:"result"`
	// contains filtered or unexported fields
}

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

func (*Operation) CloneMessageVT 

func (m *Operation) CloneMessageVT() proto.Message

func (*Operation) CloneVT 

func (m *Operation) CloneVT() *Operation

func (*Operation) Descriptor deprecated 

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

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) EqualMessageVT 

func (this *Operation) EqualMessageVT(thatMsg proto.Message) bool

func (*Operation) EqualVT 

func (this *Operation) EqualVT(that *Operation) bool

func (*Operation) GetDone 

func (x *Operation) GetDone() bool

func (*Operation) GetError 

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

func (*Operation) GetMetadata 

func (x *Operation) GetMetadata() *anypb.Any

func (*Operation) GetName 

func (x *Operation) GetName() string

func (*Operation) GetResponse 

func (x *Operation) GetResponse() *anypb.Any

func (*Operation) GetResult 

func (m *Operation) GetResult() isOperation_Result

func (*Operation) MarshalToSizedBufferVT 

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

func (*Operation) MarshalToVT 

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

func (*Operation) MarshalVT 

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

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) ProtoReflect 

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

func (*Operation) Reset 

func (x *Operation) Reset()

func (*Operation) SizeVT 

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

func (*Operation) String 

func (x *Operation) String() string

func (*Operation) UnmarshalVT 

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

func (*Operation) Validate 

func (m *Operation) Validate() error

Validate checks the field values on Operation with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Operation) ValidateAll 

func (m *Operation) ValidateAll() error

ValidateAll checks the field values on Operation with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in OperationMultiError, or nil if none found.

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"`
	// contains filtered or unexported fields
}

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 (*OperationInfo) CloneMessageVT 

func (m *OperationInfo) CloneMessageVT() proto.Message

func (*OperationInfo) CloneVT 

func (m *OperationInfo) CloneVT() *OperationInfo

func (*OperationInfo) Descriptor deprecated 

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

Deprecated: Use OperationInfo.ProtoReflect.Descriptor instead.

func (*OperationInfo) EqualMessageVT 

func (this *OperationInfo) EqualMessageVT(thatMsg proto.Message) bool

func (*OperationInfo) EqualVT 

func (this *OperationInfo) EqualVT(that *OperationInfo) bool

func (*OperationInfo) GetMetadataType 

func (x *OperationInfo) GetMetadataType() string

func (*OperationInfo) GetResponseType 

func (x *OperationInfo) GetResponseType() string

func (*OperationInfo) MarshalToSizedBufferVT 

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

func (*OperationInfo) MarshalToVT 

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

func (*OperationInfo) MarshalVT 

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

func (*OperationInfo) ProtoMessage 

func (*OperationInfo) ProtoMessage()

func (*OperationInfo) ProtoReflect 

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

func (*OperationInfo) Reset 

func (x *OperationInfo) Reset()

func (*OperationInfo) SizeVT 

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

func (*OperationInfo) String 

func (x *OperationInfo) String() string

func (*OperationInfo) UnmarshalVT 

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

func (*OperationInfo) Validate 

func (m *OperationInfo) Validate() error

Validate checks the field values on OperationInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*OperationInfo) ValidateAll 

func (m *OperationInfo) ValidateAll() error

ValidateAll checks the field values on OperationInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in OperationInfoMultiError, or nil if none found.

type OperationInfoMultiError 

type OperationInfoMultiError []error

OperationInfoMultiError is an error wrapping multiple validation errors returned by OperationInfo.ValidateAll() if the designated constraints aren't met.

func (OperationInfoMultiError) AllErrors 

func (m OperationInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OperationInfoMultiError) Error 

func (m OperationInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type OperationInfoValidationError 

type OperationInfoValidationError struct {
	// contains filtered or unexported fields
}

OperationInfoValidationError is the validation error returned by OperationInfo.Validate if the designated constraints aren't met.

func (OperationInfoValidationError) Cause 

func (e OperationInfoValidationError) Cause() error

Cause function returns cause value.

func (OperationInfoValidationError) Error 

func (e OperationInfoValidationError) Error() string

Error satisfies the builtin error interface

func (OperationInfoValidationError) ErrorName 

func (e OperationInfoValidationError) ErrorName() string

ErrorName returns error name.

func (OperationInfoValidationError) Field 

func (e OperationInfoValidationError) Field() string

Field function returns field value.

func (OperationInfoValidationError) Key 

func (e OperationInfoValidationError) Key() bool

Key function returns key value.

func (OperationInfoValidationError) Reason 

func (e OperationInfoValidationError) Reason() string

Reason function returns reason value.

type OperationMultiError 

type OperationMultiError []error

OperationMultiError is an error wrapping multiple validation errors returned by Operation.ValidateAll() if the designated constraints aren't met.

func (OperationMultiError) AllErrors 

func (m OperationMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OperationMultiError) Error 

func (m OperationMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type OperationValidationError 

type OperationValidationError struct {
	// contains filtered or unexported fields
}

OperationValidationError is the validation error returned by Operation.Validate if the designated constraints aren't met.

func (OperationValidationError) Cause 

func (e OperationValidationError) Cause() error

Cause function returns cause value.

func (OperationValidationError) Error 

func (e OperationValidationError) Error() string

Error satisfies the builtin error interface

func (OperationValidationError) ErrorName 

func (e OperationValidationError) ErrorName() string

ErrorName returns error name.

func (OperationValidationError) Field 

func (e OperationValidationError) Field() string

Field function returns field value.

func (OperationValidationError) Key 

func (e OperationValidationError) Key() bool

Key function returns key value.

func (OperationValidationError) Reason 

func (e OperationValidationError) Reason() string

Reason function returns reason value.

type Operation_Error 

type Operation_Error struct {
	// The error result of the operation in case of failure or cancellation.
	Error *rpc.Status `protobuf:"bytes,4,opt,name=error,proto3,oneof"`
}

func (*Operation_Error) CloneVT 

func (m *Operation_Error) CloneVT() isOperation_Result

func (*Operation_Error) EqualVT 

func (this *Operation_Error) EqualVT(thatIface isOperation_Result) bool

func (*Operation_Error) MarshalToSizedBufferVT 

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

func (*Operation_Error) MarshalToVT 

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

func (*Operation_Error) SizeVT 

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

type Operation_Response 

type Operation_Response struct {
	// The normal response of the operation in case of success.  If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`.  If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource.  For other
	// methods, the response should have the type `XxxResponse`, where `Xxx`
	// is the original method name.  For example, if the original method name
	// is `TakeSnapshot()`, the inferred response type is
	// `TakeSnapshotResponse`.
	Response *anypb.Any `protobuf:"bytes,5,opt,name=response,proto3,oneof"`
}

func (*Operation_Response) CloneVT 

func (m *Operation_Response) CloneVT() isOperation_Result

func (*Operation_Response) EqualVT 

func (this *Operation_Response) EqualVT(thatIface isOperation_Result) bool

func (*Operation_Response) MarshalToSizedBufferVT 

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

func (*Operation_Response) MarshalToVT 

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

func (*Operation_Response) SizeVT 

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

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) (*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.  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) (*emptypb.Empty, error)
	// Waits until the specified long-running operation 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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewOperationsClient 

func NewOperationsClient(cc grpc.ClientConnInterface) 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) (*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.  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) (*emptypb.Empty, error)
	// Waits until the specified long-running operation 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)
	// contains filtered or unexported methods
}

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

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) (*Operation, error)

func (UnimplementedOperationsServer) ListOperations 

func (UnimplementedOperationsServer) ListOperations(context.Context, *ListOperationsRequest) (*ListOperationsResponse, error)

func (UnimplementedOperationsServer) WaitOperation 

func (UnimplementedOperationsServer) WaitOperation(context.Context, *WaitOperationRequest) (*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 [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].

func (*WaitOperationRequest) CloneMessageVT 

func (m *WaitOperationRequest) CloneMessageVT() proto.Message

func (*WaitOperationRequest) CloneVT 

func (m *WaitOperationRequest) CloneVT() *WaitOperationRequest

func (*WaitOperationRequest) Descriptor deprecated 

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

Deprecated: Use WaitOperationRequest.ProtoReflect.Descriptor instead.

func (*WaitOperationRequest) EqualMessageVT 

func (this *WaitOperationRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*WaitOperationRequest) EqualVT 

func (this *WaitOperationRequest) EqualVT(that *WaitOperationRequest) bool

func (*WaitOperationRequest) GetName 

func (x *WaitOperationRequest) GetName() string

func (*WaitOperationRequest) GetTimeout 

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

func (*WaitOperationRequest) MarshalToSizedBufferVT 

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

func (*WaitOperationRequest) MarshalToVT 

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

func (*WaitOperationRequest) MarshalVT 

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

func (*WaitOperationRequest) ProtoMessage 

func (*WaitOperationRequest) ProtoMessage()

func (*WaitOperationRequest) ProtoReflect 

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

func (*WaitOperationRequest) Reset 

func (x *WaitOperationRequest) Reset()

func (*WaitOperationRequest) SizeVT 

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

func (*WaitOperationRequest) String 

func (x *WaitOperationRequest) String() string

func (*WaitOperationRequest) UnmarshalVT 

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

func (*WaitOperationRequest) Validate 

func (m *WaitOperationRequest) Validate() error

Validate checks the field values on WaitOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WaitOperationRequest) ValidateAll 

func (m *WaitOperationRequest) ValidateAll() error

ValidateAll checks the field values on WaitOperationRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WaitOperationRequestMultiError, or nil if none found.

type WaitOperationRequestMultiError 

type WaitOperationRequestMultiError []error

WaitOperationRequestMultiError is an error wrapping multiple validation errors returned by WaitOperationRequest.ValidateAll() if the designated constraints aren't met.

func (WaitOperationRequestMultiError) AllErrors 

func (m WaitOperationRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (WaitOperationRequestMultiError) Error 

func (m WaitOperationRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type WaitOperationRequestValidationError 

type WaitOperationRequestValidationError struct {
	// contains filtered or unexported fields
}

WaitOperationRequestValidationError is the validation error returned by WaitOperationRequest.Validate if the designated constraints aren't met.

func (WaitOperationRequestValidationError) Cause 

func (e WaitOperationRequestValidationError) Cause() error

Cause function returns cause value.

func (WaitOperationRequestValidationError) Error 

func (e WaitOperationRequestValidationError) Error() string

Error satisfies the builtin error interface

func (WaitOperationRequestValidationError) ErrorName 

func (e WaitOperationRequestValidationError) ErrorName() string

ErrorName returns error name.

func (WaitOperationRequestValidationError) Field 

func (e WaitOperationRequestValidationError) Field() string

Field function returns field value.

func (WaitOperationRequestValidationError) Key 

func (e WaitOperationRequestValidationError) Key() bool

Key function returns key value.

func (WaitOperationRequestValidationError) Reason 

func (e WaitOperationRequestValidationError) Reason() string

Reason function returns reason value.

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.