Google Cloud Discovery Engine V1beta Client - Class UpdateDocumentRequest (0.11.3)

Version 0.11.3

• 1.3.1 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Request message for DocumentService.UpdateDocument method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ document	Google\Cloud\DiscoveryEngine\V1beta\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
Google\Cloud\DiscoveryEngine\V1beta\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	Google\Cloud\DiscoveryEngine\V1beta\Document

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
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

static::build

Parameters
Name	Description
document	Google\Cloud\DiscoveryEngine\V1beta\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
Google\Cloud\DiscoveryEngine\V1beta\UpdateDocumentRequest