1 // Code generated by protoc-gen-go. DO NOT EDIT.
2 // source: google/protobuf/field_mask.proto
5 Package field_mask is a generated protocol buffer package.
7 It is generated from these files:
8 google/protobuf/field_mask.proto
10 It has these top-level messages:
15 import proto "github.com/golang/protobuf/proto"
19 // Reference imports to suppress errors if they are not otherwise used.
24 // This is a compile-time assertion to ensure that this generated file
25 // is compatible with the proto package it is being compiled against.
26 // A compilation error at this line likely means your copy of the
27 // proto package needs to be updated.
28 const _ = proto.ProtoPackageIsVersion2 // please upgrade the proto package
30 // `FieldMask` represents a set of symbolic field paths, for example:
35 // Here `f` represents a field in some root message, `a` and `b`
36 // fields in the message found in `f`, and `d` a field found in the
39 // Field masks are used to specify a subset of fields that should be
40 // returned by a get operation or modified by an update operation.
41 // Field masks also have a custom JSON encoding (see below).
43 // # Field Masks in Projections
45 // When used in the context of a projection, a response message or
46 // sub-message is filtered by the API to only contain those fields as
47 // specified in the mask. For example, if the mask in the previous
48 // example is applied to a response message as follows:
60 // The result will not contain specific values for fields x,y and z
61 // (their value will be set to the default, and omitted in proto text
72 // A repeated field is not allowed except at the last position of a
75 // If a FieldMask object is not present in a get operation, the
76 // operation applies to all fields (as if a FieldMask of all fields
77 // had been specified).
79 // Note that a field mask does not necessarily apply to the
80 // top-level response message. In case of a REST get operation, the
81 // field mask applies directly to the response, but in case of a REST
82 // list operation, the mask instead applies to each individual message
83 // in the returned resource list. In case of a REST custom method,
84 // other definitions may be used. Where the mask applies will be
85 // clearly documented together with its declaration in the API. In
86 // any case, the effect on the returned resource/resources is required
89 // # Field Masks in Update Operations
91 // A field mask in update operations specifies which fields of the
92 // targeted resource are going to be updated. The API is required
93 // to only change the values of the fields as specified in the mask
94 // and leave the others untouched. If a resource is passed in to
95 // describe the updated values, the API ignores the values of all
96 // fields not covered by the mask.
98 // If a repeated field is specified for an update operation, the existing
99 // repeated values in the target resource will be overwritten by the new values.
100 // Note that a repeated field is only allowed in the last position of a `paths`
103 // If a sub-message is specified in the last position of the field mask for an
104 // update operation, then the existing sub-message in the target resource is
105 // overwritten. Given the target message:
115 // And an update message:
123 // then if the field mask is:
127 // then the result will be:
136 // However, if the update mask was:
140 // then the result would be:
150 // In order to reset a field's value to the default, the field must
151 // be in the mask and set to the default value in the provided resource.
152 // Hence, in order to reset all fields of a resource, provide a default
153 // instance of the resource and set all fields in the mask, or do
154 // not provide a mask as described below.
156 // If a field mask is not present on update, the operation applies to
157 // all fields (as if a field mask of all fields has been specified).
158 // Note that in the presence of schema evolution, this may mean that
159 // fields the client does not know and has therefore not filled into
160 // the request will be reset to their default. If this is unwanted
161 // behavior, a specific service may require a client to always specify
162 // a field mask, producing an error if not.
164 // As with get operations, the location of the resource which
165 // describes the updated values in the request message depends on the
166 // operation kind. In any case, the effect of the field mask is
167 // required to be honored by the API.
169 // ## Considerations for HTTP REST
171 // The HTTP kind of an update operation which uses a field mask must
172 // be set to PATCH instead of PUT in order to satisfy HTTP semantics
173 // (PUT must only be used for full updates).
175 // # JSON Encoding of Field Masks
177 // In JSON, a field mask is encoded as a single string where paths are
178 // separated by a comma. Fields name in each path are converted
179 // to/from lower-camel naming conventions.
181 // As an example, consider the following message declarations:
188 // string display_name = 1;
189 // string address = 2;
192 // In proto a field mask for `Profile` may look as such:
195 // paths: "user.display_name"
199 // In JSON, the same mask is represented as below:
202 // mask: "user.displayName,photo"
205 // # Field Masks and Oneof Fields
207 // Field masks treat fields in oneofs just as regular fields. Consider the
208 // following message:
210 // message SampleMessage {
211 // oneof test_oneof {
213 // SubMessage sub_message = 9;
217 // The field mask can be:
226 // paths: "sub_message"
229 // Note that oneof type names ("test_oneof" in this case) cannot be used in
231 type FieldMask struct {
232 // The set of field mask paths.
233 Paths []string `protobuf:"bytes,1,rep,name=paths" json:"paths,omitempty"`
236 func (m *FieldMask) Reset() { *m = FieldMask{} }
237 func (m *FieldMask) String() string { return proto.CompactTextString(m) }
238 func (*FieldMask) ProtoMessage() {}
239 func (*FieldMask) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{0} }
241 func (m *FieldMask) GetPaths() []string {
249 proto.RegisterType((*FieldMask)(nil), "google.protobuf.FieldMask")
252 func init() { proto.RegisterFile("google/protobuf/field_mask.proto", fileDescriptor0) }
254 var fileDescriptor0 = []byte{
255 // 171 bytes of a gzipped FileDescriptorProto
256 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xe2, 0x52, 0x48, 0xcf, 0xcf, 0x4f,
257 0xcf, 0x49, 0xd5, 0x2f, 0x28, 0xca, 0x2f, 0xc9, 0x4f, 0x2a, 0x4d, 0xd3, 0x4f, 0xcb, 0x4c, 0xcd,
258 0x49, 0x89, 0xcf, 0x4d, 0x2c, 0xce, 0xd6, 0x03, 0x8b, 0x09, 0xf1, 0x43, 0x54, 0xe8, 0xc1, 0x54,
259 0x28, 0x29, 0x72, 0x71, 0xba, 0x81, 0x14, 0xf9, 0x26, 0x16, 0x67, 0x0b, 0x89, 0x70, 0xb1, 0x16,
260 0x24, 0x96, 0x64, 0x14, 0x4b, 0x30, 0x2a, 0x30, 0x6b, 0x70, 0x06, 0x41, 0x38, 0x4e, 0x9d, 0x8c,
261 0x5c, 0xc2, 0xc9, 0xf9, 0xb9, 0x7a, 0x68, 0x5a, 0x9d, 0xf8, 0xe0, 0x1a, 0x03, 0x40, 0x42, 0x01,
262 0x8c, 0x51, 0x96, 0x50, 0x25, 0xe9, 0xf9, 0x39, 0x89, 0x79, 0xe9, 0x7a, 0xf9, 0x45, 0xe9, 0xfa,
263 0xe9, 0xa9, 0x79, 0x60, 0x0d, 0xd8, 0xdc, 0x64, 0x8d, 0x60, 0x2e, 0x62, 0x62, 0x76, 0x0f, 0x70,
264 0x5a, 0xc5, 0x24, 0xe7, 0x0e, 0x31, 0x21, 0x00, 0xaa, 0x5a, 0x2f, 0x3c, 0x35, 0x27, 0xc7, 0x3b,
265 0x2f, 0xbf, 0x3c, 0x2f, 0xa4, 0xb2, 0x20, 0xb5, 0x38, 0x89, 0x0d, 0x6c, 0x8c, 0x31, 0x20, 0x00,
266 0x00, 0xff, 0xff, 0x5a, 0xdb, 0x3a, 0xc0, 0xea, 0x00, 0x00, 0x00,