Class: Google::Cloud::Talent::V4beta1::RequestMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb

Overview

Input only.

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

Instance Attribute Summary collapse

Instance Attribute Details

#allow_missing_ids ⇒ true, false

Returns Optional.

If set to true, domain, session_id and user_id are optional. Only set when any of these fields isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, session_id and user_id for the best service experience.

Returns:

  • (true, false) —

    Optional.

    If set to true, domain, session_id and user_id are optional. Only set when any of these fields isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, session_id and user_id for the best service experience.



159
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb', line 159

class RequestMetadata; end

#device_info ⇒ Google::Cloud::Talent::V4beta1::DeviceInfo

Returns Optional.

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

Returns:



159
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb', line 159

class RequestMetadata; end

#domain ⇒ String

Returns Required if 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.

Returns:

  • (String) —

    Required if 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.



159
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb', line 159

class RequestMetadata; end

#session_id ⇒ String

Returns Required if 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.

Returns:

  • (String) —

    Required if 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.



159
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb', line 159

class RequestMetadata; end

#user_id ⇒ String

Returns Required if 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.

Returns:

  • (String) —

    Required if 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.



159
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb', line 159

class RequestMetadata; end