Send feedback Class FieldMaskUtil (3.19.4) Stay organized with collections Save and categorize content based on your preferences.
public final class FieldMaskUtil Static Methods <P>trim(FieldMask mask, P source)
public static P <P>trim ( FieldMask mask , P source ) Returns the result of keeping only the masked fields of the given proto.
Parameters Name Description maskFieldMask sourceP
Returns Type Description P
fromFieldNumbers(Class<? extends Message> type, int[] fieldNumbers)
public static FieldMask fromFieldNumbers ( Class <? extends Message > type , int [] fieldNumbers ) Constructs a FieldMask from the passed field numbers.
Parameters Name Description typeClass <? extends com.google.protobuf.Message > fieldNumbersint []
fromFieldNumbers(Class<? extends Message> type, Iterable<Integer> fieldNumbers)
public static FieldMask fromFieldNumbers ( Class <? extends Message > type , Iterable<Integer> fieldNumbers ) Constructs a FieldMask from the passed field numbers.
Parameters Name Description typeClass <? extends com.google.protobuf.Message > fieldNumbersIterable <Integer >
fromJsonString(String value)
public static FieldMask fromJsonString ( String value ) Converts a field mask from a Proto3 JSON string, that is splitting the paths along commas and converting from camel case to snake case.
Parameter Name Description valueString
fromString(Class<? extends Message> type, String value)
public static FieldMask fromString ( Class <? extends Message > type , String value ) Parses from a string to a FieldMask and validates all field paths.
Parameters Name Description typeClass <? extends com.google.protobuf.Message > valueString
fromString(String value)
public static FieldMask fromString ( String value ) Parses from a string to a FieldMask.
Parameter Name Description valueString
fromStringList(Descriptors.Descriptor descriptor, Iterable<String> paths)
public static FieldMask fromStringList ( Descriptors . Descriptor descriptor , Iterable<String> paths ) Constructs a FieldMask for a list of field paths in a certain type.
fromStringList(Class<? extends Message> type, Iterable<String> paths)
public static FieldMask fromStringList ( Class <? extends Message > type , Iterable<String> paths ) Constructs a FieldMask for a list of field paths in a certain type.
Parameters Name Description typeClass <? extends com.google.protobuf.Message > pathsIterable <String >
fromStringList(Iterable<String> paths)
public static FieldMask fromStringList ( Iterable<String> paths ) Constructs a FieldMask for a list of field paths in a certain type. Does not validate the given paths.
intersection(FieldMask mask1, FieldMask mask2)
public static FieldMask intersection ( FieldMask mask1 , FieldMask mask2 ) Calculates the intersection of two FieldMasks.
isValid(Descriptors.Descriptor descriptor, FieldMask fieldMask)
public static boolean isValid ( Descriptors . Descriptor descriptor , FieldMask fieldMask ) Checks whether paths in a given fields mask are valid.
isValid(Descriptors.Descriptor descriptor, String path)
public static boolean isValid ( Descriptors . Descriptor descriptor , String path ) Checks whether paths in a given fields mask are valid.
isValid(Class<? extends Message> type, FieldMask fieldMask)
public static boolean isValid ( Class <? extends Message > type , FieldMask fieldMask ) Checks whether paths in a given fields mask are valid.
Parameters Name Description typeClass <? extends com.google.protobuf.Message > fieldMaskFieldMask
isValid(Class<? extends Message> type, String path)
public static boolean isValid ( Class <? extends Message > type , String path ) Checks whether a given field path is valid.
Parameters Name Description typeClass <? extends com.google.protobuf.Message > pathString
merge(FieldMask mask, Message source, Message.Builder destination)
public static void merge ( FieldMask mask , Message source , Message . Builder destination ) Merges fields specified by a FieldMask from one message to another.
merge(FieldMask mask, Message source, Message.Builder destination, FieldMaskUtil.MergeOptions options)
public static void merge ( FieldMask mask , Message source , Message . Builder destination , FieldMaskUtil . MergeOptions options ) Merges fields specified by a FieldMask from one message to another with the specified merge options. The destination will remain unchanged if an empty FieldMask is provided.
normalize(FieldMask mask)
public static FieldMask normalize ( FieldMask mask ) Converts a FieldMask to its canonical form. In the canonical form of a FieldMask, all field paths are sorted alphabetically and redundant field paths are removed.
subtract(FieldMask firstMask, FieldMask secondMask, FieldMask[] otherMasks)
public static FieldMask subtract ( FieldMask firstMask , FieldMask secondMask , FieldMask [] otherMasks ) Subtracts secondMask and otherMasks from firstMask.
This method disregards proto structure. That is, if firstMask is "foo" and secondMask is "foo.bar", the response will always be "foo" without considering the internal proto structure of message "foo".
toJsonString(FieldMask fieldMask)
public static String toJsonString ( FieldMask fieldMask ) Converts a field mask to a Proto3 JSON string, that is converting from snake case to camel case and joining all paths into one string with commas.
Parameter Name Description fieldMaskFieldMask
Returns Type Description String
toString(FieldMask fieldMask)
public static String toString ( FieldMask fieldMask ) Converts a FieldMask to a string.
Parameter Name Description fieldMaskFieldMask
Returns Type Description String
union(FieldMask firstMask, FieldMask secondMask, FieldMask[] otherMasks)
public static FieldMask union ( FieldMask firstMask , FieldMask secondMask , FieldMask [] otherMasks ) Creates a union of two or more FieldMasks.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-17 UTC."],[],[]]
