# Google Cloud Discovery Engine V1 Client - Class RetrievalMetadata (1.11.1)

1.11.1 (latest) 1.11.0 1.10.1 1.9.1 1.8.0 1.7.0 1.6.1 1.5.1 1.4.0 1.3.3 1.2.0 1.1.0 1.0.0 0.11.3 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class RetrievalMetadata.

Describes the metadata associated with a retrieval step.

Generated from protobuf message `google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata`

## Namespace

Google \\ Cloud \\ DiscoveryEngine \\ V1 \\ GenerateGroundedContentResponse \\ Candidate \\ GroundingMetadata

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ source` | `int` Describes the source to which the metadata is referring to. |
| `↳ dynamic_retrieval_metadata` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata` Metadata for dynamic retrieval. |

### getSource

Describes the source to which the metadata is referring to.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [Source](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source). |

### setSource

Describes the source to which the metadata is referring to.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [Source](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDynamicRetrievalMetadata

Metadata for dynamic retrieval.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata|null` |   |

### hasDynamicRetrievalMetadata

### clearDynamicRetrievalMetadata

### setDynamicRetrievalMetadata

Metadata for dynamic retrieval.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |