google-cloud-talent 0.5.0 → 0.6.0

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb

@@ -26,8 +26,7 @@ module Google
         #     End of the period (exclusive).
         class TimestampRange; end
 
-        # Output only. A resource that represents a location with full geographic
-        # information.
+        # A resource that represents a location with full geographic information.
         # @!attribute [rw] location_type
         #   @return [Google::Cloud::Talent::V4beta1::Location::LocationType]
         #     The type of a location, which corresponds to the address lines field of
@@ -94,8 +93,6 @@ module Google
           end
         end
 
-        # Input only.
-        #
         # Meta information related to the job searcher or entity
         # conducting the job search. This information is used to improve the
         # performance of the service.
@@ -152,24 +149,23 @@ module Google
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] allow_missing_ids
         #   @return [true, false]
-        #     Optional. If set to `true`,
+        #     Only set when any of
         #     {Google::Cloud::Talent::V4beta1::RequestMetadata#domain domain},
         #     {Google::Cloud::Talent::V4beta1::RequestMetadata#session_id session_id} and
-        #     {Google::Cloud::Talent::V4beta1::RequestMetadata#user_id user_id} are
-        #     optional. Only set when any of these fields isn't available for some
-        #     reason. It is highly recommended not to set this field and provide accurate
+        #     {Google::Cloud::Talent::V4beta1::RequestMetadata#user_id user_id} isn't
+        #     available for some reason. It is highly recommended not to set this field
+        #     and provide accurate
         #     {Google::Cloud::Talent::V4beta1::RequestMetadata#domain domain},
         #     {Google::Cloud::Talent::V4beta1::RequestMetadata#session_id session_id} and
         #     {Google::Cloud::Talent::V4beta1::RequestMetadata#user_id user_id} for the best
         #     service experience.
         # @!attribute [rw] device_info
         #   @return [Google::Cloud::Talent::V4beta1::DeviceInfo]
-        #     Optional. The type of device used by the job seeker at the time of the call
-        #     to the service.
+        #     The type of device used by the job seeker at the time of the call to the
+        #     service.
         class RequestMetadata; end
 
-        # Output only. Additional information returned to client, such as debugging
-        # information.
+        # Additional information returned to client, such as debugging information.
         # @!attribute [rw] request_id
         #   @return [String]
         #     A unique id associated with this call.
@@ -181,10 +177,10 @@ module Google
         # the quality of the search results across devices.
         # @!attribute [rw] device_type
         #   @return [Google::Cloud::Talent::V4beta1::DeviceInfo::DeviceType]
-        #     Optional. Type of the device.
+        #     Type of the device.
         # @!attribute [rw] id
         #   @return [String]
-        #     Optional. A device-specific ID. The ID must be a unique identifier that
+        #     A device-specific ID. The ID must be a unique identifier that
         #     distinguishes the device from other devices.
         class DeviceInfo
           # An enumeration describing an API access portal and exposure mechanism.
@@ -218,7 +214,7 @@ module Google
         # Custom attribute values that are either filterable or non-filterable.
         # @!attribute [rw] string_values
         #   @return [Array<String>]
-        #     Optional but exactly one of
+        #     Exactly one of
         #     {Google::Cloud::Talent::V4beta1::CustomAttribute#string_values string_values}
         #     or {Google::Cloud::Talent::V4beta1::CustomAttribute#long_values long_values}
         #     must be specified.
@@ -233,7 +229,7 @@ module Google
         #     Empty string isn't allowed.
         # @!attribute [rw] long_values
         #   @return [Array<Integer>]
-        #     Optional but exactly one of
+        #     Exactly one of
         #     {Google::Cloud::Talent::V4beta1::CustomAttribute#string_values string_values}
         #     or {Google::Cloud::Talent::V4beta1::CustomAttribute#long_values long_values}
         #     must be specified.
@@ -246,13 +242,13 @@ module Google
         #     supported.
         # @!attribute [rw] filterable
         #   @return [true, false]
-        #     Optional. If the `filterable` flag is true, custom field values are
-        #     searchable. If false, values are not searchable.
+        #     If the `filterable` flag is true, custom field values are searchable.
+        #     If false, values are not searchable.
         #
         #     Default is false.
         class CustomAttribute; end
 
-        # Output only. Spell check result.
+        # Spell check result.
         # @!attribute [rw] corrected
         #   @return [true, false]
         #     Indicates if the query was corrected by the spell checker.
@@ -273,15 +269,15 @@ module Google
         # Job compensation details.
         # @!attribute [rw] entries
         #   @return [Array<Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationEntry>]
-        #     Optional. Job compensation information.
+        #     Job compensation information.
         #
         #     At most one entry can be of type
         #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationType::BASE CompensationInfo::CompensationType::BASE},
         #     which is referred as **base compensation entry** for the job.
         # @!attribute [rw] annualized_base_compensation_range
         #   @return [Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationRange]
-        #     Output only. Annualized base compensation range. Computed as
-        #     base compensation entry's
+        #     Output only. Annualized base compensation range. Computed as base
+        #     compensation entry's
         #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationEntry#amount CompensationEntry#amount}
         #     times
         #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationEntry#expected_units_per_year CompensationEntry#expected_units_per_year}.
@@ -291,8 +287,8 @@ module Google
         #     for explanation on compensation annualization.
         # @!attribute [rw] annualized_total_compensation_range
         #   @return [Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationRange]
-        #     Output only. Annualized total compensation range. Computed as
-        #     all compensation entries'
+        #     Output only. Annualized total compensation range. Computed as all
+        #     compensation entries'
         #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationEntry#amount CompensationEntry#amount}
         #     times
         #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationEntry#expected_units_per_year CompensationEntry#expected_units_per_year}.
@@ -319,30 +315,30 @@ module Google
           #   {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationEntry#expected_units_per_year expected_units_per_year}.
           # @!attribute [rw] type
           #   @return [Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationType]
-          #     Optional. Compensation type.
+          #     Compensation type.
           #
           #     Default is
           #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationType::COMPENSATION_TYPE_UNSPECIFIED CompensationType::COMPENSATION_TYPE_UNSPECIFIED}.
           # @!attribute [rw] unit
           #   @return [Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationUnit]
-          #     Optional. Frequency of the specified amount.
+          #     Frequency of the specified amount.
           #
           #     Default is
           #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED}.
           # @!attribute [rw] amount
           #   @return [Google::Type::Money]
-          #     Optional. Compensation amount.
+          #     Compensation amount.
           # @!attribute [rw] range
           #   @return [Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationRange]
-          #     Optional. Compensation range.
+          #     Compensation range.
           # @!attribute [rw] description
           #   @return [String]
-          #     Optional. Compensation description.  For example, could
+          #     Compensation description.  For example, could
           #     indicate equity terms or provide additional context to an estimated
           #     bonus.
           # @!attribute [rw] expected_units_per_year
           #   @return [Google::Protobuf::DoubleValue]
-          #     Optional. Expected number of units paid each year. If not specified, when
+          #     Expected number of units paid each year. If not specified, when
           #     {Google::Cloud::Talent::V4beta1::Job#employment_types Job#employment_types}
           #     is FULLTIME, a default value is inferred based on
           #     {Google::Cloud::Talent::V4beta1::CompensationInfo::CompensationEntry#unit unit}.
@@ -357,14 +353,15 @@ module Google
           # Compensation range.
           # @!attribute [rw] max_compensation
           #   @return [Google::Type::Money]
-          #     Optional. The maximum amount of compensation. If left empty, the value is
-          #     set to a maximal compensation value and the currency code is set to match
-          #     the {Google::Type::Money#currency_code currency code} of min_compensation.
+          #     The maximum amount of compensation. If left empty, the value is set
+          #     to a maximal compensation value and the currency code is set to
+          #     match the {Google::Type::Money#currency_code currency code} of
+          #     min_compensation.
           # @!attribute [rw] min_compensation
           #   @return [Google::Type::Money]
-          #     Optional. The minimum amount of compensation. If left empty, the value is
-          #     set to zero and the currency code is set to match the [currency
-          #     code][google.type.Money.currency_code] of max_compensation.
+          #     The minimum amount of compensation. If left empty, the value is set
+          #     to zero and the currency code is set to match the
+          #     {Google::Type::Money#currency_code currency code} of max_compensation.
           class CompensationRange; end
 
           # The type of compensation.
@@ -457,23 +454,23 @@ module Google
         # Resource that represents a license or certification.
         # @!attribute [rw] display_name
         #   @return [String]
-        #     Optional. Name of license or certification.
+        #     Name of license or certification.
         #
         #     Number of characters allowed is 100.
         # @!attribute [rw] acquire_date
         #   @return [Google::Type::Date]
-        #     Optional. Acquisition date or effective date of license or certification.
+        #     Acquisition date or effective date of license or certification.
         # @!attribute [rw] expire_date
         #   @return [Google::Type::Date]
-        #     Optional. Expiration date of license of certification.
+        #     Expiration date of license of certification.
         # @!attribute [rw] authority
         #   @return [String]
-        #     Optional. Authority of license, such as government.
+        #     Authority of license, such as government.
         #
         #     Number of characters allowed is 100.
         # @!attribute [rw] description
         #   @return [String]
-        #     Optional. Description of license or certification.
+        #     Description of license or certification.
         #
         #     Number of characters allowed is 100,000.
         class Certification; end
@@ -481,21 +478,21 @@ module Google
         # Resource that represents a skill of a candidate.
         # @!attribute [rw] display_name
         #   @return [String]
-        #     Optional. Skill display name.
+        #     Skill display name.
         #
         #     For example, "Java", "Python".
         #
         #     Number of characters allowed is 100.
         # @!attribute [rw] last_used_date
         #   @return [Google::Type::Date]
-        #     Optional. The last time this skill was used.
+        #     The last time this skill was used.
         # @!attribute [rw] level
         #   @return [Google::Cloud::Talent::V4beta1::SkillProficiencyLevel]
-        #     Optional. Skill proficiency level which indicates how proficient the
-        #     candidate is at this skill.
+        #     Skill proficiency level which indicates how proficient the candidate is at
+        #     this skill.
         # @!attribute [rw] context
         #   @return [String]
-        #     Optional. A paragraph describes context of this skill.
+        #     A paragraph describes context of this skill.
         #
         #     Number of characters allowed is 100,000.
         # @!attribute [rw] skill_name_snippet
@@ -510,7 +507,7 @@ module Google
         # Details of an interview.
         # @!attribute [rw] rating
         #   @return [Google::Cloud::Talent::V4beta1::Rating]
-        #     Optional. The rating on this interview.
+        #     The rating on this interview.
         # @!attribute [rw] outcome
         #   @return [Google::Cloud::Talent::V4beta1::Outcome]
         #     Required. The overall decision resulting from this interview (positive,
@@ -533,6 +530,162 @@ module Google
         #     min = 1 indicates that the score can be 1, 2, 3, 4, or 5)
         class Rating; end
 
+        # Metadata used for long running operations returned by CTS batch APIs.
+        # It's used to replace
+        # {Google::Longrunning::Operation#metadata}.
+        # @!attribute [rw] state
+        #   @return [Google::Cloud::Talent::V4beta1::BatchOperationMetadata::State]
+        #     The state of a long running operation.
+        # @!attribute [rw] state_description
+        #   @return [String]
+        #     More detailed information about operation state.
+        # @!attribute [rw] success_count
+        #   @return [Integer]
+        #     Count of successful item(s) inside an operation.
+        # @!attribute [rw] failure_count
+        #   @return [Integer]
+        #     Count of failed item(s) inside an operation.
+        # @!attribute [rw] total_count
+        #   @return [Integer]
+        #     Count of total item(s) inside an operation.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     The time when the batch operation is created.
+        # @!attribute [rw] update_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     The time when the batch operation status is updated. The metadata and the
+        #     {Google::Cloud::Talent::V4beta1::BatchOperationMetadata#update_time update_time}
+        #     is refreshed every minute otherwise cached data is returned.
+        # @!attribute [rw] end_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     The time when the batch operation is finished and
+        #     {Google::Longrunning::Operation#done} is
+        #     set to `true`.
+        class BatchOperationMetadata
+          module State
+            # Default value.
+            STATE_UNSPECIFIED = 0
+
+            # The batch operation is being prepared for processing.
+            INITIALIZING = 1
+
+            # The batch operation is actively being processed.
+            PROCESSING = 2
+
+            # The batch operation is processed, and at least one item has been
+            # successfully processed.
+            SUCCEEDED = 3
+
+            # The batch operation is done and no item has been successfully processed.
+            FAILED = 4
+
+            # The batch operation is in the process of cancelling after
+            # {Google::Longrunning::Operations::CancelOperation}
+            # is called.
+            CANCELLING = 5
+
+            # The batch operation is done after
+            # {Google::Longrunning::Operations::CancelOperation}
+            # is called. Any items processed before cancelling are returned in the
+            # response.
+            CANCELLED = 6
+          end
+        end
+
+        # The type of candidate availability signal.
+        module AvailabilitySignalType
+          # Default value.
+          AVAILABILITY_SIGNAL_TYPE_UNSPECIFIED = 0
+
+          # Job application signal.
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals},
+          # this signal is related to the candidate's most recent application.
+          # {Profile#availability_signals#last_update_time last_update_time} is
+          # calculated from
+          # max({Google::Cloud::Talent::V4beta1::Application#create_time Application#create_time})
+          # from all {Google::Cloud::Talent::V4beta1::Application Application} records
+          # where {Google::Cloud::Talent::V4beta1::Application#source Application#source}
+          # is any of the following:
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationSource::APPLY_DIRECT_WEB APPLY_DIRECT_WEB}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationSource::APPLY_DIRECT_MOBILE_WEB APPLY_DIRECT_MOBILE_WEB}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationSource::APPLY_DIRECT_MOBILE_APP APPLY_DIRECT_MOBILE_APP}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationSource::APPLY_DIRECT_IN_PERSON APPLY_DIRECT_IN_PERSON}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationSource::APPLY_INDIRECT APPLY_INDIRECT}
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter}, the
+          # filter is applied on
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals}
+          # where {Profile#availability_signals#type type} is JOB_APPLICATION.
+          JOB_APPLICATION = 1
+
+          # Resume update signal.
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals},
+          # this signal is related to the candidate’s most recent update to their
+          # resume. For a
+          # {Google::Cloud::Talent::V4beta1::SummarizedProfile#summary SummarizedProfile#summary},
+          # {Profile#availability_signals#last_update_time last_update_time} is
+          # calculated from
+          # max({Google::Cloud::Talent::V4beta1::Profile#resume_update_time Profile#resume_update_time})
+          # from all
+          # {Google::Cloud::Talent::V4beta1::SummarizedProfile#profiles SummarizedProfile#profiles}.
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter}, the
+          # filter is applied on
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals}
+          # where {Profile#availability_signals#type type} is RESUME_UPDATE.
+          RESUME_UPDATE = 2
+
+          # Candidate update signal.
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals},
+          # this signal is related to the candidate’s most recent update to their
+          # profile. For a
+          # {Google::Cloud::Talent::V4beta1::SummarizedProfile#summary SummarizedProfile#summary},
+          # {Profile#availability_signals#last_update_time last_update_time} is
+          # calculated from
+          # max({Google::Cloud::Talent::V4beta1::Profile#candidate_update_time Profile#candidate_update_time})
+          # from all
+          # {Google::Cloud::Talent::V4beta1::SummarizedProfile#profiles SummarizedProfile#profiles}.
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter}, the
+          # filter is applied on
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals}
+          # where {Profile#availability_signals#type type} is CANDIDATE_UPDATE.
+          CANDIDATE_UPDATE = 3
+
+          # Client submission signal.
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals},
+          # this signal is related to the candidate’s most recent submission.
+          # {Profile#availability_signals#last_update_time last_update_time} is
+          # calculated from
+          # max({Google::Cloud::Talent::V4beta1::Application#create_time Application#create_time})
+          # from all {Google::Cloud::Talent::V4beta1::Application Application} records
+          # where {Google::Cloud::Talent::V4beta1::Application#stage Application#stage} is
+          # any of the following:
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationStage::HIRING_MANAGER_REVIEW HIRING_MANAGER_REVIEW}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationStage::INTERVIEW INTERVIEW}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationStage::OFFER_EXTENDED OFFER_EXTENDED}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationStage::OFFER_ACCEPTED OFFER_ACCEPTED}
+          #  {Google::Cloud::Talent::V4beta1::Application::ApplicationStage::STARTED STARTED}
+          #
+          # In the context of
+          # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter}, the
+          # filter is applied on
+          # {Google::Cloud::Talent::V4beta1::Profile#availability_signals Profile#availability_signals}
+          # where {Profile#availability_signals#type type} is CLIENT_SUBMISSION.
+          CLIENT_SUBMISSION = 4
+        end
+
         # Method for commute.
         module CommuteMethod
           # Commute method isn't specified.
@@ -699,8 +852,6 @@ module Google
           OTHER_EMPLOYMENT_TYPE = 10
         end
 
-        # Input only.
-        #
         # Option for HTML content sanitization on user input fields, for example, job
         # description. By setting this option, user can determine whether and how
         # sanitization is performed on these fields.

data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company.rb

@@ -29,10 +29,10 @@ module Google
         #
         #     The format is
         #     "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
-        #     example, "projects/api-test-project/tenants/foo/companies/bar".
+        #     example, "projects/foo/tenants/bar/companies/baz".
         #
-        #     Tenant id is optional and the default tenant is used if unspecified, for
-        #     example, "projects/api-test-project/companies/bar".
+        #     If tenant id is unspecified, the default tenant is used. For
+        #     example, "projects/foo/companies/bar".
         # @!attribute [rw] display_name
         #   @return [String]
         #     Required. The display name of the company, for example, "Google LLC".
@@ -44,43 +44,43 @@ module Google
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] size
         #   @return [Google::Cloud::Talent::V4beta1::CompanySize]
-        #     Optional. The employer's company size.
+        #     The employer's company size.
         # @!attribute [rw] headquarters_address
         #   @return [String]
-        #     Optional. The street address of the company's main headquarters, which may
-        #     be different from the job location. The service attempts to geolocate the
-        #     provided address, and populates a more specific location wherever possible
-        #     in
+        #     The street address of the company's main headquarters, which may be
+        #     different from the job location. The service attempts
+        #     to geolocate the provided address, and populates a more specific
+        #     location wherever possible in
         #     {Google::Cloud::Talent::V4beta1::Company::DerivedInfo#headquarters_location DerivedInfo#headquarters_location}.
         # @!attribute [rw] hiring_agency
         #   @return [true, false]
-        #     Optional. Set to true if it is the hiring agency that post jobs for other
+        #     Set to true if it is the hiring agency that post jobs for other
         #     employers.
         #
         #     Defaults to false if not provided.
         # @!attribute [rw] eeo_text
         #   @return [String]
-        #     Optional. Equal Employment Opportunity legal disclaimer text to be
+        #     Equal Employment Opportunity legal disclaimer text to be
         #     associated with all jobs, and typically to be displayed in all
         #     roles.
         #
         #     The maximum number of allowed characters is 500.
         # @!attribute [rw] website_uri
         #   @return [String]
-        #     Optional. The URI representing the company's primary web site or home page,
+        #     The URI representing the company's primary web site or home page,
         #     for example, "https://www.google.com".
         #
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] career_site_uri
         #   @return [String]
-        #     Optional. The URI to employer's career site or careers page on the
-        #     employer's web site, for example, "https://careers.google.com".
+        #     The URI to employer's career site or careers page on the employer's web
+        #     site, for example, "https://careers.google.com".
         # @!attribute [rw] image_uri
         #   @return [String]
-        #     Optional. A URI that hosts the employer's company logo.
+        #     A URI that hosts the employer's company logo.
         # @!attribute [rw] keyword_searchable_job_custom_attributes
         #   @return [Array<String>]
-        #     Optional. A list of keys of filterable
+        #     A list of keys of filterable
         #     {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes},
         #     whose corresponding `string_values` are used in keyword searches. Jobs with
         #     `string_values` under these specified field keys are returned if any