Usage

Updating Documents

This API follows the GRPC update model, wherein on Update RPCs, the caller must populate the updateMask field with an array of dotted paths of property names to update. This model ensures clarity as to what specific fields a caller wants to update or clear.

For example, to update just the Destination RTMP URL (while leaving the corresponding RTMP Key untouched), a caller can set update_mask in UpdateDestination() to address.rtmpPush.url and, correspondingly, set the address.rtmpPush.url property on request to the appropriate URL. Multiple fields can be updated simultaneously. If the fields are unrelated or do not comprise an entire object, updateMask may include both fields (e.g., metadata, address.rtmpPush.url). If an entire property object is to be updated, updateMask can specify the parent (e.g., address.rtmpPush).

REST Usage

GRPC clients must always specify the updateMask field. REST clients may specify the updateMask field as part of the Request body. If updateMask is not present in the Request body, it will be automatically calculated based on what elements are present (not undefined) in the request body.