Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / jobs_v3p1beta1.projects.html
blob: afdc4845664611a5670396d1b2a3ded2ce8b22ef [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="jobs_v3p1beta1.html">Cloud Talent Solution API</a> . <a href="jobs_v3p1beta1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="jobs_v3p1beta1.projects.clientEvents.html">clientEvents()</a></code>
79</p>
80<p class="firstline">Returns the clientEvents Resource.</p>
81
82<p class="toc_element">
83 <code><a href="jobs_v3p1beta1.projects.companies.html">companies()</a></code>
84</p>
85<p class="firstline">Returns the companies Resource.</p>
86
87<p class="toc_element">
88 <code><a href="jobs_v3p1beta1.projects.jobs.html">jobs()</a></code>
89</p>
90<p class="firstline">Returns the jobs Resource.</p>
91
92<p class="toc_element">
93 <code><a href="jobs_v3p1beta1.projects.operations.html">operations()</a></code>
94</p>
95<p class="firstline">Returns the operations Resource.</p>
96
97<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]98 <code><a href="#complete">complete(name, languageCodes=None, companyName=None, scope=None, pageSize=None, query=None, languageCode=None, type=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99<p class="firstline">Completes the specified prefix with keyword suggestions.</p>
100<h3>Method Details</h3>
101<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]102 <code class="details" id="complete">complete(name, languageCodes=None, companyName=None, scope=None, pageSize=None, query=None, languageCode=None, type=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 <pre>Completes the specified prefix with keyword suggestions.
104Intended for use by a job search auto-complete search box.
105
106Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107 name: string, Required. Resource name of project the completion is performed within.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109The format is &quot;projects/{project_id}&quot;, for example,
110&quot;projects/api-test-project&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 languageCodes: string, Optional. The list of languages of the query. This is
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113For more information, see
114[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
115
116For CompletionType.JOB_TITLE type, only open jobs with the same
117language_codes are returned.
118
119For CompletionType.COMPANY_NAME type,
120only companies having open jobs with the same language_codes are
121returned.
122
123For CompletionType.COMBINED type, only open jobs with the same
124language_codes or companies having open jobs with the same
125language_codes are returned.
126
127The maximum number of allowed characters is 255. (repeated)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 companyName: string, Optional. If provided, restricts completion to specified company.
129
130The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
131&quot;projects/api-test-project/companies/foo&quot;.
132 scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
133 pageSize: integer, Required. Completion result count.
134
135The maximum allowed page size is 10.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]136 query: string, Required. The query used to generate suggestions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137
138The maximum number of allowed characters is 255.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 languageCode: string, Deprecated. Use language_codes instead.
140
141Optional.
142
143The language of the query. This is
144the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;.
145For more information, see
146[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
147
148For CompletionType.JOB_TITLE type, only open jobs with the same
149language_code are returned.
150
151For CompletionType.COMPANY_NAME type,
152only companies having open jobs with the same language_code are
153returned.
154
155For CompletionType.COMBINED type, only open jobs with the same
156language_code or companies having open jobs with the same
157language_code are returned.
158
159The maximum number of allowed characters is 255.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 type: string, Optional. The completion topic. The default is CompletionType.COMBINED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165
166Returns:
167 An object of the form:
168
169 { # Output only.
170 #
171 # Response of auto-complete query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172 &quot;metadata&quot;: { # Output only. # Additional information for the API invocation, such as the request
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 # tracking id.
174 #
175 # Additional information returned to client, such as debugging information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;requestId&quot;: &quot;A String&quot;, # A unique id associated with this call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 # This id is logged for tracking purposes.
178 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 &quot;completionResults&quot;: [ # Results of the matching job/company candidates.
180 { # Output only.
181 #
182 # Resource that represents completion results.
183 &quot;imageUri&quot;: &quot;A String&quot;, # The URI of the company image for CompletionType.COMPANY_NAME.
184 &quot;type&quot;: &quot;A String&quot;, # The completion topic.
185 &quot;suggestion&quot;: &quot;A String&quot;, # The suggestion for the query.
186 },
187 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 }</pre>
189</div>
190
191</body></html>