Class UpdateDocumentRequest.Builder (0.37.0)

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

Request message for DocumentService.UpdateDocument.

Protobuf type google.cloud.contentwarehouse.v1.UpdateDocumentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

build()

public UpdateDocumentRequest build()
Returns
TypeDescription
UpdateDocumentRequest

buildPartial()

public UpdateDocumentRequest buildPartial()
Returns
TypeDescription
UpdateDocumentRequest

clear()

public UpdateDocumentRequest.Builder clear()
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

clearCloudAiDocumentOption()

public UpdateDocumentRequest.Builder clearCloudAiDocumentOption()

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

clearDocument()

public UpdateDocumentRequest.Builder clearDocument()

Required. The document to update.

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

Returns
TypeDescription
UpdateDocumentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

clearName()

public UpdateDocumentRequest.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

clearRequestMetadata()

public UpdateDocumentRequest.Builder clearRequestMetadata()

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

clearUpdateOptions()

public UpdateDocumentRequest.Builder clearUpdateOptions()

Options for the update operation.

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

Returns
TypeDescription
UpdateDocumentRequest.Builder

clone()

public UpdateDocumentRequest.Builder clone()
Returns
TypeDescription
UpdateDocumentRequest.Builder
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.

getCloudAiDocumentOptionBuilder()

public CloudAIDocumentOption.Builder getCloudAiDocumentOptionBuilder()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

Required. The document to update.

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

Returns
TypeDescription
Document.Builder

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.

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.

getRequestMetadataBuilder()

public RequestMetadata.Builder getRequestMetadataBuilder()

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

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

getUpdateOptions()

public UpdateOptions getUpdateOptions()

Options for the update operation.

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

Returns
TypeDescription
UpdateOptions

The updateOptions.

getUpdateOptionsBuilder()

public UpdateOptions.Builder getUpdateOptionsBuilder()

Options for the update operation.

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

Returns
TypeDescription
UpdateOptions.Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCloudAiDocumentOption(CloudAIDocumentOption value)

public UpdateDocumentRequest.Builder mergeCloudAiDocumentOption(CloudAIDocumentOption value)

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;

Parameter
NameDescription
valueCloudAIDocumentOption
Returns
TypeDescription
UpdateDocumentRequest.Builder

mergeDocument(Document value)

public UpdateDocumentRequest.Builder mergeDocument(Document value)

Required. The document to update.

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
UpdateDocumentRequest.Builder

mergeFrom(UpdateDocumentRequest other)

public UpdateDocumentRequest.Builder mergeFrom(UpdateDocumentRequest other)
Parameter
NameDescription
otherUpdateDocumentRequest
Returns
TypeDescription
UpdateDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UpdateDocumentRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

mergeRequestMetadata(RequestMetadata value)

public UpdateDocumentRequest.Builder mergeRequestMetadata(RequestMetadata value)

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

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

Parameter
NameDescription
valueRequestMetadata
Returns
TypeDescription
UpdateDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

mergeUpdateOptions(UpdateOptions value)

public UpdateDocumentRequest.Builder mergeUpdateOptions(UpdateOptions value)

Options for the update operation.

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

Parameter
NameDescription
valueUpdateOptions
Returns
TypeDescription
UpdateDocumentRequest.Builder

setCloudAiDocumentOption(CloudAIDocumentOption value)

public UpdateDocumentRequest.Builder setCloudAiDocumentOption(CloudAIDocumentOption value)

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;

Parameter
NameDescription
valueCloudAIDocumentOption
Returns
TypeDescription
UpdateDocumentRequest.Builder

setCloudAiDocumentOption(CloudAIDocumentOption.Builder builderForValue)

public UpdateDocumentRequest.Builder setCloudAiDocumentOption(CloudAIDocumentOption.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueCloudAIDocumentOption.Builder
Returns
TypeDescription
UpdateDocumentRequest.Builder

setDocument(Document value)

public UpdateDocumentRequest.Builder setDocument(Document value)

Required. The document to update.

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
UpdateDocumentRequest.Builder

setDocument(Document.Builder builderForValue)

public UpdateDocumentRequest.Builder setDocument(Document.Builder builderForValue)

Required. The document to update.

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

Parameter
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
UpdateDocumentRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

setName(String value)

public UpdateDocumentRequest.Builder setName(String value)

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) = { ... }

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
UpdateDocumentRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public UpdateDocumentRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
UpdateDocumentRequest.Builder

This builder for chaining.

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

public UpdateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

setRequestMetadata(RequestMetadata value)

public UpdateDocumentRequest.Builder setRequestMetadata(RequestMetadata value)

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

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

Parameter
NameDescription
valueRequestMetadata
Returns
TypeDescription
UpdateDocumentRequest.Builder

setRequestMetadata(RequestMetadata.Builder builderForValue)

public UpdateDocumentRequest.Builder setRequestMetadata(RequestMetadata.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueRequestMetadata.Builder
Returns
TypeDescription
UpdateDocumentRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateDocumentRequest.Builder
Overrides

setUpdateOptions(UpdateOptions value)

public UpdateDocumentRequest.Builder setUpdateOptions(UpdateOptions value)

Options for the update operation.

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

Parameter
NameDescription
valueUpdateOptions
Returns
TypeDescription
UpdateDocumentRequest.Builder

setUpdateOptions(UpdateOptions.Builder builderForValue)

public UpdateDocumentRequest.Builder setUpdateOptions(UpdateOptions.Builder builderForValue)

Options for the update operation.

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

Parameter
NameDescription
builderForValueUpdateOptions.Builder
Returns
TypeDescription
UpdateDocumentRequest.Builder