types

package
v1.2.2-0...-5031d1e Latest Latest
Warning

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

 Go to latest Published: Jun 28, 2019 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package types contains code for interacting with well-known types.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthAny = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowAny   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthApi = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowApi   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthDuration = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowDuration   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthEmpty = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowEmpty   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthFieldMask = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowFieldMask   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthSourceContext = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowSourceContext   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthStruct = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowStruct   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthTimestamp = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTimestamp   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthType = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowType   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthWrappers = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowWrappers   = fmt.Errorf("proto: integer overflow")
)
View Source 
var Field_Cardinality_name = map[int32]string{
	0: "CARDINALITY_UNKNOWN",
	1: "CARDINALITY_OPTIONAL",
	2: "CARDINALITY_REQUIRED",
	3: "CARDINALITY_REPEATED",
}
View Source 
var Field_Cardinality_value = map[string]int32{
	"CARDINALITY_UNKNOWN":  0,
	"CARDINALITY_OPTIONAL": 1,
	"CARDINALITY_REQUIRED": 2,
	"CARDINALITY_REPEATED": 3,
}
View Source 
var Field_Kind_name = map[int32]string{
	0:  "TYPE_UNKNOWN",
	1:  "TYPE_DOUBLE",
	2:  "TYPE_FLOAT",
	3:  "TYPE_INT64",
	4:  "TYPE_UINT64",
	5:  "TYPE_INT32",
	6:  "TYPE_FIXED64",
	7:  "TYPE_FIXED32",
	8:  "TYPE_BOOL",
	9:  "TYPE_STRING",
	10: "TYPE_GROUP",
	11: "TYPE_MESSAGE",
	12: "TYPE_BYTES",
	13: "TYPE_UINT32",
	14: "TYPE_ENUM",
	15: "TYPE_SFIXED32",
	16: "TYPE_SFIXED64",
	17: "TYPE_SINT32",
	18: "TYPE_SINT64",
}
View Source 
var Field_Kind_value = map[string]int32{
	"TYPE_UNKNOWN":  0,
	"TYPE_DOUBLE":   1,
	"TYPE_FLOAT":    2,
	"TYPE_INT64":    3,
	"TYPE_UINT64":   4,
	"TYPE_INT32":    5,
	"TYPE_FIXED64":  6,
	"TYPE_FIXED32":  7,
	"TYPE_BOOL":     8,
	"TYPE_STRING":   9,
	"TYPE_GROUP":    10,
	"TYPE_MESSAGE":  11,
	"TYPE_BYTES":    12,
	"TYPE_UINT32":   13,
	"TYPE_ENUM":     14,
	"TYPE_SFIXED32": 15,
	"TYPE_SFIXED64": 16,
	"TYPE_SINT32":   17,
	"TYPE_SINT64":   18,
}
View Source 
var NullValue_name = map[int32]string{
	0: "NULL_VALUE",
}
View Source 
var NullValue_value = map[string]int32{
	"NULL_VALUE": 0,
}
View Source 
var Syntax_name = map[int32]string{
	0: "SYNTAX_PROTO2",
	1: "SYNTAX_PROTO3",
}
View Source 
var Syntax_value = map[string]int32{
	"SYNTAX_PROTO2": 0,
	"SYNTAX_PROTO3": 1,
}

Functions

func AnyMessageName 

func AnyMessageName(any *Any) (string, error)

AnyMessageName returns the name of the message contained in a google.protobuf.Any message.

Note that regular type assertions should be done using the Is function. AnyMessageName is provided for less common use cases like filtering a sequence of Any messages based on a set of allowed message type names.

func DurationFromProto 

func DurationFromProto(p *Duration) (time.Duration, error)

DurationFromProto converts a Duration to a time.Duration. DurationFromProto returns an error if the Duration is invalid or is too large to be represented in a time.Duration.

func EmptyAny 

func EmptyAny(any *Any) (proto.Message, error)

Empty returns a new proto.Message of the type specified in a google.protobuf.Any message. It returns an error if corresponding message type isn't linked in.

func Is 

func Is(any *Any, pb proto.Message) bool

Is returns true if any value contains a given message type.

func NewPopulatedStdBool 

func NewPopulatedStdBool(r randyWrappers, easy bool) *bool

func NewPopulatedStdBytes 

func NewPopulatedStdBytes(r randyWrappers, easy bool) *[]byte

func NewPopulatedStdDouble 

func NewPopulatedStdDouble(r randyWrappers, easy bool) *float64

func NewPopulatedStdDuration 

func NewPopulatedStdDuration(r interface {
	Int63() int64
}, easy bool) *time.Duration

func NewPopulatedStdFloat 

func NewPopulatedStdFloat(r randyWrappers, easy bool) *float32

func NewPopulatedStdInt32 

func NewPopulatedStdInt32(r randyWrappers, easy bool) *int32

func NewPopulatedStdInt64 

func NewPopulatedStdInt64(r randyWrappers, easy bool) *int64

func NewPopulatedStdString 

func NewPopulatedStdString(r randyWrappers, easy bool) *string

func NewPopulatedStdTime 

func NewPopulatedStdTime(r interface {
	Int63() int64
}, easy bool) *time.Time

func NewPopulatedStdUInt32 

func NewPopulatedStdUInt32(r randyWrappers, easy bool) *uint32

func NewPopulatedStdUInt64 

func NewPopulatedStdUInt64(r randyWrappers, easy bool) *uint64

func SizeOfStdBool 

func SizeOfStdBool(v bool) int

func SizeOfStdBytes 

func SizeOfStdBytes(v []byte) int

func SizeOfStdDouble 

func SizeOfStdDouble(v float64) int

func SizeOfStdDuration 

func SizeOfStdDuration(d time.Duration) int

func SizeOfStdFloat 

func SizeOfStdFloat(v float32) int

func SizeOfStdInt32 

func SizeOfStdInt32(v int32) int

func SizeOfStdInt64 

func SizeOfStdInt64(v int64) int

func SizeOfStdString 

func SizeOfStdString(v string) int

func SizeOfStdTime 

func SizeOfStdTime(t time.Time) int

func SizeOfStdUInt32 

func SizeOfStdUInt32(v uint32) int

func SizeOfStdUInt64 

func SizeOfStdUInt64(v uint64) int

func StdBoolMarshal 

func StdBoolMarshal(v bool) ([]byte, error)

func StdBoolMarshalTo 

func StdBoolMarshalTo(v bool, data []byte) (int, error)

func StdBoolUnmarshal 

func StdBoolUnmarshal(v *bool, data []byte) error

func StdBytesMarshal 

func StdBytesMarshal(v []byte) ([]byte, error)

func StdBytesMarshalTo 

func StdBytesMarshalTo(v []byte, data []byte) (int, error)

func StdBytesUnmarshal 

func StdBytesUnmarshal(v *[]byte, data []byte) error

func StdDoubleMarshal 

func StdDoubleMarshal(v float64) ([]byte, error)

func StdDoubleMarshalTo 

func StdDoubleMarshalTo(v float64, data []byte) (int, error)

func StdDoubleUnmarshal 

func StdDoubleUnmarshal(v *float64, data []byte) error

func StdDurationMarshal 

func StdDurationMarshal(d time.Duration) ([]byte, error)

func StdDurationMarshalTo 

func StdDurationMarshalTo(d time.Duration, data []byte) (int, error)

func StdDurationUnmarshal 

func StdDurationUnmarshal(d *time.Duration, data []byte) error

func StdFloatMarshal 

func StdFloatMarshal(v float32) ([]byte, error)

func StdFloatMarshalTo 

func StdFloatMarshalTo(v float32, data []byte) (int, error)

func StdFloatUnmarshal 

func StdFloatUnmarshal(v *float32, data []byte) error

func StdInt32Marshal 

func StdInt32Marshal(v int32) ([]byte, error)

func StdInt32MarshalTo 

func StdInt32MarshalTo(v int32, data []byte) (int, error)

func StdInt32Unmarshal 

func StdInt32Unmarshal(v *int32, data []byte) error

func StdInt64Marshal 

func StdInt64Marshal(v int64) ([]byte, error)

func StdInt64MarshalTo 

func StdInt64MarshalTo(v int64, data []byte) (int, error)

func StdInt64Unmarshal 

func StdInt64Unmarshal(v *int64, data []byte) error

func StdStringMarshal 

func StdStringMarshal(v string) ([]byte, error)

func StdStringMarshalTo 

func StdStringMarshalTo(v string, data []byte) (int, error)

func StdStringUnmarshal 

func StdStringUnmarshal(v *string, data []byte) error

func StdTimeMarshal 

func StdTimeMarshal(t time.Time) ([]byte, error)

func StdTimeMarshalTo 

func StdTimeMarshalTo(t time.Time, data []byte) (int, error)

func StdTimeUnmarshal 

func StdTimeUnmarshal(t *time.Time, data []byte) error

func StdUInt32Marshal 

func StdUInt32Marshal(v uint32) ([]byte, error)

func StdUInt32MarshalTo 

func StdUInt32MarshalTo(v uint32, data []byte) (int, error)

func StdUInt32Unmarshal 

func StdUInt32Unmarshal(v *uint32, data []byte) error

func StdUInt64Marshal 

func StdUInt64Marshal(v uint64) ([]byte, error)

func StdUInt64MarshalTo 

func StdUInt64MarshalTo(v uint64, data []byte) (int, error)

func StdUInt64Unmarshal 

func StdUInt64Unmarshal(v *uint64, data []byte) error

func TimestampFromProto 

func TimestampFromProto(ts *Timestamp) (time.Time, error)

TimestampFromProto converts a google.protobuf.Timestamp proto to a time.Time. It returns an error if the argument is invalid.

Unlike most Go functions, if Timestamp returns an error, the first return value is not the zero time.Time. Instead, it is the value obtained from the time.Unix function when passed the contents of the Timestamp, in the UTC locale. This may or may not be a meaningful time; many invalid Timestamps do map to valid time.Times.

A nil Timestamp returns an error. The first return value in that case is undefined.

func TimestampString 

func TimestampString(ts *Timestamp) string

TimestampString returns the RFC 3339 string for valid Timestamps. For invalid Timestamps, it returns an error message in parentheses.

func UnmarshalAny 

func UnmarshalAny(any *Any, pb proto.Message) error

UnmarshalAny parses the protocol buffer representation in a google.protobuf.Any message and places the decoded result in pb. It returns an error if type of contents of Any message does not match type of pb message.

pb can be a proto.Message, or a *DynamicAny.

Types

type Any 

type Any struct {
	// A URL/resource name that uniquely identifies the type of the serialized
	// protocol buffer message. This string must contain at least
	// one "/" character. The last segment of the URL's path must represent
	// the fully qualified name of the type (as in
	// `path/google.protobuf.Duration`). The name should be in a canonical form
	// (e.g., leading "." is not accepted).
	//
	// In practice, teams usually precompile into the binary all types that they
	// expect it to use in the context of Any. However, for URLs which use the
	// scheme `http`, `https`, or no scheme, one can optionally set up a type
	// server that maps type URLs to message definitions as follows:
	//
	// * If no scheme is provided, `https` is assumed.
	// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
	//   value in binary format, or produce an error.
	// * Applications are allowed to cache lookup results based on the
	//   URL, or have them precompiled into a binary to avoid any
	//   lookup. Therefore, binary compatibility needs to be preserved
	//   on changes to types. (Use versioned type names to manage
	//   breaking changes.)
	//
	// Note: this functionality is not currently available in the official
	// protobuf release, and it is not used for type URLs beginning with
	// type.googleapis.com.
	//
	// Schemes other than `http`, `https` (or the empty scheme) might be
	// used with implementation specific semantics.
	//
	TypeUrl string `protobuf:"bytes,1,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// Must be a valid serialized protocol buffer of the above specified type.
	Value                []byte   `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

   Foo foo = ...;
   Any any = Any.pack(foo);
   ...
   if (any.is(Foo.class)) {
     foo = any.unpack(Foo.class);
   }

Example 3: Pack and unpack a message in Python.

   foo = Foo(...)
   any = Any()
   any.Pack(foo)
   ...
   if any.Is(Foo.DESCRIPTOR):
     any.Unpack(foo)
     ...

Example 4: Pack and unpack a message in Go

    foo := &pb.Foo{...}
    any, err := ptypes.MarshalAny(foo)
    ...
    foo := &pb.Foo{}
    if err := ptypes.UnmarshalAny(any, foo); err != nil {
      ...
    }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

func MarshalAny 

func MarshalAny(pb proto.Message) (*Any, error)

MarshalAny takes the protocol buffer and encodes it into google.protobuf.Any.

func NewPopulatedAny 

func NewPopulatedAny(r randyAny, easy bool) *Any

func (*Any) Compare 

func (this *Any) Compare(that interface{}) int

func (*Any) Descriptor 

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

func (*Any) Equal 

func (this *Any) Equal(that interface{}) bool

func (*Any) GetTypeUrl 

func (m *Any) GetTypeUrl() string

func (*Any) GetValue 

func (m *Any) GetValue() []byte

func (*Any) GoString 

func (this *Any) GoString() string

func (*Any) Marshal 

func (m *Any) Marshal() (dAtA []byte, err error)

func (*Any) MarshalTo 

func (m *Any) MarshalTo(dAtA []byte) (int, error)

func (*Any) ProtoMessage 

func (*Any) ProtoMessage()

func (*Any) ProtoSize 

func (m *Any) ProtoSize() (n int)

func (*Any) Reset 

func (m *Any) Reset()

func (*Any) Size 

func (m *Any) Size() (n int)

func (*Any) String 

func (this *Any) String() string

func (*Any) Unmarshal 

func (m *Any) Unmarshal(dAtA []byte) error

func (*Any) XXX_DiscardUnknown 

func (m *Any) XXX_DiscardUnknown()

func (*Any) XXX_Marshal 

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

func (*Any) XXX_Merge 

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

func (*Any) XXX_MessageName 

func (*Any) XXX_MessageName() string

func (*Any) XXX_Size 

func (m *Any) XXX_Size() int

func (*Any) XXX_Unmarshal 

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

func (*Any) XXX_WellKnownType 

func (*Any) XXX_WellKnownType() string

type Api 

type Api struct {
	// The fully qualified name of this interface, including package name
	// followed by the interface's simple name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The methods of this interface, in unspecified order.
	Methods []*Method `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"`
	// Any metadata attached to the interface.
	Options []*Option `protobuf:"bytes,3,rep,name=options,proto3" json:"options,omitempty"`
	// A version string for this interface. If specified, must have the form
	// `major-version.minor-version`, as in `1.10`. If the minor version is
	// omitted, it defaults to zero. If the entire version field is empty, the
	// major version is derived from the package name, as outlined below. If the
	// field is not empty, the version in the package name will be verified to be
	// consistent with what is provided here.
	//
	// The versioning schema uses [semantic
	// versioning](http://semver.org) where the major version number
	// indicates a breaking change and the minor version an additive,
	// non-breaking change. Both version numbers are signals to users
	// what to expect from different versions, and should be carefully
	// chosen based on the product plan.
	//
	// The major version is also reflected in the package name of the
	// interface, which must end in `v<major-version>`, as in
	// `google.feature.v1`. For major versions 0 and 1, the suffix can
	// be omitted. Zero major versions must only be used for
	// experimental, non-GA interfaces.
	//
	//
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Source context for the protocol buffer service represented by this
	// message.
	SourceContext *SourceContext `protobuf:"bytes,5,opt,name=source_context,json=sourceContext,proto3" json:"source_context,omitempty"`
	// Included interfaces. See [Mixin][].
	Mixins []*Mixin `protobuf:"bytes,6,rep,name=mixins,proto3" json:"mixins,omitempty"`
	// The source syntax of the service.
	Syntax               Syntax   `protobuf:"varint,7,opt,name=syntax,proto3,enum=google.protobuf.Syntax" json:"syntax,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

func NewPopulatedApi 

func NewPopulatedApi(r randyApi, easy bool) *Api

func (*Api) Compare 

func (this *Api) Compare(that interface{}) int

func (*Api) Descriptor 

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

func (*Api) Equal 

func (this *Api) Equal(that interface{}) bool

func (*Api) GetMethods 

func (m *Api) GetMethods() []*Method

func (*Api) GetMixins 

func (m *Api) GetMixins() []*Mixin

func (*Api) GetName 

func (m *Api) GetName() string

func (*Api) GetOptions 

func (m *Api) GetOptions() []*Option

func (*Api) GetSourceContext 

func (m *Api) GetSourceContext() *SourceContext

func (*Api) GetSyntax 

func (m *Api) GetSyntax() Syntax

func (*Api) GetVersion 

func (m *Api) GetVersion() string

func (*Api) GoString 

func (this *Api) GoString() string

func (*Api) Marshal 

func (m *Api) Marshal() (dAtA []byte, err error)

func (*Api) MarshalTo 

func (m *Api) MarshalTo(dAtA []byte) (int, error)

func (*Api) ProtoMessage 

func (*Api) ProtoMessage()

func (*Api) ProtoSize 

func (m *Api) ProtoSize() (n int)

func (*Api) Reset 

func (m *Api) Reset()

func (*Api) Size 

func (m *Api) Size() (n int)

func (*Api) String 

func (this *Api) String() string

func (*Api) Unmarshal 

func (m *Api) Unmarshal(dAtA []byte) error

func (*Api) XXX_DiscardUnknown 

func (m *Api) XXX_DiscardUnknown()

func (*Api) XXX_Marshal 

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

func (*Api) XXX_Merge 

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

func (*Api) XXX_MessageName 

func (*Api) XXX_MessageName() string

func (*Api) XXX_Size 

func (m *Api) XXX_Size() int

func (*Api) XXX_Unmarshal 

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

type BoolValue 

type BoolValue struct {
	// The bool value.
	Value                bool     `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `bool`.

The JSON representation for `BoolValue` is JSON `true` and `false`.

func NewPopulatedBoolValue 

func NewPopulatedBoolValue(r randyWrappers, easy bool) *BoolValue

func (*BoolValue) Compare 

func (this *BoolValue) Compare(that interface{}) int

func (*BoolValue) Descriptor 

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

func (*BoolValue) Equal 

func (this *BoolValue) Equal(that interface{}) bool

func (*BoolValue) GetValue 

func (m *BoolValue) GetValue() bool

func (*BoolValue) GoString 

func (this *BoolValue) GoString() string

func (*BoolValue) Marshal 

func (m *BoolValue) Marshal() (dAtA []byte, err error)

func (*BoolValue) MarshalTo 

func (m *BoolValue) MarshalTo(dAtA []byte) (int, error)

func (*BoolValue) ProtoMessage 

func (*BoolValue) ProtoMessage()

func (*BoolValue) ProtoSize 

func (m *BoolValue) ProtoSize() (n int)

func (*BoolValue) Reset 

func (m *BoolValue) Reset()

func (*BoolValue) Size 

func (m *BoolValue) Size() (n int)

func (*BoolValue) String 

func (this *BoolValue) String() string

func (*BoolValue) Unmarshal 

func (m *BoolValue) Unmarshal(dAtA []byte) error

func (*BoolValue) XXX_DiscardUnknown 

func (m *BoolValue) XXX_DiscardUnknown()

func (*BoolValue) XXX_Marshal 

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

func (*BoolValue) XXX_Merge 

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

func (*BoolValue) XXX_MessageName 

func (*BoolValue) XXX_MessageName() string

func (*BoolValue) XXX_Size 

func (m *BoolValue) XXX_Size() int

func (*BoolValue) XXX_Unmarshal 

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

func (*BoolValue) XXX_WellKnownType 

func (*BoolValue) XXX_WellKnownType() string

type BytesValue 

type BytesValue struct {
	// The bytes value.
	Value                []byte   `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `bytes`.

The JSON representation for `BytesValue` is JSON string.

func NewPopulatedBytesValue 

func NewPopulatedBytesValue(r randyWrappers, easy bool) *BytesValue

func (*BytesValue) Compare 

func (this *BytesValue) Compare(that interface{}) int

func (*BytesValue) Descriptor 

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

func (*BytesValue) Equal 

func (this *BytesValue) Equal(that interface{}) bool

func (*BytesValue) GetValue 

func (m *BytesValue) GetValue() []byte

func (*BytesValue) GoString 

func (this *BytesValue) GoString() string

func (*BytesValue) Marshal 

func (m *BytesValue) Marshal() (dAtA []byte, err error)

func (*BytesValue) MarshalTo 

func (m *BytesValue) MarshalTo(dAtA []byte) (int, error)

func (*BytesValue) ProtoMessage 

func (*BytesValue) ProtoMessage()

func (*BytesValue) ProtoSize 

func (m *BytesValue) ProtoSize() (n int)

func (*BytesValue) Reset 

func (m *BytesValue) Reset()

func (*BytesValue) Size 

func (m *BytesValue) Size() (n int)

func (*BytesValue) String 

func (this *BytesValue) String() string

func (*BytesValue) Unmarshal 

func (m *BytesValue) Unmarshal(dAtA []byte) error

func (*BytesValue) XXX_DiscardUnknown 

func (m *BytesValue) XXX_DiscardUnknown()

func (*BytesValue) XXX_Marshal 

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

func (*BytesValue) XXX_Merge 

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

func (*BytesValue) XXX_MessageName 

func (*BytesValue) XXX_MessageName() string

func (*BytesValue) XXX_Size 

func (m *BytesValue) XXX_Size() int

func (*BytesValue) XXX_Unmarshal 

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

func (*BytesValue) XXX_WellKnownType 

func (*BytesValue) XXX_WellKnownType() string

type DoubleValue 

type DoubleValue struct {
	// The double value.
	Value                float64  `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `double`.

The JSON representation for `DoubleValue` is JSON number.

func NewPopulatedDoubleValue 

func NewPopulatedDoubleValue(r randyWrappers, easy bool) *DoubleValue

func (*DoubleValue) Compare 

func (this *DoubleValue) Compare(that interface{}) int

func (*DoubleValue) Descriptor 

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

func (*DoubleValue) Equal 

func (this *DoubleValue) Equal(that interface{}) bool

func (*DoubleValue) GetValue 

func (m *DoubleValue) GetValue() float64

func (*DoubleValue) GoString 

func (this *DoubleValue) GoString() string

func (*DoubleValue) Marshal 

func (m *DoubleValue) Marshal() (dAtA []byte, err error)

func (*DoubleValue) MarshalTo 

func (m *DoubleValue) MarshalTo(dAtA []byte) (int, error)

func (*DoubleValue) ProtoMessage 

func (*DoubleValue) ProtoMessage()

func (*DoubleValue) ProtoSize 

func (m *DoubleValue) ProtoSize() (n int)

func (*DoubleValue) Reset 

func (m *DoubleValue) Reset()

func (*DoubleValue) Size 

func (m *DoubleValue) Size() (n int)

func (*DoubleValue) String 

func (this *DoubleValue) String() string

func (*DoubleValue) Unmarshal 

func (m *DoubleValue) Unmarshal(dAtA []byte) error

func (*DoubleValue) XXX_DiscardUnknown 

func (m *DoubleValue) XXX_DiscardUnknown()

func (*DoubleValue) XXX_Marshal 

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

func (*DoubleValue) XXX_Merge 

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

func (*DoubleValue) XXX_MessageName 

func (*DoubleValue) XXX_MessageName() string

func (*DoubleValue) XXX_Size 

func (m *DoubleValue) XXX_Size() int

func (*DoubleValue) XXX_Unmarshal 

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

func (*DoubleValue) XXX_WellKnownType 

func (*DoubleValue) XXX_WellKnownType() string

type Duration 

type Duration struct {
	// Signed seconds of the span of time. Must be from -315,576,000,000
	// to +315,576,000,000 inclusive. Note: these bounds are computed from:
	// 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
	Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`
	// Signed fractions of a second at nanosecond resolution of the span
	// of time. Durations less than one second are represented with a 0
	// `seconds` field and a positive or negative `nanos` field. For durations
	// of one second or more, a non-zero value for the `nanos` field must be
	// of the same sign as the `seconds` field. Must be from -999,999,999
	// to +999,999,999 inclusive.
	Nanos                int32    `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.

Examples

Example 1: Compute Duration from two Timestamps in pseudo code. 

Timestamp start = ...;
Timestamp end = ...;
Duration duration = ...;

duration.seconds = end.seconds - start.seconds;
duration.nanos = end.nanos - start.nanos;

if (duration.seconds < 0 && duration.nanos > 0) {
  duration.seconds += 1;
  duration.nanos -= 1000000000;
} else if (durations.seconds > 0 && duration.nanos < 0) {
  duration.seconds -= 1;
  duration.nanos += 1000000000;
}

Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. 

Timestamp start = ...;
Duration duration = ...;
Timestamp end = ...;

end.seconds = start.seconds + duration.seconds;
end.nanos = start.nanos + duration.nanos;

if (end.nanos < 0) {
  end.seconds -= 1;
  end.nanos += 1000000000;
} else if (end.nanos >= 1000000000) {
  end.seconds += 1;
  end.nanos -= 1000000000;
}

Example 3: Compute Duration from datetime.timedelta in Python. 

td = datetime.timedelta(days=3, minutes=10)
duration = Duration()
duration.FromTimedelta(td)

JSON Mapping

In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

func DurationProto 

func DurationProto(d time.Duration) *Duration

DurationProto converts a time.Duration to a Duration.

func NewPopulatedDuration 

func NewPopulatedDuration(r interface {
	Int63() int64
}, easy bool) *Duration

func (*Duration) Compare 

func (this *Duration) Compare(that interface{}) int

func (*Duration) Descriptor 

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

func (*Duration) Equal 

func (this *Duration) Equal(that interface{}) bool

func (*Duration) GetNanos 

func (m *Duration) GetNanos() int32

func (*Duration) GetSeconds 

func (m *Duration) GetSeconds() int64

func (*Duration) GoString 

func (this *Duration) GoString() string

func (*Duration) Marshal 

func (m *Duration) Marshal() (dAtA []byte, err error)

func (*Duration) MarshalTo 

func (m *Duration) MarshalTo(dAtA []byte) (int, error)

func (*Duration) ProtoMessage 

func (*Duration) ProtoMessage()

func (*Duration) ProtoSize 

func (m *Duration) ProtoSize() (n int)

func (*Duration) Reset 

func (m *Duration) Reset()

func (*Duration) Size 

func (m *Duration) Size() (n int)

func (*Duration) String 

func (d *Duration) String() string

func (*Duration) Unmarshal 

func (m *Duration) Unmarshal(dAtA []byte) error

func (*Duration) XXX_DiscardUnknown 

func (m *Duration) XXX_DiscardUnknown()

func (*Duration) XXX_Marshal 

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

func (*Duration) XXX_Merge 

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

func (*Duration) XXX_MessageName 

func (*Duration) XXX_MessageName() string

func (*Duration) XXX_Size 

func (m *Duration) XXX_Size() int

func (*Duration) XXX_Unmarshal 

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

func (*Duration) XXX_WellKnownType 

func (*Duration) XXX_WellKnownType() string

type DynamicAny 

type DynamicAny struct {
	proto.Message
}

DynamicAny is a value that can be passed to UnmarshalAny to automatically allocate a proto.Message for the type specified in a google.protobuf.Any message. The allocated message is stored in the embedded proto.Message.

Example: 

var x ptypes.DynamicAny
if err := ptypes.UnmarshalAny(a, &x); err != nil { ... }
fmt.Printf("unmarshaled message: %v", x.Message)

type Empty 

type Empty struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: 

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for `Empty` is empty JSON object `{}`.

func NewPopulatedEmpty 

func NewPopulatedEmpty(r randyEmpty, easy bool) *Empty

func (*Empty) Compare 

func (this *Empty) Compare(that interface{}) int

func (*Empty) Descriptor 

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

func (*Empty) Equal 

func (this *Empty) Equal(that interface{}) bool

func (*Empty) GoString 

func (this *Empty) GoString() string

func (*Empty) Marshal 

func (m *Empty) Marshal() (dAtA []byte, err error)

func (*Empty) MarshalTo 

func (m *Empty) MarshalTo(dAtA []byte) (int, error)

func (*Empty) ProtoMessage 

func (*Empty) ProtoMessage()

func (*Empty) ProtoSize 

func (m *Empty) ProtoSize() (n int)

func (*Empty) Reset 

func (m *Empty) Reset()

func (*Empty) Size 

func (m *Empty) Size() (n int)

func (*Empty) String 

func (this *Empty) String() string

func (*Empty) Unmarshal 

func (m *Empty) Unmarshal(dAtA []byte) error

func (*Empty) XXX_DiscardUnknown 

func (m *Empty) XXX_DiscardUnknown()

func (*Empty) XXX_Marshal 

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

func (*Empty) XXX_Merge 

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

func (*Empty) XXX_MessageName 

func (*Empty) XXX_MessageName() string

func (*Empty) XXX_Size 

func (m *Empty) XXX_Size() int

func (*Empty) XXX_Unmarshal 

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

func (*Empty) XXX_WellKnownType 

func (*Empty) XXX_WellKnownType() string

type Enum 

type Enum struct {
	// Enum type name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Enum value definitions.
	Enumvalue []*EnumValue `protobuf:"bytes,2,rep,name=enumvalue,proto3" json:"enumvalue,omitempty"`
	// Protocol buffer options.
	Options []*Option `protobuf:"bytes,3,rep,name=options,proto3" json:"options,omitempty"`
	// The source context.
	SourceContext *SourceContext `protobuf:"bytes,4,opt,name=source_context,json=sourceContext,proto3" json:"source_context,omitempty"`
	// The source syntax.
	Syntax               Syntax   `protobuf:"varint,5,opt,name=syntax,proto3,enum=google.protobuf.Syntax" json:"syntax,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Enum type definition.

func NewPopulatedEnum 

func NewPopulatedEnum(r randyType, easy bool) *Enum

func (*Enum) Compare 

func (this *Enum) Compare(that interface{}) int

func (*Enum) Descriptor 

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

func (*Enum) Equal 

func (this *Enum) Equal(that interface{}) bool

func (*Enum) GetEnumvalue 

func (m *Enum) GetEnumvalue() []*EnumValue

func (*Enum) GetName 

func (m *Enum) GetName() string

func (*Enum) GetOptions 

func (m *Enum) GetOptions() []*Option

func (*Enum) GetSourceContext 

func (m *Enum) GetSourceContext() *SourceContext

func (*Enum) GetSyntax 

func (m *Enum) GetSyntax() Syntax

func (*Enum) GoString 

func (this *Enum) GoString() string

func (*Enum) Marshal 

func (m *Enum) Marshal() (dAtA []byte, err error)

func (*Enum) MarshalTo 

func (m *Enum) MarshalTo(dAtA []byte) (int, error)

func (*Enum) ProtoMessage 

func (*Enum) ProtoMessage()

func (*Enum) ProtoSize 

func (m *Enum) ProtoSize() (n int)

func (*Enum) Reset 

func (m *Enum) Reset()

func (*Enum) Size 

func (m *Enum) Size() (n int)

func (*Enum) String 

func (this *Enum) String() string

func (*Enum) Unmarshal 

func (m *Enum) Unmarshal(dAtA []byte) error

func (*Enum) XXX_DiscardUnknown 

func (m *Enum) XXX_DiscardUnknown()

func (*Enum) XXX_Marshal 

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

func (*Enum) XXX_Merge 

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

func (*Enum) XXX_MessageName 

func (*Enum) XXX_MessageName() string

func (*Enum) XXX_Size 

func (m *Enum) XXX_Size() int

func (*Enum) XXX_Unmarshal 

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

type EnumValue 

type EnumValue struct {
	// Enum value name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Enum value number.
	Number int32 `protobuf:"varint,2,opt,name=number,proto3" json:"number,omitempty"`
	// Protocol buffer options.
	Options              []*Option `protobuf:"bytes,3,rep,name=options,proto3" json:"options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Enum value definition.

func NewPopulatedEnumValue 

func NewPopulatedEnumValue(r randyType, easy bool) *EnumValue

func (*EnumValue) Compare 

func (this *EnumValue) Compare(that interface{}) int

func (*EnumValue) Descriptor 

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

func (*EnumValue) Equal 

func (this *EnumValue) Equal(that interface{}) bool

func (*EnumValue) GetName 

func (m *EnumValue) GetName() string

func (*EnumValue) GetNumber 

func (m *EnumValue) GetNumber() int32

func (*EnumValue) GetOptions 

func (m *EnumValue) GetOptions() []*Option

func (*EnumValue) GoString 

func (this *EnumValue) GoString() string

func (*EnumValue) Marshal 

func (m *EnumValue) Marshal() (dAtA []byte, err error)

func (*EnumValue) MarshalTo 

func (m *EnumValue) MarshalTo(dAtA []byte) (int, error)

func (*EnumValue) ProtoMessage 

func (*EnumValue) ProtoMessage()

func (*EnumValue) ProtoSize 

func (m *EnumValue) ProtoSize() (n int)

func (*EnumValue) Reset 

func (m *EnumValue) Reset()

func (*EnumValue) Size 

func (m *EnumValue) Size() (n int)

func (*EnumValue) String 

func (this *EnumValue) String() string

func (*EnumValue) Unmarshal 

func (m *EnumValue) Unmarshal(dAtA []byte) error

func (*EnumValue) XXX_DiscardUnknown 

func (m *EnumValue) XXX_DiscardUnknown()

func (*EnumValue) XXX_Marshal 

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

func (*EnumValue) XXX_Merge 

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

func (*EnumValue) XXX_MessageName 

func (*EnumValue) XXX_MessageName() string

func (*EnumValue) XXX_Size 

func (m *EnumValue) XXX_Size() int

func (*EnumValue) XXX_Unmarshal 

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

type Field 

type Field struct {
	// The field type.
	Kind Field_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=google.protobuf.Field_Kind" json:"kind,omitempty"`
	// The field cardinality.
	Cardinality Field_Cardinality `protobuf:"varint,2,opt,name=cardinality,proto3,enum=google.protobuf.Field_Cardinality" json:"cardinality,omitempty"`
	// The field number.
	Number int32 `protobuf:"varint,3,opt,name=number,proto3" json:"number,omitempty"`
	// The field name.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// The field type URL, without the scheme, for message or enumeration
	// types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
	TypeUrl string `protobuf:"bytes,6,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// The index of the field type in `Type.oneofs`, for message or enumeration
	// types. The first type has index 1; zero means the type is not in the list.
	OneofIndex int32 `protobuf:"varint,7,opt,name=oneof_index,json=oneofIndex,proto3" json:"oneof_index,omitempty"`
	// Whether to use alternative packed wire representation.
	Packed bool `protobuf:"varint,8,opt,name=packed,proto3" json:"packed,omitempty"`
	// The protocol buffer options.
	Options []*Option `protobuf:"bytes,9,rep,name=options,proto3" json:"options,omitempty"`
	// The field JSON name.
	JsonName string `protobuf:"bytes,10,opt,name=json_name,json=jsonName,proto3" json:"json_name,omitempty"`
	// The string value of the default value of this field. Proto2 syntax only.
	DefaultValue         string   `protobuf:"bytes,11,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A single field of a message type.

func NewPopulatedField 

func NewPopulatedField(r randyType, easy bool) *Field

func (*Field) Compare 

func (this *Field) Compare(that interface{}) int

func (*Field) Descriptor 

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

func (*Field) Equal 

func (this *Field) Equal(that interface{}) bool

func (*Field) GetCardinality 

func (m *Field) GetCardinality() Field_Cardinality

func (*Field) GetDefaultValue 

func (m *Field) GetDefaultValue() string

func (*Field) GetJsonName 

func (m *Field) GetJsonName() string

func (*Field) GetKind 

func (m *Field) GetKind() Field_Kind

func (*Field) GetName 

func (m *Field) GetName() string

func (*Field) GetNumber 

func (m *Field) GetNumber() int32

func (*Field) GetOneofIndex 

func (m *Field) GetOneofIndex() int32

func (*Field) GetOptions 

func (m *Field) GetOptions() []*Option

func (*Field) GetPacked 

func (m *Field) GetPacked() bool

func (*Field) GetTypeUrl 

func (m *Field) GetTypeUrl() string

func (*Field) GoString 

func (this *Field) GoString() string

func (*Field) Marshal 

func (m *Field) Marshal() (dAtA []byte, err error)

func (*Field) MarshalTo 

func (m *Field) MarshalTo(dAtA []byte) (int, error)

func (*Field) ProtoMessage 

func (*Field) ProtoMessage()

func (*Field) ProtoSize 

func (m *Field) ProtoSize() (n int)

func (*Field) Reset 

func (m *Field) Reset()

func (*Field) Size 

func (m *Field) Size() (n int)

func (*Field) String 

func (this *Field) String() string

func (*Field) Unmarshal 

func (m *Field) Unmarshal(dAtA []byte) error

func (*Field) XXX_DiscardUnknown 

func (m *Field) XXX_DiscardUnknown()

func (*Field) XXX_Marshal 

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

func (*Field) XXX_Merge 

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

func (*Field) XXX_MessageName 

func (*Field) XXX_MessageName() string

func (*Field) XXX_Size 

func (m *Field) XXX_Size() int

func (*Field) XXX_Unmarshal 

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

type FieldMask 

type FieldMask struct {
	// The set of field mask paths.
	Paths                []string `protobuf:"bytes,1,rep,name=paths,proto3" json:"paths,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

`FieldMask` represents a set of symbolic field paths, for example: 

paths: "f.a"
paths: "f.b.d"

Here `f` represents a field in some root message, `a` and `b` fields in the message found in `f`, and `d` a field found in the message in `f.b`.

Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below).

Field Masks in Projections

When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows: 

f {
  a : 22
  b {
    d : 1
    x : 2
  }
  y : 13
}
z: 8

The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output): 

f {
  a : 22
  b {
    d : 1
  }
}

A repeated field is not allowed except at the last position of a paths string.

If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified).

Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs.

Field Masks in Update Operations

A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask.

If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a `paths` string.

If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource.

For example, given the target message: 

f {
  b {
    d: 1
    x: 2
  }
  c: [1]
}

And an update message: 

f {
  b {
    d: 10
  }
  c: [2]
}

then if the field mask is: 

paths: ["f.b", "f.c"]

then the result will be: 

f {
  b {
    d: 10
    x: 2
  }
  c: [1, 2]
}

An implementation may provide options to override this default behavior for repeated and message fields.

In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below.

If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not.

As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API.

## Considerations for HTTP REST

The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates).

JSON Encoding of Field Masks

In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions.

As an example, consider the following message declarations: 

message Profile {
  User user = 1;
  Photo photo = 2;
}
message User {
  string display_name = 1;
  string address = 2;
}

In proto a field mask for `Profile` may look as such: 

mask {
  paths: "user.display_name"
  paths: "photo"
}

In JSON, the same mask is represented as below: 

{
  mask: "user.displayName,photo"
}

Field Masks and Oneof Fields

Field masks treat fields in oneofs just as regular fields. Consider the following message: 

message SampleMessage {
  oneof test_oneof {
    string name = 4;
    SubMessage sub_message = 9;
  }
}

The field mask can be: 

mask {
  paths: "name"
}

Or: 

mask {
  paths: "sub_message"
}

Note that oneof type names ("test_oneof" in this case) cannot be used in paths.

## Field Mask Verification

The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an `INVALID_ARGUMENT` error if any path is duplicated or unmappable.

func NewPopulatedFieldMask 

func NewPopulatedFieldMask(r randyFieldMask, easy bool) *FieldMask

func (*FieldMask) Compare 

func (this *FieldMask) Compare(that interface{}) int

func (*FieldMask) Descriptor 

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

func (*FieldMask) Equal 

func (this *FieldMask) Equal(that interface{}) bool

func (*FieldMask) GetPaths 

func (m *FieldMask) GetPaths() []string

func (*FieldMask) GoString 

func (this *FieldMask) GoString() string

func (*FieldMask) Marshal 

func (m *FieldMask) Marshal() (dAtA []byte, err error)

func (*FieldMask) MarshalTo 

func (m *FieldMask) MarshalTo(dAtA []byte) (int, error)

func (*FieldMask) ProtoMessage 

func (*FieldMask) ProtoMessage()

func (*FieldMask) ProtoSize 

func (m *FieldMask) ProtoSize() (n int)

func (*FieldMask) Reset 

func (m *FieldMask) Reset()

func (*FieldMask) Size 

func (m *FieldMask) Size() (n int)

func (*FieldMask) String 

func (this *FieldMask) String() string

func (*FieldMask) Unmarshal 

func (m *FieldMask) Unmarshal(dAtA []byte) error

func (*FieldMask) XXX_DiscardUnknown 

func (m *FieldMask) XXX_DiscardUnknown()

func (*FieldMask) XXX_Marshal 

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

func (*FieldMask) XXX_Merge 

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

func (*FieldMask) XXX_MessageName 

func (*FieldMask) XXX_MessageName() string

func (*FieldMask) XXX_Size 

func (m *FieldMask) XXX_Size() int

func (*FieldMask) XXX_Unmarshal 

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

type Field_Cardinality 

type Field_Cardinality int32

Whether a field is optional, required, or repeated. 

const (
	// For fields with unknown cardinality.
	Field_CARDINALITY_UNKNOWN Field_Cardinality = 0
	// For optional fields.
	Field_CARDINALITY_OPTIONAL Field_Cardinality = 1
	// For required fields. Proto2 syntax only.
	Field_CARDINALITY_REQUIRED Field_Cardinality = 2
	// For repeated fields.
	Field_CARDINALITY_REPEATED Field_Cardinality = 3
)

func (Field_Cardinality) EnumDescriptor 

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

func (Field_Cardinality) String 

func (x Field_Cardinality) String() string

type Field_Kind 

type Field_Kind int32

Basic field types. 

const (
	// Field type unknown.
	Field_TYPE_UNKNOWN Field_Kind = 0
	// Field type double.
	Field_TYPE_DOUBLE Field_Kind = 1
	// Field type float.
	Field_TYPE_FLOAT Field_Kind = 2
	// Field type int64.
	Field_TYPE_INT64 Field_Kind = 3
	// Field type uint64.
	Field_TYPE_UINT64 Field_Kind = 4
	// Field type int32.
	Field_TYPE_INT32 Field_Kind = 5
	// Field type fixed64.
	Field_TYPE_FIXED64 Field_Kind = 6
	// Field type fixed32.
	Field_TYPE_FIXED32 Field_Kind = 7
	// Field type bool.
	Field_TYPE_BOOL Field_Kind = 8
	// Field type string.
	Field_TYPE_STRING Field_Kind = 9
	// Field type group. Proto2 syntax only, and deprecated.
	Field_TYPE_GROUP Field_Kind = 10
	// Field type message.
	Field_TYPE_MESSAGE Field_Kind = 11
	// Field type bytes.
	Field_TYPE_BYTES Field_Kind = 12
	// Field type uint32.
	Field_TYPE_UINT32 Field_Kind = 13
	// Field type enum.
	Field_TYPE_ENUM Field_Kind = 14
	// Field type sfixed32.
	Field_TYPE_SFIXED32 Field_Kind = 15
	// Field type sfixed64.
	Field_TYPE_SFIXED64 Field_Kind = 16
	// Field type sint32.
	Field_TYPE_SINT32 Field_Kind = 17
	// Field type sint64.
	Field_TYPE_SINT64 Field_Kind = 18
)

func (Field_Kind) EnumDescriptor 

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

func (Field_Kind) String 

func (x Field_Kind) String() string

type FloatValue 

type FloatValue struct {
	// The float value.
	Value                float32  `protobuf:"fixed32,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `float`.

The JSON representation for `FloatValue` is JSON number.

func NewPopulatedFloatValue 

func NewPopulatedFloatValue(r randyWrappers, easy bool) *FloatValue

func (*FloatValue) Compare 

func (this *FloatValue) Compare(that interface{}) int

func (*FloatValue) Descriptor 

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

func (*FloatValue) Equal 

func (this *FloatValue) Equal(that interface{}) bool

func (*FloatValue) GetValue 

func (m *FloatValue) GetValue() float32

func (*FloatValue) GoString 

func (this *FloatValue) GoString() string

func (*FloatValue) Marshal 

func (m *FloatValue) Marshal() (dAtA []byte, err error)

func (*FloatValue) MarshalTo 

func (m *FloatValue) MarshalTo(dAtA []byte) (int, error)

func (*FloatValue) ProtoMessage 

func (*FloatValue) ProtoMessage()

func (*FloatValue) ProtoSize 

func (m *FloatValue) ProtoSize() (n int)

func (*FloatValue) Reset 

func (m *FloatValue) Reset()

func (*FloatValue) Size 

func (m *FloatValue) Size() (n int)

func (*FloatValue) String 

func (this *FloatValue) String() string

func (*FloatValue) Unmarshal 

func (m *FloatValue) Unmarshal(dAtA []byte) error

func (*FloatValue) XXX_DiscardUnknown 

func (m *FloatValue) XXX_DiscardUnknown()

func (*FloatValue) XXX_Marshal 

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

func (*FloatValue) XXX_Merge 

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

func (*FloatValue) XXX_MessageName 

func (*FloatValue) XXX_MessageName() string

func (*FloatValue) XXX_Size 

func (m *FloatValue) XXX_Size() int

func (*FloatValue) XXX_Unmarshal 

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

func (*FloatValue) XXX_WellKnownType 

func (*FloatValue) XXX_WellKnownType() string

type Int32Value 

type Int32Value struct {
	// The int32 value.
	Value                int32    `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `int32`.

The JSON representation for `Int32Value` is JSON number.

func NewPopulatedInt32Value 

func NewPopulatedInt32Value(r randyWrappers, easy bool) *Int32Value

func (*Int32Value) Compare 

func (this *Int32Value) Compare(that interface{}) int

func (*Int32Value) Descriptor 

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

func (*Int32Value) Equal 

func (this *Int32Value) Equal(that interface{}) bool

func (*Int32Value) GetValue 

func (m *Int32Value) GetValue() int32

func (*Int32Value) GoString 

func (this *Int32Value) GoString() string

func (*Int32Value) Marshal 

func (m *Int32Value) Marshal() (dAtA []byte, err error)

func (*Int32Value) MarshalTo 

func (m *Int32Value) MarshalTo(dAtA []byte) (int, error)

func (*Int32Value) ProtoMessage 

func (*Int32Value) ProtoMessage()

func (*Int32Value) ProtoSize 

func (m *Int32Value) ProtoSize() (n int)

func (*Int32Value) Reset 

func (m *Int32Value) Reset()

func (*Int32Value) Size 

func (m *Int32Value) Size() (n int)

func (*Int32Value) String 

func (this *Int32Value) String() string

func (*Int32Value) Unmarshal 

func (m *Int32Value) Unmarshal(dAtA []byte) error

func (*Int32Value) XXX_DiscardUnknown 

func (m *Int32Value) XXX_DiscardUnknown()

func (*Int32Value) XXX_Marshal 

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

func (*Int32Value) XXX_Merge 

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

func (*Int32Value) XXX_MessageName 

func (*Int32Value) XXX_MessageName() string

func (*Int32Value) XXX_Size 

func (m *Int32Value) XXX_Size() int

func (*Int32Value) XXX_Unmarshal 

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

func (*Int32Value) XXX_WellKnownType 

func (*Int32Value) XXX_WellKnownType() string

type Int64Value 

type Int64Value struct {
	// The int64 value.
	Value                int64    `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `int64`.

The JSON representation for `Int64Value` is JSON string.

func NewPopulatedInt64Value 

func NewPopulatedInt64Value(r randyWrappers, easy bool) *Int64Value

func (*Int64Value) Compare 

func (this *Int64Value) Compare(that interface{}) int

func (*Int64Value) Descriptor 

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

func (*Int64Value) Equal 

func (this *Int64Value) Equal(that interface{}) bool

func (*Int64Value) GetValue 

func (m *Int64Value) GetValue() int64

func (*Int64Value) GoString 

func (this *Int64Value) GoString() string

func (*Int64Value) Marshal 

func (m *Int64Value) Marshal() (dAtA []byte, err error)

func (*Int64Value) MarshalTo 

func (m *Int64Value) MarshalTo(dAtA []byte) (int, error)

func (*Int64Value) ProtoMessage 

func (*Int64Value) ProtoMessage()

func (*Int64Value) ProtoSize 

func (m *Int64Value) ProtoSize() (n int)

func (*Int64Value) Reset 

func (m *Int64Value) Reset()

func (*Int64Value) Size 

func (m *Int64Value) Size() (n int)

func (*Int64Value) String 

func (this *Int64Value) String() string

func (*Int64Value) Unmarshal 

func (m *Int64Value) Unmarshal(dAtA []byte) error

func (*Int64Value) XXX_DiscardUnknown 

func (m *Int64Value) XXX_DiscardUnknown()

func (*Int64Value) XXX_Marshal 

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

func (*Int64Value) XXX_Merge 

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

func (*Int64Value) XXX_MessageName 

func (*Int64Value) XXX_MessageName() string

func (*Int64Value) XXX_Size 

func (m *Int64Value) XXX_Size() int

func (*Int64Value) XXX_Unmarshal 

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

func (*Int64Value) XXX_WellKnownType 

func (*Int64Value) XXX_WellKnownType() string

type ListValue 

type ListValue struct {
	// Repeated field of dynamically typed values.
	Values               []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

`ListValue` is a wrapper around a repeated field of values.

The JSON representation for `ListValue` is JSON array.

func NewPopulatedListValue 

func NewPopulatedListValue(r randyStruct, easy bool) *ListValue

func (*ListValue) Descriptor 

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

func (*ListValue) Equal 

func (this *ListValue) Equal(that interface{}) bool

func (*ListValue) GetValues 

func (m *ListValue) GetValues() []*Value

func (*ListValue) GoString 

func (this *ListValue) GoString() string

func (*ListValue) Marshal 

func (m *ListValue) Marshal() (dAtA []byte, err error)

func (*ListValue) MarshalTo 

func (m *ListValue) MarshalTo(dAtA []byte) (int, error)

func (*ListValue) ProtoMessage 

func (*ListValue) ProtoMessage()

func (*ListValue) ProtoSize 

func (m *ListValue) ProtoSize() (n int)

func (*ListValue) Reset 

func (m *ListValue) Reset()

func (*ListValue) Size 

func (m *ListValue) Size() (n int)

func (*ListValue) String 

func (this *ListValue) String() string

func (*ListValue) Unmarshal 

func (m *ListValue) Unmarshal(dAtA []byte) error

func (*ListValue) XXX_DiscardUnknown 

func (m *ListValue) XXX_DiscardUnknown()

func (*ListValue) XXX_Marshal 

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

func (*ListValue) XXX_Merge 

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

func (*ListValue) XXX_MessageName 

func (*ListValue) XXX_MessageName() string

func (*ListValue) XXX_Size 

func (m *ListValue) XXX_Size() int

func (*ListValue) XXX_Unmarshal 

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

func (*ListValue) XXX_WellKnownType 

func (*ListValue) XXX_WellKnownType() string

type Method 

type Method struct {
	// The simple name of this method.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A URL of the input message type.
	RequestTypeUrl string `protobuf:"bytes,2,opt,name=request_type_url,json=requestTypeUrl,proto3" json:"request_type_url,omitempty"`
	// If true, the request is streamed.
	RequestStreaming bool `protobuf:"varint,3,opt,name=request_streaming,json=requestStreaming,proto3" json:"request_streaming,omitempty"`
	// The URL of the output message type.
	ResponseTypeUrl string `protobuf:"bytes,4,opt,name=response_type_url,json=responseTypeUrl,proto3" json:"response_type_url,omitempty"`
	// If true, the response is streamed.
	ResponseStreaming bool `protobuf:"varint,5,opt,name=response_streaming,json=responseStreaming,proto3" json:"response_streaming,omitempty"`
	// Any metadata attached to the method.
	Options []*Option `protobuf:"bytes,6,rep,name=options,proto3" json:"options,omitempty"`
	// The source syntax of this method.
	Syntax               Syntax   `protobuf:"varint,7,opt,name=syntax,proto3,enum=google.protobuf.Syntax" json:"syntax,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Method represents a method of an API interface.

func NewPopulatedMethod 

func NewPopulatedMethod(r randyApi, easy bool) *Method

func (*Method) Compare 

func (this *Method) Compare(that interface{}) int

func (*Method) Descriptor 

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

func (*Method) Equal 

func (this *Method) Equal(that interface{}) bool

func (*Method) GetName 

func (m *Method) GetName() string

func (*Method) GetOptions 

func (m *Method) GetOptions() []*Option

func (*Method) GetRequestStreaming 

func (m *Method) GetRequestStreaming() bool

func (*Method) GetRequestTypeUrl 

func (m *Method) GetRequestTypeUrl() string

func (*Method) GetResponseStreaming 

func (m *Method) GetResponseStreaming() bool

func (*Method) GetResponseTypeUrl 

func (m *Method) GetResponseTypeUrl() string

func (*Method) GetSyntax 

func (m *Method) GetSyntax() Syntax

func (*Method) GoString 

func (this *Method) GoString() string

func (*Method) Marshal 

func (m *Method) Marshal() (dAtA []byte, err error)

func (*Method) MarshalTo 

func (m *Method) MarshalTo(dAtA []byte) (int, error)

func (*Method) ProtoMessage 

func (*Method) ProtoMessage()

func (*Method) ProtoSize 

func (m *Method) ProtoSize() (n int)

func (*Method) Reset 

func (m *Method) Reset()

func (*Method) Size 

func (m *Method) Size() (n int)

func (*Method) String 

func (this *Method) String() string

func (*Method) Unmarshal 

func (m *Method) Unmarshal(dAtA []byte) error

func (*Method) XXX_DiscardUnknown 

func (m *Method) XXX_DiscardUnknown()

func (*Method) XXX_Marshal 

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

func (*Method) XXX_Merge 

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

func (*Method) XXX_MessageName 

func (*Method) XXX_MessageName() string

func (*Method) XXX_Size 

func (m *Method) XXX_Size() int

func (*Method) XXX_Unmarshal 

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

type Mixin 

type Mixin struct {
	// The fully qualified name of the interface which is included.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If non-empty specifies a path under which inherited HTTP paths
	// are rooted.
	Root                 string   `protobuf:"bytes,2,opt,name=root,proto3" json:"root,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:

  • If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.
  • Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited.
  • If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the [root][] path if specified.

Example of a simple mixin: 

package google.acl.v1;
service AccessControl {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v1/{resource=**}:getAcl";
  }
}

package google.storage.v2;
service Storage {
  rpc GetAcl(GetAclRequest) returns (Acl);

  // Get a data record.
  rpc GetData(GetDataRequest) returns (Data) {
    option (google.api.http).get = "/v2/{resource=**}";
  }
}

Example of a mixin configuration: 

apis:
- name: google.storage.v2.Storage
  mixins:
  - name: google.acl.v1.AccessControl

The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: 

service Storage {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v2/{resource=**}:getAcl";
  }
  ...
}

Note how the version in the path pattern changed from `v1` to `v2`.

If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: 

apis:
- name: google.storage.v2.Storage
  mixins:
  - name: google.acl.v1.AccessControl
    root: acls

This implies the following inherited HTTP annotation: 

service Storage {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
  }
  ...
}

func NewPopulatedMixin 

func NewPopulatedMixin(r randyApi, easy bool) *Mixin

func (*Mixin) Compare 

func (this *Mixin) Compare(that interface{}) int

func (*Mixin) Descriptor 

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

func (*Mixin) Equal 

func (this *Mixin) Equal(that interface{}) bool

func (*Mixin) GetName 

func (m *Mixin) GetName() string

func (*Mixin) GetRoot 

func (m *Mixin) GetRoot() string

func (*Mixin) GoString 

func (this *Mixin) GoString() string

func (*Mixin) Marshal 

func (m *Mixin) Marshal() (dAtA []byte, err error)

func (*Mixin) MarshalTo 

func (m *Mixin) MarshalTo(dAtA []byte) (int, error)

func (*Mixin) ProtoMessage 

func (*Mixin) ProtoMessage()

func (*Mixin) ProtoSize 

func (m *Mixin) ProtoSize() (n int)

func (*Mixin) Reset 

func (m *Mixin) Reset()

func (*Mixin) Size 

func (m *Mixin) Size() (n int)

func (*Mixin) String 

func (this *Mixin) String() string

func (*Mixin) Unmarshal 

func (m *Mixin) Unmarshal(dAtA []byte) error

func (*Mixin) XXX_DiscardUnknown 

func (m *Mixin) XXX_DiscardUnknown()

func (*Mixin) XXX_Marshal 

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

func (*Mixin) XXX_Merge 

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

func (*Mixin) XXX_MessageName 

func (*Mixin) XXX_MessageName() string

func (*Mixin) XXX_Size 

func (m *Mixin) XXX_Size() int

func (*Mixin) XXX_Unmarshal 

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

type NullValue 

type NullValue int32

`NullValue` is a singleton enumeration to represent the null value for the `Value` type union. 

The JSON representation for `NullValue` is JSON `null`.

const (
	// Null value.
	NullValue_NULL_VALUE NullValue = 0
)

func (NullValue) EnumDescriptor 

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

func (NullValue) String 

func (x NullValue) String() string

func (NullValue) XXX_WellKnownType 

func (NullValue) XXX_WellKnownType() string

type Option 

type Option struct {
	// The option's name. For protobuf built-in options (options defined in
	// descriptor.proto), this is the short name. For example, `"map_entry"`.
	// For custom options, it should be the fully-qualified name. For example,
	// `"google.api.http"`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The option's value packed in an Any message. If the value is a primitive,
	// the corresponding wrapper type defined in google/protobuf/wrappers.proto
	// should be used. If the value is an enum, it should be stored as an int32
	// value using the google.protobuf.Int32Value type.
	Value                *Any     `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

func NewPopulatedOption 

func NewPopulatedOption(r randyType, easy bool) *Option

func (*Option) Compare 

func (this *Option) Compare(that interface{}) int

func (*Option) Descriptor 

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

func (*Option) Equal 

func (this *Option) Equal(that interface{}) bool

func (*Option) GetName 

func (m *Option) GetName() string

func (*Option) GetValue 

func (m *Option) GetValue() *Any

func (*Option) GoString 

func (this *Option) GoString() string

func (*Option) Marshal 

func (m *Option) Marshal() (dAtA []byte, err error)

func (*Option) MarshalTo 

func (m *Option) MarshalTo(dAtA []byte) (int, error)

func (*Option) ProtoMessage 

func (*Option) ProtoMessage()

func (*Option) ProtoSize 

func (m *Option) ProtoSize() (n int)

func (*Option) Reset 

func (m *Option) Reset()

func (*Option) Size 

func (m *Option) Size() (n int)

func (*Option) String 

func (this *Option) String() string

func (*Option) Unmarshal 

func (m *Option) Unmarshal(dAtA []byte) error

func (*Option) XXX_DiscardUnknown 

func (m *Option) XXX_DiscardUnknown()

func (*Option) XXX_Marshal 

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

func (*Option) XXX_Merge 

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

func (*Option) XXX_MessageName 

func (*Option) XXX_MessageName() string

func (*Option) XXX_Size 

func (m *Option) XXX_Size() int

func (*Option) XXX_Unmarshal 

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

type SourceContext 

type SourceContext struct {
	// The path-qualified name of the .proto file that contained the associated
	// protobuf element.  For example: `"google/protobuf/source_context.proto"`.
	FileName             string   `protobuf:"bytes,1,opt,name=file_name,json=fileName,proto3" json:"file_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.

func NewPopulatedSourceContext 

func NewPopulatedSourceContext(r randySourceContext, easy bool) *SourceContext

func (*SourceContext) Compare 

func (this *SourceContext) Compare(that interface{}) int

func (*SourceContext) Descriptor 

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

func (*SourceContext) Equal 

func (this *SourceContext) Equal(that interface{}) bool

func (*SourceContext) GetFileName 

func (m *SourceContext) GetFileName() string

func (*SourceContext) GoString 

func (this *SourceContext) GoString() string

func (*SourceContext) Marshal 

func (m *SourceContext) Marshal() (dAtA []byte, err error)

func (*SourceContext) MarshalTo 

func (m *SourceContext) MarshalTo(dAtA []byte) (int, error)

func (*SourceContext) ProtoMessage 

func (*SourceContext) ProtoMessage()

func (*SourceContext) ProtoSize 

func (m *SourceContext) ProtoSize() (n int)

func (*SourceContext) Reset 

func (m *SourceContext) Reset()

func (*SourceContext) Size 

func (m *SourceContext) Size() (n int)

func (*SourceContext) String 

func (this *SourceContext) String() string

func (*SourceContext) Unmarshal 

func (m *SourceContext) Unmarshal(dAtA []byte) error

func (*SourceContext) XXX_DiscardUnknown 

func (m *SourceContext) XXX_DiscardUnknown()

func (*SourceContext) XXX_Marshal 

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

func (*SourceContext) XXX_Merge 

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

func (*SourceContext) XXX_MessageName 

func (*SourceContext) XXX_MessageName() string

func (*SourceContext) XXX_Size 

func (m *SourceContext) XXX_Size() int

func (*SourceContext) XXX_Unmarshal 

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

type StringValue 

type StringValue struct {
	// The string value.
	Value                string   `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `string`.

The JSON representation for `StringValue` is JSON string.

func NewPopulatedStringValue 

func NewPopulatedStringValue(r randyWrappers, easy bool) *StringValue

func (*StringValue) Compare 

func (this *StringValue) Compare(that interface{}) int

func (*StringValue) Descriptor 

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

func (*StringValue) Equal 

func (this *StringValue) Equal(that interface{}) bool

func (*StringValue) GetValue 

func (m *StringValue) GetValue() string

func (*StringValue) GoString 

func (this *StringValue) GoString() string

func (*StringValue) Marshal 

func (m *StringValue) Marshal() (dAtA []byte, err error)

func (*StringValue) MarshalTo 

func (m *StringValue) MarshalTo(dAtA []byte) (int, error)

func (*StringValue) ProtoMessage 

func (*StringValue) ProtoMessage()

func (*StringValue) ProtoSize 

func (m *StringValue) ProtoSize() (n int)

func (*StringValue) Reset 

func (m *StringValue) Reset()

func (*StringValue) Size 

func (m *StringValue) Size() (n int)

func (*StringValue) String 

func (this *StringValue) String() string

func (*StringValue) Unmarshal 

func (m *StringValue) Unmarshal(dAtA []byte) error

func (*StringValue) XXX_DiscardUnknown 

func (m *StringValue) XXX_DiscardUnknown()

func (*StringValue) XXX_Marshal 

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

func (*StringValue) XXX_Merge 

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

func (*StringValue) XXX_MessageName 

func (*StringValue) XXX_MessageName() string

func (*StringValue) XXX_Size 

func (m *StringValue) XXX_Size() int

func (*StringValue) XXX_Unmarshal 

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

func (*StringValue) XXX_WellKnownType 

func (*StringValue) XXX_WellKnownType() string

type Struct 

type Struct struct {
	// Unordered map of dynamically typed values.
	Fields               map[string]*Value `` /* 153-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

`Struct` represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, `Struct` might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.

The JSON representation for `Struct` is JSON object.

func NewPopulatedStruct 

func NewPopulatedStruct(r randyStruct, easy bool) *Struct

func (*Struct) Descriptor 

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

func (*Struct) Equal 

func (this *Struct) Equal(that interface{}) bool

func (*Struct) GetFields 

func (m *Struct) GetFields() map[string]*Value

func (*Struct) GoString 

func (this *Struct) GoString() string

func (*Struct) Marshal 

func (m *Struct) Marshal() (dAtA []byte, err error)

func (*Struct) MarshalTo 

func (m *Struct) MarshalTo(dAtA []byte) (int, error)

func (*Struct) ProtoMessage 

func (*Struct) ProtoMessage()

func (*Struct) ProtoSize 

func (m *Struct) ProtoSize() (n int)

func (*Struct) Reset 

func (m *Struct) Reset()

func (*Struct) Size 

func (m *Struct) Size() (n int)

func (*Struct) String 

func (this *Struct) String() string

func (*Struct) Unmarshal 

func (m *Struct) Unmarshal(dAtA []byte) error

func (*Struct) XXX_DiscardUnknown 

func (m *Struct) XXX_DiscardUnknown()

func (*Struct) XXX_Marshal 

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

func (*Struct) XXX_Merge 

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

func (*Struct) XXX_MessageName 

func (*Struct) XXX_MessageName() string

func (*Struct) XXX_Size 

func (m *Struct) XXX_Size() int

func (*Struct) XXX_Unmarshal 

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

func (*Struct) XXX_WellKnownType 

func (*Struct) XXX_WellKnownType() string

type Syntax 

type Syntax int32

The syntax in which a protocol buffer element is defined. 

const (
	// Syntax `proto2`.
	Syntax_SYNTAX_PROTO2 Syntax = 0
	// Syntax `proto3`.
	Syntax_SYNTAX_PROTO3 Syntax = 1
)

func (Syntax) EnumDescriptor 

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

func (Syntax) String 

func (x Syntax) String() string

type Timestamp 

type Timestamp struct {
	// Represents seconds of UTC time since Unix epoch
	// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
	// 9999-12-31T23:59:59Z inclusive.
	Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`
	// Non-negative fractions of a second at nanosecond resolution. Negative
	// second values with fractions must still have non-negative nanos values
	// that count forward in time. Must be from 0 to 999,999,999
	// inclusive.
	Nanos                int32    `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear).

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

Examples

Example 1: Compute Timestamp from POSIX `time()`. 

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX `gettimeofday()`. 

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. 

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. 

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
    .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python. 

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format.

func NewPopulatedTimestamp 

func NewPopulatedTimestamp(r interface {
	Int63() int64
}, easy bool) *Timestamp

func TimestampNow 

func TimestampNow() *Timestamp

TimestampNow returns a google.protobuf.Timestamp for the current time.

func TimestampProto 

func TimestampProto(t time.Time) (*Timestamp, error)

TimestampProto converts the time.Time to a google.protobuf.Timestamp proto. It returns an error if the resulting Timestamp is invalid.

func (*Timestamp) Compare 

func (this *Timestamp) Compare(that interface{}) int

func (*Timestamp) Descriptor 

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

func (*Timestamp) Equal 

func (this *Timestamp) Equal(that interface{}) bool

func (*Timestamp) GetNanos 

func (m *Timestamp) GetNanos() int32

func (*Timestamp) GetSeconds 

func (m *Timestamp) GetSeconds() int64

func (*Timestamp) GoString 

func (this *Timestamp) GoString() string

func (*Timestamp) Marshal 

func (m *Timestamp) Marshal() (dAtA []byte, err error)

func (*Timestamp) MarshalTo 

func (m *Timestamp) MarshalTo(dAtA []byte) (int, error)

func (*Timestamp) ProtoMessage 

func (*Timestamp) ProtoMessage()

func (*Timestamp) ProtoSize 

func (m *Timestamp) ProtoSize() (n int)

func (*Timestamp) Reset 

func (m *Timestamp) Reset()

func (*Timestamp) Size 

func (m *Timestamp) Size() (n int)

func (*Timestamp) String 

func (ts *Timestamp) String() string

func (*Timestamp) Unmarshal 

func (m *Timestamp) Unmarshal(dAtA []byte) error

func (*Timestamp) XXX_DiscardUnknown 

func (m *Timestamp) XXX_DiscardUnknown()

func (*Timestamp) XXX_Marshal 

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

func (*Timestamp) XXX_Merge 

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

func (*Timestamp) XXX_MessageName 

func (*Timestamp) XXX_MessageName() string

func (*Timestamp) XXX_Size 

func (m *Timestamp) XXX_Size() int

func (*Timestamp) XXX_Unmarshal 

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

func (*Timestamp) XXX_WellKnownType 

func (*Timestamp) XXX_WellKnownType() string

type Type 

type Type struct {
	// The fully qualified message name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The list of fields.
	Fields []*Field `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
	// The list of types appearing in `oneof` definitions in this type.
	Oneofs []string `protobuf:"bytes,3,rep,name=oneofs,proto3" json:"oneofs,omitempty"`
	// The protocol buffer options.
	Options []*Option `protobuf:"bytes,4,rep,name=options,proto3" json:"options,omitempty"`
	// The source context.
	SourceContext *SourceContext `protobuf:"bytes,5,opt,name=source_context,json=sourceContext,proto3" json:"source_context,omitempty"`
	// The source syntax.
	Syntax               Syntax   `protobuf:"varint,6,opt,name=syntax,proto3,enum=google.protobuf.Syntax" json:"syntax,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A protocol buffer message type.

func NewPopulatedType 

func NewPopulatedType(r randyType, easy bool) *Type

func (*Type) Compare 

func (this *Type) Compare(that interface{}) int

func (*Type) Descriptor 

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

func (*Type) Equal 

func (this *Type) Equal(that interface{}) bool

func (*Type) GetFields 

func (m *Type) GetFields() []*Field

func (*Type) GetName 

func (m *Type) GetName() string

func (*Type) GetOneofs 

func (m *Type) GetOneofs() []string

func (*Type) GetOptions 

func (m *Type) GetOptions() []*Option

func (*Type) GetSourceContext 

func (m *Type) GetSourceContext() *SourceContext

func (*Type) GetSyntax 

func (m *Type) GetSyntax() Syntax

func (*Type) GoString 

func (this *Type) GoString() string

func (*Type) Marshal 

func (m *Type) Marshal() (dAtA []byte, err error)

func (*Type) MarshalTo 

func (m *Type) MarshalTo(dAtA []byte) (int, error)

func (*Type) ProtoMessage 

func (*Type) ProtoMessage()

func (*Type) ProtoSize 

func (m *Type) ProtoSize() (n int)

func (*Type) Reset 

func (m *Type) Reset()

func (*Type) Size 

func (m *Type) Size() (n int)

func (*Type) String 

func (this *Type) String() string

func (*Type) Unmarshal 

func (m *Type) Unmarshal(dAtA []byte) error

func (*Type) XXX_DiscardUnknown 

func (m *Type) XXX_DiscardUnknown()

func (*Type) XXX_Marshal 

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

func (*Type) XXX_Merge 

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

func (*Type) XXX_MessageName 

func (*Type) XXX_MessageName() string

func (*Type) XXX_Size 

func (m *Type) XXX_Size() int

func (*Type) XXX_Unmarshal 

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

type UInt32Value 

type UInt32Value struct {
	// The uint32 value.
	Value                uint32   `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `uint32`.

The JSON representation for `UInt32Value` is JSON number.

func NewPopulatedUInt32Value 

func NewPopulatedUInt32Value(r randyWrappers, easy bool) *UInt32Value

func (*UInt32Value) Compare 

func (this *UInt32Value) Compare(that interface{}) int

func (*UInt32Value) Descriptor 

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

func (*UInt32Value) Equal 

func (this *UInt32Value) Equal(that interface{}) bool

func (*UInt32Value) GetValue 

func (m *UInt32Value) GetValue() uint32

func (*UInt32Value) GoString 

func (this *UInt32Value) GoString() string

func (*UInt32Value) Marshal 

func (m *UInt32Value) Marshal() (dAtA []byte, err error)

func (*UInt32Value) MarshalTo 

func (m *UInt32Value) MarshalTo(dAtA []byte) (int, error)

func (*UInt32Value) ProtoMessage 

func (*UInt32Value) ProtoMessage()

func (*UInt32Value) ProtoSize 

func (m *UInt32Value) ProtoSize() (n int)

func (*UInt32Value) Reset 

func (m *UInt32Value) Reset()

func (*UInt32Value) Size 

func (m *UInt32Value) Size() (n int)

func (*UInt32Value) String 

func (this *UInt32Value) String() string

func (*UInt32Value) Unmarshal 

func (m *UInt32Value) Unmarshal(dAtA []byte) error

func (*UInt32Value) XXX_DiscardUnknown 

func (m *UInt32Value) XXX_DiscardUnknown()

func (*UInt32Value) XXX_Marshal 

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

func (*UInt32Value) XXX_Merge 

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

func (*UInt32Value) XXX_MessageName 

func (*UInt32Value) XXX_MessageName() string

func (*UInt32Value) XXX_Size 

func (m *UInt32Value) XXX_Size() int

func (*UInt32Value) XXX_Unmarshal 

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

func (*UInt32Value) XXX_WellKnownType 

func (*UInt32Value) XXX_WellKnownType() string

type UInt64Value 

type UInt64Value struct {
	// The uint64 value.
	Value                uint64   `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Wrapper message for `uint64`.

The JSON representation for `UInt64Value` is JSON string.

func NewPopulatedUInt64Value 

func NewPopulatedUInt64Value(r randyWrappers, easy bool) *UInt64Value

func (*UInt64Value) Compare 

func (this *UInt64Value) Compare(that interface{}) int

func (*UInt64Value) Descriptor 

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

func (*UInt64Value) Equal 

func (this *UInt64Value) Equal(that interface{}) bool

func (*UInt64Value) GetValue 

func (m *UInt64Value) GetValue() uint64

func (*UInt64Value) GoString 

func (this *UInt64Value) GoString() string

func (*UInt64Value) Marshal 

func (m *UInt64Value) Marshal() (dAtA []byte, err error)

func (*UInt64Value) MarshalTo 

func (m *UInt64Value) MarshalTo(dAtA []byte) (int, error)

func (*UInt64Value) ProtoMessage 

func (*UInt64Value) ProtoMessage()

func (*UInt64Value) ProtoSize 

func (m *UInt64Value) ProtoSize() (n int)

func (*UInt64Value) Reset 

func (m *UInt64Value) Reset()

func (*UInt64Value) Size 

func (m *UInt64Value) Size() (n int)

func (*UInt64Value) String 

func (this *UInt64Value) String() string

func (*UInt64Value) Unmarshal 

func (m *UInt64Value) Unmarshal(dAtA []byte) error

func (*UInt64Value) XXX_DiscardUnknown 

func (m *UInt64Value) XXX_DiscardUnknown()

func (*UInt64Value) XXX_Marshal 

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

func (*UInt64Value) XXX_Merge 

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

func (*UInt64Value) XXX_MessageName 

func (*UInt64Value) XXX_MessageName() string

func (*UInt64Value) XXX_Size 

func (m *UInt64Value) XXX_Size() int

func (*UInt64Value) XXX_Unmarshal 

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

func (*UInt64Value) XXX_WellKnownType 

func (*UInt64Value) XXX_WellKnownType() string

type Value 

type Value struct {
	// The kind of value.
	//
	// Types that are valid to be assigned to Kind:
	//	*Value_NullValue
	//	*Value_NumberValue
	//	*Value_StringValue
	//	*Value_BoolValue
	//	*Value_StructValue
	//	*Value_ListValue
	Kind                 isValue_Kind `protobuf_oneof:"kind"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of that variants, absence of any variant indicates an error.

The JSON representation for `Value` is JSON value.

func NewPopulatedValue 

func NewPopulatedValue(r randyStruct, easy bool) *Value

func (*Value) Descriptor 

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

func (*Value) Equal 

func (this *Value) Equal(that interface{}) bool

func (*Value) GetBoolValue 

func (m *Value) GetBoolValue() bool

func (*Value) GetKind 

func (m *Value) GetKind() isValue_Kind

func (*Value) GetListValue 

func (m *Value) GetListValue() *ListValue

func (*Value) GetNullValue 

func (m *Value) GetNullValue() NullValue

func (*Value) GetNumberValue 

func (m *Value) GetNumberValue() float64

func (*Value) GetStringValue 

func (m *Value) GetStringValue() string

func (*Value) GetStructValue 

func (m *Value) GetStructValue() *Struct

func (*Value) GoString 

func (this *Value) GoString() string

func (*Value) Marshal 

func (m *Value) Marshal() (dAtA []byte, err error)

func (*Value) MarshalTo 

func (m *Value) MarshalTo(dAtA []byte) (int, error)

func (*Value) ProtoMessage 

func (*Value) ProtoMessage()

func (*Value) ProtoSize 

func (m *Value) ProtoSize() (n int)

func (*Value) Reset 

func (m *Value) Reset()

func (*Value) Size 

func (m *Value) Size() (n int)

func (*Value) String 

func (this *Value) String() string

func (*Value) Unmarshal 

func (m *Value) Unmarshal(dAtA []byte) error

func (*Value) XXX_DiscardUnknown 

func (m *Value) XXX_DiscardUnknown()

func (*Value) XXX_Marshal 

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

func (*Value) XXX_Merge 

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

func (*Value) XXX_MessageName 

func (*Value) XXX_MessageName() string

func (*Value) XXX_OneofFuncs 

func (*Value) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*Value) XXX_Size 

func (m *Value) XXX_Size() int

func (*Value) XXX_Unmarshal 

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

func (*Value) XXX_WellKnownType 

func (*Value) XXX_WellKnownType() string

type Value_BoolValue 

type Value_BoolValue struct {
	BoolValue bool `protobuf:"varint,4,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

func NewPopulatedValue_BoolValue 

func NewPopulatedValue_BoolValue(r randyStruct, easy bool) *Value_BoolValue

func (*Value_BoolValue) Equal 

func (this *Value_BoolValue) Equal(that interface{}) bool

func (*Value_BoolValue) GoString 

func (this *Value_BoolValue) GoString() string

func (*Value_BoolValue) MarshalTo 

func (m *Value_BoolValue) MarshalTo(dAtA []byte) (int, error)

func (*Value_BoolValue) ProtoSize 

func (m *Value_BoolValue) ProtoSize() (n int)

func (*Value_BoolValue) Size 

func (m *Value_BoolValue) Size() (n int)

func (*Value_BoolValue) String 

func (this *Value_BoolValue) String() string

type Value_ListValue 

type Value_ListValue struct {
	ListValue *ListValue `protobuf:"bytes,6,opt,name=list_value,json=listValue,proto3,oneof"`
}

func NewPopulatedValue_ListValue 

func NewPopulatedValue_ListValue(r randyStruct, easy bool) *Value_ListValue

func (*Value_ListValue) Equal 

func (this *Value_ListValue) Equal(that interface{}) bool

func (*Value_ListValue) GoString 

func (this *Value_ListValue) GoString() string

func (*Value_ListValue) MarshalTo 

func (m *Value_ListValue) MarshalTo(dAtA []byte) (int, error)

func (*Value_ListValue) ProtoSize 

func (m *Value_ListValue) ProtoSize() (n int)

func (*Value_ListValue) Size 

func (m *Value_ListValue) Size() (n int)

func (*Value_ListValue) String 

func (this *Value_ListValue) String() string

type Value_NullValue 

type Value_NullValue struct {
	NullValue NullValue `protobuf:"varint,1,opt,name=null_value,json=nullValue,proto3,enum=google.protobuf.NullValue,oneof"`
}

func NewPopulatedValue_NullValue 

func NewPopulatedValue_NullValue(r randyStruct, easy bool) *Value_NullValue

func (*Value_NullValue) Equal 

func (this *Value_NullValue) Equal(that interface{}) bool

func (*Value_NullValue) GoString 

func (this *Value_NullValue) GoString() string

func (*Value_NullValue) MarshalTo 

func (m *Value_NullValue) MarshalTo(dAtA []byte) (int, error)

func (*Value_NullValue) ProtoSize 

func (m *Value_NullValue) ProtoSize() (n int)

func (*Value_NullValue) Size 

func (m *Value_NullValue) Size() (n int)

func (*Value_NullValue) String 

func (this *Value_NullValue) String() string

type Value_NumberValue 

type Value_NumberValue struct {
	NumberValue float64 `protobuf:"fixed64,2,opt,name=number_value,json=numberValue,proto3,oneof"`
}

func NewPopulatedValue_NumberValue 

func NewPopulatedValue_NumberValue(r randyStruct, easy bool) *Value_NumberValue

func (*Value_NumberValue) Equal 

func (this *Value_NumberValue) Equal(that interface{}) bool

func (*Value_NumberValue) GoString 

func (this *Value_NumberValue) GoString() string

func (*Value_NumberValue) MarshalTo 

func (m *Value_NumberValue) MarshalTo(dAtA []byte) (int, error)

func (*Value_NumberValue) ProtoSize 

func (m *Value_NumberValue) ProtoSize() (n int)

func (*Value_NumberValue) Size 

func (m *Value_NumberValue) Size() (n int)

func (*Value_NumberValue) String 

func (this *Value_NumberValue) String() string

type Value_StringValue 

type Value_StringValue struct {
	StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}

func NewPopulatedValue_StringValue 

func NewPopulatedValue_StringValue(r randyStruct, easy bool) *Value_StringValue

func (*Value_StringValue) Equal 

func (this *Value_StringValue) Equal(that interface{}) bool

func (*Value_StringValue) GoString 

func (this *Value_StringValue) GoString() string

func (*Value_StringValue) MarshalTo 

func (m *Value_StringValue) MarshalTo(dAtA []byte) (int, error)

func (*Value_StringValue) ProtoSize 

func (m *Value_StringValue) ProtoSize() (n int)

func (*Value_StringValue) Size 

func (m *Value_StringValue) Size() (n int)

func (*Value_StringValue) String 

func (this *Value_StringValue) String() string

type Value_StructValue 

type Value_StructValue struct {
	StructValue *Struct `protobuf:"bytes,5,opt,name=struct_value,json=structValue,proto3,oneof"`
}

func NewPopulatedValue_StructValue 

func NewPopulatedValue_StructValue(r randyStruct, easy bool) *Value_StructValue

func (*Value_StructValue) Equal 

func (this *Value_StructValue) Equal(that interface{}) bool

func (*Value_StructValue) GoString 

func (this *Value_StructValue) GoString() string

func (*Value_StructValue) MarshalTo 

func (m *Value_StructValue) MarshalTo(dAtA []byte) (int, error)

func (*Value_StructValue) ProtoSize 

func (m *Value_StructValue) ProtoSize() (n int)

func (*Value_StructValue) Size 

func (m *Value_StructValue) Size() (n int)

func (*Value_StructValue) String 

func (this *Value_StructValue) 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.