Send feedback
  
   
 
  
    
      Class UpdateDocumentRequest (0.8.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 0.8.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
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 
  
  DOCUMENT_FIELD_NUMBER 
  
    
public   static   final   int   DOCUMENT_FIELD_NUMBER  
   
  Field Value 
  
  NAME_FIELD_NUMBER 
  
    
public   static   final   int   NAME_FIELD_NUMBER  
   
  Field Value 
  
  REQUEST_METADATA_FIELD_NUMBER 
  
    
public   static   final   int   REQUEST_METADATA_FIELD_NUMBER  
   
  Field Value 
  
  UPDATE_OPTIONS_FIELD_NUMBER 
  
    
public   static   final   int   UPDATE_OPTIONS_FIELD_NUMBER  
   
  Field Value 
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   UpdateDocumentRequest   getDefaultInstance ()  
   
  Returns 
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  Returns 
  
   
  newBuilder() 
  
    
public   static   UpdateDocumentRequest . Builder   newBuilder ()  
   
  Returns 
  
   
  newBuilder(UpdateDocumentRequest prototype) 
  
    
public   static   UpdateDocumentRequest . Builder   newBuilder ( UpdateDocumentRequest   prototype )  
   
  Parameter 
  
  Returns 
  
   
  parseDelimitedFrom(InputStream input) 
  
    
public   static   UpdateDocumentRequest   parseDelimitedFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   UpdateDocumentRequest   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(byte[] data) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( byte []   data )  
   
  Parameter 
  
    
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteString data) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( ByteString   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(CodedInputStream input) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( CodedInputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(InputStream input) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( ByteBuffer   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   UpdateDocumentRequest   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parser() 
  
    
public   static   Parser<UpdateDocumentRequest>   parser ()  
   
  Returns 
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  getCloudAiDocumentOption() 
  
    
public   CloudAIDocumentOption   getCloudAiDocumentOption ()  
   
   Request Option for processing Cloud AI Document in CW Document.
 .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
 
 
  Returns 
  
   
  getCloudAiDocumentOptionOrBuilder() 
  
    
public   CloudAIDocumentOptionOrBuilder   getCloudAiDocumentOptionOrBuilder ()  
   
   Request Option for processing Cloud AI Document in CW Document.
 .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
 
 
  Returns 
  
   
  getDefaultInstanceForType() 
  
    
public   UpdateDocumentRequest   getDefaultInstanceForType ()  
   
  Returns 
  
   
  getDocument() 
  
    
public   Document   getDocument ()  
   
   Required. The document to update.
 
 .google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
 
 
  Returns 
  
   
  getDocumentOrBuilder() 
  
    
public   DocumentOrBuilder   getDocumentOrBuilder ()  
   
   Required. The document to update.
 
 .google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
 
 
  Returns 
  
   
  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 
  
    
      
        Type  
        Description  
       
      
        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 
  
   
  getParserForType() 
  
    
public   Parser<UpdateDocumentRequest>   getParserForType ()  
   
  Returns 
  
  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 
  
   
  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 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  Returns 
  
  Overrides 
  
   
  getUnknownFields() 
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
   
  Returns 
  
  Overrides 
  
   
  getUpdateOptions() 
  
    
public   UpdateOptions   getUpdateOptions ()  
   
   Options for the update operation.
 .google.cloud.contentwarehouse.v1.UpdateOptions update_options = 6;
 
  Returns 
  
   
  getUpdateOptionsOrBuilder() 
  
    
public   UpdateOptionsOrBuilder   getUpdateOptionsOrBuilder ()  
   
   Options for the update operation.
 .google.cloud.contentwarehouse.v1.UpdateOptions update_options = 6;
 
  Returns 
  
   
  hasCloudAiDocumentOption() 
  
    
public   boolean   hasCloudAiDocumentOption ()  
   
   Request Option for processing Cloud AI Document in CW Document.
 .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        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 
  
    
      
        Type  
        Description  
       
      
        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 
  
    
      
        Type  
        Description  
       
      
        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 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the updateOptions field is set.
 
       
     
  
   
  hashCode() 
  
  Returns 
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  Returns 
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  Returns 
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   UpdateDocumentRequest . Builder   newBuilderForType ()  
   
  Returns 
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   UpdateDocumentRequest . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  toBuilder() 
  
    
public   UpdateDocumentRequest . Builder   toBuilder ()  
   
  Returns 
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  Parameter 
  
  Overrides 
  
  Exceptions 
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    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-10-30 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-10-30 UTC."],[],[]]