FieldMask

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.protobuf.FieldMask

All Implemented Interfaces:: FieldMaskOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class FieldMask
extends com.google.protobuf.GeneratedMessageV3
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 unmappable.

Protobuf type google.protobuf.FieldMask

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FieldMask.Builder` `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`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields
Modifier and Type Field and Description

static int PATHS_FIELD_NUMBER

Fields
Modifier and Type	Field and Description
`static int`	`PATHS_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Compares the specified object with this message for equality.
`static FieldMask`	`getDefaultInstance()`
`FieldMask`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Parser<FieldMask>`	`getParserForType()` Gets the parser for a message of the same type as this message.
`java.lang.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.
`int`	`getSerializedSize()` Get the number of bytes required to encode this message.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()` Get the `UnknownFieldSet` for this message.
`int`	`hashCode()` Returns the hash code value for this message.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`static FieldMask.Builder`	`newBuilder()`
`static FieldMask.Builder`	`newBuilder(FieldMask prototype)`
`FieldMask.Builder`	`newBuilderForType()` Constructs a new builder for a message of the same type as this message.
`static FieldMask`	`parseDelimitedFrom(java.io.InputStream input)`
`static FieldMask`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static FieldMask`	`parseFrom(byte[] data)`
`static FieldMask`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static FieldMask`	`parseFrom(java.nio.ByteBuffer data)`
`static FieldMask`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static FieldMask`	`parseFrom(ByteString data)`
`static FieldMask`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static FieldMask`	`parseFrom(CodedInputStream input)`
`static FieldMask`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static FieldMask`	`parseFrom(java.io.InputStream input)`
`static FieldMask`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<FieldMask>`	`parser()`
`FieldMask.Builder`	`toBuilder()` Constructs a builder initialized with the current message.
`void`	`writeTo(CodedOutputStream output)` Serializes the message and writes it to `output`.

Methods inherited from class com.google.protobuf.GeneratedMessageV3
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - PATHS_FIELD_NUMBER
```
public static final int PATHS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - getPathsList
```
public ProtocolStringList getPathsList()
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPathsList in interface FieldMaskOrBuilder
    
    Returns:
    
    A list containing the paths.
  - getPathsCount
```
public int getPathsCount()
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPathsCount in interface FieldMaskOrBuilder
    
    Returns:
    
    The count of paths.
  - getPaths
```
public java.lang.String getPaths(int index)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPaths in interface FieldMaskOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The paths at the given index.
  - getPathsBytes
```
public ByteString getPathsBytes(int index)
```
```
 The set of field mask paths.
 
```
    repeated string paths = 1;
    Specified by:
    
    getPathsBytes in interface FieldMaskOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the paths at the given index.
  - 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 com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(CodedOutputStream output)
             throws java.io.IOException
```
    Description copied from interface: MessageLite
    
    Serializes the message and writes it to output. This does not flush or close the stream.
    
    Specified by:
    
    writeTo in interface MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    java.io.IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Description copied from interface: MessageLite
    
    Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from interface: Message
    
    Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.
    
    Specified by:
    
    equals in interface Message
    
    Overrides:
    
    equals in class AbstractMessage
    
    Parameters:
    
    obj - object to be compared for equality with this message
    
    Returns:
    
    true if the specified object is equal to this message
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Message
    
    Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.
    
    Specified by:
    
    hashCode in interface Message
    
    Overrides:
    
    hashCode in class AbstractMessage
    
    Returns:
    
    the hash code value for this message
    
    See Also:
    
    Map.hashCode()
  - parseFrom
```
public static FieldMask parseFrom(java.nio.ByteBuffer data)
                           throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static FieldMask parseFrom(java.nio.ByteBuffer data,
                                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static FieldMask parseFrom(ByteString data)
                           throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static FieldMask parseFrom(ByteString data,
                                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static FieldMask parseFrom(byte[] data)
                           throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static FieldMask parseFrom(byte[] data,
                                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static FieldMask parseFrom(java.io.InputStream input)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static FieldMask parseFrom(java.io.InputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static FieldMask parseDelimitedFrom(java.io.InputStream input)
                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static FieldMask parseDelimitedFrom(java.io.InputStream input,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static FieldMask parseFrom(CodedInputStream input)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static FieldMask parseFrom(CodedInputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newBuilderForType
```
public FieldMask.Builder newBuilderForType()
```
    Description copied from interface: MessageLite
    
    Constructs a new builder for a message of the same type as this message.
    
    Specified by:
    
    newBuilderForType in interface Message
    
    Specified by:
    
    newBuilderForType in interface MessageLite
  - newBuilder
```
public static FieldMask.Builder newBuilder()
```
  - newBuilder
```
public static FieldMask.Builder newBuilder(FieldMask prototype)
```
  - toBuilder
```
public FieldMask.Builder toBuilder()
```
    Description copied from interface: MessageLite
    
    Constructs a builder initialized with the current message. Use this to derive a new message from the current one.
    
    Specified by:
    
    toBuilder in interface Message
    
    Specified by:
    
    toBuilder in interface MessageLite
  - getDefaultInstance
```
public static FieldMask getDefaultInstance()
```
  - parser
```
public static Parser<FieldMask> parser()
```
  - getParserForType
```
public Parser<FieldMask> getParserForType()
```
    Description copied from interface: MessageLite
    
    Gets the parser for a message of the same type as this message.
    
    Specified by:
    
    getParserForType in interface Message
    
    Specified by:
    
    getParserForType in interface MessageLite
    
    Overrides:
    
    getParserForType in class com.google.protobuf.GeneratedMessageV3
  - 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

Class FieldMask

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Field Summary

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

PATHS_FIELD_NUMBER

Method Detail

getUnknownFields

getDescriptor

getPathsList

getPathsCount

getPaths

getPathsBytes

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType