public static final class RequestMetadata.Builder extends GeneratedMessageV3.Builder<RequestMetadata.Builder> implements RequestMetadataOrBuilderMeta 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RequestMetadata.BuilderImplements
RequestMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RequestMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| RequestMetadata.Builder |
build()
public RequestMetadata build()| Type | Description |
| RequestMetadata |
buildPartial()
public RequestMetadata buildPartial()| Type | Description |
| RequestMetadata |
clear()
public RequestMetadata.Builder clear()| Type | Description |
| RequestMetadata.Builder |
clearAllowMissingIds()
public RequestMetadata.Builder clearAllowMissingIds()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;
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
clearDeviceInfo()
public RequestMetadata.Builder clearDeviceInfo()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;
| Type | Description |
| RequestMetadata.Builder |
clearDomain()
public RequestMetadata.Builder clearDomain() 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;
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public RequestMetadata.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| RequestMetadata.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RequestMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| RequestMetadata.Builder |
clearSessionId()
public RequestMetadata.Builder clearSessionId() 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;
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
clearUserId()
public RequestMetadata.Builder clearUserId() 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;
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
clone()
public RequestMetadata.Builder clone()| Type | Description |
| RequestMetadata.Builder |
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;
| Type | Description |
| boolean | The allowMissingIds. |
getDefaultInstanceForType()
public RequestMetadata getDefaultInstanceForType()| Type | Description |
| RequestMetadata |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| Type | Description |
| DeviceInfo | The deviceInfo. |
getDeviceInfoBuilder()
public DeviceInfo.Builder getDeviceInfoBuilder()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;
| Type | Description |
| DeviceInfo.Builder |
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;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for domain. |
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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the deviceInfo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeDeviceInfo(DeviceInfo value)
public RequestMetadata.Builder mergeDeviceInfo(DeviceInfo value)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;
| Name | Description |
| value | DeviceInfo |
| Type | Description |
| RequestMetadata.Builder |
mergeFrom(RequestMetadata other)
public RequestMetadata.Builder mergeFrom(RequestMetadata other)| Name | Description |
| other | RequestMetadata |
| Type | Description |
| RequestMetadata.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RequestMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| RequestMetadata.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public RequestMetadata.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| RequestMetadata.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RequestMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| RequestMetadata.Builder |
setAllowMissingIds(boolean value)
public RequestMetadata.Builder setAllowMissingIds(boolean value)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;
| Name | Description |
| value | booleanThe allowMissingIds to set. |
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
setDeviceInfo(DeviceInfo value)
public RequestMetadata.Builder setDeviceInfo(DeviceInfo value)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;
| Name | Description |
| value | DeviceInfo |
| Type | Description |
| RequestMetadata.Builder |
setDeviceInfo(DeviceInfo.Builder builderForValue)
public RequestMetadata.Builder setDeviceInfo(DeviceInfo.Builder builderForValue)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;
| Name | Description |
| builderForValue | DeviceInfo.Builder |
| Type | Description |
| RequestMetadata.Builder |
setDomain(String value)
public RequestMetadata.Builder setDomain(String value) 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;
| Name | Description |
| value | StringThe domain to set. |
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
setDomainBytes(ByteString value)
public RequestMetadata.Builder setDomainBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for domain to set. |
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public RequestMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| RequestMetadata.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RequestMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| RequestMetadata.Builder |
setSessionId(String value)
public RequestMetadata.Builder setSessionId(String value) 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;
| Name | Description |
| value | StringThe sessionId to set. |
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
setSessionIdBytes(ByteString value)
public RequestMetadata.Builder setSessionIdBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for sessionId to set. |
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RequestMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| RequestMetadata.Builder |
setUserId(String value)
public RequestMetadata.Builder setUserId(String value) 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;
| Name | Description |
| value | StringThe userId to set. |
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |
setUserIdBytes(ByteString value)
public RequestMetadata.Builder setUserIdBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for userId to set. |
| Type | Description |
| RequestMetadata.Builder | This builder for chaining. |