Class RequestMetadata (2.18.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.v4.RequestMetadata

Static Fields

ALLOW_MISSING_IDS_FIELD_NUMBER

public static final int ALLOW_MISSING_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

DEVICE_INFO_FIELD_NUMBER

public static final int DEVICE_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

DOMAIN_FIELD_NUMBER

public static final int DOMAIN_FIELD_NUMBER
Field Value
TypeDescription
int

SESSION_ID_FIELD_NUMBER

public static final int SESSION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RequestMetadata getDefaultInstance()
Returns
TypeDescription
RequestMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RequestMetadata.Builder newBuilder()
Returns
TypeDescription
RequestMetadata.Builder

newBuilder(RequestMetadata prototype)

public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)
Parameter
NameDescription
prototypeRequestMetadata
Returns
TypeDescription
RequestMetadata.Builder

parseDelimitedFrom(InputStream input)

public static RequestMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RequestMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RequestMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RequestMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RequestMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RequestMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RequestMetadata> parser()
Returns
TypeDescription
Parser<RequestMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
boolean

The allowMissingIds.

getDefaultInstanceForType()

public RequestMetadata getDefaultInstanceForType()
Returns
TypeDescription
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.v4.DeviceInfo device_info = 5;

Returns
TypeDescription
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.v4.DeviceInfo device_info = 5;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for domain.

getParserForType()

public Parser<RequestMetadata> getParserForType()
Returns
TypeDescription
Parser<RequestMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for sessionId.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
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.v4.DeviceInfo device_info = 5;

Returns
TypeDescription
boolean

Whether the deviceInfo field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RequestMetadata.Builder newBuilderForType()
Returns
TypeDescription
RequestMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RequestMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RequestMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RequestMetadata.Builder toBuilder()
Returns
TypeDescription
RequestMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException