blob: 223a5515b1e598d7152467da9bfedbe3a2784066 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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_v3.html">Cloud Talent Solution API</a> . <a href="jobs_v3.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="jobs_v3.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_v3.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_v3.projects.jobs.html">jobs()</a></code>
89</p>
90<p class="firstline">Returns the jobs Resource.</p>
91
92<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070093 <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 -070094<p class="firstline">Completes the specified prefix with keyword suggestions.</p>
95<h3>Method Details</h3>
96<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070097 <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 -070098 <pre>Completes the specified prefix with keyword suggestions.
99Intended for use by a job search auto-complete search box.
100
101Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 name: string, Required. Resource name of project the completion is performed within.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103
Bu Sun Kim65020912020-05-20 12:08:20 -0700104The format is &quot;projects/{project_id}&quot;, for example,
105&quot;projects/api-test-project&quot;. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700106 languageCodes: string, Optional. The list of languages of the query. This is
107the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;.
108For more information, see
109[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
110
111For CompletionType.JOB_TITLE type, only open jobs with the same
112language_codes are returned.
113
114For CompletionType.COMPANY_NAME type,
115only companies having open jobs with the same language_codes are
116returned.
117
118For CompletionType.COMBINED type, only open jobs with the same
119language_codes or companies having open jobs with the same
120language_codes are returned.
121
122The maximum number of allowed characters is 255. (repeated)
123 companyName: string, Optional. If provided, restricts completion to specified company.
124
125The format is &quot;projects/{project_id}/companies/{company_id}&quot;, for example,
126&quot;projects/api-test-project/companies/foo&quot;.
127 scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
Bu Sun Kim65020912020-05-20 12:08:20 -0700128 pageSize: integer, Required. Completion result count.
129
130The maximum allowed page size is 10.
131 query: string, Required. The query used to generate suggestions.
132
133The maximum number of allowed characters is 255.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700134 languageCode: string, Deprecated. Use language_codes instead.
135
136Optional.
137
138The language of the query. This is
Bu Sun Kim65020912020-05-20 12:08:20 -0700139the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700140For more information, see
141[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
142
143For CompletionType.JOB_TITLE type, only open jobs with the same
144language_code are returned.
145
146For CompletionType.COMPANY_NAME type,
147only companies having open jobs with the same language_code are
148returned.
149
150For CompletionType.COMBINED type, only open jobs with the same
151language_code or companies having open jobs with the same
152language_code are returned.
153
154The maximum number of allowed characters is 255.
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 type: string, Optional. The completion topic. The default is CompletionType.COMBINED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160
161Returns:
162 An object of the form:
163
164 { # Output only.
165 #
166 # Response of auto-complete query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700167 &quot;completionResults&quot;: [ # Results of the matching job/company candidates.
168 { # Output only.
169 #
170 # Resource that represents completion results.
171 &quot;imageUri&quot;: &quot;A String&quot;, # The URI of the company image for CompletionType.COMPANY_NAME.
172 &quot;type&quot;: &quot;A String&quot;, # The completion topic.
173 &quot;suggestion&quot;: &quot;A String&quot;, # The suggestion for the query.
174 },
175 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700176 &quot;metadata&quot;: { # Output only. # Additional information for the API invocation, such as the request
177 # tracking id.
178 #
179 # Additional information returned to client, such as debugging information.
180 &quot;requestId&quot;: &quot;A String&quot;, # A unique id associated with this call.
181 # This id is logged for tracking purposes.
182 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700183 }</pre>
184</div>
185
186</body></html>