lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb in google-cloud-talent-0.3.0 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb in google-cloud-talent-0.4.0
- old
+ new
@@ -16,12 +16,11 @@
module Google
module Cloud
module Talent
module V4beta1
# A resource that represents the profile for a job candidate (also referred to
- # as a "single-source profile"). A profile belongs to a {Google::Cloud::Talent::V4beta1::Company Company}, which is
- # the company/organization that owns the profile.
+ # as a "single-source profile").
# @!attribute [rw] name
# @return [String]
# Required during profile update.
#
# Resource name assigned to a profile by the API.
@@ -29,172 +28,140 @@
# 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.
+ # Optional. Profile's id in client system if available.
#
- # Profile's id in client system if available.
- #
# The maximum number of bytes allowed is 100.
# @!attribute [rw] source
# @return [String]
- # Optional.
+ # Optional. The source description indicating where the profile is acquired.
#
- # The source description indicating where the profile is acquired.
- #
# For example, if a candidate profile is acquired from a resume, the user can
# input "resume" here to indicate the source.
#
# The maximum number of bytes allowed is 100.
# @!attribute [rw] uri
# @return [String]
- # Optional.
+ # Optional. The URI set by clients that links to this profile's client-side
+ # copy.
#
- # The URI set by clients that links to this profile's client-side copy.
- #
# The maximum number of bytes allowed is 4000.
# @!attribute [rw] group_id
# @return [String]
- # Optional.
+ # Optional. The cluster id of the profile to associate with other profile(s)
+ # for the same candidate.
#
- # The cluster id of the profile to associate with other profile(s) for the
- # same candidate.
- #
# This field should be generated by the customer. If a value is not provided,
- # a random UUI is assigned to this field of the profile.
+ # a random UUID is assigned to this field of the profile.
#
# 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]
- # Optional.
- #
- # Indicates the hirable status of the candidate.
+ # Optional. Indicates the hirable status of the candidate.
# @!attribute [rw] create_time
# @return [Google::Protobuf::Timestamp]
- # Optional.
- #
- # The timestamp when the profile was first created at this source.
+ # Optional. The timestamp when the profile was first created at this source.
# @!attribute [rw] update_time
# @return [Google::Protobuf::Timestamp]
- # Optional.
- #
- # The timestamp when the profile was last updated at this source.
+ # Optional. The timestamp when the profile was last updated at this source.
# @!attribute [rw] resume
# @return [Google::Cloud::Talent::V4beta1::Resume]
- # Optional.
- #
- # The resume representing this profile.
+ # Optional. The resume representing this profile.
# @!attribute [rw] person_names
# @return [Array<Google::Cloud::Talent::V4beta1::PersonName>]
- # Optional.
+ # Optional. The names of the candidate this profile references.
#
- # 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.
# @!attribute [rw] email_addresses
# @return [Array<Google::Cloud::Talent::V4beta1::Email>]
- # Optional.
- #
- # The candidate's email addresses.
+ # Optional. The candidate's email addresses.
# @!attribute [rw] phone_numbers
# @return [Array<Google::Cloud::Talent::V4beta1::Phone>]
- # Optional.
- #
- # The candidate's phone number(s).
+ # Optional. The candidate's phone number(s).
# @!attribute [rw] personal_uris
# @return [Array<Google::Cloud::Talent::V4beta1::PersonalUri>]
- # Optional.
- #
- # The candidate's personal URIs.
+ # Optional. The candidate's personal URIs.
# @!attribute [rw] additional_contact_info
# @return [Array<Google::Cloud::Talent::V4beta1::AdditionalContactInfo>]
- # Optional.
- #
- # 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.
+ # Optional. 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>]
- # Optional.
+ # Optional. 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:
#
- # 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:
- #
# * 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.
# @!attribute [rw] education_records
# @return [Array<Google::Cloud::Talent::V4beta1::EducationRecord>]
- # Optional.
+ # 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:
#
- # 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:
- #
# * 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.
# @!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.
+ # Optional. The skill set of the candidate. It's highly recommended to
+ # provide as much information as possible to help improve the search quality.
# @!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}.
+ # 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}.
# @!attribute [rw] publications
# @return [Array<Google::Cloud::Talent::V4beta1::Publication>]
- # Optional.
- #
- # The publications published by the candidate.
+ # Optional. The publications published by the candidate.
# @!attribute [rw] patents
# @return [Array<Google::Cloud::Talent::V4beta1::Patent>]
- # Optional.
- #
- # The patents acquired by the candidate.
+ # Optional. The patents acquired by the candidate.
# @!attribute [rw] certifications
# @return [Array<Google::Cloud::Talent::V4beta1::Certification>]
- # Optional.
- #
- # The certifications acquired by the candidate.
+ # Optional. The certifications acquired by the candidate.
# @!attribute [rw] applications
# @return [Array<String>]
# Output only. The resource names of the candidate's applications.
# @!attribute [rw] assignments
# @return [Array<String>]
# Output only. The resource names of the candidate's assignments.
# @!attribute [rw] custom_attributes
# @return [Hash{String => Google::Cloud::Talent::V4beta1::CustomAttribute}]
- # Optional.
+ # Optional. 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.
#
- # 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.
- #
# 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`.
#
@@ -207,36 +174,41 @@
# For unfilterable string values, the maximum byte size of a single key is
# 64B. An error is thrown for any request exceeding the limit.
# The maximum total byte size is 10KB.
# @!attribute [rw] processed
# @return [true, false]
- # Output only. Indicates if the profile is fully processed and searchable.
+ # Output only. Indicates if a summarized profile was created as part of the
+ # 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}.
class Profile; end
# Resource that represents a resume.
# @!attribute [rw] structured_resume
# @return [String]
- # Optional.
+ # 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.
+ # {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 {HRXML}. For example, the API parses this field and creates a profile
- # with all structured fields populated, for example. {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.
+ # 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.
# @!attribute [rw] resume_type
# @return [Google::Cloud::Talent::V4beta1::Resume::ResumeType]
- # Optional.
- #
- # The format of {Google::Cloud::Talent::V4beta1::Resume#structured_resume structured_resume}.
+ # Optional. 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
@@ -252,155 +224,127 @@
end
# Resource that represents the name of a person.
# @!attribute [rw] formatted_name
# @return [String]
- # Optional.
+ # Optional. A string represents a person's full name. For example, "Dr.
+ # John Smith".
#
- # A string represents a person's full name. For example, "Dr. John Smith".
- #
# Number of characters allowed is 100.
# @!attribute [rw] structured_name
# @return [Google::Cloud::Talent::V4beta1::PersonName::PersonStructuredName]
- # Optional.
- #
- # A person's name in a structured way (last name, first name, suffix, and
- # so on.)
+ # Optional. A person's name in a structured way (last name, first name,
+ # suffix, and so on.)
# @!attribute [rw] preferred_name
# @return [String]
- # Optional.
- #
- # Preferred name for the person. This field is ignored if {Google::Cloud::Talent::V4beta1::PersonName#structured_name structured_name}
+ # Optional. 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]
- # Optional.
+ # Optional. Given/first name.
#
- # 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]
- # Optional.
+ # Optional. Preferred given/first name or nickname.
#
- # Preferred given/first name or nickname.
- #
# Number of characters allowed is 100.
# @!attribute [rw] middle_initial
# @return [String]
- # Optional.
+ # Optional. Middle initial.
#
- # 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]
- # Optional.
+ # Optional. Family/last name.
#
- # 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>]
- # Optional.
+ # Optional. Suffixes.
#
- # Suffixes.
- #
# Number of characters allowed is 20.
# @!attribute [rw] prefixes
# @return [Array<String>]
- # Optional.
+ # Optional. Prefixes.
#
- # Prefixes.
- #
# Number of characters allowed is 20.
class PersonStructuredName; end
end
# Resource that represents a address.
# @!attribute [rw] usage
# @return [Google::Cloud::Talent::V4beta1::ContactInfoUsage]
- # Optional.
- #
- # The usage of the address. For example, SCHOOL, WORK, PERSONAL.
+ # Optional. The usage of the address. For example, SCHOOL, WORK, PERSONAL.
# @!attribute [rw] unstructured_address
# @return [String]
- # Optional.
+ # Optional. Unstructured address.
#
- # Unstructured address.
- #
# For example, "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
# "Sunnyvale, California".
#
# Number of characters allowed is 100.
# @!attribute [rw] structured_address
# @return [Google::Type::PostalAddress]
- # Optional.
- #
- # Structured address that contains street address, city, state, country,
- # and so on.
+ # Optional. Structured address that contains street address, city, state,
+ # country, and so on.
# @!attribute [rw] current
# @return [Google::Protobuf::BoolValue]
- # Optional.
- #
- # Indicates if it's the person's current address.
+ # Optional. Indicates if it's the person's current address.
class Address; end
# Resource that represents a person's email address.
# @!attribute [rw] usage
# @return [Google::Cloud::Talent::V4beta1::ContactInfoUsage]
- # Optional.
- #
- # The usage of the email address. For example, SCHOOL, WORK, PERSONAL.
+ # Optional. The usage of the email address. For example, SCHOOL, WORK,
+ # PERSONAL.
# @!attribute [rw] email_address
# @return [String]
- # Optional.
+ # Optional. Email address.
#
- # Email address.
- #
# Number of characters allowed is 4,000.
class Email; end
# Resource that represents a person's telephone number.
# @!attribute [rw] usage
# @return [Google::Cloud::Talent::V4beta1::ContactInfoUsage]
- # Optional.
- #
- # The usage of the phone. For example, SCHOOL, WORK, PERSONAL.
+ # Optional. The usage of the phone. For example, SCHOOL, WORK, PERSONAL.
# @!attribute [rw] type
# @return [Google::Cloud::Talent::V4beta1::Phone::PhoneType]
- # Optional.
- #
- # The phone type. For example, LANDLINE, MOBILE, FAX.
+ # Optional. The phone type. For example, LANDLINE, MOBILE, FAX.
# @!attribute [rw] number
# @return [String]
- # Optional.
+ # Optional. Phone number.
#
- # Phone number.
- #
# Any phone formats are supported and only exact matches are performed on
# searches. For example, if a phone number in profile is provided in the
# format of "(xxx)xxx-xxxx", in profile searches the same phone format
# has to be provided.
#
# Number of characters allowed is 20.
# @!attribute [rw] when_available
# @return [String]
- # Optional.
+ # Optional. When this number is available. Any descriptive string is
+ # expected.
#
- # When this number is available. Any descriptive string is expected.
- #
# Number of characters allowed is 100.
class Phone
# Enum that represents the type of the telephone.
module PhoneType
# Default value.
@@ -425,13 +369,14 @@
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 (see ContactInfoUsage above) should
- # be set to PERSONAL for these phone types. Some more information can be
- # found here: http://en.wikipedia.org/wiki/Personal_Numbers
+ # 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:
+ # http://en.wikipedia.org/wiki/Personal_Numbers
VIRTUAL = 7
# Voice over IP numbers. This includes TSoIP (Telephony Service over IP).
VOIP = 8
@@ -442,402 +387,317 @@
end
# Resource that represents a valid URI for a personal use.
# @!attribute [rw] uri
# @return [String]
- # Optional.
+ # Optional. The personal URI.
#
- # The personal URI.
- #
# Number of characters allowed is 4,000.
class PersonalUri; end
# Resource that represents contact information other than phone, email,
# URI and addresses.
# @!attribute [rw] usage
# @return [Google::Cloud::Talent::V4beta1::ContactInfoUsage]
- # Optional.
- #
- # The usage of this contact method. For example, SCHOOL, WORK, PERSONAL.
+ # Optional. The usage of this contact method. For example, SCHOOL, WORK,
+ # PERSONAL.
# @!attribute [rw] name
# @return [String]
- # Optional.
+ # Optional. The name of the contact method.
#
- # The name of the contact method.
- #
# For example, "hangout", "skype".
#
# Number of characters allowed is 100.
# @!attribute [rw] contact_id
# @return [String]
- # Optional.
+ # Optional. The contact id.
#
- # The contact id.
- #
# Number of characters allowed is 100.
class AdditionalContactInfo; end
# Resource that represents an employment record of a candidate.
# @!attribute [rw] start_date
# @return [Google::Type::Date]
- # Optional.
- #
- # Start date of the employment.
+ # Optional. Start date of the employment.
# @!attribute [rw] end_date
# @return [Google::Type::Date]
- # Optional.
- #
- # End date of the employment.
+ # Optional. End date of the employment.
# @!attribute [rw] employer_name
# @return [String]
- # Optional.
+ # Optional. The name of the employer company/organization.
#
- # The name of the employer company/organization.
- #
# For example, "Google", "Alphabet", and so on.
#
# Number of characters allowed is 100.
# @!attribute [rw] division_name
# @return [String]
- # Optional.
+ # Optional. The division name of the employment.
#
- # The division name of the employment.
- #
# For example, division, department, client, and so on.
#
# Number of characters allowed is 100.
# @!attribute [rw] address
# @return [Google::Cloud::Talent::V4beta1::Address]
- # Optional.
- #
- # The physical address of the employer.
+ # Optional. The physical address of the employer.
# @!attribute [rw] job_title
# @return [String]
- # Optional.
+ # Optional. The job title of the employment.
#
- # The job title of the employment.
- #
# For example, "Software Engineer", "Data Scientist", and so on.
#
# Number of characters allowed is 100.
# @!attribute [rw] job_description
# @return [String]
- # Optional.
+ # Optional. The description of job content.
#
- # The description of job content.
- #
# Number of characters allowed is 100,000.
# @!attribute [rw] is_supervisor
# @return [Google::Protobuf::BoolValue]
- # Optional.
- #
- # If the jobs is a supervisor position.
+ # Optional. If the jobs is a supervisor position.
# @!attribute [rw] is_self_employed
# @return [Google::Protobuf::BoolValue]
- # Optional.
- #
- # If this employment is self-employed.
+ # Optional. If this employment is self-employed.
# @!attribute [rw] is_current
# @return [Google::Protobuf::BoolValue]
- # Optional.
- #
- # If this employment is current.
+ # Optional. 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]
- # Optional.
- #
- # The start date of the education.
+ # Optional. The start date of the education.
# @!attribute [rw] end_date
# @return [Google::Type::Date]
- # Optional.
- #
- # The end date of the education.
+ # Optional. The end date of the education.
# @!attribute [rw] expected_graduation_date
# @return [Google::Type::Date]
- # Optional.
- #
- # The expected graduation date if currently pursuing a degree.
+ # Optional. The expected graduation date if currently pursuing a degree.
# @!attribute [rw] school_name
# @return [String]
- # Optional.
+ # Optional. The name of the school or institution.
#
- # The name of the school or institution.
- #
# For example, "Stanford University", "UC Berkeley", and so on.
#
# Number of characters allowed is 100.
# @!attribute [rw] address
# @return [Google::Cloud::Talent::V4beta1::Address]
- # Optional.
- #
- # The physical address of the education institution.
+ # Optional. The physical address of the education institution.
# @!attribute [rw] degree_description
# @return [String]
- # Optional.
+ # Optional. The full description of the degree.
#
- # The full description of the degree.
- #
# For example, "Master of Science in Computer Science", "B.S in Math".
#
# Number of characters allowed is 100.
# @!attribute [rw] structured_degree
# @return [Google::Cloud::Talent::V4beta1::Degree]
- # Optional.
- #
- # The structured notation of the degree.
+ # Optional. The structured notation of the degree.
# @!attribute [rw] description
# @return [String]
- # Optional.
+ # Optional. The description of the education.
#
- # The description of the education.
- #
# Number of characters allowed is 100,000.
# @!attribute [rw] is_current
# @return [Google::Protobuf::BoolValue]
- # Optional.
- #
- # If this education is current.
+ # Optional. 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
+ # 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.
+ # {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]
- # Optional.
- #
- # ISCED degree type.
+ # Optional. ISCED degree type.
# @!attribute [rw] degree_name
# @return [String]
- # Optional.
+ # Optional. Full Degree name.
#
- # Full Degree name.
- #
# For example, "B.S.", "Master of Arts", and so on.
#
# Number of characters allowed is 100.
# @!attribute [rw] fields_of_study
# @return [Array<String>]
- # Optional.
+ # Optional. Fields of study for the degree.
#
- # Fields of study for the degree.
- #
# For example, "Computer science", "engineering".
#
# Number of characters allowed is 100.
class Degree; end
# Resource that represents an individual or collaborative activity participated
# in by a candidate, for example, an open-source project, a class assignment,
# and so on.
# @!attribute [rw] display_name
# @return [String]
- # Optional.
+ # Optional. Activity display name.
#
- # Activity display name.
- #
# Number of characters allowed is 100.
# @!attribute [rw] description
# @return [String]
- # Optional.
+ # Optional. Activity description.
#
- # Activity description.
- #
# Number of characters allowed is 100,000.
# @!attribute [rw] uri
# @return [String]
- # Optional.
+ # Optional. Activity URI.
#
- # Activity URI.
- #
# Number of characters allowed is 4,000.
# @!attribute [rw] create_date
# @return [Google::Type::Date]
- # Optional.
- #
- # The first creation date of the activity.
+ # Optional. The first creation date of the activity.
# @!attribute [rw] update_date
# @return [Google::Type::Date]
- # Optional.
- #
- # The last update date of the activity.
+ # Optional. The last update date of the activity.
# @!attribute [rw] team_members
# @return [Array<String>]
- # Optional.
+ # Optional. A list of team members involved in this activity.
#
- # A list of team members involved in this activity.
- #
# Number of characters allowed is 100.
# @!attribute [rw] skills_used
# @return [Array<Google::Cloud::Talent::V4beta1::Skill>]
- # Optional.
- #
- # A list of skills used in this activity.
+ # Optional. A list of skills used in this activity.
# @!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>]
- # Optional.
+ # Optional. A list of author names.
#
- # A list of author names.
- #
# Number of characters allowed is 100.
# @!attribute [rw] title
# @return [String]
- # Optional.
+ # Optional. The title of the publication.
#
- # The title of the publication.
- #
# Number of characters allowed is 100.
# @!attribute [rw] description
# @return [String]
- # Optional.
+ # Optional. The description of the publication.
#
- # The description of the publication.
- #
# Number of characters allowed is 100,000.
# @!attribute [rw] journal
# @return [String]
- # Optional.
+ # Optional. The journal name of the publication.
#
- # The journal name of the publication.
- #
# Number of characters allowed is 100.
# @!attribute [rw] volume
# @return [String]
- # Optional.
+ # Optional. Volume number.
#
- # Volume number.
- #
# Number of characters allowed is 100.
# @!attribute [rw] publisher
# @return [String]
- # Optional.
+ # Optional. The publisher of the journal.
#
- # The publisher of the journal.
- #
# Number of characters allowed is 100.
# @!attribute [rw] publication_date
# @return [Google::Type::Date]
- # Optional.
- #
- # The publication date.
+ # Optional. The publication date.
# @!attribute [rw] publication_type
# @return [String]
- # Optional.
+ # Optional. The publication type.
#
- # The publication type.
- #
# Number of characters allowed is 100.
# @!attribute [rw] isbn
# @return [String]
- # Optional.
+ # Optional. ISBN number.
#
- # ISBN number.
- #
# Number of characters allowed is 100.
class Publication; end
# Resource that represents the patent acquired by a candidate.
# @!attribute [rw] display_name
# @return [String]
- # Optional.
+ # Optional. Name of the patent.
#
- # Name of the patent.
- #
# Number of characters allowed is 100.
# @!attribute [rw] inventors
# @return [Array<String>]
- # Optional.
+ # Optional. A list of inventors' names.
#
- # A list of inventors' names.
- #
# Number of characters allowed for each is 100.
# @!attribute [rw] patent_status
# @return [String]
- # Optional.
+ # Optional. The status of the patent.
#
- # The status of the patent.
- #
# Number of characters allowed is 100.
# @!attribute [rw] patent_status_date
# @return [Google::Type::Date]
- # Optional.
- #
- # The date the last time the status of the patent was checked.
+ # Optional. The date the last time the status of the patent was checked.
# @!attribute [rw] patent_filing_date
# @return [Google::Type::Date]
- # Optional.
- #
- # The date that the patent was filed.
+ # Optional. The date that the patent was filed.
# @!attribute [rw] patent_office
# @return [String]
- # Optional.
+ # Optional. The name of the patent office.
#
- # The name of the patent office.
- #
# Number of characters allowed is 100.
# @!attribute [rw] patent_number
# @return [String]
- # Optional.
+ # Optional. The number of the patent.
#
- # The number of the patent.
- #
# Number of characters allowed is 100.
# @!attribute [rw] patent_description
# @return [String]
- # Optional.
+ # Optional. The description of the patent.
#
- # The description of the patent.
- #
# Number of characters allowed is 100,000.
# @!attribute [rw] skills_used
# @return [Array<Google::Cloud::Talent::V4beta1::Skill>]
- # Optional.
- #
- # The skills used in this patent.
+ # Optional. The skills used in this patent.
class Patent; end
end
end
end
end
\ No newline at end of file