public final class ListJobsRequest extends GeneratedMessageV3 implements ListJobsRequestOrBuilder
Request message for listing jobs using
ListJobs.
Protobuf type google.cloud.scheduler.v1beta1.ListJobsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
LEGACY_APP_ENGINE_CRON_FIELD_NUMBER
public static final int LEGACY_APP_ENGINE_CRON_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListJobsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListJobsRequest.Builder newBuilder()
Returns
newBuilder(ListJobsRequest prototype)
public static ListJobsRequest.Builder newBuilder(ListJobsRequest prototype)
Parameter
Returns
public static ListJobsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListJobsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListJobsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListJobsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListJobsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListJobsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListJobsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListJobsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListJobsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListJobsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListJobsRequest getDefaultInstanceForType()
Returns
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;
| 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;
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;
| Type | Description |
| boolean | The legacyAppEngineCron.
|
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;
| 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;
| 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;
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<ListJobsRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListJobsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListJobsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListJobsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
