Interface ListJobsRequestOrBuilder (2.24.0)

public interface ListJobsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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"

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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"

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for filter.

getJobView()

public abstract JobView getJobView()

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

.google.cloud.talent.v4.JobView job_view = 5;

Returns
TypeDescription
JobView

The jobView.

getJobViewValue()

public abstract int getJobViewValue()

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

.google.cloud.talent.v4.JobView job_view = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for jobView.

getPageSize()

public abstract int getPageSize()

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.

int32 page_size = 4;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

The starting point of a query result.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The starting point of a query result.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.