Package com.google.cloud.talent.v4

Class RequestMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.talent.v4.RequestMetadata
All Implemented Interfaces:
RequestMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RequestMetadata extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RequestMetadata.Builder
    Meta information related to the job searcher or entity conducting the job search.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALLOW_MISSING_IDS_FIELD_NUMBER
     
    static final int
    DEVICE_INFO_FIELD_NUMBER
     
    static final int
    DOMAIN_FIELD_NUMBER
     
    static final int
    SESSION_ID_FIELD_NUMBER
     
    static final int
    USER_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static RequestMetadata
    getDefaultInstance()
     
    RequestMetadata
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DeviceInfo
    getDeviceInfo()
    The type of device used by the job seeker at the time of the call to the service.
    DeviceInfoOrBuilder
    getDeviceInfoOrBuilder()
    The type of device used by the job seeker at the time of the call to the service.
    String
    getDomain()
    Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
    com.google.protobuf.ByteString
    getDomainBytes()
    Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
    com.google.protobuf.Parser<RequestMetadata>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getSessionId()
    Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
    com.google.protobuf.ByteString
    getSessionIdBytes()
    Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
    String
    getUserId()
    Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
    com.google.protobuf.ByteString
    getUserIdBytes()
    Required if [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] is unset or `false`.
    boolean
    hasDeviceInfo()
    The type of device used by the job seeker at the time of the call to the service.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RequestMetadata.Builder
    newBuilder()
     
    static RequestMetadata.Builder
    newBuilder(RequestMetadata prototype)
     
    RequestMetadata.Builder
    newBuilderForType()
     
    protected RequestMetadata.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RequestMetadata
    parseDelimitedFrom(InputStream input)
     
    static RequestMetadata
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestMetadata
    parseFrom(byte[] data)
     
    static RequestMetadata
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestMetadata
    parseFrom(com.google.protobuf.ByteString data)
     
    static RequestMetadata
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestMetadata
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RequestMetadata
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestMetadata
    parseFrom(InputStream input)
     
    static RequestMetadata
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestMetadata
    parseFrom(ByteBuffer data)
     
    static RequestMetadata
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RequestMetadata>
    parser()
     
    RequestMetadata.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • DOMAIN_FIELD_NUMBER

      public static final int DOMAIN_FIELD_NUMBER
      See Also:

    • SESSION_ID_FIELD_NUMBER

      public static final int SESSION_ID_FIELD_NUMBER
      See Also:

    • USER_ID_FIELD_NUMBER

      public static final int USER_ID_FIELD_NUMBER
      See Also:

    • ALLOW_MISSING_IDS_FIELD_NUMBER

      public static final int ALLOW_MISSING_IDS_FIELD_NUMBER
      See Also:

    • DEVICE_INFO_FIELD_NUMBER

      public static final int DEVICE_INFO_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

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

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

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

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

    • 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;
      Specified by:
      getDeviceInfoOrBuilder in interface RequestMetadataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RequestMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RequestMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RequestMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static RequestMetadata.Builder newBuilder()

    • newBuilder

      public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)

    • toBuilder

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

    • newBuilderForType

      protected RequestMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RequestMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RequestMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<RequestMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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