# Google Cloud Ai Platform V1 Client - Class RagCorpus (1.60.0)

1.60.0 (latest) 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.1 0.10.0 Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class RagCorpus.

A RagCorpus is a RagFile container and a project can have multiple
RagCorpora.

Generated from protobuf message `google.cloud.aiplatform.v1.RagCorpus`

## Namespace

Google \\ Cloud \\ AIPlatform \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ vector_db_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.RagVectorDbConfig` Optional. Immutable. The config for the Vector DBs. |
| `↳ vertex_ai_search_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.VertexAiSearchConfig` Optional. Immutable. The config for the Vertex AI Search. |
| `↳ name` | `string` Output only. The resource name of the RagCorpus. |
| `↳ display_name` | `string` Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
| `↳ description` | `string` Optional. The description of the RagCorpus. |
| `↳ create_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Timestamp when this RagCorpus was created. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Timestamp when this RagCorpus was last updated. |
| `↳ corpus_status` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CorpusStatus` Output only. RagCorpus state. |
| `↳ encryption_spec` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EncryptionSpec` Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted. |

### getVectorDbConfig

Optional. Immutable. The config for the Vector DBs.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.RagVectorDbConfig|null` |   |

### hasVectorDbConfig

### setVectorDbConfig

Optional. Immutable. The config for the Vector DBs.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.RagVectorDbConfig` |

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

### getVertexAiSearchConfig

Optional. Immutable. The config for the Vertex AI Search.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.VertexAiSearchConfig|null` |   |

### hasVertexAiSearchConfig

### setVertexAiSearchConfig

Optional. Immutable. The config for the Vertex AI Search.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.VertexAiSearchConfig` |

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

### getName

Output only. The resource name of the RagCorpus.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Output only. The resource name of the RagCorpus.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getDisplayName

Required. The display name of the RagCorpus.

The name can be up to 128 characters long and can consist of any UTF-8
characters.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDisplayName

Required. The display name of the RagCorpus.

The name can be up to 128 characters long and can consist of any UTF-8
characters.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getDescription

Optional. The description of the RagCorpus.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDescription

Optional. The description of the RagCorpus.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getCreateTime

Output only. Timestamp when this RagCorpus was created.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

Output only. Timestamp when this RagCorpus was created.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

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

### getUpdateTime

Output only. Timestamp when this RagCorpus was last updated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasUpdateTime

### clearUpdateTime

### setUpdateTime

Output only. Timestamp when this RagCorpus was last updated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

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

### getCorpusStatus

Output only. RagCorpus state.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CorpusStatus|null` |   |

### hasCorpusStatus

### clearCorpusStatus

### setCorpusStatus

Output only. RagCorpus state.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CorpusStatus` |

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

### getEncryptionSpec

Optional. Immutable. The CMEK key name used to encrypt at-rest data related
to this Corpus. Only applicable to RagManagedDb option for Vector DB. This
field can only be set at corpus creation time, and cannot be updated or
deleted.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EncryptionSpec|null` |   |

### hasEncryptionSpec

### clearEncryptionSpec

### setEncryptionSpec

Optional. Immutable. The CMEK key name used to encrypt at-rest data related
to this Corpus. Only applicable to RagManagedDb option for Vector DB. This
field can only be set at corpus creation time, and cannot be updated or
deleted.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EncryptionSpec` |

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

### getBackendConfig

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |