Class UpdateDocumentRequest (0.28.0)

public final class UpdateDocumentRequest extends GeneratedMessageV3 implements UpdateDocumentRequestOrBuilder

Request message for DocumentService.UpdateDocument.

Protobuf type google.cloud.contentwarehouse.v1.UpdateDocumentRequest

Static Fields

CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER

public static final int CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_METADATA_FIELD_NUMBER

public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_OPTIONS_FIELD_NUMBER

public static final int UPDATE_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateDocumentRequest getDefaultInstance()
Returns
TypeDescription
UpdateDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UpdateDocumentRequest.Builder newBuilder()
Returns
TypeDescription
UpdateDocumentRequest.Builder

newBuilder(UpdateDocumentRequest prototype)

public static UpdateDocumentRequest.Builder newBuilder(UpdateDocumentRequest prototype)
Parameter
NameDescription
prototypeUpdateDocumentRequest
Returns
TypeDescription
UpdateDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateDocumentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateDocumentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateDocumentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateDocumentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateDocumentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateDocumentRequest> parser()
Returns
TypeDescription
Parser<UpdateDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCloudAiDocumentOption()

public CloudAIDocumentOption getCloudAiDocumentOption()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
CloudAIDocumentOption

The cloudAiDocumentOption.

getCloudAiDocumentOptionOrBuilder()

public CloudAIDocumentOptionOrBuilder getCloudAiDocumentOptionOrBuilder()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
CloudAIDocumentOptionOrBuilder

getDefaultInstanceForType()

public UpdateDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateDocumentRequest

getDocument()

public Document getDocument()

Required. The document to update.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Document

The document.

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

Required. The document to update.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DocumentOrBuilder

getName()

public String getName()

Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<UpdateDocumentRequest> getParserForType()
Returns
TypeDescription
Parser<UpdateDocumentRequest>
Overrides

getRequestMetadata()

public RequestMetadata getRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
TypeDescription
RequestMetadata

The requestMetadata.

getRequestMetadataOrBuilder()

public RequestMetadataOrBuilder getRequestMetadataOrBuilder()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
TypeDescription
RequestMetadataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUpdateOptions()

public UpdateOptions getUpdateOptions()

Options for the update operation.

.google.cloud.contentwarehouse.v1.UpdateOptions update_options = 6;

Returns
TypeDescription
UpdateOptions

The updateOptions.

getUpdateOptionsOrBuilder()

public UpdateOptionsOrBuilder getUpdateOptionsOrBuilder()

Options for the update operation.

.google.cloud.contentwarehouse.v1.UpdateOptions update_options = 6;

Returns
TypeDescription
UpdateOptionsOrBuilder

hasCloudAiDocumentOption()

public boolean hasCloudAiDocumentOption()

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.

.google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;

Returns
TypeDescription
boolean

Whether the cloudAiDocumentOption field is set.

hasDocument()

public boolean hasDocument()

Required. The document to update.

.google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the document field is set.

hasRequestMetadata()

public boolean hasRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
TypeDescription
boolean

Whether the requestMetadata field is set.

hasUpdateOptions()

public boolean hasUpdateOptions()

Options for the update operation.

.google.cloud.contentwarehouse.v1.UpdateOptions update_options = 6;

Returns
TypeDescription
boolean

Whether the updateOptions field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateDocumentRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateDocumentRequest.Builder toBuilder()
Returns
TypeDescription
UpdateDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException