lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb in google-cloud-talent-0.8.2 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb in google-cloud-talent-0.8.3

- old
+ new

@@ -1,6 +1,6 @@ -# Copyright 2019 Google LLC +# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # @@ -58,13 +58,12 @@ # # This is used to link multiple profiles to the same candidate. For example, # a client has a candidate with two profiles, where one was created recently # and the other one was created 5 years ago. These two profiles may be very # different. The clients can create the first profile and get a generated - # {Google::Cloud::Talent::V4beta1::Profile#group_id group_id}, and assign it - # when the second profile is created, indicating these two profiles are - # referring to the same candidate. + # {Google::Cloud::Talent::V4beta1::Profile#group_id group_id}, and assign it when the second profile is created, + # indicating these two profiles are referring to the same candidate. # @!attribute [rw] is_hirable # @return [Google::Protobuf::BoolValue] # Indicates the hirable status of the candidate. # @!attribute [rw] create_time # @return [Google::Protobuf::Timestamp] @@ -85,29 +84,24 @@ # * Indirect actions by the candidate such as uploading a resume to a job # board that is collected by the agency through a feed, providing a resume to # a recruiter who then uploads it into the ATS, and so on. # * Updates made to the candidate's profile by the recruiter as a result of # interacting with the candidate (for example adding a skill or work - # preference, and so on). Changes to - # {Google::Cloud::Talent::V4beta1::Profile#recruiting_notes recruiting_notes} - # are specifically excluded from this action type. + # preference, and so on). Changes to {Google::Cloud::Talent::V4beta1::Profile#recruiting_notes recruiting_notes} are specifically + # excluded from this action type. # - # Note: - # {Google::Cloud::Talent::V4beta1::Profile#candidate_update_time candidate_update_time} - # must be greater than or equal to - # {Google::Cloud::Talent::V4beta1::Profile#resume_update_time resume_update_time} - # or an error is thrown. + # Note: {Google::Cloud::Talent::V4beta1::Profile#candidate_update_time candidate_update_time} must be greater than or equal to + # {Google::Cloud::Talent::V4beta1::Profile#resume_update_time resume_update_time} or an error is thrown. # @!attribute [rw] resume_update_time # @return [Google::Protobuf::Timestamp] # The timestamp when the candidate's resume was added or updated on the # candidate's profile. Whether that resume was directly uploaded by a # candidate, pulled from a 3rd party job board feed, added by a recruiter, # and so on. # - # If this field is updated, it's expected that - # {Google::Cloud::Talent::V4beta1::Profile#resume resume} is provided in the - # create or update calls. + # If this field is updated, it's expected that {Google::Cloud::Talent::V4beta1::Profile#resume resume} is provided in + # the create or update calls. # @!attribute [rw] resume # @return [Google::Cloud::Talent::V4beta1::Resume] # The resume representing this profile. # @!attribute [rw] person_names # @return [Array<Google::Cloud::Talent::V4beta1::PersonName>] @@ -118,34 +112,28 @@ # @return [Array<Google::Cloud::Talent::V4beta1::Address>] # The candidate's postal addresses. It's highly recommended to # input this information as accurately as possible to help improve search # quality. Here are some recommendations: # - # * Provide {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} if - # possible, especially if the address is PERSONAL. During a search only - # personal addresses are considered. If there is no such address, all - # addresses with unspecified usage are assumed to be personal. - # * Provide {Google::Cloud::Talent::V4beta1::Address#current Address#current} - # for the current address if possible. During a search, only current - # addresses are considered. If there is no such address, all addresses are - # assumed to be current. + # * Provide {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} if possible, especially if the address is + # PERSONAL. During a search only personal addresses are considered. If there + # is no such address, all addresses with unspecified usage are assumed to be + # personal. + # * Provide {Google::Cloud::Talent::V4beta1::Address#current Address#current} for the current address if possible. During + # a search, only current addresses are considered. If there is no such + # address, all addresses are assumed to be current. # # When displaying a candidate's addresses, it is sometimes desirable to limit # the number of addresses shown. In these cases we recommend that you display # the addresses in the following order of priority: - # 1. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is PERSONAL - # and {Google::Cloud::Talent::V4beta1::Address#current Address#current} is true. - # 2. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is PERSONAL - # and {Google::Cloud::Talent::V4beta1::Address#current Address#current} is false - # or not set. - # 3. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is - # CONTACT_INFO_USAGE_UNSPECIFIED and + # 1. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is PERSONAL and {Google::Cloud::Talent::V4beta1::Address#current Address#current} is true. + # 2. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is PERSONAL and {Google::Cloud::Talent::V4beta1::Address#current Address#current} is false or not + # set. + # 3. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is CONTACT_INFO_USAGE_UNSPECIFIED and # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is true. - # 4. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is - # CONTACT_INFO_USAGE_UNSPECIFIED and - # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is false or - # not set. + # 4. {Google::Cloud::Talent::V4beta1::Address#usage Address#usage} is CONTACT_INFO_USAGE_UNSPECIFIED and + # {Google::Cloud::Talent::V4beta1::Address#current Address#current} is false or not set. # @!attribute [rw] email_addresses # @return [Array<Google::Cloud::Talent::V4beta1::Email>] # The candidate's email addresses. # @!attribute [rw] phone_numbers # @return [Array<Google::Cloud::Talent::V4beta1::Phone>] @@ -153,16 +141,12 @@ # @!attribute [rw] personal_uris # @return [Array<Google::Cloud::Talent::V4beta1::PersonalUri>] # The candidate's personal URIs. # @!attribute [rw] additional_contact_info # @return [Array<Google::Cloud::Talent::V4beta1::AdditionalContactInfo>] - # Available contact information besides - # {Google::Cloud::Talent::V4beta1::Profile#addresses addresses}, - # {Google::Cloud::Talent::V4beta1::Profile#email_addresses email_addresses}, - # {Google::Cloud::Talent::V4beta1::Profile#phone_numbers phone_numbers} and - # {Google::Cloud::Talent::V4beta1::Profile#personal_uris personal_uris}. For - # example, Hang-out, Skype. + # Available contact information besides {Google::Cloud::Talent::V4beta1::Profile#addresses addresses}, {Google::Cloud::Talent::V4beta1::Profile#email_addresses email_addresses}, + # {Google::Cloud::Talent::V4beta1::Profile#phone_numbers phone_numbers} and {Google::Cloud::Talent::V4beta1::Profile#personal_uris personal_uris}. For example, Hang-out, Skype. # @!attribute [rw] employment_records # @return [Array<Google::Cloud::Talent::V4beta1::EmploymentRecord>] # The employment history records of the candidate. It's highly recommended # to input this information as accurately as possible to help improve search # quality. Here are some recommendations: @@ -170,14 +154,12 @@ # * Specify the start and end dates of the employment records. # * List different employment types separately, no matter how minor the # change is. # For example, only job title is changed from "software engineer" to "senior # software engineer". - # * Provide - # {Google::Cloud::Talent::V4beta1::EmploymentRecord#is_current EmploymentRecord#is_current} - # for the current employment if possible. If not, it's inferred from user - # inputs. + # * Provide {Google::Cloud::Talent::V4beta1::EmploymentRecord#is_current EmploymentRecord#is_current} for the current employment if + # possible. If not, it's inferred from user inputs. # # The limitation for max number of employment records is 100. # @!attribute [rw] education_records # @return [Array<Google::Cloud::Talent::V4beta1::EducationRecord>] # The education history record of the candidate. It's highly recommended to @@ -186,14 +168,12 @@ # # * Specify the start and end dates of the education records. # * List each education type separately, no matter how minor the change is. # For example, the profile contains the education experience from the same # school but different degrees. - # * Provide - # {Google::Cloud::Talent::V4beta1::EducationRecord#is_current EducationRecord#is_current} - # for the current education if possible. If not, it's inferred from user - # inputs. + # * Provide {Google::Cloud::Talent::V4beta1::EducationRecord#is_current EducationRecord#is_current} for the current education if + # possible. If not, it's inferred from user inputs. # # The limitation for max number of education records is 100. # @!attribute [rw] skills # @return [Array<Google::Cloud::Talent::V4beta1::Skill>] # The skill set of the candidate. It's highly recommended to provide as @@ -202,12 +182,11 @@ # The limitation for max number of skills is 500. # @!attribute [rw] activities # @return [Array<Google::Cloud::Talent::V4beta1::Activity>] # The individual or collaborative activities which the candidate has # participated in, for example, open-source projects, class assignments that - # aren't listed in - # {Google::Cloud::Talent::V4beta1::Profile#employment_records employment_records}. + # aren't listed in {Google::Cloud::Talent::V4beta1::Profile#employment_records employment_records}. # # The limitation for max number of activities is 50. # @!attribute [rw] publications # @return [Array<Google::Cloud::Talent::V4beta1::Publication>] # The publications published by the candidate. @@ -227,12 +206,11 @@ # Output only. The resource names of the candidate's assignments. # @!attribute [rw] custom_attributes # @return [Hash{String => Google::Cloud::Talent::V4beta1::CustomAttribute}] # A map of fields to hold both filterable and non-filterable custom profile # attributes that aren't covered by the provided structured fields. See - # {Google::Cloud::Talent::V4beta1::CustomAttribute CustomAttribute} for more - # details. + # {Google::Cloud::Talent::V4beta1::CustomAttribute CustomAttribute} for more details. # # At most 100 filterable and at most 100 unfilterable keys are supported. If # limit is exceeded, an error is thrown. Custom attributes are `unfilterable` # by default. These are filterable when the `filterable` flag is set to # `true`. @@ -252,23 +230,19 @@ # profile creation API call. This flag does not indicate whether a profile is # searchable or not. # @!attribute [rw] keyword_snippet # @return [String] # Output only. Keyword snippet shows how the search result is related to a - # search query. This is only returned in - # {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}. + # search query. This is only returned in {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}. # @!attribute [rw] availability_signals # @return [Array<Google::Cloud::Talent::V4beta1::AvailabilitySignal>] # Output only. Candidate's availability signals. # @!attribute [rw] derived_addresses # @return [Array<Google::Cloud::Talent::V4beta1::Location>] - # Output only. Derived locations of the profile, resolved from - # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses}. + # Output only. Derived locations of the profile, resolved from {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses}. # - # {Google::Cloud::Talent::V4beta1::Profile#derived_addresses derived_addresses} - # are exactly matched to - # {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} in the + # {Google::Cloud::Talent::V4beta1::Profile#derived_addresses derived_addresses} are exactly matched to {Google::Cloud::Talent::V4beta1::Profile#addresses Profile#addresses} in the # same order. class Profile; end # Candidate availability signal. # @!attribute [rw] type @@ -277,42 +251,34 @@ # @!attribute [rw] last_update_time # @return [Google::Protobuf::Timestamp] # Timestamp of when the given availability activity last happened. # @!attribute [rw] filter_satisfied # @return [Google::Protobuf::BoolValue] - # Indicates if the - # {Google::Cloud::Talent::V4beta1::AvailabilitySignal#last_update_time last_update_time} - # is within + # Indicates if the {Google::Cloud::Talent::V4beta1::AvailabilitySignal#last_update_time last_update_time} is within # {Google::Cloud::Talent::V4beta1::AvailabilityFilter#range AvailabilityFilter#range}. # - # Returned only in a search response when there is an - # {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter} in - # {Google::Cloud::Talent::V4beta1::ProfileQuery#availability_filters ProfileQuery#availability_filters} - # where - # {Google::Cloud::Talent::V4beta1::AvailabilityFilter#signal_type signal_type} - # matches {Google::Cloud::Talent::V4beta1::AvailabilitySignal#type type}. + # Returned only in a search response when there is an {Google::Cloud::Talent::V4beta1::AvailabilityFilter AvailabilityFilter} + # in {Google::Cloud::Talent::V4beta1::ProfileQuery#availability_filters ProfileQuery#availability_filters} where + # {Google::Cloud::Talent::V4beta1::AvailabilityFilter#signal_type signal_type} matches {Google::Cloud::Talent::V4beta1::AvailabilitySignal#type type}. class AvailabilitySignal; end # Resource that represents a resume. # @!attribute [rw] structured_resume # @return [String] - # Users can create a profile with only this field field, if - # {Google::Cloud::Talent::V4beta1::Resume#resume_type resume_type} is - # {Google::Cloud::Talent::V4beta1::Resume::ResumeType::HRXML HRXML}. For example, - # the API parses this field and creates a profile with all structured fields - # populated. - # {Google::Cloud::Talent::V4beta1::EmploymentRecord EmploymentRecord}, - # {Google::Cloud::Talent::V4beta1::EducationRecord EducationRecord}, and so on. - # An error is thrown if this field cannot be parsed. + # Users can create a profile with only this field field, if {Google::Cloud::Talent::V4beta1::Resume#resume_type resume_type} + # is {Google::Cloud::Talent::V4beta1::Resume::ResumeType::HRXML HRXML}. For example, the API parses this field and + # creates a profile + # with all structured fields populated. {Google::Cloud::Talent::V4beta1::EmploymentRecord EmploymentRecord}, + # {Google::Cloud::Talent::V4beta1::EducationRecord EducationRecord}, and so on. An error is thrown if this field cannot be + # parsed. # # Note that the use of the functionality offered by this field to extract # data from resumes is an Alpha feature and as such is not covered by any # SLA. # @!attribute [rw] resume_type # @return [Google::Cloud::Talent::V4beta1::Resume::ResumeType] - # The format of - # {Google::Cloud::Talent::V4beta1::Resume#structured_resume structured_resume}. + # The format of {Google::Cloud::Talent::V4beta1::Resume#structured_resume structured_resume}. class Resume # The format of a structured resume. module ResumeType # Default value. RESUME_TYPE_UNSPECIFIED = 0 @@ -337,24 +303,21 @@ # @return [Google::Cloud::Talent::V4beta1::PersonName::PersonStructuredName] # A person's name in a structured way (last name, first name, suffix, and # so on.) # @!attribute [rw] preferred_name # @return [String] - # Preferred name for the person. This field is ignored if - # {Google::Cloud::Talent::V4beta1::PersonName#structured_name structured_name} + # Preferred name for the person. This field is ignored if {Google::Cloud::Talent::V4beta1::PersonName#structured_name structured_name} # is provided. # # Number of characters allowed is 100. class PersonName # Resource that represents a person's structured name. # @!attribute [rw] given_name # @return [String] # Given/first name. # - # It's derived from - # {Google::Cloud::Talent::V4beta1::PersonName#formatted_name formatted_name} - # if not provided. + # It's derived from {Google::Cloud::Talent::V4beta1::PersonName#formatted_name formatted_name} if not provided. # # Number of characters allowed is 100. # @!attribute [rw] preferred_name # @return [String] # Preferred given/first name or nickname. @@ -362,22 +325,18 @@ # Number of characters allowed is 100. # @!attribute [rw] middle_initial # @return [String] # Middle initial. # - # It's derived from - # {Google::Cloud::Talent::V4beta1::PersonName#formatted_name formatted_name} - # if not provided. + # It's derived from {Google::Cloud::Talent::V4beta1::PersonName#formatted_name formatted_name} if not provided. # # Number of characters allowed is 20. # @!attribute [rw] family_name # @return [String] # Family/last name. # - # It's derived from - # {Google::Cloud::Talent::V4beta1::PersonName#formatted_name formatted_name} - # if not provided. + # It's derived from {Google::Cloud::Talent::V4beta1::PersonName#formatted_name formatted_name} if not provided. # # Number of characters allowed is 100. # @!attribute [rw] suffixes # @return [Array<String>] # Suffixes. @@ -470,14 +429,13 @@ VOICEMAIL = 6 # A virtual telephone number is a number that can be routed to another # number and managed by the user via Web, SMS, IVR, and so on. It is # associated with a particular person, and may be routed to either a MOBILE - # or LANDLINE number. The [phone - # usage][google.cloud.talent.v4beta1.ContactInfoUsage] should be set to - # PERSONAL for these phone types. Some more information can be found here: - # https://en.wikipedia.org/wiki/Personal_Numbers + # or LANDLINE number. The {Google::Cloud::Talent::V4beta1::ContactInfoUsage phone usage} should + # be set to PERSONAL for these phone types. Some more information can be + # found here: https://en.wikipedia.org/wiki/Personal_Numbers VIRTUAL = 7 # Voice over IP numbers. This includes TSoIP (Telephony Service over IP). VOIP = 8 @@ -559,29 +517,23 @@ # @!attribute [rw] is_current # @return [Google::Protobuf::BoolValue] # If this employment is current. # @!attribute [rw] job_title_snippet # @return [String] - # Output only. The job title snippet shows how the - # {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_title job_title} is - # related to a search query. It's empty if the - # {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_title job_title} isn't - # related to the search query. + # Output only. The job title snippet shows how the {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_title job_title} is related + # to a search query. It's empty if the {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_title job_title} isn't related to the + # search query. # @!attribute [rw] job_description_snippet # @return [String] - # Output only. The job description snippet shows how the - # {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_description job_description} - # is related to a search query. It's empty if the - # {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_description job_description} - # isn't related to the search query. + # Output only. The job description snippet shows how the {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_description job_description} + # is related to a search query. It's empty if the {Google::Cloud::Talent::V4beta1::EmploymentRecord#job_description job_description} isn't + # related to the search query. # @!attribute [rw] employer_name_snippet # @return [String] - # Output only. The employer name snippet shows how the - # {Google::Cloud::Talent::V4beta1::EmploymentRecord#employer_name employer_name} - # is related to a search query. It's empty if the - # {Google::Cloud::Talent::V4beta1::EmploymentRecord#employer_name employer_name} - # isn't related to the search query. + # Output only. The employer name snippet shows how the {Google::Cloud::Talent::V4beta1::EmploymentRecord#employer_name employer_name} is + # related to a search query. It's empty if the {Google::Cloud::Talent::V4beta1::EmploymentRecord#employer_name employer_name} isn't + # related to the search query. class EmploymentRecord; end # Resource that represents an education record of a candidate. # @!attribute [rw] start_date # @return [Google::Type::Date] @@ -620,22 +572,18 @@ # @!attribute [rw] is_current # @return [Google::Protobuf::BoolValue] # If this education is current. # @!attribute [rw] school_name_snippet # @return [String] - # Output only. The school name snippet shows how the - # {Google::Cloud::Talent::V4beta1::EducationRecord#school_name school_name} is - # related to a search query in search result. It's empty if the - # {Google::Cloud::Talent::V4beta1::EducationRecord#school_name school_name} - # isn't related to the search query. + # Output only. The school name snippet shows how the {Google::Cloud::Talent::V4beta1::EducationRecord#school_name school_name} is related to a + # search query in search result. It's empty if the {Google::Cloud::Talent::V4beta1::EducationRecord#school_name school_name} isn't + # related to the search query. # @!attribute [rw] degree_snippet # @return [String] - # Output only. The job description snippet shows how the - # {Google::Cloud::Talent::V4beta1::Degree Degree} is related to a search query - # in search result. It's empty if the - # {Google::Cloud::Talent::V4beta1::Degree Degree} isn't related to the search - # query. + # Output only. The job description snippet shows how the {Google::Cloud::Talent::V4beta1::Degree Degree} is related to a search + # query in search result. It's empty if the {Google::Cloud::Talent::V4beta1::Degree Degree} isn't related to the + # search query. class EducationRecord; end # Resource that represents a degree pursuing or acquired by a candidate. # @!attribute [rw] degree_type # @return [Google::Cloud::Talent::V4beta1::DegreeType] @@ -692,28 +640,22 @@ # A list of skills used in this activity. # # The limitation for max number of skills used is 50. # @!attribute [rw] activity_name_snippet # @return [String] - # Output only. Activity name snippet shows how the - # {Google::Cloud::Talent::V4beta1::Activity#display_name display_name} is - # related to a search query. It's empty if the - # {Google::Cloud::Talent::V4beta1::Activity#display_name display_name} isn't - # related to the search query. + # Output only. Activity name snippet shows how the {Google::Cloud::Talent::V4beta1::Activity#display_name display_name} is related to a search + # query. It's empty if the {Google::Cloud::Talent::V4beta1::Activity#display_name display_name} isn't related to the search + # query. # @!attribute [rw] activity_description_snippet # @return [String] # Output only. Activity description snippet shows how the - # {Google::Cloud::Talent::V4beta1::Activity#description description} is related - # to a search query. It's empty if the - # {Google::Cloud::Talent::V4beta1::Activity#description description} isn't - # related to the search query. + # {Google::Cloud::Talent::V4beta1::Activity#description description} is related to a search query. It's empty if the + # {Google::Cloud::Talent::V4beta1::Activity#description description} isn't related to the search query. # @!attribute [rw] skills_used_snippet # @return [Array<String>] # Output only. Skill used snippet shows how the corresponding - # {Google::Cloud::Talent::V4beta1::Activity#skills_used skills_used} are related - # to a search query. It's empty if the corresponding - # {Google::Cloud::Talent::V4beta1::Activity#skills_used skills_used} are not - # related to the search query. + # {Google::Cloud::Talent::V4beta1::Activity#skills_used skills_used} are related to a search query. It's empty if the + # corresponding {Google::Cloud::Talent::V4beta1::Activity#skills_used skills_used} are not related to the search query. class Activity; end # Resource that represents a publication resource of a candidate. # @!attribute [rw] authors # @return [Array<String>] \ No newline at end of file