Ydb_Operations

package
v2.11.0 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2021 License: Apache-2.0 Imports: 7 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",
}
View Source 
var OperationParams_OperationMode_value = map[string]int32{
	"OPERATION_MODE_UNSPECIFIED": 0,
	"SYNC":                       1,
	"ASYNC":                      2,
}

Functions

This section is empty.

Types

type CancelOperationRequest 

type CancelOperationRequest struct {
	Id                   string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CancelOperationRequest) Descriptor 

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

func (*CancelOperationRequest) GetId 

func (m *CancelOperationRequest) GetId() string

func (*CancelOperationRequest) ProtoMessage 

func (*CancelOperationRequest) ProtoMessage()

func (*CancelOperationRequest) Reset 

func (m *CancelOperationRequest) Reset()

func (*CancelOperationRequest) String 

func (m *CancelOperationRequest) String() string

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_Size 

func (m *CancelOperationRequest) XXX_Size() int

func (*CancelOperationRequest) XXX_Unmarshal 

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

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

func (*CancelOperationResponse) Descriptor 

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

func (*CancelOperationResponse) GetIssues 

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

func (*CancelOperationResponse) GetStatus 

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

func (*CancelOperationResponse) ProtoMessage 

func (*CancelOperationResponse) ProtoMessage()

func (*CancelOperationResponse) Reset 

func (m *CancelOperationResponse) Reset()

func (*CancelOperationResponse) String 

func (m *CancelOperationResponse) String() string

func (*CancelOperationResponse) XXX_DiscardUnknown 

func (m *CancelOperationResponse) XXX_DiscardUnknown()

func (*CancelOperationResponse) XXX_Marshal 

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

func (*CancelOperationResponse) XXX_Merge 

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

func (*CancelOperationResponse) XXX_Size 

func (m *CancelOperationResponse) XXX_Size() int

func (*CancelOperationResponse) XXX_Unmarshal 

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

type ForgetOperationRequest 

type ForgetOperationRequest struct {
	Id                   string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ForgetOperationRequest) Descriptor 

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

func (*ForgetOperationRequest) GetId 

func (m *ForgetOperationRequest) GetId() string

func (*ForgetOperationRequest) ProtoMessage 

func (*ForgetOperationRequest) ProtoMessage()

func (*ForgetOperationRequest) Reset 

func (m *ForgetOperationRequest) Reset()

func (*ForgetOperationRequest) String 

func (m *ForgetOperationRequest) String() string

func (*ForgetOperationRequest) XXX_DiscardUnknown 

func (m *ForgetOperationRequest) XXX_DiscardUnknown()

func (*ForgetOperationRequest) XXX_Marshal 

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

func (*ForgetOperationRequest) XXX_Merge 

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

func (*ForgetOperationRequest) XXX_Size 

func (m *ForgetOperationRequest) XXX_Size() int

func (*ForgetOperationRequest) XXX_Unmarshal 

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

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

func (*ForgetOperationResponse) Descriptor 

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

func (*ForgetOperationResponse) GetIssues 

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

func (*ForgetOperationResponse) GetStatus 

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

func (*ForgetOperationResponse) ProtoMessage 

func (*ForgetOperationResponse) ProtoMessage()

func (*ForgetOperationResponse) Reset 

func (m *ForgetOperationResponse) Reset()

func (*ForgetOperationResponse) String 

func (m *ForgetOperationResponse) String() string

func (*ForgetOperationResponse) XXX_DiscardUnknown 

func (m *ForgetOperationResponse) XXX_DiscardUnknown()

func (*ForgetOperationResponse) XXX_Marshal 

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

func (*ForgetOperationResponse) XXX_Merge 

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

func (*ForgetOperationResponse) XXX_Size 

func (m *ForgetOperationResponse) XXX_Size() int

func (*ForgetOperationResponse) XXX_Unmarshal 

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

type GetOperationRequest 

type GetOperationRequest struct {
	Id                   string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetOperationRequest) Descriptor 

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

func (*GetOperationRequest) GetId 

func (m *GetOperationRequest) GetId() string

func (*GetOperationRequest) ProtoMessage 

func (*GetOperationRequest) ProtoMessage()

func (*GetOperationRequest) Reset 

func (m *GetOperationRequest) Reset()

func (*GetOperationRequest) String 

func (m *GetOperationRequest) String() string

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_Size 

func (m *GetOperationRequest) XXX_Size() int

func (*GetOperationRequest) XXX_Unmarshal 

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

type GetOperationResponse 

type GetOperationResponse struct {
	Operation            *Operation `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*GetOperationResponse) Descriptor 

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

func (*GetOperationResponse) GetOperation 

func (m *GetOperationResponse) GetOperation() *Operation

func (*GetOperationResponse) ProtoMessage 

func (*GetOperationResponse) ProtoMessage()

func (*GetOperationResponse) Reset 

func (m *GetOperationResponse) Reset()

func (*GetOperationResponse) String 

func (m *GetOperationResponse) String() string

func (*GetOperationResponse) XXX_DiscardUnknown 

func (m *GetOperationResponse) XXX_DiscardUnknown()

func (*GetOperationResponse) XXX_Marshal 

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

func (*GetOperationResponse) XXX_Merge 

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

func (*GetOperationResponse) XXX_Size 

func (m *GetOperationResponse) XXX_Size() int

func (*GetOperationResponse) XXX_Unmarshal 

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

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

func (*ListOperationsRequest) Descriptor 

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

func (*ListOperationsRequest) GetKind 

func (m *ListOperationsRequest) GetKind() string

func (*ListOperationsRequest) GetPageSize 

func (m *ListOperationsRequest) GetPageSize() uint64

func (*ListOperationsRequest) GetPageToken 

func (m *ListOperationsRequest) GetPageToken() string

func (*ListOperationsRequest) ProtoMessage 

func (*ListOperationsRequest) ProtoMessage()

func (*ListOperationsRequest) Reset 

func (m *ListOperationsRequest) Reset()

func (*ListOperationsRequest) String 

func (m *ListOperationsRequest) String() string

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_Size 

func (m *ListOperationsRequest) XXX_Size() int

func (*ListOperationsRequest) XXX_Unmarshal 

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

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

func (*ListOperationsResponse) Descriptor 

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

func (*ListOperationsResponse) GetIssues 

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

func (*ListOperationsResponse) GetNextPageToken 

func (m *ListOperationsResponse) GetNextPageToken() string

func (*ListOperationsResponse) GetOperations 

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

func (*ListOperationsResponse) GetStatus 

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

func (*ListOperationsResponse) ProtoMessage 

func (*ListOperationsResponse) ProtoMessage()

func (*ListOperationsResponse) Reset 

func (m *ListOperationsResponse) Reset()

func (*ListOperationsResponse) String 

func (m *ListOperationsResponse) String() string

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_Size 

func (m *ListOperationsResponse) XXX_Size() int

func (*ListOperationsResponse) XXX_Unmarshal 

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

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

func (*Operation) Descriptor 

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

func (*Operation) GetCostInfo 

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

func (*Operation) GetId 

func (m *Operation) GetId() string

func (*Operation) GetIssues 

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

func (*Operation) GetMetadata 

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

func (*Operation) GetReady 

func (m *Operation) GetReady() bool

func (*Operation) GetResult 

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

func (*Operation) GetStatus 

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

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) Reset 

func (m *Operation) Reset()

func (*Operation) String 

func (m *Operation) String() string

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_Size 

func (m *Operation) XXX_Size() int

func (*Operation) XXX_Unmarshal 

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

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

func (*OperationParams) Descriptor 

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

func (*OperationParams) GetCancelAfter 

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

func (*OperationParams) GetLabels 

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

func (*OperationParams) GetOperationMode 

func (m *OperationParams) GetOperationMode() OperationParams_OperationMode

func (*OperationParams) GetOperationTimeout 

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

func (*OperationParams) GetReportCostInfo 

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

func (*OperationParams) ProtoMessage 

func (*OperationParams) ProtoMessage()

func (*OperationParams) Reset 

func (m *OperationParams) Reset()

func (*OperationParams) String 

func (m *OperationParams) String() string

func (*OperationParams) XXX_DiscardUnknown 

func (m *OperationParams) XXX_DiscardUnknown()

func (*OperationParams) XXX_Marshal 

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

func (*OperationParams) XXX_Merge 

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

func (*OperationParams) XXX_Size 

func (m *OperationParams) XXX_Size() int

func (*OperationParams) XXX_Unmarshal 

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

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

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

func (OperationParams_OperationMode) String 

func (x OperationParams_OperationMode) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.