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