lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb in google-cloud-talent-0.4.0 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb in google-cloud-talent-0.5.0

- old
+ new

@@ -28,11 +28,13 @@ # The format is # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", # for example, "projects/api-test-project/tenants/foo/profiles/bar". # @!attribute [rw] external_id # @return [String] - # Optional. Profile's id in client system if available. + # Optional. Profile's id in client system if available. This value is not + # required to be unique to each profile. However, providing unique values + # makes it easier to specify individual profiles when filing support tickets. # # The maximum number of bytes allowed is 100. # @!attribute [rw] source # @return [String] # Optional. The source description indicating where the profile is acquired. @@ -79,11 +81,38 @@ # Optional. The names of the candidate this profile references. # # Currently only one person name is supported. # @!attribute [rw] addresses # @return [Array<Google::Cloud::Talent::V4beta1::Address>] - # Optional. The candidate's postal addresses. + # Optional. 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. + # + # 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 + # {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. # @!attribute [rw] email_addresses # @return [Array<Google::Cloud::Talent::V4beta1::Email>] # Optional. The candidate's email addresses. # @!attribute [rw] phone_numbers # @return [Array<Google::Cloud::Talent::V4beta1::Phone>] @@ -112,10 +141,12 @@ # 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. + # + # The limitation for max number of employment records is 100. # @!attribute [rw] education_records # @return [Array<Google::Cloud::Talent::V4beta1::EducationRecord>] # Optional. The education history record of the candidate. It's highly # recommended to input this information as accurately as possible to help # improve search quality. Here are some recommendations: @@ -126,23 +157,31 @@ # 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. + # + # The limitation for max number of education records is 100. # @!attribute [rw] skills # @return [Array<Google::Cloud::Talent::V4beta1::Skill>] # Optional. The skill set of the candidate. It's highly recommended to # provide as much information as possible to help improve the search quality. + # + # The limitation for max number of skills is 500. # @!attribute [rw] activities # @return [Array<Google::Cloud::Talent::V4beta1::Activity>] # Optional. 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}. + # + # The limitation for max number of activities is 50. # @!attribute [rw] publications # @return [Array<Google::Cloud::Talent::V4beta1::Publication>] # Optional. The publications published by the candidate. + # + # The limitation for max number of publications is 50. # @!attribute [rw] patents # @return [Array<Google::Cloud::Talent::V4beta1::Patent>] # Optional. The patents acquired by the candidate. # @!attribute [rw] certifications # @return [Array<Google::Cloud::Talent::V4beta1::Certification>] @@ -182,29 +221,36 @@ # @!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}. + # @!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}. + # + # {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 # Resource that represents a resume. # @!attribute [rw] structured_resume # @return [String] # Optional. 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, for example. + # 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. # - # If this field is provided during profile creation or update, - # any other structured data provided in the profile is ignored. The - # API populates these fields by parsing this field. 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. + # 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] # Optional. The format of # {Google::Cloud::Talent::V4beta1::Resume#structured_resume structured_resume}. class Resume @@ -425,11 +471,11 @@ # @return [String] # Optional. The name of the employer company/organization. # # For example, "Google", "Alphabet", and so on. # - # Number of characters allowed is 100. + # Number of characters allowed is 250. # @!attribute [rw] division_name # @return [String] # Optional. The division name of the employment. # # For example, division, department, client, and so on. @@ -442,11 +488,11 @@ # @return [String] # Optional. The job title of the employment. # # For example, "Software Engineer", "Data Scientist", and so on. # - # Number of characters allowed is 100. + # Number of characters allowed is 250. # @!attribute [rw] job_description # @return [String] # Optional. The description of job content. # # Number of characters allowed is 100,000. @@ -496,11 +542,11 @@ # @return [String] # Optional. The name of the school or institution. # # For example, "Stanford University", "UC Berkeley", and so on. # - # Number of characters allowed is 100. + # Number of characters allowed is 250. # @!attribute [rw] address # @return [Google::Cloud::Talent::V4beta1::Address] # Optional. The physical address of the education institution. # @!attribute [rw] degree_description # @return [String] @@ -583,12 +629,16 @@ # @!attribute [rw] team_members # @return [Array<String>] # Optional. A list of team members involved in this activity. # # Number of characters allowed is 100. + # + # The limitation for max number of team members is 50. # @!attribute [rw] skills_used # @return [Array<Google::Cloud::Talent::V4beta1::Skill>] # Optional. 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 \ No newline at end of file