Class UpdateDocumentRequest.Builder (0.39.0)

public static final class UpdateDocumentRequest.Builder extends GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder> implements UpdateDocumentRequestOrBuilder

Request message for DocumentService.UpdateDocument method.

Protobuf type google.cloud.discoveryengine.v1.UpdateDocumentRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

build()

public UpdateDocumentRequest build()
Returns
Type Description
UpdateDocumentRequest

buildPartial()

public UpdateDocumentRequest buildPartial()
Returns
Type Description
UpdateDocumentRequest

clear()

public UpdateDocumentRequest.Builder clear()
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

clearAllowMissing()

public UpdateDocumentRequest.Builder clearAllowMissing()

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

bool allow_missing = 2;

Returns
Type Description
UpdateDocumentRequest.Builder

This builder for chaining.

clearDocument()

public UpdateDocumentRequest.Builder clearDocument()

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
UpdateDocumentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

clearUpdateMask()

public UpdateDocumentRequest.Builder clearUpdateMask()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
UpdateDocumentRequest.Builder

clone()

public UpdateDocumentRequest.Builder clone()
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

getAllowMissing()

public boolean getAllowMissing()

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

bool allow_missing = 2;

Returns
Type Description
boolean

The allowMissing.

getDefaultInstanceForType()

public UpdateDocumentRequest getDefaultInstanceForType()
Returns
Type Description
UpdateDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocument()

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

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

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.Builder

getDocumentOrBuilder()

public 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 FieldMask getUpdateMask()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMaskOrBuilder

hasDocument()

public 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 boolean hasUpdateMask()

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

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDocument(Document value)

public UpdateDocumentRequest.Builder mergeDocument(Document value)

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];

Parameter
Name Description
value Document
Returns
Type Description
UpdateDocumentRequest.Builder

mergeFrom(UpdateDocumentRequest other)

public UpdateDocumentRequest.Builder mergeFrom(UpdateDocumentRequest other)
Parameter
Name Description
other UpdateDocumentRequest
Returns
Type Description
UpdateDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateDocumentRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateDocumentRequest.Builder mergeUpdateMask(FieldMask value)

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

.google.protobuf.FieldMask update_mask = 3;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateDocumentRequest.Builder

setAllowMissing(boolean value)

public UpdateDocumentRequest.Builder setAllowMissing(boolean value)

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

bool allow_missing = 2;

Parameter
Name Description
value boolean

The allowMissing to set.

Returns
Type Description
UpdateDocumentRequest.Builder

This builder for chaining.

setDocument(Document value)

public UpdateDocumentRequest.Builder setDocument(Document value)

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];

Parameter
Name Description
value Document
Returns
Type Description
UpdateDocumentRequest.Builder

setDocument(Document.Builder builderForValue)

public UpdateDocumentRequest.Builder setDocument(Document.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Document.Builder
Returns
Type Description
UpdateDocumentRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateDocumentRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateDocumentRequest.Builder setUpdateMask(FieldMask value)

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

.google.protobuf.FieldMask update_mask = 3;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateDocumentRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateDocumentRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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

.google.protobuf.FieldMask update_mask = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateDocumentRequest.Builder