GoogleApi.Jobs.V3.Api.Projects (google_api_jobs v0.21.0)
View SourceAPI calls for all endpoints tagged Projects
.
Summary
Functions
Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in self service tools. Learn more about self service tools.
Creates a new company entity.
Deletes specified company. Prerequisite: The company has no jobs associated with it.
Retrieves specified company.
Lists all companies associated with the service account.
Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.
Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
Deletes a list of Jobs by filter.
Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.
Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
Lists jobs by filter.
Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.
Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.
Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.
Functions
@spec jobs_projects_client_events_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.ClientEvent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in self service tools. Learn more about self service tools.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Parent project name. -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.CreateClientEventRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.ClientEvent{}}
on success -
{:error, info}
on failure
@spec jobs_projects_companies_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.Company.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new company entity.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.CreateCompanyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Company{}}
on success -
{:error, info}
on failure
@spec jobs_projects_companies_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes specified company. Prerequisite: The company has no jobs associated with it.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Empty{}}
on success -
{:error, info}
on failure
@spec jobs_projects_companies_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.Company.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves specified company.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Company{}}
on success -
{:error, info}
on failure
@spec jobs_projects_companies_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.ListCompaniesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all companies associated with the service account.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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"). -
: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. -
:requireOpenJobs
(type:boolean()
) - Optional. Set to true if the companies requested 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.ListCompaniesResponse{}}
on success -
{:error, info}
on failure
@spec jobs_projects_companies_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.Company.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.UpdateCompanyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Company{}}
on success -
{:error, info}
on failure
@spec jobs_projects_complete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Jobs.V3.Model.CompleteQueryResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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"). -
:companyName
(type:String.t
) - 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". -
:languageCode
(type:String.t
) - 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. -
:languageCodes
(type:list(String.t)
) - 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. -
:pageSize
(type:integer()
) - Required. Completion result count. The maximum allowed page size is 10. -
:query
(type:String.t
) - Required. The query used to generate suggestions. The maximum number of allowed characters is 255. -
:scope
(type:String.t
) - Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. -
:type
(type:String.t
) - Optional. The completion topic. The default is CompletionType.COMBINED.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.CompleteQueryResponse{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_batch_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a list of Jobs by filter.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.BatchDeleteJobsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Empty{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_create(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Jobs.V3.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.CreateJobRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Job{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Jobs.V3.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Empty{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Jobs.V3.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Job{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Jobs.V3.Model.ListJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists jobs by filter.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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
requisitionId
status
Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. At least one ofcompanyName
andrequisitionId
must present or an INVALID_ARGUMENT error is thrown. Sample Query: companyName = "projects/api-test-project/companies/123" companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" companyName = "projects/api-test-project/companies/123" AND status = "EXPIRED" requisitionId = "req-1" requisitionId = "req-1" AND status = "EXPIRED" -
:jobView
(type:String.t
) - Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. -
:pageSize
(type:integer()
) - Optional. The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, 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.V3.Model.ListJobsResponse{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Jobs.V3.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.UpdateJobRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.Job{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_search(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Jobs.V3.Model.SearchJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.SearchJobsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.SearchJobsResponse{}}
on success -
{:error, info}
on failure
@spec jobs_projects_jobs_search_for_alert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Jobs.V3.Model.SearchJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.
Parameters
-
connection
(type:GoogleApi.Jobs.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". -
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"). -
:body
(type:GoogleApi.Jobs.V3.Model.SearchJobsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Jobs.V3.Model.SearchJobsResponse{}}
on success -
{:error, info}
on failure