FieldMask.Builder (Protocol Buffers [Core] 3.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
    - - com.google.protobuf.FieldMask.Builder

All Implemented Interfaces:: FieldMaskOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:: FieldMask

public static final class FieldMask.Builder
extends GeneratedMessageV3.Builder<FieldMask.Builder>
implements FieldMaskOrBuilder

 `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, the existing
 repeated values in the target resource will be overwritten by the new values.
 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 the existing sub-message in the target resource is
 overwritten. Given the target message:
     f {
       b {
         d : 1
         x : 2
       }
       c : 1
     }
 And an update message:
     f {
       b {
         d : 10
       }
     }
 then if the field mask is:
  paths: "f.b"
 then the result will be:
     f {
       b {
         d : 10
       }
       c : 1
     }
 However, if the update mask was:
  paths: "f.b.d"
 then the result would be:
     f {
       b {
         d : 10
         x : 2
       }
       c : 1
     }
 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 the all the API methods, which have any FieldMask type
 field in the request, should verify the included field paths, and return
 `INVALID_ARGUMENT` error if any path is duplicated or unmappable.

Protobuf type google.protobuf.FieldMask

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldMask.Builder`	`addAllPaths(Iterable<String> values)` The set of field mask paths.
`FieldMask.Builder`	`addPaths(String value)` The set of field mask paths.
`FieldMask.Builder`	`addPathsBytes(ByteString value)` The set of field mask paths.
`FieldMask.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)` Like `setRepeatedField`, but appends the value as a new element.
`FieldMask`	`build()` Constructs the message based on the state of the Builder.
`FieldMask`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`FieldMask.Builder`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`FieldMask.Builder`	`clearField(Descriptors.FieldDescriptor field)` Clears the field.
`FieldMask.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)` TODO(jieluo): Clear it when all subclasses have implemented this method.
`FieldMask.Builder`	`clearPaths()` The set of field mask paths.
`FieldMask.Builder`	`clone()` Clones the Builder.
`FieldMask`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`String`	`getPaths(int index)` The set of field mask paths.
`ByteString`	`getPathsBytes(int index)` The set of field mask paths.
`int`	`getPathsCount()` The set of field mask paths.
`ProtocolStringList`	`getPathsList()` The set of field mask paths.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()` Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`FieldMask.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`FieldMask.Builder`	`mergeFrom(FieldMask other)`
`FieldMask.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`FieldMask.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for this message.
`FieldMask.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)` Sets a field to the given value.
`FieldMask.Builder`	`setPaths(int index, String value)` The set of field mask paths.
`FieldMask.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)` Sets an element of a repeated field to the given value.
`FieldMask.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3.Builder
    
    Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
    
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - clear
```
public FieldMask.Builder clear()
```
    Description copied from class: GeneratedMessageV3.Builder
    
    Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
    
    Specified by:
    
    clear in interface Message.Builder
    
    Specified by:
    
    clear in interface MessageLite.Builder
    
    Overrides:
    
    clear in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
    Description copied from interface: Message.Builder
    
    Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().
    
    Specified by:
    
    getDescriptorForType in interface Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - getDefaultInstanceForType
```
public FieldMask getDefaultInstanceForType()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder
  - build
```
public FieldMask build()
```
    Description copied from interface: MessageLite.Builder
    
    Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    build in interface Message.Builder
    
    Specified by:
    
    build in interface MessageLite.Builder
  - buildPartial
```
public FieldMask buildPartial()
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    buildPartial in interface Message.Builder
    
    Specified by:
    
    buildPartial in interface MessageLite.Builder
  - clone
```
public FieldMask.Builder clone()
```
    Description copied from interface: MessageLite.Builder
    
    Clones the Builder.
    
    Specified by:
    
    clone in interface Message.Builder
    
    Specified by:
    
    clone in interface MessageLite.Builder
    
    Overrides:
    
    clone in class GeneratedMessageV3.Builder<FieldMask.Builder>
    
    See Also:
    
    Object.clone()
  - setField
```
public FieldMask.Builder setField(Descriptors.FieldDescriptor field,
                                  Object value)
```
    Description copied from interface: Message.Builder
    
    Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.
    
    Specified by:
    
    setField in interface Message.Builder
    
    Overrides:
    
    setField in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - clearField
```
public FieldMask.Builder clearField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: Message.Builder
    
    Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.
    
    Specified by:
    
    clearField in interface Message.Builder
    
    Overrides:
    
    clearField in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - clearOneof
```
public FieldMask.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
    Description copied from class: AbstractMessage.Builder
    
    TODO(jieluo): Clear it when all subclasses have implemented this method.
    
    Specified by:
    
    clearOneof in interface Message.Builder
    
    Overrides:
    
    clearOneof in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - setRepeatedField
```
public FieldMask.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)
```
    Description copied from interface: Message.Builder
    
    Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.
    
    Specified by:
    
    setRepeatedField in interface Message.Builder
    
    Overrides:
    
    setRepeatedField in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - addRepeatedField
```
public FieldMask.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                          Object value)
```
    Description copied from interface: Message.Builder
    
    Like setRepeatedField, but appends the value as a new element.
    
    Specified by:
    
    addRepeatedField in interface Message.Builder
    
    Overrides:
    
    addRepeatedField in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - mergeFrom
```
public FieldMask.Builder mergeFrom(Message other)
```
    Description copied from interface: Message.Builder
    
    Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
    * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
    * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
    * For repeated fields, the elements in other are concatenated with the elements in this message.
    * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved. This is equivalent to the Message::MergeFrom method in C++.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<FieldMask.Builder>
  - mergeFrom
```
public FieldMask.Builder mergeFrom(FieldMask other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - mergeFrom
```
public FieldMask.Builder mergeFrom(CodedInputStream input,
                                   ExtensionRegistryLite extensionRegistry)
                            throws IOException
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Specified by:
    
    mergeFrom in interface MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<FieldMask.Builder>
    
    Throws:
    
    IOException
  - getPathsList
```
public ProtocolStringList getPathsList()
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPathsList in interface FieldMaskOrBuilder
  - getPathsCount
```
public int getPathsCount()
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPathsCount in interface FieldMaskOrBuilder
  - getPaths
```
public String getPaths(int index)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPaths in interface FieldMaskOrBuilder
  - getPathsBytes
```
public ByteString getPathsBytes(int index)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPathsBytes in interface FieldMaskOrBuilder
  - setPaths
```
public FieldMask.Builder setPaths(int index,
                                  String value)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - addPaths
```
public FieldMask.Builder addPaths(String value)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - addAllPaths
```
public FieldMask.Builder addAllPaths(Iterable<String> values)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - clearPaths
```
public FieldMask.Builder clearPaths()
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - addPathsBytes
```
public FieldMask.Builder addPathsBytes(ByteString value)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - setUnknownFields
```
public final FieldMask.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Set the UnknownFieldSet for this message.
    
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class GeneratedMessageV3.Builder<FieldMask.Builder>
  - mergeUnknownFields
```
public final FieldMask.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Merge some unknown fields into the UnknownFieldSet for this message.
    
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class GeneratedMessageV3.Builder<FieldMask.Builder>

Class FieldMask.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getPathsList

getPathsCount

getPaths

getPathsBytes

setPaths

addPaths

addAllPaths

clearPaths

addPathsBytes

setUnknownFields

mergeUnknownFields