protocol

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_volcengine_common_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Date 

type Date struct {

	// Year of the date. Must be from 1 to 9999, or 0 to specify a date without
	// a year.
	Year int32 `protobuf:"varint,1,opt,name=year,proto3" json:"year,omitempty"`
	// Month of a year. Must be from 1 to 12, or 0 to specify a year without a
	// month and day.
	Month int32 `protobuf:"varint,2,opt,name=month,proto3" json:"month,omitempty"`
	// Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
	// to specify a year by itself or a year and month where the day isn't
	// significant.
	Day int32 `protobuf:"varint,3,opt,name=day,proto3" json:"day,omitempty"`
	// contains filtered or unexported fields
}

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

* A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date

func (*Date) Descriptor deprecated 

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

Deprecated: Use Date.ProtoReflect.Descriptor instead.

func (*Date) GetDay 

func (x *Date) GetDay() int32

func (*Date) GetMonth 

func (x *Date) GetMonth() int32

func (*Date) GetYear 

func (x *Date) GetYear() int32

func (*Date) ProtoMessage 

func (*Date) ProtoMessage()

func (*Date) ProtoReflect 

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

func (*Date) Reset 

func (x *Date) Reset()

func (*Date) String 

func (x *Date) String() string

type DoneRequest 

type DoneRequest struct {

	// The target data date list
	DataDates []*Date `protobuf:"bytes,1,rep,name=data_dates,json=dataDates,proto3" json:"data_dates,omitempty"`
	// contains filtered or unexported fields
}

the request for Done, contains a date list

func (*DoneRequest) Descriptor deprecated 

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

Deprecated: Use DoneRequest.ProtoReflect.Descriptor instead.

func (*DoneRequest) GetDataDates 

func (x *DoneRequest) GetDataDates() []*Date

func (*DoneRequest) ProtoMessage 

func (*DoneRequest) ProtoMessage()

func (*DoneRequest) ProtoReflect 

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

func (*DoneRequest) Reset 

func (x *DoneRequest) Reset()

func (*DoneRequest) String 

func (x *DoneRequest) String() string

type DoneResponse 

type DoneResponse struct {

	// 本次请求结果（与异步任务执行情况无关），status.code为0代表请求成功
	Status *Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DoneResponse) Descriptor deprecated 

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

Deprecated: Use DoneResponse.ProtoReflect.Descriptor instead.

func (*DoneResponse) GetStatus 

func (x *DoneResponse) GetStatus() *Status

func (*DoneResponse) ProtoMessage 

func (*DoneResponse) ProtoMessage()

func (*DoneResponse) ProtoReflect 

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

func (*DoneResponse) Reset 

func (x *DoneResponse) Reset()

func (*DoneResponse) String 

func (x *DoneResponse) String() string

type GetOperationRequest 

type GetOperationRequest struct {

	// Required.
	// The name of the operation.
	// This field is returned by all the long running calls.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for `GetOperation`.

func (*GetOperationRequest) Descriptor deprecated 

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

Deprecated: Use GetOperationRequest.ProtoReflect.Descriptor instead.

func (*GetOperationRequest) GetName 

func (x *GetOperationRequest) GetName() 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 ListOperationsRequest 

type ListOperationsRequest struct {

	// Optional. An expression for filtering the results of the request.
	// Composite filters should be provided with ['and']
	//
	//   * `date` supports ['=' '!=' '>' '<' '>=' '<=']. Please refer to
	//   `DateConfig.date` for the format.
	//   * `worksOn` supports ['=' '!='].
	//   The acceptable values are "ImportUsers", "ImportProducts",
	//   "ImportUserEvents".
	//   * `done` supports ['=' '!=']. The operation has finished running or not
	//
	// Some single filter examples:
	//   * `date=2021-05-02`，`date>=2021-05-02`
	//   * `worksOn=ImportUsers`
	//   * `done=true`、`done=false`
	//
	// A composite filter examples:
	//   * `date=2021-05-02 and worksOn=ImportUsers and done=true`
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional, default 20
	// The standard list page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional
	// 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 ListOperations

func (*ListOperationsRequest) Descriptor deprecated 

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

Deprecated: Use ListOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListOperationsRequest) GetFilter 

func (x *ListOperationsRequest) GetFilter() string

func (*ListOperationsRequest) GetPageSize 

func (x *ListOperationsRequest) GetPageSize() int32

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 {

	// Output only.
	// The status of this response.
	// `operations` is only populated if `status.code` is 0
	Status *Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// A list of operations that matches the specified filter in the request.
	Operations []*Operation `protobuf:"bytes,2,rep,name=operations,proto3" json:"operations,omitempty"`
	// The standard List next-page token.
	NextPageToken string `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response message for ListOperations.

func (*ListOperationsResponse) Descriptor deprecated 

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

Deprecated: Use ListOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListOperationsResponse) GetNextPageToken 

func (x *ListOperationsResponse) GetNextPageToken() string

func (*ListOperationsResponse) GetOperations 

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

func (*ListOperationsResponse) GetStatus 

func (x *ListOperationsResponse) GetStatus() *Status

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 Metadata 

type Metadata struct {

	// Output only.
	// The date of entries, please refer to `DateConfig.date`
	Date string `protobuf:"bytes,1,opt,name=date,proto3" json:"date,omitempty"`
	// Output only.
	// The total number of entries.
	// This should be equal to `failure_count` + `success_count` finally.
	TotalCount int64 `protobuf:"varint,2,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// Output only.
	// The count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Output only.
	// The count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// Output only.
	// The time when the task is submitted.
	// It's formatted according to 'rcf3339'
	SubmitTime string `protobuf:"bytes,5,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
	// Output only.
	// Operation last update time.
	// If the operation is done, this is also the finish time.
	// It's formatted according to 'rcf3339'
	UpdateTime string `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the Import operation. This will be returned by the Operation.metadata field.

func (*Metadata) Descriptor deprecated 

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

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetDate 

func (x *Metadata) GetDate() string

func (*Metadata) GetFailureCount 

func (x *Metadata) GetFailureCount() int64

func (*Metadata) GetSubmitTime 

func (x *Metadata) GetSubmitTime() string

func (*Metadata) GetSuccessCount 

func (x *Metadata) GetSuccessCount() int64

func (*Metadata) GetTotalCount 

func (x *Metadata) GetTotalCount() int64

func (*Metadata) GetUpdateTime 

func (x *Metadata) GetUpdateTime() string

func (*Metadata) ProtoMessage 

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect 

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

func (*Metadata) Reset 

func (x *Metadata) Reset()

func (*Metadata) String 

func (x *Metadata) String() string

type Operation 

type Operation struct {

	// Output only.
	// The server-assigned name, which is only unique within the same service
	// that originally returns it.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only.
	// Service-specific metadata associated with the operation.
	Metadata *Metadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Output only.
	// If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, response is populated.
	Done bool `protobuf:"varint,3,opt,name=done,proto3" json:"done,omitempty"`
	// Output only.
	// The operation result of one of the XXXResponse.
	// If `done` == `false`,  `response` is not set.
	// If `done` == `true`, `response` is set.
	Response *anypb.Any `protobuf:"bytes,4,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Operation) Descriptor deprecated 

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

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetDone 

func (x *Operation) GetDone() bool

func (*Operation) GetMetadata 

func (x *Operation) GetMetadata() *Metadata

func (*Operation) GetName 

func (x *Operation) GetName() string

func (*Operation) GetResponse 

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

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 OperationResponse 

type OperationResponse struct {

	// Output only.
	// The status of the call to fetch the operation.
	// Note: This status is unrelated to the actual long running call.
	Status *Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// The operation itself.
	Operation *Operation `protobuf:"bytes,2,opt,name=operation,proto3" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

The response for the operation itself.

func (*OperationResponse) Descriptor deprecated 

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

Deprecated: Use OperationResponse.ProtoReflect.Descriptor instead.

func (*OperationResponse) GetOperation 

func (x *OperationResponse) GetOperation() *Operation

func (*OperationResponse) GetStatus 

func (x *OperationResponse) GetStatus() *Status

func (*OperationResponse) ProtoMessage 

func (*OperationResponse) ProtoMessage()

func (*OperationResponse) ProtoReflect 

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

func (*OperationResponse) Reset 

func (x *OperationResponse) Reset()

func (*OperationResponse) String 

func (x *OperationResponse) String() string

type Status 

type Status struct {

	// Output only.
	// The error code. Callers should expect this field for all
	// responses.
	// Here is the table for the possible codes.
	// 0   : The request is successfully returned. Other values indicates errors.
	// xxx : The 3-digit error codes align with standard http error codes, e.g.
	//       4xx indicates user error while 5xx indicates server error.
	// 1xxx: The errors related to Import calls.
	// 2xxx: The errors related to Predict calls.
	// Please refer to [this](../docs/error-code) for more details.
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// Output only. Detailed error message.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// success mark
	Success bool `protobuf:"varint,3,opt,name=success,proto3" json:"success,omitempty"`
	// contains filtered or unexported fields
}

The `Status` type defines a logical error model, Each `Status` message contains 2 pieces of data: error code, error message. / Chinese version. /

func (*Status) Descriptor deprecated 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode 

func (x *Status) GetCode() int32

func (*Status) GetMessage 

func (x *Status) GetMessage() string

func (*Status) GetSuccess 

func (x *Status) GetSuccess() bool

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

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

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

func (x *Status) 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.