google-cloud-talent 0.3.0 → 0.4.0

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

@@ -20,33 +20,28 @@ module Google
         # List profiles request.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     The resource name of the tenant under which the job is created.
+        #     Required. The resource name of the tenant under which the profile is
+        #     created.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenants/foo".
         # @!attribute [rw] page_token
         #   @return [String]
-        #     Optional.
-        #
-        #     The token that specifies the current offset (that is, starting result).
+        #     Optional. The token that specifies the current offset (that is, starting
+        #     result).
         #
-        #     Please set the value to {Google::Cloud::Talent::V4beta1::ListProfilesResponse#next_page_token ListProfilesResponse#next_page_token} to
-        #     continue the list.
+        #     Please set the value to
+        #     {Google::Cloud::Talent::V4beta1::ListProfilesResponse#next_page_token ListProfilesResponse#next_page_token}
+        #     to continue the list.
         # @!attribute [rw] page_size
         #   @return [Integer]
-        #     Optional.
-        #
-        #     The maximum number of profiles to be returned, at most 100.
+        #     Optional. The maximum number of profiles to be returned, at most 100.
         #
         #     Default is 100 unless a positive number smaller than 100 is specified.
         # @!attribute [rw] read_mask
         #   @return [Google::Protobuf::FieldMask]
-        #     Optional.
-        #
-        #     A field mask to specify the profile fields to be listed in response.
-        #     All fields are listed if it is unset.
+        #     Optional. A field mask to specify the profile fields to be listed in
+        #     response. All fields are listed if it is unset.
         #
         #     Valid values are:
         #
@@ -66,25 +61,19 @@ module Google
         # Create profile request.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     The name of the tenant this profile belongs to.
+        #     Required. The name of the tenant this profile belongs to.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenants/foo".
         # @!attribute [rw] profile
         #   @return [Google::Cloud::Talent::V4beta1::Profile]
-        #     Required.
-        #
-        #     The profile to be created.
+        #     Required. The profile to be created.
         class CreateProfileRequest; end
 
         # Get profile request.
         # @!attribute [rw] name
         #   @return [String]
-        #     Required.
-        #
-        #     Resource name of the profile to get.
+        #     Required. Resource name of the profile to get.
         #
         #     The format is
         #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
@@ -94,50 +83,44 @@ module Google
         # Update profile request
         # @!attribute [rw] profile
         #   @return [Google::Cloud::Talent::V4beta1::Profile]
-        #     Required.
-        #
-        #     Profile to be updated.
+        #     Required. Profile to be updated.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
-        #     Optional.
-        #
-        #     A field mask to specify the profile fields to update.
+        #     Optional. A field mask to specify the profile fields to update.
         #
         #     A full update is performed if it is unset.
         #
         #     Valid values are:
         #
-        #     * externalId
+        #     * external_id
         #     * source
         #     * uri
-        #     * isHirable
-        #     * createTime
-        #     * updateTime
-        #     * resumeHrxml
-        #     * personNames
+        #     * is_hirable
+        #     * create_time
+        #     * update_time
+        #     * resume
+        #     * person_names
         #     * addresses
-        #     * emailAddresses
-        #     * phoneNumbers
-        #     * personalUris
-        #     * additionalContactInfo
-        #     * employmentRecords
-        #     * educationRecords
+        #     * email_addresses
+        #     * phone_numbers
+        #     * personal_uris
+        #     * additional_contact_info
+        #     * employment_records
+        #     * education_records
         #     * skills
         #     * projects
         #     * publications
         #     * patents
         #     * certifications
-        #     * recruitingNotes
-        #     * customAttributes
-        #     * groupId
+        #     * recruiting_notes
+        #     * custom_attributes
+        #     * group_id
         class UpdateProfileRequest; end
 
         # Delete profile request.
         # @!attribute [rw] name
         #   @return [String]
-        #     Required.
-        #
-        #     Resource name of the profile to be deleted.
+        #     Required. Resource name of the profile to be deleted.
         #
         #     The format is
         #     "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
@@ -147,49 +130,40 @@ module Google
         # The request body of the `SearchProfiles` call.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     The resource name of the tenant to search within.
+        #     Required. The resource name of the tenant to search within.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenants/foo".
         # @!attribute [rw] request_metadata
         #   @return [Google::Cloud::Talent::V4beta1::RequestMetadata]
-        #     Required.
-        #
-        #     The meta information collected about the profile search user. This is used
-        #     to improve the search quality of the service. These values are provided by
-        #     users, and must be precise and consistent.
+        #     Required. The meta information collected about the profile search user.
+        #     This is used to improve the search quality of the service. These values are
+        #     provided by users, and must be precise and consistent.
         # @!attribute [rw] profile_query
         #   @return [Google::Cloud::Talent::V4beta1::ProfileQuery]
-        #     Optional.
-        #
-        #     Search query to execute. See {Google::Cloud::Talent::V4beta1::ProfileQuery ProfileQuery} for more details.
+        #     Optional. Search query to execute. See
+        #     {Google::Cloud::Talent::V4beta1::ProfileQuery ProfileQuery} for more details.
         # @!attribute [rw] page_size
         #   @return [Integer]
-        #     Optional.
-        #
-        #     A limit on the number of profiles returned in the search results.
+        #     Optional. A limit on the number of profiles returned in the search results.
         #     A value above the default value 10 can increase search response time.
         #
         #     The maximum value allowed is 100. Otherwise an error is thrown.
         # @!attribute [rw] page_token
         #   @return [String]
-        #     Optional.
-        #
-        #     The pageToken, similar to offset enables users of the API to paginate
-        #     through the search results. To retrieve the first page of results, set the
-        #     pageToken to empty. The search response includes a
-        #     {Google::Cloud::Talent::V4beta1::SearchProfilesResponse#next_page_token nextPageToken} field that can be
-        #     used to populate the pageToken field for the next page of results. Using
-        #     pageToken instead of offset increases the performance of the API,
-        #     especially compared to larger offset values.
+        #     Optional. The pageToken, similar to offset enables users of the API to
+        #     paginate through the search results. To retrieve the first page of results,
+        #     set the pageToken to empty. The search response includes a
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesResponse#next_page_token nextPageToken}
+        #     field that can be used to populate the pageToken field for the next page of
+        #     results. Using pageToken instead of offset increases the performance of the
+        #     API, especially compared to larger offset values.
         # @!attribute [rw] offset
         #   @return [Integer]
-        #     Optional.
-        #
-        #     An integer that specifies the current offset (that is, starting result) in
-        #     search results. This field is only considered if {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#page_token page_token} is unset.
+        #     Optional. An integer that specifies the current offset (that is, starting
+        #     result) in search results. This field is only considered if
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#page_token page_token}
+        #     is unset.
         #
         #     The maximum allowed value is 5000. Otherwise an error is thrown.
         #
@@ -198,48 +172,51 @@ module Google
         #     pageSize = 10 and offset = 10 means to search from the second page.
         # @!attribute [rw] disable_spell_check
         #   @return [true, false]
-        #     Optional.
-        #
-        #     This flag controls the spell-check feature. If `false`, the
+        #     Optional. This flag controls the spell-check feature. If `false`, the
         #     service attempts to correct a misspelled query.
         #
         #     For example, "enginee" is corrected to "engineer".
         # @!attribute [rw] order_by
         #   @return [String]
-        #     Optional.
-        #
-        #     The criteria that determines how search results are sorted.
+        #     Optional. The criteria that determines how search results are sorted.
         #     Defaults is "relevance desc" if no value is specified.
         #
         #     Supported options are:
         #
         #     * "relevance desc": By descending relevance, as determined by the API
         #       algorithms.
-        #     * "update_date desc": Sort by {Profile#update_date} in descending order
+        #     * "update_time desc": Sort by
+        #       {Google::Cloud::Talent::V4beta1::Profile#update_time Profile#update_time} in
+        #       descending order
         #       (recently updated profiles first).
-        #     * "create_date desc": Sort by {Profile#create_date} in descending order
+        #     * "create_time desc": Sort by
+        #       {Google::Cloud::Talent::V4beta1::Profile#create_time Profile#create_time} in
+        #       descending order
         #       (recently created profiles first).
-        #     * "first_name": Sort by {PersonStrcuturedName#given_name} in ascending
-        #       order.
-        #     * "first_name desc": Sort by {PersonStrcuturedName#given_name} in
-        #       descending order.
-        #     * "last_name": Sort by {PersonStrcuturedName#family_name} in ascending
-        #       order.
-        #     * "last_name desc": Sort by {PersonStrcuturedName#family_name} in
+        #     * "first_name": Sort by
+        #       {Google::Cloud::Talent::V4beta1::PersonName::PersonStructuredName#given_name PersonName::PersonStructuredName#given_name}
+        #       in
         #       ascending order.
+        #     * "first_name desc": Sort by
+        #       {Google::Cloud::Talent::V4beta1::PersonName::PersonStructuredName#given_name PersonName::PersonStructuredName#given_name}
+        #       in descending order.
+        #     * "last_name": Sort by
+        #       {Google::Cloud::Talent::V4beta1::PersonName::PersonStructuredName#family_name PersonName::PersonStructuredName#family_name}
+        #       in
+        #       ascending order.
+        #     * "last_name desc": Sort by
+        #       {Google::Cloud::Talent::V4beta1::PersonName::PersonStructuredName#family_name PersonName::PersonStructuredName#family_name}
+        #       in ascending order.
         # @!attribute [rw] case_sensitive_sort
         #   @return [true, false]
-        #     Optional.
-        #
-        #     When sort by field is based on alphabetical order, sort values case
-        #     sensitively (based on ASCII) when the value is set to true. Default value
-        #     is case in-sensitive sort (false).
+        #     Optional. When sort by field is based on alphabetical order, sort values
+        #     case sensitively (based on ASCII) when the value is set to true. Default
+        #     value is case in-sensitive sort (false).
         # @!attribute [rw] histogram_queries
         #   @return [Array<Google::Cloud::Talent::V4beta1::HistogramQuery>]
-        #     Optional.
-        #
-        #     A list of expressions specifies histogram requests against matching
-        #     profiles for {Google::Cloud::Talent::V4beta1::SearchProfilesRequest SearchProfilesRequest}.
+        #     Optional. A list of expressions specifies histogram requests against
+        #     matching profiles for
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest SearchProfilesRequest}.
         #
         #     The expression syntax looks like a function definition with optional
         #     parameters.
@@ -292,13 +269,19 @@ module Google
         #     * experience_in_months: experience in months. 0 means 0 month to 1 month
         #       (exclusive).
         #     * application_date: The application date specifies application start dates.
-        #       See {Google::Cloud::Talent::V4beta1::ApplicationDateFilter ApplicationDateFilter} for more details.
+        #       See
+        #       {Google::Cloud::Talent::V4beta1::ApplicationDateFilter ApplicationDateFilter}
+        #       for more details.
         #     * application_outcome_notes: The application outcome reason specifies the
         #       reasons behind the outcome of the job application.
-        #       See {Google::Cloud::Talent::V4beta1::ApplicationOutcomeNotesFilter ApplicationOutcomeNotesFilter} for more details.
+        #       See
+        #       {Google::Cloud::Talent::V4beta1::ApplicationOutcomeNotesFilter ApplicationOutcomeNotesFilter}
+        #       for more details.
         #     * application_job_title: The application job title specifies the job
         #       applied for in the application.
-        #       See {Google::Cloud::Talent::V4beta1::ApplicationJobFilter ApplicationJobFilter} for more details.
+        #       See
+        #       {Google::Cloud::Talent::V4beta1::ApplicationJobFilter ApplicationJobFilter}
+        #       for more details.
         #     * hirable_status: Hirable status specifies the profile's hirable status.
         #     * string_custom_attribute: String custom attributes. Values can be accessed
         #       via square bracket notation like string_custom_attribute["key1"].
@@ -313,6 +296,34 @@ module Google
         #     * count(string_custom_attribute["assigned_recruiter"])
         #     * count(numeric_custom_attribute["favorite_number"],
         #       [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
+        # @!attribute [rw] result_set_id
+        #   @return [String]
+        #     Optional. An id that uniquely identifies the result set of a
+        #     {SearchProfiles} call.  The id should be retrieved from the
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}
+        #     message returned from a previous invocation of {SearchProfiles}.
+        #
+        #     A result set is an ordered list of search results.
+        #
+        #     If this field is not set, a new result set is computed based on the
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#profile_query profile_query}.
+        #     A new
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#result_set_id result_set_id}
+        #     is returned as a handle to access this result set.
+        #
+        #     If this field is set, the service will ignore the resource and
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#profile_query profile_query}
+        #     values, and simply retrieve a page of results from the corresponding result
+        #     set.  In this case, one and only one of [page_token] or [offset] must be
+        #     set.
+        #
+        #     A typical use case is to invoke
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest SearchProfilesRequest}
+        #     without this field, then use the resulting
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#result_set_id result_set_id}
+        #     in
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}
+        #     to page through the results.
         class SearchProfilesRequest; end
 
         # Response of SearchProfiles method.
@@ -338,23 +349,32 @@ module Google
         #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest#histogram_queries SearchProfilesRequest#histogram_queries}.
         # @!attribute [rw] summarized_profiles
         #   @return [Array<Google::Cloud::Talent::V4beta1::SummarizedProfile>]
-        #     The profile entities that match the specified {Google::Cloud::Talent::V4beta1::SearchProfilesRequest SearchProfilesRequest}.
+        #     The profile entities that match the specified
+        #     {Google::Cloud::Talent::V4beta1::SearchProfilesRequest SearchProfilesRequest}.
+        # @!attribute [rw] result_set_id
+        #   @return [String]
+        #     An id that uniquely identifies the result set of a
+        #     {Google::Cloud::Talent::V4beta1::ProfileService::SearchProfiles SearchProfiles}
+        #     call for consistent results.
         class SearchProfilesResponse; end
 
         # Output only.
         #
-        # Profile entry with metadata inside {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}.
+        # Profile entry with metadata inside
+        # {Google::Cloud::Talent::V4beta1::SearchProfilesResponse SearchProfilesResponse}.
         # @!attribute [rw] profiles
         #   @return [Array<Google::Cloud::Talent::V4beta1::Profile>]
-        #     A list of profiles that are linked by {Profile#cluster_id}.
+        #     A list of profiles that are linked by
+        #     {Google::Cloud::Talent::V4beta1::Profile#group_id Profile#group_id}.
         # @!attribute [rw] summary
         #   @return [Google::Cloud::Talent::V4beta1::Profile]
         #     A profile summary shows the profile summary and how the profile matches the
         #     search query.
         #
-        #     In profile summary, the profiles with the same {Profile#cluster_id} are
-        #     merged together. Among profiles, same education/employment records may be
-        #     slightly different but they are merged into one with best efforts.
+        #     In profile summary, the profiles with the same
+        #     {Google::Cloud::Talent::V4beta1::Profile#group_id Profile#group_id} are merged
+        #     together. Among profiles, same education/employment records may be slightly
+        #     different but they are merged into one with best efforts.
         #
         #     For example, in one profile the school name is "UC Berkeley" and the field
         #     study is "Computer Science" and in another one the school name is

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

@@ -32,26 +32,24 @@ module Google
         #     "projects/api-test-project/tenants/foo".
         # @!attribute [rw] external_id
         #   @return [String]
-        #     Required.
-        #
-        #     Client side tenant identifier, used to uniquely identify the tenant.
+        #     Required. Client side tenant identifier, used to uniquely identify the
+        #     tenant.
         #
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] usage_type
         #   @return [Google::Cloud::Talent::V4beta1::Tenant::DataUsageType]
-        #     Optional.
-        #
-        #     Indicates whether data owned by this tenant may be used to provide product
-        #     improvements across other tenants.
+        #     Optional. Indicates whether data owned by this tenant may be used to
+        #     provide product improvements across other tenants.
         #
-        #     Defaults behavior is {Google::Cloud::Talent::V4beta1::Tenant::DataUsageType::ISOLATED DataUsageType::ISOLATED} if it's unset.
+        #     Defaults behavior is
+        #     {Google::Cloud::Talent::V4beta1::Tenant::DataUsageType::ISOLATED DataUsageType::ISOLATED}
+        #     if it's unset.
         # @!attribute [rw] keyword_searchable_profile_custom_attributes
         #   @return [Array<String>]
-        #     Optional.
-        #
-        #     A list of keys of filterable {Google::Cloud::Talent::V4beta1::Profile#custom_attributes Profile#custom_attributes}, whose
-        #     corresponding `string_values` are used in keyword searches. Profiles with
-        #     `string_values` under these specified field keys are returned if any
+        #     Optional. A list of keys of filterable
+        #     {Google::Cloud::Talent::V4beta1::Profile#custom_attributes Profile#custom_attributes},
+        #     whose corresponding `string_values` are used in keyword searches. Profiles
+        #     with `string_values` under these specified field keys are returned if any
         #     of the values match the search keyword. Custom field values with
         #     parenthesis, brackets and special symbols are not searchable as-is,
         #     and must be surrounded by quotes.

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

@@ -20,25 +20,19 @@ module Google
         # The Request of the CreateTenant method.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     Resource name of the project under which the tenant is created.
+        #     Required. Resource name of the project under which the tenant is created.
         #
         #     The format is "projects/{project_id}", for example,
         #     "projects/api-test-project".
         # @!attribute [rw] tenant
         #   @return [Google::Cloud::Talent::V4beta1::Tenant]
-        #     Required.
-        #
-        #     The tenant to be created.
+        #     Required. The tenant to be created.
         class CreateTenantRequest; end
 
         # Request for getting a tenant by name.
         # @!attribute [rw] name
         #   @return [String]
-        #     Required.
-        #
-        #     The resource name of the tenant to be retrieved.
+        #     Required. The resource name of the tenant to be retrieved.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenants/foo".
@@ -47,27 +41,28 @@ module Google
         # Request for updating a specified tenant.
         # @!attribute [rw] tenant
         #   @return [Google::Cloud::Talent::V4beta1::Tenant]
-        #     Required.
-        #
-        #     The tenant resource to replace the current resource in the system.
+        #     Required. The tenant resource to replace the current resource in the
+        #     system.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
         #     Optional but strongly recommended for the best service
         #     experience.
         #
-        #     If {Google::Cloud::Talent::V4beta1::UpdateTenantRequest#update_mask update_mask} is provided, only the specified fields in
-        #     {Google::Cloud::Talent::V4beta1::UpdateTenantRequest#tenant tenant} are updated. Otherwise all the fields are updated.
+        #     If
+        #     {Google::Cloud::Talent::V4beta1::UpdateTenantRequest#update_mask update_mask}
+        #     is provided, only the specified fields in
+        #     {Google::Cloud::Talent::V4beta1::UpdateTenantRequest#tenant tenant} are
+        #     updated. Otherwise all the fields are updated.
         #
         #     A field mask to specify the tenant fields to be updated. Only
-        #     top level fields of {Google::Cloud::Talent::V4beta1::Tenant Tenant} are supported.
+        #     top level fields of {Google::Cloud::Talent::V4beta1::Tenant Tenant} are
+        #     supported.
         class UpdateTenantRequest; end
 
         # Request to delete a tenant.
         # @!attribute [rw] name
         #   @return [String]
-        #     Required.
-        #
-        #     The resource name of the tenant to be deleted.
+        #     Required. The resource name of the tenant to be deleted.
         #
         #     The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         #     "projects/api-test-project/tenants/foo".
@@ -76,22 +71,16 @@ module Google
         # List tenants for which the client has ACL visibility.
         # @!attribute [rw] parent
         #   @return [String]
-        #     Required.
-        #
-        #     Resource name of the project under which the tenant is created.
+        #     Required. Resource name of the project under which the tenant is created.
         #
         #     The format is "projects/{project_id}", for example,
         #     "projects/api-test-project".
         # @!attribute [rw] page_token
         #   @return [String]
-        #     Optional.
-        #
-        #     The starting indicator from which to return results.
+        #     Optional. The starting indicator from which to return results.
         # @!attribute [rw] page_size
         #   @return [Integer]
-        #     Optional.
-        #
-        #     The maximum number of tenants to be returned, at most 100.
+        #     Optional. The maximum number of tenants to be returned, at most 100.
         #     Default is 100 if a non-positive number is provided.
         class ListTenantsRequest; end