Struct google_docs1::WriteControl

pub struct WriteControl {
    pub required_revision_id: Option<String>,
    pub target_revision_id: Option<String>,
}

Provides control over how write requests are executed.

This type is not used in any activity, and only used as part of another schema.

Fields

required_revision_id: Option<String>

The revision ID of the document that the write request will be applied to. If this is not the latest revision of the document, the request will not be processed and will return a 400 bad request error.

When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.

target_revision_id: Option<String>

The target revision ID of the document that the write request will be applied to.

If collaborator changes have occurred after the document was read using the API, the changes produced by this write request will be transformed against the collaborator changes. This results in a new revision of the document which incorporates both the changes in the request and the collaborator changes, and the Docs server will resolve conflicting changes. When using target_revision_id, the API client can be thought of as another collaborator of the document.

The target revision ID may only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request will not be processed and will return a 400 bad request error and the request should be retried after reading the latest version of the document. In most cases a revision_id will remain valid for use as a target revision for several minutes after it is read, but for frequently-edited documents this window may be shorter.

Trait Implementations

impl Part for WriteControl

impl Default for WriteControl

fn default() -> WriteControl

Returns the "default value" for a type.

impl Clone for WriteControl

fn clone(&self) -> WriteControl

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WriteControl

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for WriteControl

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for WriteControl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.