GoogleApi.Jobs.V2.Api.Jobs.jobs_jobs_list

You're seeing just the function jobs_jobs_list, go back to GoogleApi.Jobs.V2.Api.Jobs module for more information.
Link to this function

jobs_jobs_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

jobs_jobs_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Jobs.V2.Model.ListJobsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Lists jobs by filter.

Parameters

  • connection (type: GoogleApi.Jobs.V2.Connection.t) - Connection to server

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.

    • :access_token (type: String.t) - OAuth access token.

    • :alt (type: String.t) - Data format for response.

    • :callback (type: String.t) - JSONP

    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.

    • :key (type: String.t) - 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.

    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.

    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.

    • :quotaUser (type: String.t) - 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.

    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").

    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").

    • :filter (type: String.t) - Required. The filter string specifies the jobs to be enumerated.

      Supported operator: =, AND The fields eligible for filtering are:

      • companyName (Required)
      • requisitionId (Optional) Sample Query:
      • companyName = "companies/123"
      • companyName = "companies/123" AND requisitionId = "req-1"
    • :idsOnly (type: boolean()) - Optional. If set to true, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false.

    • :pageSize (type: integer()) - Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.

    • :pageToken (type: String.t) - Optional. The starting point of a query result.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Jobs.V2.Model.ListJobsResponse{}} on success
  • {:error, info} on failure