profile.rb in google-cloud-talent-0.3.0

- old
+ new

@@ -58,14 +58,12 @@
         #     Optional.
         #
         #     The cluster id of the profile to associate with other profile(s) for the
         #     same candidate.
         #
-        #     A random UUID is assigned if {Google::Cloud::Talent::V4beta1::Profile#group_id group_id} isn't provided. To ensure
-        #     global uniqueness, customized {Google::Cloud::Talent::V4beta1::Profile#group_id group_id} isn't supported. If
-        #     {Google::Cloud::Talent::V4beta1::Profile#group_id group_id} is set, there must be at least one other profile with the
-        #     same system generated {Google::Cloud::Talent::V4beta1::Profile#group_id group_id}, otherwise an error is thrown.
+        #     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.
         #
         #     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
@@ -84,27 +82,15 @@
         # @!attribute [rw] update_time
         #   @return [Google::Protobuf::Timestamp]
         #     Optional.
         #
         #     The timestamp when the profile was last updated at this source.
-        # @!attribute [rw] resume_hrxml
-        #   @return [String]
+        # @!attribute [rw] resume
+        #   @return [Google::Cloud::Talent::V4beta1::Resume]
         #     Optional.
         #
-        #     The profile contents in HR-XML format.
-        #     See http://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more
-        #     information about Human Resources XML.
-        #
-        #     Users can create a profile with only {Google::Cloud::Talent::V4beta1::Profile#resume_hrxml resume_hrxml} field. For example,
-        #     the API parses the {Google::Cloud::Talent::V4beta1::Profile#resume_hrxml resume_hrxml} 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 the {Google::Cloud::Talent::V4beta1::Profile#resume_hrxml resume_hrxml}
-        #     can't be parsed.
-        #
-        #     If the {Google::Cloud::Talent::V4beta1::Profile#resume_hrxml resume_hrxml} is provided during profile creation or update,
-        #     any other structured data provided in the profile is ignored. The
-        #     API populates these fields by parsing the HR-XML.
+        #     The resume representing this profile.
         # @!attribute [rw] person_names
         #   @return [Array<Google::Cloud::Talent::V4beta1::PersonName>]
         #     Optional.
         #
         #     The names of the candidate this profile references.
@@ -225,13 +211,48 @@
         #   @return [true, false]
         #     Output only. Indicates if the profile is fully processed and searchable.
         # @!attribute [rw] keyword_snippet
         #   @return [String]
         #     Output only. Keyword snippet shows how the search result is related to a
-        #     search query.
+        #     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.
+        #
+        #     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.
+        # @!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
+          # The format of a structured resume.
+          module ResumeType
+            # Default value.
+            RESUME_TYPE_UNSPECIFIED = 0
+
+            # The profile contents in HR-XML format.
+            # See http://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more
+            # information about Human Resources XML.
+            HRXML = 1
+
+            # Resume type not specified.
+            OTHER_RESUME_TYPE = 2
+          end
+        end
+
         # Resource that represents the name of a person.
         # @!attribute [rw] formatted_name
         #   @return [String]
         #     Optional.
         #
@@ -246,11 +267,14 @@
         #     so on.)
         # @!attribute [rw] preferred_name
         #   @return [String]
         #     Optional.
         #
-        #     Preferred name for the person.
+        #     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.
@@ -258,10 +282,17 @@
           #     Given/first name.
           #
           #     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.
+          #
+          #     Preferred given/first name or nickname.
+          #
+          #     Number of characters allowed is 100.
           # @!attribute [rw] middle_initial
           #   @return [String]
           #     Optional.
           #
           #     Middle initial.
@@ -449,22 +480,9 @@
         # @!attribute [rw] start_date
         #   @return [Google::Type::Date]
         #     Optional.
         #
         #     Start date of the employment.
-        #
-        #     It can be a partial date (only year, or only year and month), but must be
-        #     valid. Otherwise an error is thrown.
-        #
-        #     Examples:
-        #     {"year": 2017, "month": 2, "day": 28} is valid.
-        #     {"year": 2020, "month": 1, "date": 31} is valid.
-        #     {"year": 2018, "month": 12} is valid (partial date).
-        #     {"year": 2018} is valid (partial date).
-        #     {"year": 2015, "day": 21} is not valid (month is missing but day is
-        #     presented).
-        #     {"year": 2018, "month": 13} is not valid (invalid month).
-        #     {"year": 2017, "month": 1, "day": 32} is not valid (invalid day).
         # @!attribute [rw] end_date
         #   @return [Google::Type::Date]
         #     Optional.
         #
         #     End date of the employment.
\ No newline at end of file