Documentation
¶
Overview ¶
Package types is a generated protocol buffer package.
It is generated from these files:
github.com/appcelerator/amp/api/rpc/types/types.proto
It has these top-level messages:
Version IndexEntry Annotations Driver Meta
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Annotations ¶
type Annotations struct {
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
Labels map[string]string `` /* 132-byte string literal not displayed */
// Indices provides keys and values for indexing this object.
// A single key may have multiple values.
Indices []*IndexEntry `protobuf:"bytes,4,rep,name=indices" json:"indices,omitempty"`
}
Annotations provide useful information to identify API objects. They are common to all API specs.
func (*Annotations) Descriptor ¶
func (*Annotations) Descriptor() ([]byte, []int)
func (*Annotations) GetIndices ¶
func (m *Annotations) GetIndices() []*IndexEntry
func (*Annotations) GetLabels ¶
func (m *Annotations) GetLabels() map[string]string
func (*Annotations) GetName ¶
func (m *Annotations) GetName() string
func (*Annotations) ProtoMessage ¶
func (*Annotations) ProtoMessage()
func (*Annotations) Reset ¶
func (m *Annotations) Reset()
func (*Annotations) String ¶
func (m *Annotations) String() string
type Driver ¶
type Driver struct {
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
Options map[string]string `` /* 134-byte string literal not displayed */
}
Driver is a generic driver type to be used throughout the API. For now, a driver is simply a name and set of options. The field contents depend on the target use case and driver application. For example, a network driver may have different rules than a volume driver.
func (*Driver) Descriptor ¶
func (*Driver) GetOptions ¶
func (*Driver) ProtoMessage ¶
func (*Driver) ProtoMessage()
type IndexEntry ¶
type IndexEntry struct {
Key string `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"`
Val string `protobuf:"bytes,2,opt,name=val" json:"val,omitempty"`
}
func (*IndexEntry) Descriptor ¶
func (*IndexEntry) Descriptor() ([]byte, []int)
func (*IndexEntry) GetKey ¶
func (m *IndexEntry) GetKey() string
func (*IndexEntry) GetVal ¶
func (m *IndexEntry) GetVal() string
func (*IndexEntry) ProtoMessage ¶
func (*IndexEntry) ProtoMessage()
func (*IndexEntry) Reset ¶
func (m *IndexEntry) Reset()
func (*IndexEntry) String ¶
func (m *IndexEntry) String() string
type Meta ¶
type Meta struct {
// Version tracks the current version of the object.
Version *Version `protobuf:"bytes,1,opt,name=version" json:"version,omitempty"`
// Object timestamps.
// Note: can't use stdtime because these fields are nullable.
CreatedAt *google_protobuf.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt" json:"created_at,omitempty"`
UpdatedAt *google_protobuf.Timestamp `protobuf:"bytes,3,opt,name=updated_at,json=updatedAt" json:"updated_at,omitempty"`
}
Meta contains metadata about objects. Every object contains a meta field. from: api/objects.proto
func (*Meta) Descriptor ¶
func (*Meta) GetCreatedAt ¶
func (m *Meta) GetCreatedAt() *google_protobuf.Timestamp
func (*Meta) GetUpdatedAt ¶
func (m *Meta) GetUpdatedAt() *google_protobuf.Timestamp
func (*Meta) GetVersion ¶
func (*Meta) ProtoMessage ¶
func (*Meta) ProtoMessage()
type Version ¶
type Version struct {
Index uint64 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
}
Version tracks the last time an object in the store was updated.
func (*Version) Descriptor ¶
func (*Version) ProtoMessage ¶
func (*Version) ProtoMessage()