Class ListJobsRequest.Builder (2.50.0) 

public static final class ListJobsRequest.Builder extends GeneratedMessageV3.Builder<ListJobsRequest.Builder> implements ListJobsRequestOrBuilder

List jobs request.

Protobuf type google.cloud.talent.v4beta1.ListJobsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListJobsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListJobsRequest.Builder
Overrides

build()

public ListJobsRequest build()
Returns
Type Description
ListJobsRequest

buildPartial()

public ListJobsRequest buildPartial()
Returns
Type Description
ListJobsRequest

clear()

public ListJobsRequest.Builder clear()
Returns
Type Description
ListJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListJobsRequest.Builder
Overrides

clearFilter()

public ListJobsRequest.Builder clearFilter()

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
Type Description
ListJobsRequest.Builder

This builder for chaining.

clearJobView()

public ListJobsRequest.Builder clearJobView()

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.v4beta1.JobView job_view = 5;

Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListJobsRequest.Builder
Overrides

clearPageSize()

public ListJobsRequest.Builder clearPageSize()

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
Type Description
ListJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListJobsRequest.Builder clearPageToken()

The starting point of a query result.

string page_token = 3;

Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

clearParent()

public ListJobsRequest.Builder clearParent()

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

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

Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

clone()

public ListJobsRequest.Builder clone()
Returns
Type Description
ListJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListJobsRequest getDefaultInstanceForType()
Returns
Type Description
ListJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public 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
Type Description
String

The filter.

getFilterBytes()

public 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
Type Description
ByteString

The bytes for filter.

getJobView()

public 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.v4beta1.JobView job_view = 5;

Returns
Type Description
JobView

The jobView.

getJobViewValue()

public 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.v4beta1.JobView job_view = 5;

Returns
Type Description
int

The enum numeric value on the wire for jobView.

getPageSize()

public 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
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The starting point of a query result.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The starting point of a query result.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public 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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

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

Returns
Type Description
String

The parent.

getParentBytes()

public 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/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListJobsRequest other)

public ListJobsRequest.Builder mergeFrom(ListJobsRequest other)
Parameter
Name Description
other ListJobsRequest
Returns
Type Description
ListJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListJobsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListJobsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListJobsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListJobsRequest.Builder
Overrides

setFilter(String value)

public ListJobsRequest.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListJobsRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setJobView(JobView value)

public ListJobsRequest.Builder setJobView(JobView value)

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.v4beta1.JobView job_view = 5;

Parameter
Name Description
value JobView

The jobView to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setJobViewValue(int value)

public ListJobsRequest.Builder setJobViewValue(int value)

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.v4beta1.JobView job_view = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for jobView to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListJobsRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListJobsRequest.Builder setPageToken(String value)

The starting point of a query result.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListJobsRequest.Builder setPageTokenBytes(ByteString value)

The starting point of a query result.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListJobsRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListJobsRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListJobsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListJobsRequest.Builder
Overrides