Cloud Talent Solution V4 API - Class Google::Cloud::Talent::V4::ListJobsRequest (v0.10.1)

Reference documentation and code samples for the Cloud Talent Solution V4 API class Google::Cloud::Talent::V4::ListJobsRequest.

List jobs request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    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 of companyName and requisitionId must present or an INVALID_ARGUMENT error is thrown.

    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"
    • requisitionId = "req-1"
    • requisitionId = "req-1" AND status = "EXPIRED"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    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 of companyName and requisitionId must present or an INVALID_ARGUMENT error is thrown.

    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"
    • requisitionId = "req-1"
    • requisitionId = "req-1" 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
    • requisitionId
    • status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified.

    At least one of companyName and requisitionId must present or an INVALID_ARGUMENT error is thrown.

    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"
    • requisitionId = "req-1"
    • requisitionId = "req-1" AND status = "EXPIRED"

#job_view

def job_view() -> ::Google::Cloud::Talent::V4::JobView
Returns

#job_view=

def job_view=(value) -> ::Google::Cloud::Talent::V4::JobView
Parameter
Returns

#page_size

def page_size() -> ::Integer
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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::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.

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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The starting point of a query result.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The starting point of a query result.
Returns
  • (::String) — The starting point of a query result.

#parent

def parent() -> ::String
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/tenants/bar".

#parent=

def parent=(value) -> ::String
Parameter
  • value (::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/tenants/bar".

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/tenants/bar".