GoogleApi.Jobs.V2.Api.Companies.jobs_companies_list

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

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

View Source

Specs

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

Lists all companies associated with a Cloud Talent Solution account.

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").

    • :mustHaveOpenJobs (type: boolean()) - Optional. Set to true if the companies request must have open jobs.

      Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

    • :pageSize (type: integer()) - Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

    • :pageToken (type: String.t) - Optional. The starting indicator from which to return results.

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

Returns

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