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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int ALLOW_MISSING_IDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
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 | |
public static final int SESSION_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int USER_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static RequestMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static RequestMetadata.Builder newBuilder()
public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)
public static RequestMetadata parseDelimitedFrom(InputStream input)
public static RequestMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RequestMetadata parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static RequestMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RequestMetadata parseFrom(ByteString data)
public static RequestMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RequestMetadata parseFrom(CodedInputStream input)
public static RequestMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RequestMetadata parseFrom(InputStream input)
public static RequestMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RequestMetadata parseFrom(ByteBuffer data)
public static RequestMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<RequestMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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.
|
public RequestMetadata getDefaultInstanceForType()
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;
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;
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.
|
public Parser<RequestMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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.
|
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.
|
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.
|
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.
|
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 |
|---|
| Type | Description |
boolean | Whether the deviceInfo field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public RequestMetadata.Builder newBuilderForType()
protected RequestMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public RequestMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
