Ydb_Operations

package
v0.0.0-...-8dd88c8 Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	OperationParams_OperationMode_name = map[int32]string{
		0: "OPERATION_MODE_UNSPECIFIED",
		1: "SYNC",
		2: "ASYNC",
	}
	OperationParams_OperationMode_value = map[string]int32{
		"OPERATION_MODE_UNSPECIFIED": 0,
		"SYNC":                       1,
		"ASYNC":                      2,
	}
)

Enum value maps for OperationParams_OperationMode.

View Source 
var File_protos_ydb_operation_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CancelOperationRequest 

type CancelOperationRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelOperationRequest) Descriptor deprecated 

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

Deprecated: Use CancelOperationRequest.ProtoReflect.Descriptor instead.

func (*CancelOperationRequest) GetId 

func (x *CancelOperationRequest) GetId() string

func (*CancelOperationRequest) ProtoMessage 

func (*CancelOperationRequest) ProtoMessage()

func (*CancelOperationRequest) ProtoReflect 

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

func (*CancelOperationRequest) Reset 

func (x *CancelOperationRequest) Reset()

func (*CancelOperationRequest) String 

func (x *CancelOperationRequest) String() string

type CancelOperationResponse 

type CancelOperationResponse struct {
	Status Ydb.StatusIds_StatusCode  `protobuf:"varint,1,opt,name=status,proto3,enum=Ydb.StatusIds_StatusCode" json:"status,omitempty"`
	Issues []*Ydb_Issue.IssueMessage `protobuf:"bytes,2,rep,name=issues,proto3" json:"issues,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelOperationResponse) Descriptor deprecated 

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

Deprecated: Use CancelOperationResponse.ProtoReflect.Descriptor instead.

func (*CancelOperationResponse) GetIssues 

func (x *CancelOperationResponse) GetIssues() []*Ydb_Issue.IssueMessage

func (*CancelOperationResponse) GetStatus 

func (x *CancelOperationResponse) GetStatus() Ydb.StatusIds_StatusCode

func (*CancelOperationResponse) ProtoMessage 

func (*CancelOperationResponse) ProtoMessage()

func (*CancelOperationResponse) ProtoReflect 

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

func (*CancelOperationResponse) Reset 

func (x *CancelOperationResponse) Reset()

func (*CancelOperationResponse) String 

func (x *CancelOperationResponse) String() string

type ForgetOperationRequest 

type ForgetOperationRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*ForgetOperationRequest) Descriptor deprecated 

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

Deprecated: Use ForgetOperationRequest.ProtoReflect.Descriptor instead.

func (*ForgetOperationRequest) GetId 

func (x *ForgetOperationRequest) GetId() string

func (*ForgetOperationRequest) ProtoMessage 

func (*ForgetOperationRequest) ProtoMessage()

func (*ForgetOperationRequest) ProtoReflect 

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

func (*ForgetOperationRequest) Reset 

func (x *ForgetOperationRequest) Reset()

func (*ForgetOperationRequest) String 

func (x *ForgetOperationRequest) String() string

type ForgetOperationResponse 

type ForgetOperationResponse struct {
	Status Ydb.StatusIds_StatusCode  `protobuf:"varint,1,opt,name=status,proto3,enum=Ydb.StatusIds_StatusCode" json:"status,omitempty"`
	Issues []*Ydb_Issue.IssueMessage `protobuf:"bytes,2,rep,name=issues,proto3" json:"issues,omitempty"`
	// contains filtered or unexported fields
}

func (*ForgetOperationResponse) Descriptor deprecated 

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

Deprecated: Use ForgetOperationResponse.ProtoReflect.Descriptor instead.

func (*ForgetOperationResponse) GetIssues 

func (x *ForgetOperationResponse) GetIssues() []*Ydb_Issue.IssueMessage

func (*ForgetOperationResponse) GetStatus 

func (x *ForgetOperationResponse) GetStatus() Ydb.StatusIds_StatusCode

func (*ForgetOperationResponse) ProtoMessage 

func (*ForgetOperationResponse) ProtoMessage()

func (*ForgetOperationResponse) ProtoReflect 

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

func (*ForgetOperationResponse) Reset 

func (x *ForgetOperationResponse) Reset()

func (*ForgetOperationResponse) String 

func (x *ForgetOperationResponse) String() string

type GetOperationRequest 

type GetOperationRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetOperationRequest) Descriptor deprecated 

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

Deprecated: Use GetOperationRequest.ProtoReflect.Descriptor instead.

func (*GetOperationRequest) GetId 

func (x *GetOperationRequest) GetId() string

func (*GetOperationRequest) ProtoMessage 

func (*GetOperationRequest) ProtoMessage()

func (*GetOperationRequest) ProtoReflect 

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

func (*GetOperationRequest) Reset 

func (x *GetOperationRequest) Reset()

func (*GetOperationRequest) String 

func (x *GetOperationRequest) String() string

type GetOperationResponse 

type GetOperationResponse struct {
	Operation *Operation `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

func (*GetOperationResponse) Descriptor deprecated 

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

Deprecated: Use GetOperationResponse.ProtoReflect.Descriptor instead.

func (*GetOperationResponse) GetOperation 

func (x *GetOperationResponse) GetOperation() *Operation

func (*GetOperationResponse) ProtoMessage 

func (*GetOperationResponse) ProtoMessage()

func (*GetOperationResponse) ProtoReflect 

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

func (*GetOperationResponse) Reset 

func (x *GetOperationResponse) Reset()

func (*GetOperationResponse) String 

func (x *GetOperationResponse) String() string

type ListOperationsRequest 

type ListOperationsRequest struct {
	Kind      string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	PageSize  uint64 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListOperationsRequest) Descriptor deprecated 

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

Deprecated: Use ListOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListOperationsRequest) GetKind 

func (x *ListOperationsRequest) GetKind() string

func (*ListOperationsRequest) GetPageSize 

func (x *ListOperationsRequest) GetPageSize() uint64

func (*ListOperationsRequest) GetPageToken 

func (x *ListOperationsRequest) GetPageToken() string

func (*ListOperationsRequest) ProtoMessage 

func (*ListOperationsRequest) ProtoMessage()

func (*ListOperationsRequest) ProtoReflect 

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

func (*ListOperationsRequest) Reset 

func (x *ListOperationsRequest) Reset()

func (*ListOperationsRequest) String 

func (x *ListOperationsRequest) String() string

type ListOperationsResponse 

type ListOperationsResponse struct {
	Status        Ydb.StatusIds_StatusCode  `protobuf:"varint,1,opt,name=status,proto3,enum=Ydb.StatusIds_StatusCode" json:"status,omitempty"`
	Issues        []*Ydb_Issue.IssueMessage `protobuf:"bytes,2,rep,name=issues,proto3" json:"issues,omitempty"`
	Operations    []*Operation              `protobuf:"bytes,3,rep,name=operations,proto3" json:"operations,omitempty"`
	NextPageToken string                    `protobuf:"bytes,4,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListOperationsResponse) Descriptor deprecated 

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

Deprecated: Use ListOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListOperationsResponse) GetIssues 

func (x *ListOperationsResponse) GetIssues() []*Ydb_Issue.IssueMessage

func (*ListOperationsResponse) GetNextPageToken 

func (x *ListOperationsResponse) GetNextPageToken() string

func (*ListOperationsResponse) GetOperations 

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

func (*ListOperationsResponse) GetStatus 

func (x *ListOperationsResponse) GetStatus() Ydb.StatusIds_StatusCode

func (*ListOperationsResponse) ProtoMessage 

func (*ListOperationsResponse) ProtoMessage()

func (*ListOperationsResponse) ProtoReflect 

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

func (*ListOperationsResponse) Reset 

func (x *ListOperationsResponse) Reset()

func (*ListOperationsResponse) String 

func (x *ListOperationsResponse) String() string

type Operation 

type Operation struct {

	// Identifier of the operation, empty value means no active operation object is present (it was forgotten or
	// not created in the first place, as in SYNC operation mode).
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// true - this operation has beed finished (doesn't matter successful or not),
	// so Status field has status code, and Result field can contains result data.
	// false - this operation still running. You can repeat request using operation Id.
	Ready  bool                      `protobuf:"varint,2,opt,name=ready,proto3" json:"ready,omitempty"`
	Status Ydb.StatusIds_StatusCode  `protobuf:"varint,3,opt,name=status,proto3,enum=Ydb.StatusIds_StatusCode" json:"status,omitempty"`
	Issues []*Ydb_Issue.IssueMessage `protobuf:"bytes,4,rep,name=issues,proto3" json:"issues,omitempty"`
	// Result data
	Result   *anypb.Any `protobuf:"bytes,5,opt,name=result,proto3" json:"result,omitempty"`
	Metadata *anypb.Any `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Contains information about the cost of the operation.
	// For completed operations, it shows the final cost of the operation.
	// For operations in progress, it might indicate the current cost of the operation (if supported).
	CostInfo *Ydb.CostInfo `protobuf:"bytes,7,opt,name=cost_info,json=costInfo,proto3" json:"cost_info,omitempty"`
	// contains filtered or unexported fields
}

func (*Operation) Descriptor deprecated 

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

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetCostInfo 

func (x *Operation) GetCostInfo() *Ydb.CostInfo

func (*Operation) GetId 

func (x *Operation) GetId() string

func (*Operation) GetIssues 

func (x *Operation) GetIssues() []*Ydb_Issue.IssueMessage

func (*Operation) GetMetadata 

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

func (*Operation) GetReady 

func (x *Operation) GetReady() bool

func (*Operation) GetResult 

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

func (*Operation) GetStatus 

func (x *Operation) GetStatus() Ydb.StatusIds_StatusCode

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) ProtoReflect 

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

func (*Operation) Reset 

func (x *Operation) Reset()

func (*Operation) String 

func (x *Operation) String() string

type OperationParams 

type OperationParams struct {
	OperationMode OperationParams_OperationMode `` /* 151-byte string literal not displayed */
	// Indicates that client is no longer interested in the result of operation after the specified duration
	// starting from the time operation arrives at the server.
	// Server will try to stop the execution of operation and if no result is currently available the operation
	// will receive TIMEOUT status code, which will be sent back to client if it was waiting for the operation result.
	// Timeout of operation does not tell anything about its result, it might be completed successfully
	// or cancelled on server.
	OperationTimeout *durationpb.Duration `protobuf:"bytes,2,opt,name=operation_timeout,json=operationTimeout,proto3" json:"operation_timeout,omitempty"`
	// Server will try to cancel the operation after the specified duration starting from the time
	// the operation arrives at server.
	// In case of successful cancellation operation will receive CANCELLED status code, which will be
	// sent back to client if it was waiting for the operation result.
	// In case when cancellation isn't possible, no action will be performed.
	CancelAfter *durationpb.Duration `protobuf:"bytes,3,opt,name=cancel_after,json=cancelAfter,proto3" json:"cancel_after,omitempty"`
	// User-defined labels of operation.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// If enabled, server will report cost information, if supported by the operation.
	// This flag is mostly useful for SYNC operations, to get the cost information in the response.
	ReportCostInfo Ydb.FeatureFlag_Status `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*OperationParams) Descriptor deprecated 

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

Deprecated: Use OperationParams.ProtoReflect.Descriptor instead.

func (*OperationParams) GetCancelAfter 

func (x *OperationParams) GetCancelAfter() *durationpb.Duration

func (*OperationParams) GetLabels 

func (x *OperationParams) GetLabels() map[string]string

func (*OperationParams) GetOperationMode 

func (x *OperationParams) GetOperationMode() OperationParams_OperationMode

func (*OperationParams) GetOperationTimeout 

func (x *OperationParams) GetOperationTimeout() *durationpb.Duration

func (*OperationParams) GetReportCostInfo 

func (x *OperationParams) GetReportCostInfo() Ydb.FeatureFlag_Status

func (*OperationParams) ProtoMessage 

func (*OperationParams) ProtoMessage()

func (*OperationParams) ProtoReflect 

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

func (*OperationParams) Reset 

func (x *OperationParams) Reset()

func (*OperationParams) String 

func (x *OperationParams) String() string

type OperationParams_OperationMode 

type OperationParams_OperationMode int32
const (
	OperationParams_OPERATION_MODE_UNSPECIFIED OperationParams_OperationMode = 0
	// Server will only reply once operation is finished (ready=true), and operation object won't be
	// accessible after the reply. This is a basic request-response mode.
	OperationParams_SYNC  OperationParams_OperationMode = 1
	OperationParams_ASYNC OperationParams_OperationMode = 2
)

func (OperationParams_OperationMode) Descriptor 

func (OperationParams_OperationMode) Descriptor() protoreflect.EnumDescriptor

func (OperationParams_OperationMode) Enum 

func (x OperationParams_OperationMode) Enum() *OperationParams_OperationMode

func (OperationParams_OperationMode) EnumDescriptor deprecated 

func (OperationParams_OperationMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationParams_OperationMode.Descriptor instead.

func (OperationParams_OperationMode) Number 

func (x OperationParams_OperationMode) Number() protoreflect.EnumNumber

func (OperationParams_OperationMode) String 

func (x OperationParams_OperationMode) String() string

func (OperationParams_OperationMode) Type 

func (OperationParams_OperationMode) Type() protoreflect.EnumType

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.