Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / jobs_v2.v2.html
blob: dc1f8683b4d4754818787f51c97b66b6611e608b [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_v2.html">Cloud Talent Solution API</a> . <a href="jobs_v2.v2.html">v2</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]81 <code><a href="#complete">complete(type=None, scope=None, languageCode=None, companyName=None, pageSize=None, query=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]90 <code class="details" id="complete">complete(type=None, scope=None, languageCode=None, companyName=None, pageSize=None, query=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <pre>Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92
93Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]94 type: string, Optional. The completion topic. The default is CompletionType.COMBINED.
95 Allowed values
96 COMPLETION_TYPE_UNSPECIFIED - Default value.
97 JOB_TITLE - Only suggest job titles.
98 COMPANY_NAME - Only suggest company names.
99 COMBINED - Suggest both job titles and company names.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]101 Allowed values
102 COMPLETION_SCOPE_UNSPECIFIED - Default value.
103 TENANT - Suggestions are based only on the data provided by the client.
104 PUBLIC - Suggestions are based on all jobs data in the system that&#x27;s visible to the client
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]105 languageCode: string, Required. The language of the query. This is the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 companyName: string, Optional. If provided, restricts completion to the specified company.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]107 pageSize: integer, Required. Completion result count. The maximum allowed page size is 10.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]108 query: string, Required. The query used to generate suggestions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 { # Output only. Response of auto-complete query.
118 &quot;metadata&quot;: { # Output only. Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.
119 &quot;experimentIdList&quot;: [ # Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 42,
121 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]122 &quot;requestId&quot;: &quot;A String&quot;, # A unique id associated with this call. This id is logged for tracking purposes.
123 &quot;mode&quot;: &quot;A String&quot;, # For search response only. Indicates the mode of a performed search.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]125 &quot;completionResults&quot;: [ # Results of the matching job/company candidates.
126 { # Output only. Resource that represents completion results.
127 &quot;type&quot;: &quot;A String&quot;, # The completion topic.
128 &quot;imageUrl&quot;: &quot;A String&quot;, # The URL for the company logo if `type=COMPANY_NAME`.
129 &quot;suggestion&quot;: &quot;A String&quot;, # The suggestion for the query.
130 },
131 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 }</pre>
133</div>
134
135</body></html>