Class RequestMetadata.Builder (2.4.4)

Stay organized with collections Save and categorize content based on your preferences.
public static final class RequestMetadata.Builder extends GeneratedMessageV3.Builder<RequestMetadata.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RequestMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RequestMetadata.Builder
Overrides

build()

public RequestMetadata build()
Returns
TypeDescription
RequestMetadata

buildPartial()

public RequestMetadata buildPartial()
Returns
TypeDescription
RequestMetadata

clear()

public RequestMetadata.Builder clear()
Returns
TypeDescription
RequestMetadata.Builder
Overrides

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;

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

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

Returns
TypeDescription
RequestMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RequestMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RequestMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RequestMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RequestMetadata.Builder
Overrides

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;

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

Returns
TypeDescription
RequestMetadata.Builder

This builder for chaining.

clone()

public RequestMetadata.Builder clone()
Returns
TypeDescription
RequestMetadata.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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

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

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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

Parameter
NameDescription
valueDeviceInfo
Returns
TypeDescription
RequestMetadata.Builder

mergeFrom(RequestMetadata other)

public RequestMetadata.Builder mergeFrom(RequestMetadata other)
Parameter
NameDescription
otherRequestMetadata
Returns
TypeDescription
RequestMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RequestMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RequestMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RequestMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RequestMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RequestMetadata.Builder
Overrides

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;

Parameter
NameDescription
valueboolean

The allowMissingIds to set.

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

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

Parameter
NameDescription
builderForValueDeviceInfo.Builder
Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The domain to set.

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

Parameter
NameDescription
valueByteString

The bytes for domain to set.

Returns
TypeDescription
RequestMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RequestMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RequestMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RequestMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RequestMetadata.Builder
Overrides

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;

Parameter
NameDescription
valueString

The sessionId to set.

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

Parameter
NameDescription
valueByteString

The bytes for sessionId to set.

Returns
TypeDescription
RequestMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RequestMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RequestMetadata.Builder
Overrides

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;

Parameter
NameDescription
valueString

The userId to set.

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

Parameter
NameDescription
valueByteString

The bytes for userId to set.

Returns
TypeDescription
RequestMetadata.Builder

This builder for chaining.