public static final class ListJobsRequest.Builder extends GeneratedMessageV3.Builder<ListJobsRequest.Builder> implements ListJobsRequestOrBuilderRequest message for listing jobs using ListJobs.
Protobuf type google.cloud.scheduler.v1beta1.ListJobsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListJobsRequest.BuilderImplements
ListJobsRequestOrBuilderStatic 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 | |
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 | |
clearField(Descriptors.FieldDescriptor field)
public ListJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListJobsRequest.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ListJobsRequest.Builder | This builder for chaining. |
clone()
public ListJobsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListJobsRequest.Builder | |
getDefaultInstanceForType()
public ListJobsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListJobsRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListJobsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListJobsRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListJobsRequest.Builder | |
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 | |
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 | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | booleanThe legacyAppEngineCron to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe 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 location name. For example:
projects/PROJECT_ID/locations/LOCATION_ID.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe 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 | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListJobsRequest.Builder | |