Class ListJobsRequest.Builder (2.34.0)

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

Request message for listing jobs using ListJobs.

Protobuf type google.cloud.scheduler.v1beta1.ListJobsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

build()

public ListJobsRequest build()
Returns
TypeDescription
ListJobsRequest

buildPartial()

public ListJobsRequest buildPartial()
Returns
TypeDescription
ListJobsRequest

clear()

public ListJobsRequest.Builder clear()
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

clearFilter()

public ListJobsRequest.Builder clearFilter()

filter can be used to specify a subset of jobs.

If filter equals target_config="HttpConfig", then the http target jobs are retrieved. If filter equals target_config="PubSubConfig", then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.

string filter = 4;

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clearLegacyAppEngineCron()

public ListJobsRequest.Builder clearLegacyAppEngineCron()

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead.

bool legacy_app_engine_cron = 7;

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

clearPageSize()

public ListJobsRequest.Builder clearPageSize()

Requested page size.

The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.

int32 page_size = 5;

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListJobsRequest.Builder clearPageToken()

A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.

string page_token = 6;

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clearParent()

public ListJobsRequest.Builder clearParent()

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

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

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clone()

public ListJobsRequest.Builder clone()
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListJobsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

filter can be used to specify a subset of jobs.

If filter equals target_config="HttpConfig", then the http target jobs are retrieved. If filter equals target_config="PubSubConfig", then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

filter can be used to specify a subset of jobs.

If filter equals target_config="HttpConfig", then the http target jobs are retrieved. If filter equals target_config="PubSubConfig", then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getLegacyAppEngineCron()

public boolean getLegacyAppEngineCron()

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead.

bool legacy_app_engine_cron = 7;

Returns
TypeDescription
boolean

The legacyAppEngineCron.

getPageSize()

public int getPageSize()

Requested page size.

The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.

int32 page_size = 5;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.

string page_token = 6;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.

string page_token = 6;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListJobsRequest other)

public ListJobsRequest.Builder mergeFrom(ListJobsRequest other)
Parameter
NameDescription
otherListJobsRequest
Returns
TypeDescription
ListJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListJobsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListJobsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

setFilter(String value)

public ListJobsRequest.Builder setFilter(String value)

filter can be used to specify a subset of jobs.

If filter equals target_config="HttpConfig", then the http target jobs are retrieved. If filter equals target_config="PubSubConfig", then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListJobsRequest.Builder setFilterBytes(ByteString value)

filter can be used to specify a subset of jobs.

If filter equals target_config="HttpConfig", then the http target jobs are retrieved. If filter equals target_config="PubSubConfig", then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setLegacyAppEngineCron(boolean value)

public ListJobsRequest.Builder setLegacyAppEngineCron(boolean value)

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead.

bool legacy_app_engine_cron = 7;

Parameter
NameDescription
valueboolean

The legacyAppEngineCron to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListJobsRequest.Builder setPageSize(int value)

Requested page size.

The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.

int32 page_size = 5;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListJobsRequest.Builder setPageToken(String value)

A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.

string page_token = 6;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListJobsRequest.Builder setPageTokenBytes(ByteString value)

A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.

string page_token = 6;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListJobsRequest.Builder setParent(String value)

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListJobsRequest.Builder setParentBytes(ByteString value)

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListJobsRequest.Builder
Overrides