Struct gcp_client::google::cloud::talent::v4beta1::RequestMetadata

pub struct RequestMetadata {
    pub domain: String,
    pub session_id: String,
    pub user_id: String,
    pub allow_missing_ids: bool,
    pub device_info: Option<DeviceInfo>,
}

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

Fields

domain: String

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

user_id: String

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

allow_missing_ids: bool

Only set when any of [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.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.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] for the best service experience.

device_info: Option<DeviceInfo>

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

Trait Implementations

impl Clone for RequestMetadata

fn clone(&self) -> RequestMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestMetadata

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for RequestMetadata

fn default() -> RequestMetadata

Returns the "default value" for a type.

impl Message for RequestMetadata

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<RequestMetadata> for RequestMetadata

fn eq(&self, other: &RequestMetadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RequestMetadata) -> bool

This method tests for !=.

impl StructuralPartialEq for RequestMetadata