com.google.cloud.discoveryengine.v1beta

Class UpdateDocumentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.UpdateDocumentRequest

All Implemented Interfaces:

UpdateDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class UpdateDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements UpdateDocumentRequestOrBuilder

 Request message for
 [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument]
 method.
 

Protobuf type google.cloud.discoveryengine.v1beta.UpdateDocumentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateDocumentRequest.Builder Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_MISSING_FIELD_NUMBER
static int	DOCUMENT_FIELD_NUMBER
static int	UPDATE_MASK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAllowMissing() If set to `true` and the [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
static UpdateDocumentRequest	getDefaultInstance()
UpdateDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document	getDocument() Required.
DocumentOrBuilder	getDocumentOrBuilder() Required.
com.google.protobuf.Parser<UpdateDocumentRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.FieldMask	getUpdateMask() Indicates which fields in the provided imported 'document' to update.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Indicates which fields in the provided imported 'document' to update.
boolean	hasDocument() Required.
int	hashCode()
boolean	hasUpdateMask() Indicates which fields in the provided imported 'document' to update.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static UpdateDocumentRequest.Builder	newBuilder()
static UpdateDocumentRequest.Builder	newBuilder(UpdateDocumentRequest prototype)
UpdateDocumentRequest.Builder	newBuilderForType()
protected UpdateDocumentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static UpdateDocumentRequest	parseDelimitedFrom(InputStream input)
static UpdateDocumentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateDocumentRequest	parseFrom(byte[] data)
static UpdateDocumentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateDocumentRequest	parseFrom(ByteBuffer data)
static UpdateDocumentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateDocumentRequest	parseFrom(com.google.protobuf.ByteString data)
static UpdateDocumentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static UpdateDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateDocumentRequest	parseFrom(InputStream input)
static UpdateDocumentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<UpdateDocumentRequest>	parser()
UpdateDocumentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_MISSING_FIELD_NUMBER

public static final int ALLOW_MISSING_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasDocument

public boolean hasDocument()

 Required. The document to update/create.

 If the caller does not have permission to update the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
 

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

Specified by:

hasDocument in interface UpdateDocumentRequestOrBuilder

Returns:

Whether the document field is set.

getDocument

public Document getDocument()

 Required. The document to update/create.

 If the caller does not have permission to update the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
 

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

Specified by:

getDocument in interface UpdateDocumentRequestOrBuilder

Returns:

The document.

getDocumentOrBuilder

public DocumentOrBuilder getDocumentOrBuilder()

 Required. The document to update/create.

 If the caller does not have permission to update the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
 

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

Specified by:

getDocumentOrBuilder in interface UpdateDocumentRequestOrBuilder

getAllowMissing

public boolean getAllowMissing()

 If set to `true` and the
 [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
 new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
 

bool allow_missing = 2;

Specified by:

getAllowMissing in interface UpdateDocumentRequestOrBuilder

Returns:

The allowMissing.

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;

Specified by:

hasUpdateMask in interface UpdateDocumentRequestOrBuilder

Returns:

Whether the updateMask field is set.

getUpdateMask

public com.google.protobuf.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;

Specified by:

getUpdateMask in interface UpdateDocumentRequestOrBuilder

Returns:

The updateMask.

getUpdateMaskOrBuilder

public com.google.protobuf.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;

Specified by:

getUpdateMaskOrBuilder in interface UpdateDocumentRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static UpdateDocumentRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateDocumentRequest parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateDocumentRequest parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateDocumentRequest parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateDocumentRequest parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateDocumentRequest parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateDocumentRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static UpdateDocumentRequest parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static UpdateDocumentRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static UpdateDocumentRequest parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static UpdateDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static UpdateDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public UpdateDocumentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static UpdateDocumentRequest.Builder newBuilder()

newBuilder

public static UpdateDocumentRequest.Builder newBuilder(UpdateDocumentRequest prototype)

toBuilder

public UpdateDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected UpdateDocumentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static UpdateDocumentRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<UpdateDocumentRequest> parser()

getParserForType

public com.google.protobuf.Parser<UpdateDocumentRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public UpdateDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder