Class RequestMetadata (2.44.0)

public final class RequestMetadata extends GeneratedMessageV3 implements RequestMetadataOrBuilder

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

Protobuf type google.cloud.talent.v4beta1.RequestMetadata

Static Fields

ALLOW_MISSING_IDS_FIELD_NUMBER

public static final int ALLOW_MISSING_IDS_FIELD_NUMBER
Field Value
Type Description
int

DEVICE_INFO_FIELD_NUMBER

public static final int DEVICE_INFO_FIELD_NUMBER
Field Value
Type Description
int

DOMAIN_FIELD_NUMBER

public static final int DOMAIN_FIELD_NUMBER
Field Value
Type Description
int

SESSION_ID_FIELD_NUMBER

public static final int SESSION_ID_FIELD_NUMBER
Field Value
Type Description
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RequestMetadata getDefaultInstance()
Returns
Type Description
RequestMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RequestMetadata.Builder newBuilder()
Returns
Type Description
RequestMetadata.Builder

newBuilder(RequestMetadata prototype)

public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)
Parameter
Name Description
prototype RequestMetadata
Returns
Type Description
RequestMetadata.Builder

parseDelimitedFrom(InputStream input)

public static RequestMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RequestMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RequestMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RequestMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RequestMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RequestMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RequestMetadata> parser()
Returns
Type Description
Parser<RequestMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowMissingIds()

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

getDefaultInstanceForType()

public RequestMetadata getDefaultInstanceForType()
Returns
Type Description
RequestMetadata

getDeviceInfo()

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

getParserForType()

public Parser<RequestMetadata> getParserForType()
Returns
Type Description
Parser<RequestMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionId()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RequestMetadata.Builder newBuilderForType()
Returns
Type Description
RequestMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RequestMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RequestMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RequestMetadata.Builder toBuilder()
Returns
Type Description
RequestMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException