Google Cloud Discovery Engine V1 Client - Class UpdateDocumentRequest (1.7.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UpdateDocumentRequest.

Request message for DocumentService.UpdateDocument method.

Generated from protobuf message google.cloud.discoveryengine.v1.UpdateDocumentRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ document
Document

Required. The document to update/create. If the caller does not have permission to update the Document , regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

↳ allow_missing
bool

If set to true and the Document is not found, a new Document is be created.

↳ update_mask
Google\Protobuf\FieldMask

Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

getDocument

Required. The document to update/create.

If the caller does not have permission to update the Document , regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

Returns
Type
Description
Document |null

hasDocument

clearDocument

setDocument

Required. The document to update/create.

If the caller does not have permission to update the Document , regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

Parameter
Name
Description
var
Returns
Type
Description
$this

getAllowMissing

If set to true and the Document is not found, a new Document is be created.

Returns
Type
Description
bool

setAllowMissing

If set to true and the Document is not found, a new Document is be created.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getUpdateMask

Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

Returns
Type
Description

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

Parameter
Name
Description
Returns
Type
Description
$this

static::build

Parameters
Name
Description
document
Document

Required. The document to update/create.

If the caller does not have permission to update the Document , regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

updateMask
Google\Protobuf\FieldMask

Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: