Google Cloud Talent Solution v4 API - Class RequestMetadata (2.5.0)

public sealed class RequestMetadata : IMessage<RequestMetadata>, IEquatable<RequestMetadata>, IDeepCloneable<RequestMetadata>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Talent Solution v4 API 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.

Inheritance

object > RequestMetadata

Implements

IMessage RequestMetadata, IEquatable RequestMetadata, IDeepCloneable RequestMetadata, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Talent.V4

Assembly

Google.Cloud.Talent.V4.dll

Constructors

RequestMetadata()

public RequestMetadata()

RequestMetadata(RequestMetadata)

public RequestMetadata(RequestMetadata other)

Parameter
Name	Description
`other`	`RequestMetadata`

Properties

AllowMissingIds

public bool AllowMissingIds { get; set; }

Only set when any of [domain][google.cloud.talent.v4.RequestMetadata.domain], [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4.RequestMetadata.user_id] isn't available for some reason. It is highly recommended not to set this field and provide accurate [domain][google.cloud.talent.v4.RequestMetadata.domain], [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4.RequestMetadata.user_id] for the best service experience.

Property Value
Type	Description
`bool`

DeviceInfo

public DeviceInfo DeviceInfo { get; set; }

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

Property Value
Type	Description
`DeviceInfo`

Domain

public string Domain { get; set; }

Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 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 <em>Foo, Inc.</em>, 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.

Property Value
Type	Description
`string`

SessionId

public string SessionId { get; set; }

Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 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.

Property Value
Type	Description
`string`

UserId

public string UserId { get; set; }

Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 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.

Property Value
Type	Description
`string`