Class CreateIndexRequest (0.32.0) 
  
      
     
  
  
  
   
  
    
  
  
    
    
    
  Version 0.32.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  CreateIndexRequest   extends   GeneratedMessageV3   implements   CreateIndexRequestOrBuilder  
   
   Message for creating an Index.
 Protobuf type google.cloud.visionai.v1.CreateIndexRequest
 
  
  
  
    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
   
  INDEX_FIELD_NUMBER 
  
    
public   static   final   int   INDEX_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  INDEX_ID_FIELD_NUMBER 
  
    
public   static   final   int   INDEX_ID_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  PARENT_FIELD_NUMBER 
  
    
public   static   final   int   PARENT_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   CreateIndexRequest   getDefaultInstance ()  
   
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   CreateIndexRequest . Builder   newBuilder ()  
   
  
   
  newBuilder(CreateIndexRequest prototype) 
  
    
public   static   CreateIndexRequest . Builder   newBuilder ( CreateIndexRequest   prototype )  
   
  
  
   
  
  
    
public   static   CreateIndexRequest   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   CreateIndexRequest   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   CreateIndexRequest   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   CreateIndexRequest   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   CreateIndexRequest   parseFrom ( ByteString   data )  
   
  
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   CreateIndexRequest   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   CreateIndexRequest   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   CreateIndexRequest   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   CreateIndexRequest   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   CreateIndexRequest   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   CreateIndexRequest   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   CreateIndexRequest   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parser() 
  
    
public   static   Parser<CreateIndexRequest>   parser ()  
   
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   CreateIndexRequest   getDefaultInstanceForType ()  
   
  
   
  getIndex() 
  
   Required. The index being created.
 .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Index  
        The index.
 
       
     
  
   
  getIndexId() 
  
    
public   String   getIndexId ()  
   
   Optional. The ID for the index. This will become the final resource name
 for the index. If the user does not specify this value, it will be
 generated by system.
 This value should be up to 63 characters, and valid characters
 are /a-z -/. The first character must be a letter, the last could be
 a letter or a number.
 string index_id = 2 [(.google.api.field_behavior) = OPTIONAL];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The indexId.
 
       
     
  
   
  getIndexIdBytes() 
  
    
public   ByteString   getIndexIdBytes ()  
   
   Optional. The ID for the index. This will become the final resource name
 for the index. If the user does not specify this value, it will be
 generated by system.
 This value should be up to 63 characters, and valid characters
 are /a-z -/. The first character must be a letter, the last could be
 a letter or a number.
 string index_id = 2 [(.google.api.field_behavior) = OPTIONAL];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for indexId.
 
       
     
  
   
  getIndexOrBuilder() 
  
    
public   IndexOrBuilder   getIndexOrBuilder ()  
   
   Required. The index being created.
 .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
 
 
  
   
  getParent() 
  
    
public   String   getParent ()  
   
   Required. Value for the parent. The resource name of the Corpus under which
 this index is created. Format:
 projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
 
 string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The parent.
 
       
     
  
   
  getParentBytes() 
  
    
public   ByteString   getParentBytes ()  
   
   Required. Value for the parent. The resource name of the Corpus under which
 this index is created. Format:
 projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
 
 string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for parent.
 
       
     
  
   
  getParserForType() 
  
    
public   Parser<CreateIndexRequest>   getParserForType ()  
   
  
  Overrides 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  hasIndex() 
  
    
public   boolean   hasIndex ()  
   
   Required. The index being created.
 .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the index field is set.
 
       
     
  
   
  hashCode() 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   CreateIndexRequest . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   CreateIndexRequest . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   CreateIndexRequest . Builder   toBuilder ()  
   
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
 
  
    
    
      
       
    
    
  
  
 
  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.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]