Package com.google.genai.types

Class GroundingMetadata.Builder

java.lang.Object
com.google.genai.types.GroundingMetadata.Builder
Enclosing class:
GroundingMetadata
public abstract static class GroundingMetadata.Builder extends Object
Builder for GroundingMetadata.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • googleMapsWidgetContextToken

      public abstract GroundingMetadata.Builder googleMapsWidgetContextToken(String googleMapsWidgetContextToken)
      Setter for googleMapsWidgetContextToken.

      googleMapsWidgetContextToken: Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. This field is not supported in Gemini API.

    • clearGoogleMapsWidgetContextToken

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearGoogleMapsWidgetContextToken()
      Clears the value of googleMapsWidgetContextToken field.

    • groundingChunks

      public abstract GroundingMetadata.Builder groundingChunks(List<GroundingChunk> groundingChunks)
      Setter for groundingChunks.

      groundingChunks: List of supporting references retrieved from specified grounding source.

    • groundingChunks

      @CanIgnoreReturnValue public GroundingMetadata.Builder groundingChunks(GroundingChunk... groundingChunks)
      Setter for groundingChunks.

      groundingChunks: List of supporting references retrieved from specified grounding source.

    • groundingChunks

      @CanIgnoreReturnValue public GroundingMetadata.Builder groundingChunks(GroundingChunk.Builder... groundingChunksBuilders)
      Setter for groundingChunks builder.

      groundingChunks: List of supporting references retrieved from specified grounding source.

    • clearGroundingChunks

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearGroundingChunks()
      Clears the value of groundingChunks field.

    • groundingSupports

      public abstract GroundingMetadata.Builder groundingSupports(List<GroundingSupport> groundingSupports)
      Setter for groundingSupports.

      groundingSupports: Optional. List of grounding support.

    • groundingSupports

      @CanIgnoreReturnValue public GroundingMetadata.Builder groundingSupports(GroundingSupport... groundingSupports)
      Setter for groundingSupports.

      groundingSupports: Optional. List of grounding support.

    • groundingSupports

      @CanIgnoreReturnValue public GroundingMetadata.Builder groundingSupports(GroundingSupport.Builder... groundingSupportsBuilders)
      Setter for groundingSupports builder.

      groundingSupports: Optional. List of grounding support.

    • clearGroundingSupports

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearGroundingSupports()
      Clears the value of groundingSupports field.

    • retrievalMetadata

      public abstract GroundingMetadata.Builder retrievalMetadata(RetrievalMetadata retrievalMetadata)
      Setter for retrievalMetadata.

      retrievalMetadata: Optional. Output only. Retrieval metadata.

    • retrievalMetadata

      @CanIgnoreReturnValue public GroundingMetadata.Builder retrievalMetadata(RetrievalMetadata.Builder retrievalMetadataBuilder)
      Setter for retrievalMetadata builder.

      retrievalMetadata: Optional. Output only. Retrieval metadata.

    • clearRetrievalMetadata

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearRetrievalMetadata()
      Clears the value of retrievalMetadata field.

    • retrievalQueries

      public abstract GroundingMetadata.Builder retrievalQueries(List<String> retrievalQueries)
      Setter for retrievalQueries.

      retrievalQueries: Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API.

    • retrievalQueries

      @CanIgnoreReturnValue public GroundingMetadata.Builder retrievalQueries(String... retrievalQueries)
      Setter for retrievalQueries.

      retrievalQueries: Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API.

    • clearRetrievalQueries

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearRetrievalQueries()
      Clears the value of retrievalQueries field.

    • searchEntryPoint

      public abstract GroundingMetadata.Builder searchEntryPoint(SearchEntryPoint searchEntryPoint)
      Setter for searchEntryPoint.

      searchEntryPoint: Optional. Google search entry for the following-up web searches.

    • searchEntryPoint

      @CanIgnoreReturnValue public GroundingMetadata.Builder searchEntryPoint(SearchEntryPoint.Builder searchEntryPointBuilder)
      Setter for searchEntryPoint builder.

      searchEntryPoint: Optional. Google search entry for the following-up web searches.

    • clearSearchEntryPoint

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearSearchEntryPoint()
      Clears the value of searchEntryPoint field.

    • sourceFlaggingUris

      public abstract GroundingMetadata.Builder sourceFlaggingUris(List<GroundingMetadataSourceFlaggingUri> sourceFlaggingUris)
      Setter for sourceFlaggingUris.

      sourceFlaggingUris: Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. This field is not supported in Gemini API.

    • sourceFlaggingUris

      @CanIgnoreReturnValue public GroundingMetadata.Builder sourceFlaggingUris(GroundingMetadataSourceFlaggingUri... sourceFlaggingUris)
      Setter for sourceFlaggingUris.

      sourceFlaggingUris: Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. This field is not supported in Gemini API.

    • sourceFlaggingUris

      @CanIgnoreReturnValue public GroundingMetadata.Builder sourceFlaggingUris(GroundingMetadataSourceFlaggingUri.Builder... sourceFlaggingUrisBuilders)
      Setter for sourceFlaggingUris builder.

      sourceFlaggingUris: Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. This field is not supported in Gemini API.

    • clearSourceFlaggingUris

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearSourceFlaggingUris()
      Clears the value of sourceFlaggingUris field.

    • webSearchQueries

      public abstract GroundingMetadata.Builder webSearchQueries(List<String> webSearchQueries)
      Setter for webSearchQueries.

      webSearchQueries: Optional. Web search queries for the following-up web search.

    • webSearchQueries

      @CanIgnoreReturnValue public GroundingMetadata.Builder webSearchQueries(String... webSearchQueries)
      Setter for webSearchQueries.

      webSearchQueries: Optional. Web search queries for the following-up web search.

    • clearWebSearchQueries

      @CanIgnoreReturnValue public GroundingMetadata.Builder clearWebSearchQueries()
      Clears the value of webSearchQueries field.

    • build

      public abstract GroundingMetadata build()