types

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

• type Annotations
  • func (*Annotations) Descriptor() ([]byte, []int)
  • func (m *Annotations) GetIndices() []*IndexEntry
  • func (m *Annotations) GetLabels() map[string]string
  • func (m *Annotations) GetName() string
  • func (*Annotations) ProtoMessage()
  • func (m *Annotations) Reset()
  • func (m *Annotations) String() string
• type Driver
  • func (*Driver) Descriptor() ([]byte, []int)
  • func (m *Driver) GetName() string
  • func (m *Driver) GetOptions() map[string]string
  • func (*Driver) ProtoMessage()
  • func (m *Driver) Reset()
  • func (m *Driver) String() string
• type IndexEntry
  • func (*IndexEntry) Descriptor() ([]byte, []int)
  • func (m *IndexEntry) GetKey() string
  • func (m *IndexEntry) GetVal() string
  • func (*IndexEntry) ProtoMessage()
  • func (m *IndexEntry) Reset()
  • func (m *IndexEntry) String() string
• type Meta
  • func (*Meta) Descriptor() ([]byte, []int)
  • func (m *Meta) GetCreatedAt() *google_protobuf.Timestamp
  • func (m *Meta) GetUpdatedAt() *google_protobuf.Timestamp
  • func (m *Meta) GetVersion() *Version
  • func (*Meta) ProtoMessage()
  • func (m *Meta) Reset()
  • func (m *Meta) String() string
• type Version
  • func (*Version) Descriptor() ([]byte, []int)
  • func (m *Version) GetIndex() uint64
  • func (*Version) ProtoMessage()
  • func (m *Version) Reset()
  • func (m *Version) String() string

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) Descriptor() ([]byte, []int)

func (*Driver) GetName

func (m *Driver) GetName() string

func (*Driver) GetOptions

func (m *Driver) GetOptions() map[string]string

func (*Driver) ProtoMessage

func (*Driver) ProtoMessage()

func (*Driver) Reset

func (m *Driver) Reset()

func (*Driver) String

func (m *Driver) String() string

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) Descriptor() ([]byte, []int)

func (*Meta) GetCreatedAt

func (m *Meta) GetCreatedAt() *google_protobuf.Timestamp

func (*Meta) GetUpdatedAt

func (m *Meta) GetUpdatedAt() *google_protobuf.Timestamp

func (*Meta) GetVersion

func (m *Meta) GetVersion() *Version

func (*Meta) ProtoMessage

func (*Meta) ProtoMessage()

func (*Meta) Reset

func (m *Meta) Reset()

func (*Meta) String

func (m *Meta) String() string

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) Descriptor() ([]byte, []int)

func (*Version) GetIndex

func (m *Version) GetIndex() uint64

func (*Version) ProtoMessage

func (*Version) ProtoMessage()

func (*Version) Reset

func (m *Version) Reset()

func (*Version) String

func (m *Version) String() string