# Google Cloud Talent Solution V4 Client - Class RequestMetadata (2.3.0)

2.3.0 (latest) 2.2.1 2.1.3 2.0.2 1.3.5 1.2.2 1.1.1 1.0.5 Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class RequestMetadata.

Meta information related to the job searcher or entity
conducting the job search. This information is used to improve the
performance of the service.

Generated from protobuf message `google.cloud.talent.v4.RequestMetadata`

## Namespace

Google \\ Cloud \\ Talent \\ V4

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ domain` | `string` Required if [allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__) is unset or `false`. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client *Foo, Inc.*, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique domain. The maximum number of allowed characters is 255. |
| `↳ session_id` | `string` Required if [allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__) is unset or `false`. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique session ID. The maximum number of allowed characters is 255. |
| `↳ user_id` | `string` Required if [allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__) is unset or `false`. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique user ID. The maximum number of allowed characters is 255. |
| `↳ allow_missing_ids` | `bool` Only set when any of [domain](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__), [session_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and [user_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) isn't available for some reason. It is highly recommended not to set this field and provide accurate [domain](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__), [session_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and [user_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) for the best service experience. |
| `↳ device_info` | `https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.DeviceInfo` The type of device used by the job seeker at the time of the call to the service. |

### getDomain

Required if
[allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)
is unset or `false`.

The client-defined scope or source of the service call, which typically
is the domain on
which the service has been implemented and is currently being run.
For example, if the service is being run by client *Foo, Inc.*, on
job board www.foo.com and career site www.bar.com, then this field is
set to "foo.com" for use on the job board, and "bar.com" for use on the
career site.
Note that any improvements to the model for a particular tenant site rely
on this field being set correctly to a unique domain.
The maximum number of allowed characters is 255.

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

### setDomain

Required if
[allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)
is unset or `false`.

The client-defined scope or source of the service call, which typically
is the domain on
which the service has been implemented and is currently being run.
For example, if the service is being run by client *Foo, Inc.*, on
job board www.foo.com and career site www.bar.com, then this field is
set to "foo.com" for use on the job board, and "bar.com" for use on the
career site.
Note that any improvements to the model for a particular tenant site rely
on this field being set correctly to a unique domain.
The maximum number of allowed characters is 255.

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

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

### getSessionId

Required if
[allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)
is unset or `false`.

A unique session identification string. A session is defined as the
duration of an end user's interaction with the service over a certain
period.
Obfuscate this field for privacy concerns before
providing it to the service.
Note that any improvements to the model for a particular tenant site rely
on this field being set correctly to a unique session ID.
The maximum number of allowed characters is 255.

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

### setSessionId

Required if
[allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)
is unset or `false`.

A unique session identification string. A session is defined as the
duration of an end user's interaction with the service over a certain
period.
Obfuscate this field for privacy concerns before
providing it to the service.
Note that any improvements to the model for a particular tenant site rely
on this field being set correctly to a unique session ID.
The maximum number of allowed characters is 255.

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

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

### getUserId

Required if
[allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)
is unset or `false`.

A unique user identification string, as determined by the client.
To have the strongest positive impact on search quality
make sure the client-level is unique.
Obfuscate this field for privacy concerns before
providing it to the service.
Note that any improvements to the model for a particular tenant site rely
on this field being set correctly to a unique user ID.
The maximum number of allowed characters is 255.

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

### setUserId

Required if
[allow_missing_ids](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)
is unset or `false`.

A unique user identification string, as determined by the client.
To have the strongest positive impact on search quality
make sure the client-level is unique.
Obfuscate this field for privacy concerns before
providing it to the service.
Note that any improvements to the model for a particular tenant site rely
on this field being set correctly to a unique user ID.
The maximum number of allowed characters is 255.

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

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

### getAllowMissingIds

Only set when any of
[domain](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),
[session_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and
[user_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) isn't available
for some reason. It is highly recommended not to set this field and provide
accurate [domain](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),
[session_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and
[user_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) for the best
service experience.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setAllowMissingIds

Only set when any of
[domain](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),
[session_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and
[user_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) isn't available
for some reason. It is highly recommended not to set this field and provide
accurate [domain](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),
[session_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and
[user_id](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) for the best
service experience.

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

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

### getDeviceInfo

The type of device used by the job seeker at the time of the call to the
service.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.DeviceInfo|null` |   |

### hasDeviceInfo

### clearDeviceInfo

### setDeviceInfo

The type of device used by the job seeker at the time of the call to the
service.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.DeviceInfo` |

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