Struct google_jobs3::ProjectCompleteCall

pub struct ProjectCompleteCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

A builder for the complete method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().complete("name")
             .type_("diam")
             .scope("ipsum")
             .query("Lorem")
             .page_size(-21)
             .add_language_codes("duo")
             .language_code("aliquyam")
             .company_name("sea")
             .doit();

Methods

impl<'a, C, A> ProjectCompleteCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, CompleteQueryResponse)>

Perform the operation you have build so far.

pub fn name(self, new_value: &str) -> ProjectCompleteCall<'a, C, A>

Required.

Resource name of project the completion is performed within.

The format is "projects/{project_id}", for example, "projects/api-test-project".

Sets the name path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn type_(self, new_value: &str) -> ProjectCompleteCall<'a, C, A>

Optional.

The completion topic. The default is CompletionType.COMBINED.

Sets the type query property to the given value.

pub fn scope(self, new_value: &str) -> ProjectCompleteCall<'a, C, A>

Optional.

The scope of the completion. The defaults is CompletionScope.PUBLIC.

Sets the scope query property to the given value.

pub fn query(self, new_value: &str) -> ProjectCompleteCall<'a, C, A>

Required.

The query used to generate suggestions.

The maximum number of allowed characters is 255.

Sets the query query property to the given value.

pub fn page_size(self, new_value: i32) -> ProjectCompleteCall<'a, C, A>

Required.

Completion result count.

The maximum allowed page size is 10.

Sets the page size query property to the given value.

pub fn add_language_codes(
    self,
    new_value: &str
) -> ProjectCompleteCall<'a, C, A>

Optional.

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.

For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned.

For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned.

For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned.

The maximum number of allowed characters is 255.

Append the given value to the language codes query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

pub fn language_code(self, new_value: &str) -> ProjectCompleteCall<'a, C, A>

Deprecated. Use language_codes instead.

Optional.

The language 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.

For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned.

For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned.

For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned.

The maximum number of allowed characters is 255.

Sets the language code query property to the given value.

pub fn company_name(self, new_value: &str) -> ProjectCompleteCall<'a, C, A>

Optional.

If provided, restricts completion to specified company.

The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo".

Sets the company name query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> ProjectCompleteCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> ProjectCompleteCall<'a, C, A> where
    T: AsRef<str>, 

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> ProjectCompleteCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for ProjectCompleteCall<'a, C, A>