FieldMask.Builder (lib 1.0.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, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:: FieldMask

public static final class FieldMask.Builder
extends com.google.protobuf.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, 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.

Protobuf type google.protobuf.FieldMask

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldMask.Builder`	`addAllPaths(java.lang.Iterable<java.lang.String> values)` The set of field mask paths.
`FieldMask.Builder`	`addPaths(java.lang.String value)` The set of field mask paths.
`FieldMask.Builder`	`addPathsBytes(com.google.protobuf.ByteString value)` The set of field mask paths.
`FieldMask.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`FieldMask`	`build()`
`FieldMask`	`buildPartial()`
`FieldMask.Builder`	`clear()`
`FieldMask.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`FieldMask.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`FieldMask.Builder`	`clearPaths()` The set of field mask paths.
`FieldMask.Builder`	`clone()`
`FieldMask`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getPaths(int index)` The set of field mask paths.
`com.google.protobuf.ByteString`	`getPathsBytes(int index)` The set of field mask paths.
`int`	`getPathsCount()` The set of field mask paths.
`com.google.protobuf.ProtocolStringList`	`getPathsList()` The set of field mask paths.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`FieldMask.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`FieldMask.Builder`	`mergeFrom(FieldMask other)`
`FieldMask.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`FieldMask.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`FieldMask.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`FieldMask.Builder`	`setPaths(int index, java.lang.String value)` The set of field mask paths.
`FieldMask.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`FieldMask.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

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 com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - clear
```
public FieldMask.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - getDefaultInstanceForType
```
public FieldMask getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public FieldMask build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public FieldMask buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public FieldMask.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - setField
```
public FieldMask.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  java.lang.Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - clearField
```
public FieldMask.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - clearOneof
```
public FieldMask.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - setRepeatedField
```
public FieldMask.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          java.lang.Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - addRepeatedField
```
public FieldMask.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          java.lang.Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - mergeFrom
```
public FieldMask.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldMask.Builder>
  - mergeFrom
```
public FieldMask.Builder mergeFrom(FieldMask other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - mergeFrom
```
public FieldMask.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldMask.Builder>
    
    Throws:
    
    java.io.IOException
  - getPathsList
```
public com.google.protobuf.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 java.lang.String getPaths(int index)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPaths in interface FieldMaskOrBuilder
  - getPathsBytes
```
public com.google.protobuf.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,
                                  java.lang.String value)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - addPaths
```
public FieldMask.Builder addPaths(java.lang.String value)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - addAllPaths
```
public FieldMask.Builder addAllPaths(java.lang.Iterable<java.lang.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(com.google.protobuf.ByteString value)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
  - setUnknownFields
```
public final FieldMask.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
  - mergeUnknownFields
```
public final FieldMask.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.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