Interface UpdateDocumentRequestOrBuilder (0.43.0)

Version 0.43.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface UpdateDocumentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowMissing()

public abstract boolean getAllowMissing()

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

bool allow_missing = 2;

Returns
Type	Description
boolean	The allowMissing.

getDocument()

public abstract Document 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.

.google.cloud.discoveryengine.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Document	The document.

getDocumentOrBuilder()

public abstract DocumentOrBuilder getDocumentOrBuilder()

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.

.google.cloud.discoveryengine.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
DocumentOrBuilder

getUpdateMask()

public abstract FieldMask getUpdateMask()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type	Description
FieldMask	The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type	Description
FieldMaskOrBuilder

hasDocument()

public abstract boolean hasDocument()

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.

.google.cloud.discoveryengine.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the document field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type	Description
boolean	Whether the updateMask field is set.