ApplyFieldMaskOptions
Defined in: fieldmask.ts:206
Applies a field mask to a message, creating a new message with only the fields specified in the field mask. If the inverse argument is true, the inverse of the field mask is applied, meaning that only the fields NOT specified in the field mask are included in the new message. Note that this operation does not mutate the original message. Instead, it creates a new message with the field mask applied.
The FieldMask spec does not allow for wildcards and repeated or map fields must be the last part
of the path. The final argument for this function is strict, which defaults to true. If strict
is true, the function will only allow field masks that are valid according to the spec. However,
the AIP Guidelines allow for wildcards in field masks. So, if you want to
allow wildcards, you can set strict to false. This will allow for field masks with standalone
wildcards or wildcards in repeated or map fields (i.e. '*', 'foo.*', 'foo.*.bar', etc.).
Properties
Section titled “Properties”inverse?
Section titled “inverse?”
optionalinverse?:boolean
Defined in: fieldmask.ts:207
strict?
Section titled “strict?”
optionalstrict?:boolean
Defined in: fieldmask.ts:208