aboutsummaryrefslogtreecommitdiff
path: root/src/google/protobuf/field_mask.proto
diff options
context:
space:
mode:
authorJisi Liu <jisi.liu@gmail.com>2015-08-21 11:18:45 -0700
committerJisi Liu <jisi.liu@gmail.com>2015-08-21 11:18:45 -0700
commitb0f661181d10bddc08e380992590a1cdd92be92b (patch)
treed9291cf324a72206ae3e474fe49186e8c96b2a9e /src/google/protobuf/field_mask.proto
parentd119a275495b7dcc9c389c9c650ebd83de265511 (diff)
downloadprotobuf-b0f661181d10bddc08e380992590a1cdd92be92b.tar.gz
protobuf-b0f661181d10bddc08e380992590a1cdd92be92b.tar.bz2
protobuf-b0f661181d10bddc08e380992590a1cdd92be92b.zip
Down-integrate from internal branch.
Change-Id: Ieb7a2c2fbf35bc2a8fa65b915a5ecb68c83863e4
Diffstat (limited to 'src/google/protobuf/field_mask.proto')
-rw-r--r--src/google/protobuf/field_mask.proto8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/google/protobuf/field_mask.proto b/src/google/protobuf/field_mask.proto
index 35b1acc3..4d06fef6 100644
--- a/src/google/protobuf/field_mask.proto
+++ b/src/google/protobuf/field_mask.proto
@@ -31,13 +31,13 @@ syntax = "proto3";
package google.protobuf;
+option csharp_namespace = "Google.ProtocolBuffers";
+option java_generate_equals_and_hash = true;
option java_multiple_files = true;
option java_outer_classname = "FieldMaskProto";
option java_package = "com.google.protobuf";
-option csharp_namespace = "Google.ProtocolBuffers";
option objc_class_prefix = "GPB";
-
// `FieldMask` represents a set of symbolic field paths, for example:
//
// paths: "f.a"
@@ -52,6 +52,7 @@ option objc_class_prefix = "GPB";
// 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
@@ -97,6 +98,7 @@ option objc_class_prefix = "GPB";
// 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
@@ -124,11 +126,13 @@ option objc_class_prefix = "GPB";
// 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.