0.10.0 (latest) 0.9.0 0.8.4 0.7.0 0.6.0 0.5.3 0.4.0 0.3.1 0.2.0 0.1.0

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

Reference documentation and code samples for the Google Cloud Model Armor V1beta Client class SanitizeUserPromptRequest.

Sanitize User Prompt request.

Generated from protobuf message `google.cloud.modelarmor.v1beta.SanitizeUserPromptRequest`

## Namespace

Google \\ Cloud \\ ModelArmor \\ V1beta

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. Represents resource name of template e.g. name=projects/sample-project/locations/us-central1/templates/templ01 |
| `↳ user_prompt_data` | `https://docs.cloud.google.com/php/docs/reference/cloud-modelarmor/latest/V1beta.DataItem` Required. User prompt data to sanitize. |
| `↳ multi_language_detection_metadata` | `https://docs.cloud.google.com/php/docs/reference/cloud-modelarmor/latest/V1beta.MultiLanguageDetectionMetadata` Optional. Metadata related to Multi Language Detection. |
| `↳ streaming_mode` | `int` Optional. Streaming Mode for StreamSanitize\* API. |

### getName

Required. Represents resource name of template
e.g. name=projects/sample-project/locations/us-central1/templates/templ01

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

### setName

Required. Represents resource name of template
e.g. name=projects/sample-project/locations/us-central1/templates/templ01

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

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

### getUserPromptData

Required. User prompt data to sanitize.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-modelarmor/latest/V1beta.DataItem|null` |   |

### hasUserPromptData

### clearUserPromptData

### setUserPromptData

Required. User prompt data to sanitize.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-modelarmor/latest/V1beta.DataItem` |

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

### getMultiLanguageDetectionMetadata

Optional. Metadata related to Multi Language Detection.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-modelarmor/latest/V1beta.MultiLanguageDetectionMetadata|null` |   |

### hasMultiLanguageDetectionMetadata

### clearMultiLanguageDetectionMetadata

### setMultiLanguageDetectionMetadata

Optional. Metadata related to Multi Language Detection.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-modelarmor/latest/V1beta.MultiLanguageDetectionMetadata` |

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

### getStreamingMode

Optional. Streaming Mode for StreamSanitize\* API.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### hasStreamingMode

### clearStreamingMode

### setStreamingMode

Optional. Streaming Mode for StreamSanitize\* API.

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

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