Interface RequestMetadataOrBuilder (2.45.0) 

public interface RequestMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowMissingIds()

public abstract boolean getAllowMissingIds()

Only set when any of domain, session_id and user_id 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.

bool allow_missing_ids = 4;

Returns
Type Description
boolean

The allowMissingIds.

getDeviceInfo()

public abstract DeviceInfo getDeviceInfo()

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

.google.cloud.talent.v4beta1.DeviceInfo device_info = 5;

Returns
Type Description
DeviceInfo

The deviceInfo.

getDeviceInfoOrBuilder()

public abstract DeviceInfoOrBuilder getDeviceInfoOrBuilder()

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

.google.cloud.talent.v4beta1.DeviceInfo device_info = 5;

Returns
Type Description
DeviceInfoOrBuilder

getDomain()

public abstract String getDomain()

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

string domain = 1;

Returns
Type Description
String

The domain.

getDomainBytes()

public abstract ByteString getDomainBytes()

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

string domain = 1;

Returns
Type Description
ByteString

The bytes for domain.

getSessionId()

public abstract String getSessionId()

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.

string session_id = 2;

Returns
Type Description
String

The sessionId.

getSessionIdBytes()

public abstract ByteString getSessionIdBytes()

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.

string session_id = 2;

Returns
Type Description
ByteString

The bytes for sessionId.

getUserId()

public abstract String getUserId()

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.

string user_id = 3;

Returns
Type Description
String

The userId.

getUserIdBytes()

public abstract ByteString getUserIdBytes()

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.

string user_id = 3;

Returns
Type Description
ByteString

The bytes for userId.

hasDeviceInfo()

public abstract boolean hasDeviceInfo()

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

.google.cloud.talent.v4beta1.DeviceInfo device_info = 5;

Returns
Type Description
boolean

Whether the deviceInfo field is set.