Send feedback
Class UpdateDocumentRequest (0.51.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.51.0 keyboard_arrow_down
public final class UpdateDocumentRequest extends GeneratedMessageV3 implements UpdateDocumentRequestOrBuilder
Request message for
DocumentService.UpdateDocument
method.
Protobuf type google.cloud.discoveryengine.v1.UpdateDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALLOW_MISSING_FIELD_NUMBER
public static final int ALLOW_MISSING_FIELD_NUMBER
Field Value
Type
Description
int
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type
Description
int
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static UpdateDocumentRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static UpdateDocumentRequest . Builder newBuilder ()
newBuilder(UpdateDocumentRequest prototype)
public static UpdateDocumentRequest . Builder newBuilder ( UpdateDocumentRequest prototype )
public static UpdateDocumentRequest parseDelimitedFrom ( InputStream input )
public static UpdateDocumentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static UpdateDocumentRequest parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateDocumentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static UpdateDocumentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateDocumentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static UpdateDocumentRequest parseFrom ( CodedInputStream input )
public static UpdateDocumentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static UpdateDocumentRequest parseFrom ( InputStream input )
public static UpdateDocumentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static UpdateDocumentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateDocumentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<UpdateDocumentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getAllowMissing()
public 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.
getDefaultInstanceForType()
public UpdateDocumentRequest getDefaultInstanceForType ()
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.
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];
getParserForType()
public Parser<UpdateDocumentRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
getUpdateMask()
public 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 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;
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, by default updates all fields.
.google.protobuf.FieldMask update_mask = 3;
Returns
Type
Description
boolean
Whether the updateMask field is set.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public UpdateDocumentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateDocumentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public UpdateDocumentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]