Class: Google::Cloud::Talent::V4beta1::ListJobsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb

Overview

List jobs request.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ String

Returns Required. The filter string specifies the jobs to be enumerated.

Supported operator: =, AND

The fields eligible for filtering are:

  • companyName (Required)
  • requisitionId
  • status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified.

Sample Query:

  • companyName = "projects/foo/tenants/bar/companies/baz"
  • companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1"
  • companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED".

Returns:

  • (String) —

    Required. The filter string specifies the jobs to be enumerated.

    Supported operator: =, AND

    The fields eligible for filtering are:

    • companyName (Required)
    • requisitionId
    • status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified.

    Sample Query:

    • companyName = "projects/foo/tenants/bar/companies/baz"
    • companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1"
    • companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"


147
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 147

class ListJobsRequest; end

#job_view ⇒ Google::Cloud::Talent::V4beta1::JobView

Returns The desired job attributes returned for jobs in the search response. Defaults to JobView::JOB_VIEW_FULL if no value is specified.

Returns:



147
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 147

class ListJobsRequest; end

#page_size ⇒ Integer

Returns 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.

Returns:

  • (Integer) —

    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.



147
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 147

class ListJobsRequest; end

#page_token ⇒ String

Returns The starting point of a query result.

Returns:

  • (String) —

    The starting point of a query result.



147
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 147

class ListJobsRequest; end

#parent ⇒ String

Returns Required. The resource name of the tenant under which the job is created.

The format is "projects/project_id/tenants/tenant_id". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

Returns:

  • (String) —

    Required. The resource name of the tenant under which the job is created.

    The format is "projects/project_id/tenants/tenant_id". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".



147
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 147

class ListJobsRequest; end