

In order to reset a field’s value to the default, the field must be in the maskĪnd set to the default value in the provided resource. Resource is passed in to describe the updated values, the API ignores the values

Of the fields as specified in the mask and leave the others untouched.

The API is required to only change the values Field Masks in Update OperationsĪ field mask in update operations specifies which fields of the targeted The returned resource/resources is required behavior for APIs. Where the mask applies will be clearlyĭocumented together with its declaration in the API. Individual message in the returned resource list. Response, but in case of a REST list operation, the mask instead applies to each In case of a REST get operation, the field mask applies directly to the Note that a field mask does not necessarily apply to the top-level response To all fields (as if a FieldMask of all fields had been specified). If a FieldMask object is not present in a get operation, the operation applies Proto2 syntax only, and deprecated.įieldMask represents a set of symbolic field paths, for example:Ī repeated field is not allowed except at the last position of a field mask. Whether a field is optional, required, or repeated. The string value of the default value of this field. Whether to use alternative packed wire representation. The first type has index 1 zero means the type is The index of the field type in Type.oneofs, for message orĮnumeration types. The field type URL, without the scheme, for message or enumeration
