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_v4.html">Cloud Talent Solution API</a> . <a href="jobs_v4.projects.html">projects</a> . <a href="jobs_v4.projects.tenants.html">tenants</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="jobs_v4.projects.tenants.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_v4.projects.tenants.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_v4.projects.tenants.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="#close">close()</a></code></p> 94<p class="firstline">Close httplib2 connections.</p> 95<p class="toc_element"> 96 <code><a href="#completeQuery">completeQuery(tenant, company=None, languageCodes=None, pageSize=None, query=None, scope=None, type=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.</p> 98<p class="toc_element"> 99 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Creates a new tenant entity.</p> 101<p class="toc_element"> 102 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 103<p class="firstline">Deletes specified tenant.</p> 104<p class="toc_element"> 105 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 106<p class="firstline">Retrieves specified tenant.</p> 107<p class="toc_element"> 108 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Lists all tenants associated with the project.</p> 110<p class="toc_element"> 111 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 112<p class="firstline">Retrieves the next page of results.</p> 113<p class="toc_element"> 114 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Updates specified tenant.</p> 116<h3>Method Details</h3> 117<div class="method"> 118 <code class="details" id="close">close()</code> 119 <pre>Close httplib2 connections.</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="completeQuery">completeQuery(tenant, company=None, languageCodes=None, pageSize=None, query=None, scope=None, type=None, x__xgafv=None)</code> 124 <pre>Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box. 125 126Args: 127 tenant: 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". (required) 128 company: 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". 129 languageCodes: 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. (repeated) 130 pageSize: integer, Required. Completion result count. The maximum allowed page size is 10. 131 query: string, Required. The query used to generate suggestions. The maximum number of allowed characters is 255. 132 scope: string, The scope of the completion. The defaults is CompletionScope.PUBLIC. 133 Allowed values 134 COMPLETION_SCOPE_UNSPECIFIED - Default value. 135 TENANT - Suggestions are based only on the data provided by the client. 136 PUBLIC - Suggestions are based on all jobs data in the system that's visible to the client 137 type: string, The completion topic. The default is CompletionType.COMBINED. 138 Allowed values 139 COMPLETION_TYPE_UNSPECIFIED - Default value. 140 JOB_TITLE - Suggest job titles for jobs autocomplete. For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. 141 COMPANY_NAME - Suggest company names for jobs autocomplete. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. 142 COMBINED - Suggest both job titles and company names for jobs autocomplete. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. 143 x__xgafv: string, V1 error format. 144 Allowed values 145 1 - v1 error format 146 2 - v2 error format 147 148Returns: 149 An object of the form: 150 151 { # Response of auto-complete query. 152 "completionResults": [ # Results of the matching job/company candidates. 153 { # Resource that represents completion results. 154 "imageUri": "A String", # The URI of the company image for COMPANY_NAME. 155 "suggestion": "A String", # The suggestion for the query. 156 "type": "A String", # The completion topic. 157 }, 158 ], 159 "metadata": { # Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id. 160 "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purposes. 161 }, 162}</pre> 163</div> 164 165<div class="method"> 166 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 167 <pre>Creates a new tenant entity. 168 169Args: 170 parent: string, Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo". (required) 171 body: object, The request body. 172 The object takes the form of: 173 174{ # A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups. 175 "externalId": "A String", # Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255. 176 "name": "A String", # Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 177} 178 179 x__xgafv: string, V1 error format. 180 Allowed values 181 1 - v1 error format 182 2 - v2 error format 183 184Returns: 185 An object of the form: 186 187 { # A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups. 188 "externalId": "A String", # Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255. 189 "name": "A String", # Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 190}</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 195 <pre>Deletes specified tenant. 196 197Args: 198 name: string, Required. The resource name of the tenant to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". (required) 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 208}</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="get">get(name, x__xgafv=None)</code> 213 <pre>Retrieves specified tenant. 214 215Args: 216 name: string, Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". (required) 217 x__xgafv: string, V1 error format. 218 Allowed values 219 1 - v1 error format 220 2 - v2 error format 221 222Returns: 223 An object of the form: 224 225 { # A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups. 226 "externalId": "A String", # Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255. 227 "name": "A String", # Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 233 <pre>Lists all tenants associated with the project. 234 235Args: 236 parent: string, Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo". (required) 237 pageSize: integer, The maximum number of tenants to be returned, at most 100. Default is 100 if a non-positive number is provided. 238 pageToken: string, The starting indicator from which to return results. 239 x__xgafv: string, V1 error format. 240 Allowed values 241 1 - v1 error format 242 2 - v2 error format 243 244Returns: 245 An object of the form: 246 247 { # The List tenants response object. 248 "metadata": { # Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id. 249 "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purposes. 250 }, 251 "nextPageToken": "A String", # A token to retrieve the next page of results. 252 "tenants": [ # Tenants for the current client. 253 { # A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups. 254 "externalId": "A String", # Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255. 255 "name": "A String", # Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 256 }, 257 ], 258}</pre> 259</div> 260 261<div class="method"> 262 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 263 <pre>Retrieves the next page of results. 264 265Args: 266 previous_request: The request for the previous page. (required) 267 previous_response: The response from the request for the previous page. (required) 268 269Returns: 270 A request object that you can call 'execute()' on to request the next 271 page. Returns None if there are no more items in the collection. 272 </pre> 273</div> 274 275<div class="method"> 276 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 277 <pre>Updates specified tenant. 278 279Args: 280 name: string, Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". (required) 281 body: object, The request body. 282 The object takes the form of: 283 284{ # A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups. 285 "externalId": "A String", # Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255. 286 "name": "A String", # Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 287} 288 289 updateMask: string, Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in 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 Tenant are supported. 290 x__xgafv: string, V1 error format. 291 Allowed values 292 1 - v1 error format 293 2 - v2 error format 294 295Returns: 296 An object of the form: 297 298 { # A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups. 299 "externalId": "A String", # Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255. 300 "name": "A String", # Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 301}</pre> 302</div> 303 304</body></html>