Send feedback
  
   
 
  
    
      Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder (0.64.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 0.64.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   static   final   class  GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   extends   GeneratedMessageV3 . Builder<GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder >  implements   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadataOrBuilder  
   
   Describes the metadata associated with a retrieval step.
 Protobuf type 
 google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata
 
  
  
  
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder() 
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int) 
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int) 
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString) 
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int) 
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int) 
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder) 
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Methods
   
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
  Methods
   
   
  addRepeatedField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   addRepeatedField ( Descriptors . FieldDescriptor   field ,   Object   value )  
   
  
  
  Overrides 
  
   
  build() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata   build ()  
   
  
   
  buildPartial() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata   buildPartial ()  
   
  
   
  clear() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   clear ()  
   
  
  Overrides 
  
   
  clearDynamicRetrievalMetadata() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   clearDynamicRetrievalMetadata ()  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
   
  clearField(Descriptors.FieldDescriptor field) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   clearField ( Descriptors . FieldDescriptor   field )  
   
  
  
  Overrides 
  
   
  clearOneof(Descriptors.OneofDescriptor oneof) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   clearOneof ( Descriptors . OneofDescriptor   oneof )  
   
  
  
  Overrides 
  
   
  clearSource() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   clearSource ()  
   
   Describes the source to which the metadata is referring to.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;
 
 
  
   
  clone() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   clone ()  
   
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata   getDefaultInstanceForType ()  
   
  
   
  getDescriptorForType() 
  
    
public   Descriptors . Descriptor   getDescriptorForType ()  
   
  
  Overrides 
  
   
  getDynamicRetrievalMetadata() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . DynamicRetrievalMetadata   getDynamicRetrievalMetadata ()  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
   
  getDynamicRetrievalMetadataBuilder() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . DynamicRetrievalMetadata . Builder   getDynamicRetrievalMetadataBuilder ()  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
   
  getDynamicRetrievalMetadataOrBuilder() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . DynamicRetrievalMetadataOrBuilder   getDynamicRetrievalMetadataOrBuilder ()  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
   
  getSource() 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Source   getSource ()  
   
   Describes the source to which the metadata is referring to.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;
 
 
  
   
  getSourceValue() 
  
    
public   int   getSourceValue ()  
   
   Describes the source to which the metadata is referring to.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
        The enum numeric value on the wire for source.
 
       
     
  
   
  hasDynamicRetrievalMetadata() 
  
    
public   boolean   hasDynamicRetrievalMetadata ()  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the dynamicRetrievalMetadata field is set.
 
       
     
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  mergeDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata value) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   mergeDynamicRetrievalMetadata ( GenerateGroundedContentResponse . Candidate . GroundingMetadata . DynamicRetrievalMetadata   value )  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
  
   
  mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata other) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   mergeFrom ( GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata   other )  
   
  
  
   
  mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   mergeFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  Overrides 
  
  
   
  mergeFrom(Message other) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   mergeFrom ( Message   other )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        other 
        Message  
       
     
  
  
  Overrides 
  
   
  mergeUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   mergeUnknownFields ( UnknownFieldSet   unknownFields )  
   
  
  
  Overrides 
  
   
  setDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata value) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   setDynamicRetrievalMetadata ( GenerateGroundedContentResponse . Candidate . GroundingMetadata . DynamicRetrievalMetadata   value )  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
  
   
  setDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata.Builder builderForValue) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   setDynamicRetrievalMetadata ( GenerateGroundedContentResponse . Candidate . GroundingMetadata . DynamicRetrievalMetadata . Builder   builderForValue )  
   
   Metadata for dynamic retrieval.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;
 
 
  
  
   
  setField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   setField ( Descriptors . FieldDescriptor   field ,   Object   value )  
   
  
  
  Overrides 
  
   
  setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   setRepeatedField ( Descriptors . FieldDescriptor   field ,   int   index ,   Object   value )  
   
  
  
  Overrides 
  
   
  setSource(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source value) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   setSource ( GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Source   value )  
   
   Describes the source to which the metadata is referring to.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;
 
 
  
  
   
  setSourceValue(int value) 
  
    
public   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   setSourceValue ( int   value )  
   
   Describes the source to which the metadata is referring to.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;
 
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        value 
        int The enum numeric value on the wire for source to set.
 
       
     
  
  
   
  setUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   GenerateGroundedContentResponse . Candidate . GroundingMetadata . RetrievalMetadata . Builder   setUnknownFields ( UnknownFieldSet   unknownFields )  
   
  
  
  Overrides 
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    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."],[],[]]