google-cloud-talent-v4 0.1.0

data/proto_docs/google/cloud/talent/v4/company.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Talent
+      module V4
+        # A Company resource represents a company in the service. A company is the
+        # entity that owns job postings, that is, the hiring entity responsible for
+        # employing applicants for the job position.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required during company update.
+        #
+        #     The resource name for a company. This is generated by the service when a
+        #     company is created.
+        #
+        #     The format is
+        #     "projects/\\{project_id}/tenants/\\{tenant_id}/companies/\\{company_id}", for
+        #     example, "projects/foo/tenants/bar/companies/baz".
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the company, for example, "Google LLC".
+        # @!attribute [rw] external_id
+        #   @return [::String]
+        #     Required. Client side company identifier, used to uniquely identify the
+        #     company.
+        #
+        #     The maximum number of allowed characters is 255.
+        # @!attribute [rw] size
+        #   @return [::Google::Cloud::Talent::V4::CompanySize]
+        #     The employer's company size.
+        # @!attribute [rw] headquarters_address
+        #   @return [::String]
+        #     The street address of the company's main headquarters, which may be
+        #     different from the job location. The service attempts
+        #     to geolocate the provided address, and populates a more specific
+        #     location wherever possible in
+        #     {::Google::Cloud::Talent::V4::Company::DerivedInfo#headquarters_location DerivedInfo.headquarters_location}.
+        # @!attribute [rw] hiring_agency
+        #   @return [::Boolean]
+        #     Set to true if it is the hiring agency that post jobs for other
+        #     employers.
+        #
+        #     Defaults to false if not provided.
+        # @!attribute [rw] eeo_text
+        #   @return [::String]
+        #     Equal Employment Opportunity legal disclaimer text to be
+        #     associated with all jobs, and typically to be displayed in all
+        #     roles.
+        #
+        #     The maximum number of allowed characters is 500.
+        # @!attribute [rw] website_uri
+        #   @return [::String]
+        #     The URI representing the company's primary web site or home page,
+        #     for example, "https://www.google.com".
+        #
+        #     The maximum number of allowed characters is 255.
+        # @!attribute [rw] career_site_uri
+        #   @return [::String]
+        #     The URI to employer's career site or careers page on the employer's web
+        #     site, for example, "https://careers.google.com".
+        # @!attribute [rw] image_uri
+        #   @return [::String]
+        #     A URI that hosts the employer's company logo.
+        # @!attribute [rw] keyword_searchable_job_custom_attributes
+        #   @return [::Array<::String>]
+        #     A list of keys of filterable
+        #     {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes},
+        #     whose corresponding `string_values` are used in keyword searches. Jobs 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 those keyword queries must be surrounded by quotes.
+        # @!attribute [r] derived_info
+        #   @return [::Google::Cloud::Talent::V4::Company::DerivedInfo]
+        #     Output only. Derived details about the company.
+        # @!attribute [r] suspended
+        #   @return [::Boolean]
+        #     Output only. Indicates whether a company is flagged to be suspended from
+        #     public availability by the service when job content appears suspicious,
+        #     abusive, or spammy.
+        class Company
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Derived details about the company.
+          # @!attribute [rw] headquarters_location
+          #   @return [::Google::Cloud::Talent::V4::Location]
+          #     A structured headquarters location of the company, resolved from
+          #     {::Google::Cloud::Talent::V4::Company#headquarters_address Company.headquarters_address}
+          #     if provided.
+          class DerivedInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/talent/v4/company_service.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Talent
+      module V4
+        # The Request of the CreateCompany method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the tenant under which the company is created.
+        #
+        #     The format is "projects/\\{project_id}/tenants/\\{tenant_id}", for example,
+        #     "projects/foo/tenants/bar".
+        # @!attribute [rw] company
+        #   @return [::Google::Cloud::Talent::V4::Company]
+        #     Required. The company to be created.
+        class CreateCompanyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for getting a company by name.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the company to be retrieved.
+        #
+        #     The format is
+        #     "projects/\\{project_id}/tenants/\\{tenant_id}/companies/\\{company_id}", for
+        #     example, "projects/api-test-project/tenants/foo/companies/bar".
+        class GetCompanyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for updating a specified company.
+        # @!attribute [rw] company
+        #   @return [::Google::Cloud::Talent::V4::Company]
+        #     Required. The company resource to replace the current resource in the
+        #     system.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Strongly recommended for the best service experience.
+        #
+        #     If {::Google::Cloud::Talent::V4::UpdateCompanyRequest#update_mask update_mask}
+        #     is provided, only the specified fields in
+        #     {::Google::Cloud::Talent::V4::UpdateCompanyRequest#company company} are updated.
+        #     Otherwise all the fields are updated.
+        #
+        #     A field mask to specify the company fields to be updated. Only
+        #     top level fields of {::Google::Cloud::Talent::V4::Company Company} are
+        #     supported.
+        class UpdateCompanyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to delete a company.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the company to be deleted.
+        #
+        #     The format is
+        #     "projects/\\{project_id}/tenants/\\{tenant_id}/companies/\\{company_id}", for
+        #     example, "projects/foo/tenants/bar/companies/baz".
+        class DeleteCompanyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # List companies for which the client has ACL visibility.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the tenant under which the company is created.
+        #
+        #     The format is "projects/\\{project_id}/tenants/\\{tenant_id}", for example,
+        #     "projects/foo/tenants/bar".
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The starting indicator from which to return results.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of companies to be returned, at most 100.
+        #     Default is 100 if a non-positive number is provided.
+        # @!attribute [rw] require_open_jobs
+        #   @return [::Boolean]
+        #     Set to true if the companies requested must have open jobs.
+        #
+        #     Defaults to false.
+        #
+        #     If true, at most
+        #     {::Google::Cloud::Talent::V4::ListCompaniesRequest#page_size page_size} of
+        #     companies are fetched, among which only those with open jobs are returned.
+        class ListCompaniesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The List companies response object.
+        # @!attribute [rw] companies
+        #   @return [::Array<::Google::Cloud::Talent::V4::Company>]
+        #     Companies for the current client.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::Talent::V4::ResponseMetadata]
+        #     Additional information for the API invocation, such as the request
+        #     tracking id.
+        class ListCompaniesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/talent/v4/completion_service.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Talent
+      module V4
+        # Auto-complete parameters.
+        # @!attribute [rw] tenant
+        #   @return [::String]
+        #     Required. Resource name of tenant the completion is performed within.
+        #
+        #     The format is "projects/\\{project_id}/tenants/\\{tenant_id}", for example,
+        #     "projects/foo/tenants/bar".
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     Required. The query used to generate suggestions.
+        #
+        #     The maximum number of allowed characters is 255.
+        # @!attribute [rw] language_codes
+        #   @return [::Array<::String>]
+        #     The list of languages of the query. This is
+        #     the BCP-47 language code, such as "en-US" or "sr-Latn".
+        #     For more information, see
+        #     [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
+        #
+        #     The maximum number of allowed characters is 255.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Required. Completion result count.
+        #
+        #     The maximum allowed page size is 10.
+        # @!attribute [rw] company
+        #   @return [::String]
+        #     If provided, restricts completion to specified company.
+        #
+        #     The format is
+        #     "projects/\\{project_id}/tenants/\\{tenant_id}/companies/\\{company_id}", for
+        #     example, "projects/foo/tenants/bar/companies/baz".
+        # @!attribute [rw] scope
+        #   @return [::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope]
+        #     The scope of the completion. The defaults is
+        #     {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope.PUBLIC}.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType]
+        #     The completion topic. The default is
+        #     {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMBINED CompletionType.COMBINED}.
+        class CompleteQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enum to specify the scope of completion.
+          module CompletionScope
+            # Default value.
+            COMPLETION_SCOPE_UNSPECIFIED = 0
+
+            # Suggestions are based only on the data provided by the client.
+            TENANT = 1
+
+            # Suggestions are based on all jobs data in the system that's visible to
+            # the client
+            PUBLIC = 2
+          end
+
+          # Enum to specify auto-completion topics.
+          module CompletionType
+            # Default value.
+            COMPLETION_TYPE_UNSPECIFIED = 0
+
+            # Suggest job titles for jobs autocomplete.
+            #
+            # For
+            # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType.JOB_TITLE}
+            # type, only open jobs with the same
+            # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
+            # are returned.
+            JOB_TITLE = 1
+
+            # Suggest company names for jobs autocomplete.
+            #
+            # For
+            # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType.COMPANY_NAME}
+            # type, only companies having open jobs with the same
+            # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
+            # are returned.
+            COMPANY_NAME = 2
+
+            # Suggest both job titles and company names for jobs autocomplete.
+            #
+            # For
+            # {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMBINED CompletionType.COMBINED}
+            # type, only open jobs with the same
+            # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
+            # or companies having open jobs with the same
+            # {::Google::Cloud::Talent::V4::CompleteQueryRequest#language_codes language_codes}
+            # are returned.
+            COMBINED = 3
+          end
+        end
+
+        # Response of auto-complete query.
+        # @!attribute [rw] completion_results
+        #   @return [::Array<::Google::Cloud::Talent::V4::CompleteQueryResponse::CompletionResult>]
+        #     Results of the matching job/company candidates.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::Talent::V4::ResponseMetadata]
+        #     Additional information for the API invocation, such as the request
+        #     tracking id.
+        class CompleteQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Resource that represents completion results.
+          # @!attribute [rw] suggestion
+          #   @return [::String]
+          #     The suggestion for the query.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType]
+          #     The completion topic.
+          # @!attribute [rw] image_uri
+          #   @return [::String]
+          #     The URI of the company image for
+          #     {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMPANY_NAME COMPANY_NAME}.
+          class CompletionResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/talent/v4/event.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Talent
+      module V4
+        # An event issued when an end user interacts with the application that
+        # implements Cloud Talent Solution. Providing this information improves the
+        # quality of results for the API clients, enabling the
+        # service to perform optimally. The number of events sent must be consistent
+        # with other calls, such as job searches, issued to the service by the client.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Strongly recommended for the best service experience.
+        #
+        #     A unique ID generated in the API responses. It can be found in
+        #     {::Google::Cloud::Talent::V4::ResponseMetadata#request_id ResponseMetadata.request_id}.
+        # @!attribute [rw] event_id
+        #   @return [::String]
+        #     Required. A unique identifier, generated by the client application.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Required. The timestamp of the event.
+        # @!attribute [rw] job_event
+        #   @return [::Google::Cloud::Talent::V4::JobEvent]
+        #     An event issued when a job seeker interacts with the application that
+        #     implements Cloud Talent Solution.
+        # @!attribute [rw] event_notes
+        #   @return [::String]
+        #     Notes about the event provided by recruiters or other users, for example,
+        #     feedback on why a job was bookmarked.
+        class ClientEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An event issued when a job seeker interacts with the application that
+        # implements Cloud Talent Solution.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::Talent::V4::JobEvent::JobEventType]
+        #     Required. The type of the event (see
+        #     {::Google::Cloud::Talent::V4::JobEvent::JobEventType JobEventType}).
+        # @!attribute [rw] jobs
+        #   @return [::Array<::String>]
+        #     Required. The [job name(s)][google.cloud.talent.v4.Job.name] associated
+        #     with this event. For example, if this is an
+        #     {::Google::Cloud::Talent::V4::JobEvent::JobEventType::IMPRESSION impression}
+        #     event, this field contains the identifiers of all jobs shown to the job
+        #     seeker. If this was a
+        #     {::Google::Cloud::Talent::V4::JobEvent::JobEventType::VIEW view} event, this field
+        #     contains the identifier of the viewed job.
+        #
+        #     The format is
+        #     "projects/\\{project_id}/tenants/\\{tenant_id}/jobs/\\{job_id}", for
+        #     example, "projects/foo/tenants/bar/jobs/baz".
+        class JobEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # An enumeration of an event attributed to the behavior of the end user,
+          # such as a job seeker.
+          module JobEventType
+            # The event is unspecified by other provided values.
+            JOB_EVENT_TYPE_UNSPECIFIED = 0
+
+            # The job seeker or other entity interacting with the service has
+            # had a job rendered in their view, such as in a list of search results in
+            # a compressed or clipped format. This event is typically associated with
+            # the viewing of a jobs list on a single page by a job seeker.
+            IMPRESSION = 1
+
+            # The job seeker, or other entity interacting with the service, has
+            # viewed the details of a job, including the full description. This
+            # event doesn't apply to the viewing a snippet of a job appearing as a
+            # part of the job search results. Viewing a snippet is associated with an
+            # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::IMPRESSION impression}).
+            VIEW = 2
+
+            # The job seeker or other entity interacting with the service
+            # performed an action to view a job and was redirected to a different
+            # website for job.
+            VIEW_REDIRECT = 3
+
+            # The job seeker or other entity interacting with the service
+            # began the process or demonstrated the intention of applying for a job.
+            APPLICATION_START = 4
+
+            # The job seeker or other entity interacting with the service
+            # submitted an application for a job.
+            APPLICATION_FINISH = 5
+
+            # The job seeker or other entity interacting with the service
+            # submitted an application for a job with a single click without
+            # entering information. If a job seeker performs this action, send only
+            # this event to the service. Do not also send
+            # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_START JobEventType.APPLICATION_START}
+            # or
+            # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_FINISH JobEventType.APPLICATION_FINISH}
+            # events.
+            APPLICATION_QUICK_SUBMISSION = 6
+
+            # The job seeker or other entity interacting with the service
+            # performed an action to apply to a job and was redirected to a different
+            # website to complete the application.
+            APPLICATION_REDIRECT = 7
+
+            # The job seeker or other entity interacting with the service began the
+            # process or demonstrated the intention of applying for a job from the
+            # search results page without viewing the details of the job posting.
+            # If sending this event, JobEventType.VIEW event shouldn't be sent.
+            APPLICATION_START_FROM_SEARCH = 8
+
+            # The job seeker, or other entity interacting with the service, performs an
+            # action with a single click from the search results page to apply to a job
+            # (without viewing the details of the job posting), and is redirected
+            # to a different website to complete the application. If a candidate
+            # performs this action, send only this event to the service. Do not also
+            # send
+            # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_START JobEventType.APPLICATION_START},
+            # {::Google::Cloud::Talent::V4::JobEvent::JobEventType::APPLICATION_FINISH JobEventType.APPLICATION_FINISH}
+            # or {::Google::Cloud::Talent::V4::JobEvent::JobEventType::VIEW JobEventType.VIEW}
+            # events.
+            APPLICATION_REDIRECT_FROM_SEARCH = 9
+
+            # This event should be used when a company submits an application
+            # on behalf of a job seeker. This event is intended for use by staffing
+            # agencies attempting to place candidates.
+            APPLICATION_COMPANY_SUBMIT = 10
+
+            # The job seeker or other entity interacting with the service demonstrated
+            # an interest in a job by bookmarking or saving it.
+            BOOKMARK = 11
+
+            # The job seeker or other entity interacting with the service was
+            # sent a notification, such as an email alert or device notification,
+            # containing one or more jobs listings generated by the service.
+            NOTIFICATION = 12
+
+            # The job seeker or other entity interacting with the service was
+            # employed by the hiring entity (employer). Send this event
+            # only if the job seeker was hired through an application that was
+            # initiated by a search conducted through the Cloud Talent Solution
+            # service.
+            HIRED = 13
+
+            # A recruiter or staffing agency submitted an application on behalf of the
+            # candidate after interacting with the service to identify a suitable job
+            # posting.
+            SENT_CV = 14
+
+            # The entity interacting with the service (for example, the job seeker),
+            # was granted an initial interview by the hiring entity (employer). This
+            # event should only be sent if the job seeker was granted an interview as
+            # part of an application that was initiated by a search conducted through /
+            # recommendation provided by the Cloud Talent Solution service.
+            INTERVIEW_GRANTED = 15
+          end
+        end
+      end
+    end
+  end
+end