Class RequestMetadata.Builder (2.55.0)

Version 2.55.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.6
• 2.2.9

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RequestMetadata.Builder

Implements

RequestMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RequestMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public RequestMetadata build()

Returns
Type	Description
RequestMetadata

buildPartial()

public RequestMetadata buildPartial()

Returns
Type	Description
RequestMetadata

clear()

public RequestMetadata.Builder clear()

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

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

Returns
Type	Description
RequestMetadata.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RequestMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public RequestMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Returns
Type	Description
RequestMetadata.Builder	This builder for chaining.

clone()

public RequestMetadata.Builder clone()

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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

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

Returns
Type	Description
boolean	Whether the deviceInfo field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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
Name	Description
value	DeviceInfo

Returns
Type	Description
RequestMetadata.Builder

mergeFrom(RequestMetadata other)

public RequestMetadata.Builder mergeFrom(RequestMetadata other)

Parameter
Name	Description
other	RequestMetadata

Returns
Type	Description
RequestMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RequestMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RequestMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public RequestMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
RequestMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RequestMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
value	boolean The allowMissingIds to set.

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

Parameter
Name	Description
value	DeviceInfo

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

Parameter
Name	Description
builderForValue	DeviceInfo.Builder

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

Parameter
Name	Description
value	String The domain to set.

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

Parameter
Name	Description
value	ByteString The bytes for domain to set.

Returns
Type	Description
RequestMetadata.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RequestMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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
Name	Description
value	String The sessionId to set.

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

Parameter
Name	Description
value	ByteString The bytes for sessionId to set.

Returns
Type	Description
RequestMetadata.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RequestMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
RequestMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
value	String The userId to set.

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

Parameter
Name	Description
value	ByteString The bytes for userId to set.

Returns
Type	Description
RequestMetadata.Builder	This builder for chaining.