known_proto

package
v2.0.0-...-d24bc72 Latest Latest
Warning

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

 Go to latest Published: Apr 20, 2019 License: BSD-3-Clause Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Field_Cardinality_name = map[int32]string{
	0: "CARDINALITY_UNKNOWN",
	1: "CARDINALITY_OPTIONAL",
	2: "CARDINALITY_REQUIRED",
	3: "CARDINALITY_REPEATED",
}

Deprecated: Use Field_Cardinality.Type.Values instead.

View Source 
var Field_Cardinality_value = map[string]int32{
	"CARDINALITY_UNKNOWN":  0,
	"CARDINALITY_OPTIONAL": 1,
	"CARDINALITY_REQUIRED": 2,
	"CARDINALITY_REPEATED": 3,
}

Deprecated: Use Field_Cardinality.Type.Values instead.

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

Deprecated: Use Field_Kind.Type.Values instead.

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,
}

Deprecated: Use Field_Kind.Type.Values instead.

View Source 
var File_google_protobuf_any_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_api_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_duration_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_empty_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_field_mask_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_source_context_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_struct_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_timestamp_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_type_proto protoreflect.FileDescriptor
View Source 
var File_google_protobuf_wrappers_proto protoreflect.FileDescriptor
View Source 
var NullValue_name = map[int32]string{
	0: "NULL_VALUE",
}

Deprecated: Use NullValue.Type.Values instead.

View Source 
var NullValue_value = map[string]int32{
	"NULL_VALUE": 0,
}

Deprecated: Use NullValue.Type.Values instead.

View Source 
var Syntax_name = map[int32]string{
	0: "SYNTAX_PROTO2",
	1: "SYNTAX_PROTO3",
}

Deprecated: Use Syntax.Type.Values instead.

View Source 
var Syntax_value = map[string]int32{
	"SYNTAX_PROTO2": 0,
	"SYNTAX_PROTO3": 1,
}

Deprecated: Use Syntax.Type.Values instead.

Functions

This section is empty.

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Any) Descriptor deprecated 

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

Deprecated: Use Any.ProtoReflect.Type instead.

func (*Any) GetTypeUrl 

func (x *Any) GetTypeUrl() string

func (*Any) GetValue 

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

func (*Any) ProtoMessage 

func (*Any) ProtoMessage()

func (*Any) ProtoReflect 

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

func (*Any) Reset 

func (x *Any) Reset()

func (*Any) String 

func (x *Any) String() string

func (*Any) XXX_Methods 

func (m *Any) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Api) Descriptor deprecated 

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

Deprecated: Use Api.ProtoReflect.Type instead.

func (*Api) GetMethods 

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

func (*Api) GetMixins 

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

func (*Api) GetName 

func (x *Api) GetName() string

func (*Api) GetOptions 

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

func (*Api) GetSourceContext 

func (x *Api) GetSourceContext() *SourceContext

func (*Api) GetSyntax 

func (x *Api) GetSyntax() Syntax

func (*Api) GetVersion 

func (x *Api) GetVersion() string

func (*Api) ProtoMessage 

func (*Api) ProtoMessage()

func (*Api) ProtoReflect 

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

func (*Api) Reset 

func (x *Api) Reset()

func (*Api) String 

func (x *Api) String() string

func (*Api) XXX_Methods 

func (m *Api) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `bool`.

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

func (*BoolValue) Descriptor deprecated 

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

Deprecated: Use BoolValue.ProtoReflect.Type instead.

func (*BoolValue) GetValue 

func (x *BoolValue) GetValue() bool

func (*BoolValue) ProtoMessage 

func (*BoolValue) ProtoMessage()

func (*BoolValue) ProtoReflect 

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

func (*BoolValue) Reset 

func (x *BoolValue) Reset()

func (*BoolValue) String 

func (x *BoolValue) String() string

func (*BoolValue) XXX_Methods 

func (m *BoolValue) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `bytes`.

The JSON representation for `BytesValue` is JSON string.

func (*BytesValue) Descriptor deprecated 

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

Deprecated: Use BytesValue.ProtoReflect.Type instead.

func (*BytesValue) GetValue 

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

func (*BytesValue) ProtoMessage 

func (*BytesValue) ProtoMessage()

func (*BytesValue) ProtoReflect 

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

func (*BytesValue) Reset 

func (x *BytesValue) Reset()

func (*BytesValue) String 

func (x *BytesValue) String() string

func (*BytesValue) XXX_Methods 

func (m *BytesValue) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `double`.

The JSON representation for `DoubleValue` is JSON number.

func (*DoubleValue) Descriptor deprecated 

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

Deprecated: Use DoubleValue.ProtoReflect.Type instead.

func (*DoubleValue) GetValue 

func (x *DoubleValue) GetValue() float64

func (*DoubleValue) ProtoMessage 

func (*DoubleValue) ProtoMessage()

func (*DoubleValue) ProtoReflect 

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

func (*DoubleValue) Reset 

func (x *DoubleValue) Reset()

func (*DoubleValue) String 

func (x *DoubleValue) String() string

func (*DoubleValue) XXX_Methods 

func (m *DoubleValue) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Duration) Descriptor deprecated 

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

Deprecated: Use Duration.ProtoReflect.Type instead.

func (*Duration) GetNanos 

func (x *Duration) GetNanos() int32

func (*Duration) GetSeconds 

func (x *Duration) GetSeconds() int64

func (*Duration) ProtoMessage 

func (*Duration) ProtoMessage()

func (*Duration) ProtoReflect 

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

func (*Duration) Reset 

func (x *Duration) Reset()

func (*Duration) String 

func (x *Duration) String() string

func (*Duration) XXX_Methods 

func (m *Duration) XXX_Methods() *protoiface.Methods

func (*Duration) XXX_WellKnownType 

func (*Duration) XXX_WellKnownType() string

type Empty 

type Empty struct {
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Empty) Descriptor deprecated 

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

Deprecated: Use Empty.ProtoReflect.Type instead.

func (*Empty) ProtoMessage 

func (*Empty) ProtoMessage()

func (*Empty) ProtoReflect 

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

func (*Empty) Reset 

func (x *Empty) Reset()

func (*Empty) String 

func (x *Empty) String() string

func (*Empty) XXX_Methods 

func (m *Empty) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Enum type definition.

func (*Enum) Descriptor deprecated 

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

Deprecated: Use Enum.ProtoReflect.Type instead.

func (*Enum) GetEnumvalue 

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

func (*Enum) GetName 

func (x *Enum) GetName() string

func (*Enum) GetOptions 

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

func (*Enum) GetSourceContext 

func (x *Enum) GetSourceContext() *SourceContext

func (*Enum) GetSyntax 

func (x *Enum) GetSyntax() Syntax

func (*Enum) ProtoMessage 

func (*Enum) ProtoMessage()

func (*Enum) ProtoReflect 

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

func (*Enum) Reset 

func (x *Enum) Reset()

func (*Enum) String 

func (x *Enum) String() string

func (*Enum) XXX_Methods 

func (m *Enum) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Enum value definition.

func (*EnumValue) Descriptor deprecated 

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

Deprecated: Use EnumValue.ProtoReflect.Type instead.

func (*EnumValue) GetName 

func (x *EnumValue) GetName() string

func (*EnumValue) GetNumber 

func (x *EnumValue) GetNumber() int32

func (*EnumValue) GetOptions 

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

func (*EnumValue) ProtoMessage 

func (*EnumValue) ProtoMessage()

func (*EnumValue) ProtoReflect 

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

func (*EnumValue) Reset 

func (x *EnumValue) Reset()

func (*EnumValue) String 

func (x *EnumValue) String() string

func (*EnumValue) XXX_Methods 

func (m *EnumValue) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

A single field of a message type.

func (*Field) Descriptor deprecated 

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

Deprecated: Use Field.ProtoReflect.Type instead.

func (*Field) GetCardinality 

func (x *Field) GetCardinality() Field_Cardinality

func (*Field) GetDefaultValue 

func (x *Field) GetDefaultValue() string

func (*Field) GetJsonName 

func (x *Field) GetJsonName() string

func (*Field) GetKind 

func (x *Field) GetKind() Field_Kind

func (*Field) GetName 

func (x *Field) GetName() string

func (*Field) GetNumber 

func (x *Field) GetNumber() int32

func (*Field) GetOneofIndex 

func (x *Field) GetOneofIndex() int32

func (*Field) GetOptions 

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

func (*Field) GetPacked 

func (x *Field) GetPacked() bool

func (*Field) GetTypeUrl 

func (x *Field) GetTypeUrl() string

func (*Field) ProtoMessage 

func (*Field) ProtoMessage()

func (*Field) ProtoReflect 

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

func (*Field) Reset 

func (x *Field) Reset()

func (*Field) String 

func (x *Field) String() string

func (*Field) XXX_Methods 

func (m *Field) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*FieldMask) Descriptor deprecated 

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

Deprecated: Use FieldMask.ProtoReflect.Type instead.

func (*FieldMask) GetPaths 

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

func (*FieldMask) ProtoMessage 

func (*FieldMask) ProtoMessage()

func (*FieldMask) ProtoReflect 

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

func (*FieldMask) Reset 

func (x *FieldMask) Reset()

func (*FieldMask) String 

func (x *FieldMask) String() string

func (*FieldMask) XXX_Methods 

func (m *FieldMask) XXX_Methods() *protoiface.Methods

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 deprecated 

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

Deprecated: Use Field_Cardinality.Type instead.

func (Field_Cardinality) Number 

func (x Field_Cardinality) Number() protoreflect.EnumNumber

func (Field_Cardinality) String 

func (x Field_Cardinality) String() string

func (Field_Cardinality) Type 

func (Field_Cardinality) Type() protoreflect.EnumType

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 deprecated 

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

Deprecated: Use Field_Kind.Type instead.

func (Field_Kind) Number 

func (x Field_Kind) Number() protoreflect.EnumNumber

func (Field_Kind) String 

func (x Field_Kind) String() string

func (Field_Kind) Type 

func (Field_Kind) Type() protoreflect.EnumType

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `float`.

The JSON representation for `FloatValue` is JSON number.

func (*FloatValue) Descriptor deprecated 

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

Deprecated: Use FloatValue.ProtoReflect.Type instead.

func (*FloatValue) GetValue 

func (x *FloatValue) GetValue() float32

func (*FloatValue) ProtoMessage 

func (*FloatValue) ProtoMessage()

func (*FloatValue) ProtoReflect 

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

func (*FloatValue) Reset 

func (x *FloatValue) Reset()

func (*FloatValue) String 

func (x *FloatValue) String() string

func (*FloatValue) XXX_Methods 

func (m *FloatValue) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `int32`.

The JSON representation for `Int32Value` is JSON number.

func (*Int32Value) Descriptor deprecated 

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

Deprecated: Use Int32Value.ProtoReflect.Type instead.

func (*Int32Value) GetValue 

func (x *Int32Value) GetValue() int32

func (*Int32Value) ProtoMessage 

func (*Int32Value) ProtoMessage()

func (*Int32Value) ProtoReflect 

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

func (*Int32Value) Reset 

func (x *Int32Value) Reset()

func (*Int32Value) String 

func (x *Int32Value) String() string

func (*Int32Value) XXX_Methods 

func (m *Int32Value) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `int64`.

The JSON representation for `Int64Value` is JSON string.

func (*Int64Value) Descriptor deprecated 

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

Deprecated: Use Int64Value.ProtoReflect.Type instead.

func (*Int64Value) GetValue 

func (x *Int64Value) GetValue() int64

func (*Int64Value) ProtoMessage 

func (*Int64Value) ProtoMessage()

func (*Int64Value) ProtoReflect 

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

func (*Int64Value) Reset 

func (x *Int64Value) Reset()

func (*Int64Value) String 

func (x *Int64Value) String() string

func (*Int64Value) XXX_Methods 

func (m *Int64Value) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

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

The JSON representation for `ListValue` is JSON array.

func (*ListValue) Descriptor deprecated 

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

Deprecated: Use ListValue.ProtoReflect.Type instead.

func (*ListValue) GetValues 

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

func (*ListValue) ProtoMessage 

func (*ListValue) ProtoMessage()

func (*ListValue) ProtoReflect 

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

func (*ListValue) Reset 

func (x *ListValue) Reset()

func (*ListValue) String 

func (x *ListValue) String() string

func (*ListValue) XXX_Methods 

func (m *ListValue) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Method represents a method of an API interface.

func (*Method) Descriptor deprecated 

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

Deprecated: Use Method.ProtoReflect.Type instead.

func (*Method) GetName 

func (x *Method) GetName() string

func (*Method) GetOptions 

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

func (*Method) GetRequestStreaming 

func (x *Method) GetRequestStreaming() bool

func (*Method) GetRequestTypeUrl 

func (x *Method) GetRequestTypeUrl() string

func (*Method) GetResponseStreaming 

func (x *Method) GetResponseStreaming() bool

func (*Method) GetResponseTypeUrl 

func (x *Method) GetResponseTypeUrl() string

func (*Method) GetSyntax 

func (x *Method) GetSyntax() Syntax

func (*Method) ProtoMessage 

func (*Method) ProtoMessage()

func (*Method) ProtoReflect 

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

func (*Method) Reset 

func (x *Method) Reset()

func (*Method) String 

func (x *Method) String() string

func (*Method) XXX_Methods 

func (m *Method) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Mixin) Descriptor deprecated 

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

Deprecated: Use Mixin.ProtoReflect.Type instead.

func (*Mixin) GetName 

func (x *Mixin) GetName() string

func (*Mixin) GetRoot 

func (x *Mixin) GetRoot() string

func (*Mixin) ProtoMessage 

func (*Mixin) ProtoMessage()

func (*Mixin) ProtoReflect 

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

func (*Mixin) Reset 

func (x *Mixin) Reset()

func (*Mixin) String 

func (x *Mixin) String() string

func (*Mixin) XXX_Methods 

func (m *Mixin) XXX_Methods() *protoiface.Methods

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 deprecated 

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

Deprecated: Use NullValue.Type instead.

func (NullValue) Number 

func (x NullValue) Number() protoreflect.EnumNumber

func (NullValue) String 

func (x NullValue) String() string

func (NullValue) Type 

func (NullValue) Type() protoreflect.EnumType

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

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

func (*Option) Descriptor deprecated 

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

Deprecated: Use Option.ProtoReflect.Type instead.

func (*Option) GetName 

func (x *Option) GetName() string

func (*Option) GetValue 

func (x *Option) GetValue() *Any

func (*Option) ProtoMessage 

func (*Option) ProtoMessage()

func (*Option) ProtoReflect 

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

func (*Option) Reset 

func (x *Option) Reset()

func (*Option) String 

func (x *Option) String() string

func (*Option) XXX_Methods 

func (m *Option) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

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

func (*SourceContext) Descriptor deprecated 

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

Deprecated: Use SourceContext.ProtoReflect.Type instead.

func (*SourceContext) GetFileName 

func (x *SourceContext) GetFileName() string

func (*SourceContext) ProtoMessage 

func (*SourceContext) ProtoMessage()

func (*SourceContext) ProtoReflect 

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

func (*SourceContext) Reset 

func (x *SourceContext) Reset()

func (*SourceContext) String 

func (x *SourceContext) String() string

func (*SourceContext) XXX_Methods 

func (m *SourceContext) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `string`.

The JSON representation for `StringValue` is JSON string.

func (*StringValue) Descriptor deprecated 

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

Deprecated: Use StringValue.ProtoReflect.Type instead.

func (*StringValue) GetValue 

func (x *StringValue) GetValue() string

func (*StringValue) ProtoMessage 

func (*StringValue) ProtoMessage()

func (*StringValue) ProtoReflect 

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

func (*StringValue) Reset 

func (x *StringValue) Reset()

func (*StringValue) String 

func (x *StringValue) String() string

func (*StringValue) XXX_Methods 

func (m *StringValue) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Struct) Descriptor deprecated 

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

Deprecated: Use Struct.ProtoReflect.Type instead.

func (*Struct) GetFields 

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

func (*Struct) ProtoMessage 

func (*Struct) ProtoMessage()

func (*Struct) ProtoReflect 

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

func (*Struct) Reset 

func (x *Struct) Reset()

func (*Struct) String 

func (x *Struct) String() string

func (*Struct) XXX_Methods 

func (m *Struct) XXX_Methods() *protoiface.Methods

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 deprecated 

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

Deprecated: Use Syntax.Type instead.

func (Syntax) Number 

func (x Syntax) Number() protoreflect.EnumNumber

func (Syntax) String 

func (x Syntax) String() string

func (Syntax) Type 

func (Syntax) Type() protoreflect.EnumType

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Timestamp) Descriptor deprecated 

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

Deprecated: Use Timestamp.ProtoReflect.Type instead.

func (*Timestamp) GetNanos 

func (x *Timestamp) GetNanos() int32

func (*Timestamp) GetSeconds 

func (x *Timestamp) GetSeconds() int64

func (*Timestamp) ProtoMessage 

func (*Timestamp) ProtoMessage()

func (*Timestamp) ProtoReflect 

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

func (*Timestamp) Reset 

func (x *Timestamp) Reset()

func (*Timestamp) String 

func (x *Timestamp) String() string

func (*Timestamp) XXX_Methods 

func (m *Timestamp) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

A protocol buffer message type.

func (*Type) Descriptor deprecated 

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

Deprecated: Use Type.ProtoReflect.Type instead.

func (*Type) GetFields 

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

func (*Type) GetName 

func (x *Type) GetName() string

func (*Type) GetOneofs 

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

func (*Type) GetOptions 

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

func (*Type) GetSourceContext 

func (x *Type) GetSourceContext() *SourceContext

func (*Type) GetSyntax 

func (x *Type) GetSyntax() Syntax

func (*Type) ProtoMessage 

func (*Type) ProtoMessage()

func (*Type) ProtoReflect 

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

func (*Type) Reset 

func (x *Type) Reset()

func (*Type) String 

func (x *Type) String() string

func (*Type) XXX_Methods 

func (m *Type) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `uint32`.

The JSON representation for `UInt32Value` is JSON number.

func (*UInt32Value) Descriptor deprecated 

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

Deprecated: Use UInt32Value.ProtoReflect.Type instead.

func (*UInt32Value) GetValue 

func (x *UInt32Value) GetValue() uint32

func (*UInt32Value) ProtoMessage 

func (*UInt32Value) ProtoMessage()

func (*UInt32Value) ProtoReflect 

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

func (*UInt32Value) Reset 

func (x *UInt32Value) Reset()

func (*UInt32Value) String 

func (x *UInt32Value) String() string

func (*UInt32Value) XXX_Methods 

func (m *UInt32Value) XXX_Methods() *protoiface.Methods

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     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `json:"-"`
}

Wrapper message for `uint64`.

The JSON representation for `UInt64Value` is JSON string.

func (*UInt64Value) Descriptor deprecated 

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

Deprecated: Use UInt64Value.ProtoReflect.Type instead.

func (*UInt64Value) GetValue 

func (x *UInt64Value) GetValue() uint64

func (*UInt64Value) ProtoMessage 

func (*UInt64Value) ProtoMessage()

func (*UInt64Value) ProtoReflect 

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

func (*UInt64Value) Reset 

func (x *UInt64Value) Reset()

func (*UInt64Value) String 

func (x *UInt64Value) String() string

func (*UInt64Value) XXX_Methods 

func (m *UInt64Value) XXX_Methods() *protoiface.Methods

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:
	// Represents a null value.
	//	*Value_NullValue
	// Represents a double value.
	//	*Value_NumberValue
	// Represents a string value.
	//	*Value_StringValue
	// Represents a boolean value.
	//	*Value_BoolValue
	// Represents a structured value.
	//	*Value_StructValue
	// Represents a repeated `Value`.
	//	*Value_ListValue
	Kind                 isValue_Kind            `protobuf_oneof:"kind"`
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     protoimpl.UnknownFields `json:"-"`
	XXX_sizecache        protoimpl.SizeCache     `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 (*Value) Descriptor deprecated 

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

Deprecated: Use Value.ProtoReflect.Type instead.

func (*Value) GetBoolValue 

func (x *Value) GetBoolValue() bool

func (*Value) GetKind 

func (m *Value) GetKind() isValue_Kind

func (*Value) GetListValue 

func (x *Value) GetListValue() *ListValue

func (*Value) GetNullValue 

func (x *Value) GetNullValue() NullValue

func (*Value) GetNumberValue 

func (x *Value) GetNumberValue() float64

func (*Value) GetStringValue 

func (x *Value) GetStringValue() string

func (*Value) GetStructValue 

func (x *Value) GetStructValue() *Struct

func (*Value) ProtoMessage 

func (*Value) ProtoMessage()

func (*Value) ProtoReflect 

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

func (*Value) Reset 

func (x *Value) Reset()

func (*Value) String 

func (x *Value) String() string

func (*Value) XXX_Methods 

func (m *Value) XXX_Methods() *protoiface.Methods

func (*Value) XXX_OneofWrappers 

func (*Value) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

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

type Value_ListValue 

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

type Value_NullValue 

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

type Value_NumberValue 

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

type Value_StringValue 

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

type Value_StructValue 

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

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.