Package com.google.cloud.talent.v4

Class RequestMetadata.Builder

  • All Implemented Interfaces:
    RequestMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    RequestMetadata
    public static final class RequestMetadata.Builder
extends com.google.protobuf.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

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • clear

        public RequestMetadata.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • getDefaultInstanceForType

        public RequestMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public RequestMetadata build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public RequestMetadata buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public RequestMetadata.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • setField

        public RequestMetadata.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • clearField

        public RequestMetadata.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • clearOneof

        public RequestMetadata.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • setRepeatedField

        public RequestMetadata.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • addRepeatedField

        public RequestMetadata.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • mergeFrom

        public RequestMetadata.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RequestMetadata.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • mergeFrom

        public RequestMetadata.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RequestMetadata.Builder>
        Throws:
        IOException

      • getDomain

        public String getDomain()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Specified by:
        getDomain in interface RequestMetadataOrBuilder
        Returns:
        The domain.

      • getDomainBytes

        public com.google.protobuf.ByteString getDomainBytes()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Specified by:
        getDomainBytes in interface RequestMetadataOrBuilder
        Returns:
        The bytes for domain.

      • setDomain

        public RequestMetadata.Builder setDomain​(String value)
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Parameters:
        value - The domain to set.
        Returns:
        This builder for chaining.

      • clearDomain

        public RequestMetadata.Builder clearDomain()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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:
        This builder for chaining.

      • setDomainBytes

        public RequestMetadata.Builder setDomainBytes​(com.google.protobuf.ByteString value)
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Parameters:
        value - The bytes for domain to set.
        Returns:
        This builder for chaining.

      • getSessionId

        public String getSessionId()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Specified by:
        getSessionId in interface RequestMetadataOrBuilder
        Returns:
        The sessionId.

      • getSessionIdBytes

        public com.google.protobuf.ByteString getSessionIdBytes()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Specified by:
        getSessionIdBytes in interface RequestMetadataOrBuilder
        Returns:
        The bytes for sessionId.

      • setSessionId

        public RequestMetadata.Builder setSessionId​(String value)
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Parameters:
        value - The sessionId to set.
        Returns:
        This builder for chaining.

      • clearSessionId

        public RequestMetadata.Builder clearSessionId()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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:
        This builder for chaining.

      • setSessionIdBytes

        public RequestMetadata.Builder setSessionIdBytes​(com.google.protobuf.ByteString value)
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Parameters:
        value - The bytes for sessionId to set.
        Returns:
        This builder for chaining.

      • getUserId

        public String getUserId()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Specified by:
        getUserId in interface RequestMetadataOrBuilder
        Returns:
        The userId.

      • getUserIdBytes

        public com.google.protobuf.ByteString getUserIdBytes()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Specified by:
        getUserIdBytes in interface RequestMetadataOrBuilder
        Returns:
        The bytes for userId.

      • setUserId

        public RequestMetadata.Builder setUserId​(String value)
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Parameters:
        value - The userId to set.
        Returns:
        This builder for chaining.

      • clearUserId

        public RequestMetadata.Builder clearUserId()
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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:
        This builder for chaining.

      • setUserIdBytes

        public RequestMetadata.Builder setUserIdBytes​(com.google.protobuf.ByteString value)
         Required if
 [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.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;
        Parameters:
        value - The bytes for userId to set.
        Returns:
        This builder for chaining.

      • getAllowMissingIds

        public boolean getAllowMissingIds()
         Only set when any of
 [domain][google.cloud.talent.v4.RequestMetadata.domain],
 [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and
 [user_id][google.cloud.talent.v4.RequestMetadata.user_id] isn't available
 for some reason. It is highly recommended not to set this field and provide
 accurate [domain][google.cloud.talent.v4.RequestMetadata.domain],
 [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and
 [user_id][google.cloud.talent.v4.RequestMetadata.user_id] for the best
 service experience.
        bool allow_missing_ids = 4;
        Specified by:
        getAllowMissingIds in interface RequestMetadataOrBuilder
        Returns:
        The allowMissingIds.

      • setAllowMissingIds

        public RequestMetadata.Builder setAllowMissingIds​(boolean value)
         Only set when any of
 [domain][google.cloud.talent.v4.RequestMetadata.domain],
 [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and
 [user_id][google.cloud.talent.v4.RequestMetadata.user_id] isn't available
 for some reason. It is highly recommended not to set this field and provide
 accurate [domain][google.cloud.talent.v4.RequestMetadata.domain],
 [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and
 [user_id][google.cloud.talent.v4.RequestMetadata.user_id] for the best
 service experience.
        bool allow_missing_ids = 4;
        Parameters:
        value - The allowMissingIds to set.
        Returns:
        This builder for chaining.

      • clearAllowMissingIds

        public RequestMetadata.Builder clearAllowMissingIds()
         Only set when any of
 [domain][google.cloud.talent.v4.RequestMetadata.domain],
 [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and
 [user_id][google.cloud.talent.v4.RequestMetadata.user_id] isn't available
 for some reason. It is highly recommended not to set this field and provide
 accurate [domain][google.cloud.talent.v4.RequestMetadata.domain],
 [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and
 [user_id][google.cloud.talent.v4.RequestMetadata.user_id] for the best
 service experience.
        bool allow_missing_ids = 4;
        Returns:
        This builder for chaining.

      • 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;
        Specified by:
        hasDeviceInfo in interface RequestMetadataOrBuilder
        Returns:
        Whether the deviceInfo field is set.

      • 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;
        Specified by:
        getDeviceInfo in interface RequestMetadataOrBuilder
        Returns:
        The deviceInfo.

      • setDeviceInfo

        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;

      • setDeviceInfo

        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;

      • mergeDeviceInfo

        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;

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

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

      • setUnknownFields

        public final RequestMetadata.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>

      • mergeUnknownFields

        public final RequestMetadata.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RequestMetadata.Builder>