api

Documentation

Index

• Variables
• type Operation
  • func (*Operation) Descriptor() ([]byte, []int)
  • func (x *Operation) GetDone() bool
  • func (x *Operation) GetError() *status.Status
  • func (x *Operation) GetMetadata() *anypb.Any
  • func (x *Operation) GetName() string
  • func (x *Operation) GetResponse() *anypb.Any
  • func (m *Operation) GetResult() isOperation_Result
  • func (*Operation) ProtoMessage()
  • func (x *Operation) ProtoReflect() protoreflect.Message
  • func (x *Operation) Reset()
  • func (x *Operation) String() string
• type Operation_Error
• type Operation_Response
• type User
  • func (*User) Descriptor() ([]byte, []int)
  • func (x *User) GetMetadata() map[string]string
  • func (x *User) GetName() string
  • func (x *User) GetParent() string
  • func (*User) ProtoMessage()
  • func (x *User) ProtoReflect() protoreflect.Message
  • func (x *User) Reset()
  • func (x *User) String() string

Variables

var File_api_operation_proto protoreflect.FileDescriptor

var File_api_user_proto protoreflect.FileDescriptor

Types

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

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

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetDone

func (x *Operation) GetDone() bool

func (*Operation) GetError

func (x *Operation) GetError() *status.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) 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 Operation_Error

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

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"`
}

type User

type User struct {

	// User's unique name (or id).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The user's parent. If empty or non-existent, it means this user is a root user;
	// otherwise, it's a subuser.
	Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
	// The attributes (key/value pair) of the user. If hierarchy is supported, it will be
	// separated by '/', such as 'key/subkey=value'. See https://alphauslabs.github.io/blueapi/
	// for the list of supported attributes.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*User) Descriptor

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetMetadata

func (x *User) GetMetadata() map[string]string

func (*User) GetName

func (x *User) GetName() string

func (*User) GetParent

func (x *User) GetParent() string

func (*User) ProtoMessage

func (*User) ProtoMessage()

func (*User) ProtoReflect

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

func (*User) Reset

func (x *User) Reset()

func (*User) String

func (x *User) String() string