| // Code generated by protoc-gen-go. DO NOT EDIT. |
| // source: google/protobuf/field_mask.proto |
| |
| package known_proto |
| |
| import ( |
| protoreflect "google.golang.org/protobuf/reflect/protoreflect" |
| protoregistry "google.golang.org/protobuf/reflect/protoregistry" |
| protoiface "google.golang.org/protobuf/runtime/protoiface" |
| protoimpl "google.golang.org/protobuf/runtime/protoimpl" |
| sync "sync" |
| ) |
| |
| const _ = protoimpl.EnforceVersion(protoimpl.Version - 0) |
| |
| // `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. |
| 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:"-"` |
| } |
| |
| func (x *FieldMask) Reset() { |
| *x = FieldMask{} |
| } |
| |
| func (x *FieldMask) String() string { |
| return protoimpl.X.MessageStringOf(x) |
| } |
| |
| func (*FieldMask) ProtoMessage() {} |
| |
| func (x *FieldMask) ProtoReflect() protoreflect.Message { |
| return file_google_protobuf_field_mask_proto_msgTypes[0].MessageOf(x) |
| } |
| |
| func (m *FieldMask) XXX_Methods() *protoiface.Methods { |
| return file_google_protobuf_field_mask_proto_msgTypes[0].Methods() |
| } |
| |
| // Deprecated: Use FieldMask.ProtoReflect.Type instead. |
| func (*FieldMask) Descriptor() ([]byte, []int) { |
| return file_google_protobuf_field_mask_proto_rawDescGZIP(), []int{0} |
| } |
| |
| func (x *FieldMask) GetPaths() []string { |
| if x != nil { |
| return x.Paths |
| } |
| return nil |
| } |
| |
| var File_google_protobuf_field_mask_proto protoreflect.FileDescriptor |
| |
| var file_google_protobuf_field_mask_proto_rawDesc = []byte{ |
| 0x0a, 0x20, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, |
| 0x66, 0x2f, 0x66, 0x69, 0x65, 0x6c, 0x64, 0x5f, 0x6d, 0x61, 0x73, 0x6b, 0x2e, 0x70, 0x72, 0x6f, |
| 0x74, 0x6f, 0x12, 0x0f, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, |
| 0x62, 0x75, 0x66, 0x22, 0x21, 0x0a, 0x09, 0x46, 0x69, 0x65, 0x6c, 0x64, 0x4d, 0x61, 0x73, 0x6b, |
| 0x12, 0x14, 0x0a, 0x05, 0x70, 0x61, 0x74, 0x68, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x09, 0x52, |
| 0x05, 0x70, 0x61, 0x74, 0x68, 0x73, 0x42, 0x85, 0x01, 0x0a, 0x13, 0x63, 0x6f, 0x6d, 0x2e, 0x67, |
| 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x42, 0x0e, |
| 0x46, 0x69, 0x65, 0x6c, 0x64, 0x4d, 0x61, 0x73, 0x6b, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, |
| 0x5a, 0x32, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x67, 0x6f, 0x6c, 0x61, 0x6e, 0x67, 0x2e, |
| 0x6f, 0x72, 0x67, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2f, 0x74, 0x79, 0x70, |
| 0x65, 0x73, 0x2f, 0x6b, 0x6e, 0x6f, 0x77, 0x6e, 0x3b, 0x6b, 0x6e, 0x6f, 0x77, 0x6e, 0x5f, 0x70, |
| 0x72, 0x6f, 0x74, 0x6f, 0xf8, 0x01, 0x01, 0xa2, 0x02, 0x03, 0x47, 0x50, 0x42, 0xaa, 0x02, 0x1e, |
| 0x47, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, |
| 0x57, 0x65, 0x6c, 0x6c, 0x4b, 0x6e, 0x6f, 0x77, 0x6e, 0x54, 0x79, 0x70, 0x65, 0x73, 0x62, 0x06, |
| 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, |
| } |
| |
| var ( |
| file_google_protobuf_field_mask_proto_rawDescOnce sync.Once |
| file_google_protobuf_field_mask_proto_rawDescData = file_google_protobuf_field_mask_proto_rawDesc |
| ) |
| |
| func file_google_protobuf_field_mask_proto_rawDescGZIP() []byte { |
| file_google_protobuf_field_mask_proto_rawDescOnce.Do(func() { |
| file_google_protobuf_field_mask_proto_rawDescData = protoimpl.X.CompressGZIP(file_google_protobuf_field_mask_proto_rawDescData) |
| }) |
| return file_google_protobuf_field_mask_proto_rawDescData |
| } |
| |
| var file_google_protobuf_field_mask_proto_msgTypes = make([]protoimpl.MessageType, 1) |
| var file_google_protobuf_field_mask_proto_goTypes = []interface{}{ |
| (*FieldMask)(nil), // 0: google.protobuf.FieldMask |
| } |
| var file_google_protobuf_field_mask_proto_depIdxs = []int32{} |
| |
| func init() { file_google_protobuf_field_mask_proto_init() } |
| func file_google_protobuf_field_mask_proto_init() { |
| if File_google_protobuf_field_mask_proto != nil { |
| return |
| } |
| File_google_protobuf_field_mask_proto = protoimpl.FileBuilder{ |
| RawDescriptor: file_google_protobuf_field_mask_proto_rawDesc, |
| GoTypes: file_google_protobuf_field_mask_proto_goTypes, |
| DependencyIndexes: file_google_protobuf_field_mask_proto_depIdxs, |
| MessageOutputTypes: file_google_protobuf_field_mask_proto_msgTypes, |
| FilesRegistry: protoregistry.GlobalFiles, |
| TypesRegistry: protoregistry.GlobalTypes, |
| }.Init() |
| file_google_protobuf_field_mask_proto_rawDesc = nil |
| file_google_protobuf_field_mask_proto_goTypes = nil |
| file_google_protobuf_field_mask_proto_depIdxs = nil |
| } |
