Package com.google.cloud.talent.v4

Interface RequestMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RequestMetadata, RequestMetadata.Builder
@Generated public interface RequestMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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`.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDomain

      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;
      Returns:
      The domain.

    • getDomainBytes

      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;
      Returns:
      The bytes for domain.

    • getSessionId

      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;
      Returns:
      The sessionId.

    • getSessionIdBytes

      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;
      Returns:
      The bytes for sessionId.

    • getUserId

      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;
      Returns:
      The userId.

    • getUserIdBytes

      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;
      Returns:
      The bytes for userId.

    • getAllowMissingIds

      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;
      Returns:
      The allowMissingIds.

    • hasDeviceInfo

      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:
      Whether the deviceInfo field is set.

    • getDeviceInfo

      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:
      The deviceInfo.

    • getDeviceInfoOrBuilder

      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;