### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ProvisionProjectMetadata.Builder

Builds an instance of ProvisionProjectMetadata.

```APIDOC
## build()

### Description
Builds an instance of ProvisionProjectMetadata.

### Method
```java
public ProvisionProjectMetadata build()
```

### Returns
- **Type**: `ProvisionProjectMetadata`
- **Description**: The built ProvisionProjectMetadata object.
```

--------------------------------

### getStartIndex

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

Gets the start index of the segment.

```APIDOC
## getStartIndex()

### Description
Retrieves the `start_index` of the segment, which is the zero-based byte index indicating the start of the segment.

### Method Signature
```java
public long getStartIndex()
```

### Returns
- **long** - The start index of the segment.
```

--------------------------------

### SearchTuningServiceStub.build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchTuningServiceGrpc.SearchTuningServiceStub

Protected method to create a new instance of the stub with the given channel and call options.

```APIDOC
## build(Channel channel, CallOptions callOptions)

### Description
Protected method to create a new instance of the stub with the given channel and call options.

### Method
`protected SearchTuningServiceGrpc.SearchTuningServiceStub build(Channel channel, CallOptions callOptions)`

### Parameters
#### Path Parameters
- **channel** (io.grpc.Channel) - Description
- **callOptions** (io.grpc.CallOptions) - Description

### Returns
#### Success Response
- **Type**: `SearchTuningServiceGrpc.SearchTuningServiceStub` - Description

### Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
```

--------------------------------

### Get Start Index of Attributed Segment

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchResponse.Summary.Citation.Builder

Retrieves the start index of the attributed segment, measured in bytes or Unicode characters.

```java
public long getStartIndex()
```

--------------------------------

### AssistantServiceSettings.Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantServiceSettings.Builder

Provides methods for configuring and building AssistantServiceSettings.

```APIDOC
## Methods

*   **applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)**: Applies a given function to all unaryCallSettings builders.
*   **build()**: Builds the AssistantServiceSettings object.
*   **getStubSettingsBuilder()**: Returns the builder for stub settings.
*   **streamAssistSettings()**: Configures settings for the streamAssist method.
```

--------------------------------

### Get Start Index of Segment

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantGroundedContent.TextGroundingMetadata.SegmentOrBuilder

Retrieves the zero-based start index of the text segment. This index is measured in bytes of a UTF-8 string.

```java
public abstract long getStartIndex()
```

--------------------------------

### SiteSearchEngineServiceSettings build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SiteSearchEngineServiceSettings.Builder

Builds the SiteSearchEngineServiceSettings object. Overrides ClientSettings.Builder.build().

```java
public SiteSearchEngineServiceSettings build()
```

--------------------------------

### Get Claim Start Position (Bytes)

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.Builder

Retrieves the start position of the claim in bytes. Note that this is byte-based, not character-based, and requires careful rendering for non-ASCII characters.

```java
public int getStartPos()
```

--------------------------------

### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantServiceSettings.Builder

Builds the AssistantServiceSettings object. Throws IOException if an error occurs during the build process.

```APIDOC
## build()

### Description
Builds the AssistantServiceSettings object.

### Returns
#### Success Response
- **Type**: `AssistantServiceSettings` - Description: 

### Exceptions
#### IOException
- **Type**: `IOException` - Description: 

### Code
```java
public AssistantServiceSettings build()
```
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.MostPopularFeatureConfig.Builder

Retrieves the default instance of MostPopularFeatureConfig. This can be used as a starting point or for comparison.

```java
public Engine.MediaRecommendationEngineConfig.MostPopularFeatureConfig getDefaultInstanceForType()
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig.Builder

Retrieves the default instance of the OptimizationObjectiveConfig. This is often used for comparison or as a starting point.

```java
public Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig getDefaultInstanceForType()
```

--------------------------------

### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.GroundingConfigName.Builder

Builds the GroundingConfigName object.

```APIDOC
## Methods 
### build()
```java
public GroundingConfigName build()
```

**Returns**  
---
**Type** | **Description**  
`GroundingConfigName` |   
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DeleteSitemapMetadata.Builder

Retrieves the default instance of DeleteSitemapMetadata. This is often used for comparisons or as a starting point.

```java
public DeleteSitemapMetadata getDefaultInstanceForType()
```

--------------------------------

### Build RecommendRequest

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.RecommendRequest.Builder

Builds an instance of RecommendRequest.

```java
public RecommendRequest build()
```

--------------------------------

### MediaConfig Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ServingConfig.MediaConfig.Builder

Provides documentation for the build, buildPartial, and clear methods of the MediaConfig builder.

```APIDOC
## Methods 
### build()
```
public ServingConfig.MediaConfig build()
```

**Returns**  
---
**Type** | **Description**  
`ServingConfig.MediaConfig` |   

### buildPartial()
```
public ServingConfig.MediaConfig buildPartial()
```

**Returns**  
---
**Type** | **Description**  
`ServingConfig.MediaConfig` |   

### clear()
```
public ServingConfig.MediaConfig.Builder clear()
```

**Returns**  
---
**Type** | **Description**  
`ServingConfig.MediaConfig.Builder` |   
**Overrides**
GeneratedMessage.Builder<BuilderType>.clear()
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.BatchUpdateUserLicensesResponse.Builder

Retrieves the default instance of BatchUpdateUserLicensesResponse. This is often used for comparisons or as a starting point.

```java
public BatchUpdateUserLicensesResponse getDefaultInstanceForType()
```

--------------------------------

### Control.PromoteAction.Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Control.PromoteAction.Builder

This section lists the methods available on the Control.PromoteAction.Builder class for constructing and modifying PromoteAction configurations.

```APIDOC
## Class Control.PromoteAction.Builder

### Description
Builder for `Control.PromoteAction`. Used to promote certain links based on some trigger queries. For example, promote a shoe store link when searching for the `shoe` keyword. The link can be outside of the associated data store.

### Methods

*   **build()**: Builds the `Control.PromoteAction` object.
*   **buildPartial()**: Builds a partial `Control.PromoteAction` object.
*   **clear()**: Clears all fields in the builder.
*   **clearDataStore()**: Clears the `dataStore` field.
*   **clearSearchLinkPromotion()**: Clears the `searchLinkPromotion` field.
*   **getDataStore()**: Gets the `dataStore` field.
*   **getDataStoreBytes()**: Gets the `dataStore` field as bytes.
*   **getDefaultInstanceForType()**: Gets the default instance for the builder's type.
*   **getDescriptorForType()**: Gets the descriptor for the builder's type.
*   **getSearchLinkPromotion()**: Gets the `searchLinkPromotion` field.
*   **getSearchLinkPromotionBuilder()**: Gets a builder for the `searchLinkPromotion` field.
*   **getSearchLinkPromotionOrBuilder()**: Gets the `searchLinkPromotion` field or its builder.
*   **hasSearchLinkPromotion()**: Checks if the `searchLinkPromotion` field is set.
*   **internalGetFieldAccessorTable()**: Returns the internal field accessor table.
*   **isInitialized()**: Checks if the message is initialized.
*   **mergeFrom(Control.PromoteAction other)**: Merges another `Control.PromoteAction` into this builder.
*   **mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)**: Merges from a coded input stream.
*   **mergeFrom(Message other)**: Merges from another message.
*   **mergeSearchLinkPromotion(SearchLinkPromotion value)**: Merges a `SearchLinkPromotion` into the `searchLinkPromotion` field.
*   **setDataStore(String value)**: Sets the `dataStore` field.
*   **setDataStoreBytes(ByteString value)**: Sets the `dataStore` field as bytes.
*   **setSearchLinkPromotion(SearchLinkPromotion value)**: Sets the `searchLinkPromotion` field.
*   **setSearchLinkPromotion(SearchLinkPromotion.Builder builderForValue)**: Sets the `searchLinkPromotion` field using a builder.
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext.Builder

Returns the default instance of DocumentContext. This is typically used for comparisons or as a starting point.

```java
public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext getDefaultInstanceForType()
```

--------------------------------

### Get Default UrisMatcher Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.FetchSitemapsRequest.UrisMatcher.Builder

Retrieves the default, unconfigured instance of UrisMatcher. This can be useful for comparisons or as a starting point.

```java
public FetchSitemapsRequest.UrisMatcher getDefaultInstanceForType()
```

--------------------------------

### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DataStoreName.ProjectLocationCollectionDataStoreBuilder

Builds the DataStoreName object.

```APIDOC
## Methods 
### build()
```java
public DataStoreName build()
```

**Returns**
---
**Type** | **Description**
`DataStoreName` |
```

--------------------------------

### Claim Position Access

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.Builder

Methods to get the start and end byte positions of the claim within the answer candidate.

```APIDOC
## getStartPos()

### Description
Retrieves the byte position indicating the start of the claim in the answer candidate.

### Method
```java
public int getStartPos()
```

### Returns
* **int** - The start position of the claim in bytes.
```

```APIDOC
## getEndPos()

### Description
Retrieves the byte position indicating the end of the claim in the answer candidate (exclusive).

### Method
```java
public int getEndPos()
```

### Returns
* **int** - The end position of the claim in bytes.
```

--------------------------------

### build

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Control.SynonymsAction.Builder

Builds the Control.SynonymsAction object.

```APIDOC
## build()

### Description
Builds the Control.SynonymsAction object.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Returns
- **Type**: Control.SynonymsAction
- **Description**: The built Control.SynonymsAction object.
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder

Returns an immutable instance of the ControlPoint with default values. This is often used for comparisons or as a starting point.

```java
public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint getDefaultInstanceForType()
```

--------------------------------

### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Answer.GroundingSupport.Builder

Builds the Answer.GroundingSupport object.

```APIDOC
## build()

### Description
Builds the Answer.GroundingSupport object.

### Method
public Answer.GroundingSupport build()

### Returns
#### Success Response
- **Type**: Answer.GroundingSupport - Description not available
```

--------------------------------

### Instance Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig

Methods for interacting with an Engine instance.

```APIDOC
## Instance Methods

### equals(Object obj)
- Description: Checks if this Engine is equal to another object.
- Parameters:
  - obj (Object) - The object to compare with.
- Returns: boolean - True if the objects are equal, false otherwise.

### getDefaultInstanceForType()
- Description: Gets the default instance for the current message type.
- Returns: MessageLite - The default instance.

### getParserForType()
- Description: Gets the parser for the current message type.
- Returns: Parser<Engine> - The parser.

### getSearchAddOns(int index)
- Description: Gets a specific search add-on by index.
- Parameters:
  - index (int) - The index of the search add-on.
- Returns: SearchAddOn - The search add-on at the specified index.

### getSearchAddOnsCount()
- Description: Gets the number of search add-ons.
- Returns: int - The count of search add-ons.

### getSearchAddOnsList()
- Description: Gets the list of all search add-ons.
- Returns: List<SearchAddOn> - The list of search add-ons.

### getSearchAddOnsValue(int index)
- Description: Gets the enum value of a specific search add-on by index.
- Parameters:
  - index (int) - The index of the search add-on.
- Returns: int - The enum value of the search add-on.

### getSearchAddOnsValueList()
- Description: Gets the list of enum values for all search add-ons.
- Returns: List<Integer> - The list of enum values.

### getSearchTier()
- Description: Gets the search tier.
- Returns: SearchTier - The search tier.

### getSearchTierValue()
- Description: Gets the enum value of the search tier.
- Returns: int - The enum value of the search tier.

### getSerializedSize()
- Description: Gets the serialized size of the Engine.
- Returns: int - The serialized size.

### hashCode()
- Description: Computes the hash code for this Engine.
- Returns: int - The hash code.

### internalGetFieldAccessorTable()
- Description: Internal method to get the field accessor table.
- Returns: FieldAccessorTable - The field accessor table.

### isInitialized()
- Description: Checks if the Engine is initialized.
- Returns: boolean - True if initialized, false otherwise.

### newBuilderForType()
- Description: Creates a new builder for the same type as this Engine.
- Returns: Builder - A new builder instance.

### newBuilderForType(AbstractMessage.BuilderParent parent)
- Description: Creates a new builder for the same type with a parent.
- Parameters:
  - parent (AbstractMessage.BuilderParent) - The parent builder.
- Returns: Builder - A new builder instance.

### toBuilder()
- Description: Creates a builder that contains the state of this Engine.
- Returns: Builder - A builder instance with the current state.

### writeTo(CodedOutputStream output)
- Description: Writes the Engine to a CodedOutputStream.
- Parameters:
  - output (CodedOutputStream) - The output stream to write to.
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata.Builder

Retrieves the default instance of DocumentMetadata for the current type. This is often used for comparisons or as a starting point.

```java
public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata getDefaultInstanceForType()
```

--------------------------------

### Get Signal Value - Java

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

Use `getValue()` to retrieve the optional float value representing the ranking signal. For example, 1.25 for BM25.

```java
public float getValue()
```

--------------------------------

### Assistant Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Assistant.Builder

Provides documentation for the builder methods available for the Assistant class, including build, buildPartial, and clear.

```APIDOC
## build()

### Description
Builds the Assistant instance using the current builder configuration.

### Method
```java
public Assistant build()
```

### Returns
- **Type**: `Assistant`
- **Description**: The constructed Assistant object.

## buildPartial()

### Description
Builds a partial Assistant instance, which may not be fully initialized.

### Method
```java
public Assistant buildPartial()
```

### Returns
- **Type**: `Assistant`
- **Description**: The partially constructed Assistant object.

## clear()

### Description
Clears all fields in the builder, resetting it to its initial state.

### Method
```java
public Assistant.Builder clear()
```

### Returns
- **Type**: `Assistant.Builder`
- **Description**: The builder instance after clearing all fields.

### Overrides
GeneratedMessage.Builder<BuilderType>.clear()
```

--------------------------------

### getControl

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ControlServiceGrpc.ControlServiceFutureStub

Gets a Control. 

If the Control to get is a `SearchEngineControl`, then the control id must not be empty. 

If the Control to get is a `ChatControl`, then the control id must not be empty. 

If the Control to get is a `CompletionControl`, then the control id must not be empty.

```APIDOC
## getControl(GetControlRequest request)

### Description
Gets a Control.

### Method
GET

### Endpoint
/v1/projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/controls/{control}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name of the project to get the control from.
- **location** (string) - Required - The location of the project.
- **collection** (string) - Required - The collection ID.
- **dataStore** (string) - Required - The data store ID.
- **control** (string) - Required - The ID of the control to retrieve.

### Response
#### Success Response (200)
- **name** (string) - The fully qualified resource name of the control.
- **solution_type** (string) - The solution type of the control.
- **search_engine_control** (object) - The control to be used for search engine.
  - **search_engine_id** (string) - The search engine ID.
- **completion_control** (object) - The control to be used for completion.
  - **search_enabled** (boolean) - Indicates whether the completion suggestion is enabled.
- **display_name** (string) - The display name of the control.
- **common_config** (object) - Common config for all control types.
  - **solution_type** (string) - The solution type of the control.
  - **display_name** (string) - The display name of the control.

#### Response Example
```json
{
  "name": "projects/my-project/locations/global/collections/default_collection/dataStores/my-datastore/controls/control-id-123",
  "solution_type": "SOLUTION_TYPE_SEARCH",
  "search_engine_control": {
    "search_engine_id": "search_engine_123"
  },
  "display_name": "My Search Control",
  "common_config": {
    "solution_type": "SOLUTION_TYPE_SEARCH",
    "display_name": "My Search Control"
  }
}
```
```

--------------------------------

### ControlServiceSettings.Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ControlServiceSettings.Builder

Lists the available methods for configuring ControlService settings.

```APIDOC
## Methods

*   `applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)`
*   `build()`
*   `createControlSettings()`
*   `deleteControlSettings()`
*   `getControlSettings()`
*   `getStubSettingsBuilder()`
*   `listControlsSettings()`
*   `updateControlSettings()`
```

--------------------------------

### Get Descriptor

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion.Builder

Gets the descriptor for the type of this message.

```APIDOC
## getDescriptorForType()

### Description
Gets the descriptor for the type of this message.

### Method
```java
public Descriptors.Descriptor getDescriptorForType()
```

### Returns
- **Descriptor**: The descriptor for the message type.
```

--------------------------------

### ControlPoint Utility Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder

Includes methods for getting the default instance, descriptor, and checking initialization status.

```APIDOC
## getDefaultInstanceForType()

### Description
Gets the default instance of the ControlPoint.

### Method
```java
public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint getDefaultInstanceForType()
```

### Returns
- **Type**: `SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint`

### getDescriptorForType()

### Description
Gets the descriptor for the ControlPoint type.

### Method
```java
public Descriptors.Descriptor getDescriptorForType()
```

### Returns
- **Type**: `Descriptor`

### isInitialized()

### Description
Checks if the ControlPoint is initialized.

### Method
```java
public final boolean isInitialized()
```

### Returns
- **Type**: `boolean`
```

--------------------------------

### build

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ProjectServiceSettings.Builder

Builds the ProjectServiceSettings object.

```APIDOC
### build()
```
public ProjectServiceSettings build()
```

**Returns**  
---
**Type** | **Description**  
`ProjectServiceSettings` |   
**Overrides**
ClientSettings.Builder<SettingsT,B>.build()
**Exceptions**  
---
**Type** | **Description**  
`IOException` |   
```

--------------------------------

### Check if Start Position is Set

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.Builder

Determines if the start position of the claim has been set. The start position is measured in bytes and may differ from character-based measurements for non-ASCII text.

```java
public boolean hasStartPos()
```

--------------------------------

### Get Default Instance

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ListCustomModelsResponse.Builder

Methods to get the default instance of the response.

```APIDOC
## getDefaultInstanceForType()

### Description
Returns the default instance of this message type.

### Method
```java
public ListCustomModelsResponse getDefaultInstanceForType()
```

### Returns
- **ListCustomModelsResponse** - The default instance.
```

```APIDOC
## getDescriptorForType()

### Description
Gets the descriptor for the message type.

### Method
```java
public Descriptors.Descriptor getDescriptorForType()
```

### Overrides
GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

### Returns
- **Descriptor** - The descriptor for the message type.
```

--------------------------------

### Builder and Instance Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.BatchGetDocumentsMetadataRequest.UrisMatcher

Methods for creating new instances, builders, and retrieving default instances.

```APIDOC
## newBuilderForType()

### Description
Creates a new builder for a UrisMatcher of the same type.

### Method
`public BatchGetDocumentsMetadataRequest.UrisMatcher.Builder newBuilderForType()`

### Returns
* **BatchGetDocumentsMetadataRequest.UrisMatcher.Builder** - A new instance of the builder.
```

```APIDOC
## newBuilderForType(AbstractMessage.BuilderParent parent)

### Description
Creates a new builder for a UrisMatcher with a parent builder.

### Method
`protected BatchGetDocumentsMetadataRequest.UrisMatcher.Builder newBuilderForType(AbstractMessage.BuilderParent parent)`

### Parameters
* **parent** (AbstractMessage.BuilderParent) - The parent builder.

### Returns
* **BatchGetDocumentsMetadataRequest.UrisMatcher.Builder** - A new instance of the builder associated with the parent.
```

```APIDOC
## getDefaultInstanceForType()

### Description
Retrieves the default instance for the UrisMatcher type.

### Method
`public BatchGetDocumentsMetadataRequest.UrisMatcher getDefaultInstanceForType()`

### Returns
* **BatchGetDocumentsMetadataRequest.UrisMatcher** - The default instance.
```

--------------------------------

### build

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchTuningServiceSettings.Builder

Builds the SearchTuningServiceSettings object.

```APIDOC
## build()

### Description
Builds the SearchTuningServiceSettings object.

### Method
```java
public SearchTuningServiceSettings build()
```

### Returns
- **Type**: SearchTuningServiceSettings
- **Description**: 

### Exceptions
- **Type**: IOException
- **Description**: 
```

--------------------------------

### Set Start Index

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

Sets the zero-based start index of the segment.

```APIDOC
## setStartIndex(long value)

### Description
Sets the zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string.

### Parameters
* **value** (long) - Required - The startIndex to set.

### Returns
* **Type**: AssistantGroundedContent.TextGroundingMetadata.Segment.Builder
* **Description**: This builder for chaining.
```

--------------------------------

### Get Citation Indices for Claim

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CheckGroundingResponse.Builder

Retrieves a list of indices that point to cited chunks supporting the claim. Use getCitationIndicesCount() to get the number of indices and getCitationIndicesList() to get the entire list.

```java
public int getCitationIndices(int index)
```

```java
public int getCitationIndicesCount()
```

```java
public List<Integer> getCitationIndicesList()
```

--------------------------------

### Build ProvisionProjectMetadata

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ProvisionProjectMetadata.Builder

Constructs a new ProvisionProjectMetadata instance.

```java
public ProvisionProjectMetadata build()
```

--------------------------------

### Constructors

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AnswerName.ProjectLocationCollectionEngineSessionAnswerBuilder

Initializes a new instance of the AnswerName.ProjectLocationCollectionEngineSessionAnswerBuilder class.

```APIDOC
## Constructors 
### ProjectLocationCollectionEngineSessionAnswerBuilder()
```java
protected ProjectLocationCollectionEngineSessionAnswerBuilder()
```
```

--------------------------------

### Get Time Zone

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistUserMetadata.Builder

Gets the IANA time zone. This is an optional field.

```java
public String getTimeZone()
```

--------------------------------

### Accessing Start Index

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Answer.Citation.Builder

Method for retrieving the start index of the attributed segment.

```APIDOC
## getStartIndex()

### Description
Retrieves the start index of the attributed segment, measured in bytes (UTF-8 unicode).

### Method
`public long getStartIndex()`

### Returns
#### Success Response
- **long** - The start index of the segment.
```

--------------------------------

### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.IdentityMappingStoreName.Builder

Builds an instance of IdentityMappingStoreName.

```APIDOC
## build()

### Description
Builds an instance of IdentityMappingStoreName.

### Method
```java
public IdentityMappingStoreName build()
```

### Returns
* **Type**: `IdentityMappingStoreName`
* **Description**: An instance of IdentityMappingStoreName.
```

--------------------------------

### Get Name from DeleteCmekConfigRequest

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DeleteCmekConfigRequest.Builder

Gets the resource name of the CmekConfig to delete. This is a required field.

```java
public String getName()
```

--------------------------------

### SiteSearchEngine.Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SiteSearchEngine.Builder

This section details the available methods for building and manipulating SiteSearchEngine configurations.

```APIDOC
## Class SiteSearchEngine.Builder

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

### Methods

*   **build()**: Builds the SiteSearchEngine object.
*   **buildPartial()**: Builds a partial SiteSearchEngine object.
*   **clear()**: Clears the SiteSearchEngine builder.
*   **clearName()**: Clears the name field.
*   **getDefaultInstanceForType()**: Gets the default instance for the builder's type.
*   **getDescriptorForType()**: Gets the descriptor for the builder's type.
*   **getName()**: Gets the name of the SiteSearchEngine.
*   **getNameBytes()**: Gets the name of the SiteSearchEngine as a ByteString.
*   **internalGetFieldAccessorTable()**: Internal method to get the field accessor table.
*   **isInitialized()**: Checks if the SiteSearchEngine is initialized.
*   **mergeFrom(SiteSearchEngine other)**: Merges another SiteSearchEngine into this builder.
*   **mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)**: Merges from a CodedInputStream.
*   **mergeFrom(Message other)**: Merges from a Message.
*   **setName(String value)**: Sets the name of the SiteSearchEngine.
*   **setNameBytes(ByteString value)**: Sets the name of the SiteSearchEngine as a ByteString.
```

--------------------------------

### DataStore Configuration Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DataStore.Builder

This section outlines various methods for configuring a DataStore, including setting its industry vertical, KMS key name, name, natural language query understanding settings, solution types, starting schema, and workspace configuration.

```APIDOC
## DataStore Configuration

### Methods

- `setIndustryVerticalValue(int value)`: Sets the industry vertical for the DataStore.
- `setKmsKeyName(String value)`: Sets the KMS key name for encryption.
- `setKmsKeyNameBytes(ByteString value)`: Sets the KMS key name as bytes.
- `setName(String value)`: Sets the name of the DataStore.
- `setNameBytes(ByteString value)`: Sets the name of the DataStore as bytes.
- `setNaturalLanguageQueryUnderstandingConfig(NaturalLanguageQueryUnderstandingConfig value)`: Sets the natural language query understanding configuration.
- `setNaturalLanguageQueryUnderstandingConfig(NaturalLanguageQueryUnderstandingConfig.Builder builderForValue)`: Sets the natural language query understanding configuration using a builder.
- `setSolutionTypes(int index, SolutionType value)`: Sets a specific solution type at a given index.
- `setSolutionTypesValue(int index, int value)`: Sets the integer value of a solution type at a given index.
- `setStartingSchema(Schema value)`: Sets the starting schema for the DataStore.
- `setStartingSchema(Schema.Builder builderForValue)`: Sets the starting schema using a builder.
- `setWorkspaceConfig(WorkspaceConfig value)`: Sets the workspace configuration.
- `setWorkspaceConfig(WorkspaceConfig.Builder builderForValue)`: Sets the workspace configuration using a builder.
```

--------------------------------

### Internal Get Field Accessor Table

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion.Builder

Gets the field accessor table for this message.

```APIDOC
## internalGetFieldAccessorTable()

### Description
Gets the field accessor table for this message.

### Method
```java
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```

### Returns
- **FieldAccessorTable**: The field accessor table.
```

--------------------------------

### build

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ServingConfigServiceSettings.Builder

Builds the ServingConfigServiceSettings object.

```APIDOC
## build()
```java
public ServingConfigServiceSettings build()
```

**Returns**
---
**Type** | **Description**
`ServingConfigServiceSettings` |

**Overrides**
ClientSettings.Builder<SettingsT,B>.build()

**Exceptions**
---
**Type** | **Description**
`IOException` |
```

--------------------------------

### Boost Condition Example

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Example of a boost condition expression. This syntax is compatible with SearchRequest.filter.

```plaintext
(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
```

--------------------------------

### SearchRequest.SearchAsYouTypeSpec.Condition Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition

The SearchAsYouTypeSpec.Condition enum provides the following instance methods:
- `getDescriptorForType()`: Gets the Descriptor for the type.
- `getNumber()`: Gets the numeric value of the enum constant.
- `getValueDescriptor()`: Gets the EnumValueDescriptor for the enum constant.

```APIDOC
## Methods

*   `getDescriptorForType()`
*   `getNumber()`
*   `getValueDescriptor()`
```

--------------------------------

### build

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata.Builder

Builds the SearchResponse.Summary.SummaryWithMetadata object.

```APIDOC
## build()

### Description
Constructs and returns the immutable SearchResponse.Summary.SummaryWithMetadata object.

### Method Signature
```java
public SearchResponse.Summary.SummaryWithMetadata build()
```

### Returns
* **SearchResponse.Summary.SummaryWithMetadata** - The constructed SummaryWithMetadata object.
```

```APIDOC
## buildPartial()

### Description
Constructs and returns a partial SearchResponse.Summary.SummaryWithMetadata object. This method is typically used internally.

### Method Signature
```java
public SearchResponse.Summary.SummaryWithMetadata buildPartial()
```

### Returns
* **SearchResponse.Summary.SummaryWithMetadata** - The constructed partial SummaryWithMetadata object.
```

--------------------------------

### Build Partial RecommendRequest

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.RecommendRequest.Builder

Builds a partial instance of RecommendRequest.

```java
public RecommendRequest buildPartial()
```

--------------------------------

### Get Alternative Phrases Count

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CompletionSuggestion.Builder

Gets the total count of alternative matching phrases for the suggestion.

```java
public int getAlternativePhrasesCount()
```

--------------------------------

### General Configuration Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ServingConfig.GenericConfig.Builder

Methods for retrieving and managing the default instance and descriptor for GenericConfig.

```APIDOC
## getDefaultInstanceForType()

### Description
Gets the default instance of GenericConfig for the current type.

### Method
`public ServingConfig.GenericConfig getDefaultInstanceForType()`

### Returns
- **Type**: `ServingConfig.GenericConfig`
- **Description**: The default instance.
```

```APIDOC
## getDescriptorForType()

### Description
Gets the descriptor for the type of GenericConfig.

### Method
`public Descriptors.Descriptor getDescriptorForType()`

### Returns
- **Type**: `Descriptor`
- **Description**: The descriptor for the type.
```

```APIDOC
## isInitialized()

### Description
Checks if the message is initialized.

### Method
`public final boolean isInitialized()`

### Returns
- **Type**: `boolean`
- **Description**: True if the message is initialized, false otherwise.
```

--------------------------------

### Get Time Zone Bytes

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistUserMetadata.Builder

Gets the IANA time zone as a ByteString. This is an optional field.

```java
public ByteString getTimeZoneBytes()
```

--------------------------------

### Get Document URI

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata

Retrieves the URI for the document. Use this method to get the URI as a String.

```java
public String getUri()
```

--------------------------------

### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ListCmekConfigsResponse.Builder

Builds the ListCmekConfigsResponse object.

```APIDOC
## build()

### Description
Builds the ListCmekConfigsResponse object.

### Method
```java
public ListCmekConfigsResponse build()
```

### Returns
* **ListCmekConfigsResponse** - The constructed ListCmekConfigsResponse object.
```

--------------------------------

### Get Document Title

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata

Retrieves the title of the document. Use this method to get the title as a String.

```java
public String getTitle()
```

--------------------------------

### ServingConfigServiceFutureStub Build Method

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ServingConfigServiceGrpc.ServingConfigServiceFutureStub

This method is used to create a new stub instance with the specified channel and call options. It overrides the build method from the AbstractStub class.

```java
protected ServingConfigServiceGrpc.ServingConfigServiceFutureStub build(Channel channel, CallOptions callOptions)
```

--------------------------------

### Internal Get Field Accessor Table

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DeleteCmekConfigMetadata.Builder

Internal method to get the field accessor table for the builder.

```APIDOC
## internalGetFieldAccessorTable()

### Description
Internal method to retrieve the field accessor table for the builder.

### Method Signature
```java
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```

### Returns
- **Type**: `GeneratedMessage.FieldAccessorTable`
- **Description**: The field accessor table.
```

--------------------------------

### Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ServingConfigServiceSettings.Builder

The available methods for the ServingConfigServiceSettings.Builder class.

```APIDOC
## Methods

### applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

### build()

### getStubSettingsBuilder()

### updateServingConfigSettings()
```

--------------------------------

### Get Name Bytes from DeleteCmekConfigRequest

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DeleteCmekConfigRequest.Builder

Gets the resource name of the CmekConfig to delete as bytes. This is a required field.

```java
public ByteString getNameBytes()
```

--------------------------------

### Build Partial ProvisionProjectMetadata

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ProvisionProjectMetadata.Builder

Constructs a partial ProvisionProjectMetadata instance, which may not be fully initialized.

```java
public ProvisionProjectMetadata buildPartial()
```

--------------------------------

### Get User Labels (Deprecated)

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CheckGroundingRequest.Builder

Deprecated method to get user labels. Use #getUserLabelsMap() instead.

```java
public Map<String,String> getUserLabels()
```

--------------------------------

### Build SearchTuningServiceStub

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchTuningServiceGrpc.SearchTuningServiceStub

Constructs a new stub with the specified channel and call options. This method is protected and intended for internal use or subclassing.

```java
protected SearchTuningServiceGrpc.SearchTuningServiceStub build(Channel channel, CallOptions callOptions)
```

--------------------------------

### getServingConfigBytes

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.RecommendRequest.Builder

Retrieves the serving configuration as a ByteString for the recommendation request.

```APIDOC
## getServingConfigBytes()

### Description
Gets the serving configuration used for the recommendation request as a ByteString. This is an alternative way to access the serving configuration.

### Method Signature
```java
public ByteString getServingConfigBytes()
```

### Returns
* **ByteString** - The serving configuration as a ByteString.

### Serving Config Format
`projects/*/locations/global/collections/*/engines/*/servingConfigs/*` or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

### Example Serving Config
For an engine `projects/*/locations/global/collections/*/engines/my-engine`, a valid serving config could be `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`.
```

--------------------------------

### Get Document Title

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo.DocumentMetadataOrBuilder

Retrieves the title of the document as a String. Use this method to get the human-readable title.

```java
public abstract String getTitle()
```

--------------------------------

### Build RecommendationServiceSettings

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.RecommendationServiceSettings.Builder

Builds the RecommendationServiceSettings object. This method may throw an IOException.

```java
public RecommendationServiceSettings build()

```

--------------------------------

### Get Default Instance - Java

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SuggestionDenyListEntry.Builder

Gets the default instance of SuggestionDenyListEntry. This is useful for obtaining a base instance of the object.

```java
public SuggestionDenyListEntry getDefaultInstanceForType()
```

--------------------------------

### Get Chunk Content

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContentOrBuilder

Retrieves the textual content of a chunk. Use this method to get the string representation of the content.

```java
public abstract String getContent()

Chunk textual content.
`string content = 1;`
```

--------------------------------

### CompletionServiceSettings.Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.CompletionServiceSettings.Builder

These methods allow for the configuration and building of CompletionServiceSettings.

```APIDOC
## Methods

### applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

Applies the given settings updater to all unary methods.

### build()

Builds the `CompletionServiceSettings` instance.

### completeQuerySettings()

Returns the settings for the `CompleteQuery` method.

### getStubSettingsBuilder()

Returns the builder for the stub settings.

### importCompletionSuggestionsOperationSettings()

Returns the settings for the `ImportCompletionSuggestions` operation.

### importCompletionSuggestionsSettings()

Returns the settings for the `ImportCompletionSuggestions` method.

### importSuggestionDenyListEntriesOperationSettings()

Returns the settings for the `ImportSuggestionDenyListEntries` operation.

### importSuggestionDenyListEntriesSettings()

Returns the settings for the `ImportSuggestionDenyListEntries` method.

### purgeCompletionSuggestionsOperationSettings()

Returns the settings for the `PurgeCompletionSuggestions` operation.

### purgeCompletionSuggestionsSettings()

Returns the settings for the `PurgeCompletionSuggestions` method.

### purgeSuggestionDenyListEntriesOperationSettings()

Returns the settings for the `PurgeSuggestionDenyListEntries` operation.

### purgeSuggestionDenyListEntriesSettings()

Returns the settings for the `PurgeSuggestionDenyListEntries` method.
```

--------------------------------

### RecommendedForYouFeatureConfig Build Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig.Builder

Provides methods to build instances of RecommendedForYouFeatureConfig.

```APIDOC
## build()
```java
public Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig build()
```

**Returns**
---
**Type** | **Description**
`Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig` |

## buildPartial()
```java
public Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig buildPartial()
```

**Returns**
---
**Type** | **Description**
`Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig` |
```

--------------------------------

### Get Longitude - Java

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.GeolocationConstraint.Builder

Retrieves the longitude of the geolocation inferred from the input query. Use this to get the longitude value.

```java
public double getLongitude()
```

--------------------------------

### Check Initialization and Get Default Instance - Java

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.PurgeCompletionSuggestionsMetadata.Builder

Check if the message is initialized and get the default instance of PurgeCompletionSuggestionsMetadata.

```java
public PurgeCompletionSuggestionsMetadata getDefaultInstanceForType()
```

```java
public final boolean isInitialized()
```

--------------------------------

### EngineServiceSettings.Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.EngineServiceSettings.Builder

Lists the available methods for configuring EngineServiceSettings.

```APIDOC
## Methods

### applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

### build()

### createEngineOperationSettings()

### createEngineSettings()

### deleteEngineOperationSettings()

### deleteEngineSettings()

### getEngineSettings()

### getStubSettingsBuilder()

### listEnginesSettings()

### updateEngineSettings()
```

--------------------------------

### AssistantServiceSettings.Builder Constructors

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantServiceSettings.Builder

Provides various constructors for initializing the AssistantServiceSettings.Builder.

```APIDOC
## Constructors

*   **Builder()**
*   **Builder(ClientContext clientContext)**
*   **Builder(AssistantServiceSettings settings)**
*   **Builder(AssistantServiceStubSettings.Builder stubSettings)**
```

--------------------------------

### Get Default Instance for DynamicRetrievalMetadata

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata.Builder

Retrieves the default instance of DynamicRetrievalMetadata. This is often used to get a baseline configuration.

```java
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata getDefaultInstanceForType()
```

--------------------------------

### ProjectServiceSettings.Builder

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.ProjectServiceSettings.Builder

Constructors for ProjectServiceSettings.Builder.

```APIDOC
## Constructors 
### Builder()
```
protected Builder()
```

### Builder(ClientContext clientContext)
```
protected Builder(ClientContext clientContext)
```
**Parameter**  
---
**Name** | **Description**  
`clientContext` | `ClientContext`  

### Builder(ProjectServiceSettings settings)
```
protected Builder(ProjectServiceSettings settings)
```
**Parameter**  
---
**Name** | **Description**  
`settings` | `ProjectServiceSettings`  

### Builder(ProjectServiceStubSettings.Builder stubSettings)
```
protected Builder(ProjectServiceStubSettings.Builder stubSettings)
```
**Parameter**  
---
**Name** | **Description**  
`stubSettings` | `ProjectServiceStubSettings.Builder`  
```

--------------------------------

### Get Website URI

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata.WebsiteInfo

Retrieves the URL of the website as a String. Use this method to get the website's URI.

```java
public abstract String getUri()

The url of the website.
`string uri = 1;`
```

--------------------------------

### Build SearchTuningServiceSettings

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchTuningServiceSettings.Builder

Builds the SearchTuningServiceSettings object. This method may throw an IOException.

```java
public SearchTuningServiceSettings build()

```

--------------------------------

### Get Website Title

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata.WebsiteInfo

Retrieves the title of the website as a String. Use this method to get the website's title.

```java
public abstract String getTitle()

The title of the website.
`string title = 2;`
```

--------------------------------

### SitemapName.ProjectLocationCollectionDataStoreSitemapBuilder Constructors

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SitemapName.ProjectLocationCollectionDataStoreSitemapBuilder

Initializes a new instance of the SitemapName.ProjectLocationCollectionDataStoreSitemapBuilder class.

```APIDOC
## Constructors 
### ProjectLocationCollectionDataStoreSitemapBuilder()
```java
protected ProjectLocationCollectionDataStoreSitemapBuilder()
```
```

--------------------------------

### Get Page Identifier as String

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext.Builder

Retrieves the page identifier as a String. This method is used to get the identifier of the page.

```java
public String getPageIdentifier()
```

--------------------------------

### Check if Starting Schema is Set

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DataStore.Builder

Verifies if a starting schema is set for the DataStore. This field is used only by the CreateDataStore API.

```java
public boolean hasStartingSchema()
```

--------------------------------

### build

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

Builds the AssistantGroundedContent.TextGroundingMetadata.Segment object.

```APIDOC
## build()

### Description
Builds and returns the immutable AssistantGroundedContent.TextGroundingMetadata.Segment object.

### Method Signature
```java
public AssistantGroundedContent.TextGroundingMetadata.Segment build()
```

### Returns
- **AssistantGroundedContent.TextGroundingMetadata.Segment** - The constructed segment object.
```

--------------------------------

### DataStoreServiceImplBase()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.DataStoreServiceGrpc.DataStoreServiceImplBase

Constructs a new instance of DataStoreServiceImplBase.

```APIDOC
## DataStoreServiceImplBase()

### Description
Constructs a new instance of DataStoreServiceImplBase.

### Constructor Signature
```java
public DataStoreServiceImplBase()
```
```

--------------------------------

### clearStartIndex()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Answer.Citation.Builder

Clears the start index of the attributed segment. The start index indicates the beginning of the segment, measured in bytes.

```APIDOC
## clearStartIndex()

### Description
Clears the start index of the attributed segment.

`int64 start_index = 1;`

### Method Signature
```java
public Answer.Citation.Builder clearStartIndex()
```

### Returns
- **Type** | **Description**
- `Answer.Citation.Builder` | This builder for chaining.
```

--------------------------------

### build()

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchResponse.Summary.Citation.Builder

Builds the SearchResponse.Summary.Citation object.

```APIDOC
## build()

### Description
Builds the SearchResponse.Summary.Citation object.

### Method Signature
```java
public SearchResponse.Summary.Citation build()
```

### Returns
* **SearchResponse.Summary.Citation** - The constructed SearchResponse.Summary.Citation object.
```

--------------------------------

### Get Session Name as ByteString

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.StreamAssistResponse.SessionInfo

Retrieves the session name as a ByteString. This is an alternative to getting it as a String, potentially for performance reasons.

```java
public ByteString getSessionBytes()
```

--------------------------------

### AssistantServiceSettings.Builder(ClientContext) Constructor

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantServiceSettings.Builder

Initializes a new instance of the AssistantServiceSettings.Builder class with the specified client context.

```java
protected Builder(ClientContext clientContext)
```

--------------------------------

### Get Rank Signals Or Builder - Java

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.Builder

Retrieves an object that can be used to get or build the ranking signals. This field is optional.

```java
public SearchResponse.SearchResult.RankSignalsOrBuilder getRankSignalsOrBuilder()
```

--------------------------------

### Get Document Resource Name

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfoOrBuilder

Retrieves the document resource name as a String. This method is used to get the identifier for the document.

```java
public abstract String getDocument()

```

--------------------------------

### AssistantContent.Blob Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantContent.Blob.Builder

Provides documentation for the core builder methods used to construct and manipulate AssistantContent.Blob objects.

```APIDOC
## Methods 
### build()
```java
public AssistantContent.Blob build()
```

**Returns**  
---
**Type** | **Description**  
`AssistantContent.Blob` |   

### buildPartial()
```java
public AssistantContent.Blob buildPartial()
```

**Returns**  
---
**Type** | **Description**  
`AssistantContent.Blob` |   

### clear()
```java
public AssistantContent.Blob.Builder clear()
```

**Returns**  
---
**Type** | **Description**  
`AssistantContent.Blob.Builder` |   
**Overrides**
GeneratedMessage.Builder<BuilderType>.clear()
```

--------------------------------

### Get Step Description

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Answer.StepOrBuilder

Retrieves the textual description of the step. Use this to get the human-readable explanation of the step's purpose.

```java
public abstract String getDescription()
```

--------------------------------

### buildPartial

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

Builds a partial AssistantGroundedContent.TextGroundingMetadata.Segment object.

```APIDOC
## buildPartial()

### Description
Builds a potentially incomplete AssistantGroundedContent.TextGroundingMetadata.Segment object. This is useful when the object is being serialized to avoid an exception.

### Method Signature
```java
public AssistantGroundedContent.TextGroundingMetadata.Segment buildPartial()
```

### Returns
- **AssistantGroundedContent.TextGroundingMetadata.Segment** - The partially constructed segment object.
```

--------------------------------

### Create Target Site Settings

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SiteSearchEngineServiceSettings.Builder

Returns the builder for settings used for createTargetSite calls. Handles synchronous operations.

```java
public UnaryCallSettings.Builder<CreateTargetSiteRequest,Operation> createTargetSiteSettings()
```

--------------------------------

### clearStartIndex

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.Answer.GroundingSupport.Builder

Clears the start index for the claim. The start index indicates the beginning of the claim, measured in bytes (UTF-8 unicode).

```APIDOC
## clearStartIndex()

### Description
Clears the start index for the claim. The start index indicates the beginning of the claim, measured in bytes (UTF-8 unicode).

### Method Signature
```java
public Answer.GroundingSupport.Builder clearStartIndex()
```

### Returns
- **Type**: `Answer.GroundingSupport.Builder`
- **Description**: This builder for chaining.
```

--------------------------------

### SessionServiceSettings.Builder Methods

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.SessionServiceSettings.Builder

Lists the available methods for configuring SessionServiceSettings.

```APIDOC
## Methods

*   `applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)`
*   `build()`
*   `createSessionSettings()`
*   `deleteSessionSettings()`
*   `getSessionSettings()`
*   `getStubSettingsBuilder()`
*   `listSessionsSettings()`
*   `updateSessionSettings()`
```

--------------------------------

### Get Model Name

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.TrainCustomModelResponse.Builder

Retrieves the fully qualified name of the CustomTuningModel. Use this method to get the model's unique identifier.

```java
public String getModelName()
```

```java
public ByteString getModelNameBytes()
```

--------------------------------

### Get Include Answer Details

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.GetSessionRequest.Builder

Gets the value of the includeAnswerDetails field. If true, the full session including all answer details will be returned.

```java
public boolean getIncludeAnswerDetails()
```

--------------------------------

### TargetSiteName.Builder Constructors

Source: https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1.TargetSiteName.Builder

Provides information on how to instantiate the TargetSiteName.Builder.

```APIDOC
## Builder()
```java
protected Builder()
```

### Description
Default constructor for the Builder.
```