public final class ListSchedulesRequest extends GeneratedMessageV3 implements ListSchedulesRequestOrBuilder
Request message for
ScheduleService.ListSchedules.
Protobuf type google.cloud.aiplatform.v1.ListSchedulesRequest
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
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ORDER_BY_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 |
|
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ListSchedulesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListSchedulesRequest.Builder newBuilder()
public static ListSchedulesRequest.Builder newBuilder(ListSchedulesRequest prototype)
public static ListSchedulesRequest parseDelimitedFrom(InputStream input)
public static ListSchedulesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListSchedulesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ListSchedulesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListSchedulesRequest parseFrom(ByteString data)
public static ListSchedulesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListSchedulesRequest parseFrom(CodedInputStream input)
public static ListSchedulesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListSchedulesRequest parseFrom(InputStream input)
public static ListSchedulesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListSchedulesRequest parseFrom(ByteBuffer data)
public static ListSchedulesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListSchedulesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ListSchedulesRequest getDefaultInstanceForType()
public String getFilter()
Lists the Schedules that match the filter expression. The following
fields are supported:
display_name: Supports =, != comparisons, and : wildcard.state: Supports = and != comparisons.request: Supports existence of the <request_type> check.
(e.g. create_pipeline_job_request:* --> Schedule has
create_pipeline_job_request).create_time: Supports =, !=, <, >, <=, and >= comparisons.
Values must be in RFC 3339 format.start_time: Supports =, !=, <, >, <=, and >= comparisons.
Values must be in RFC 3339 format.end_time: Supports =, !=, <, >, <=, >= comparisons and :*
existence check. Values must be in RFC 3339 format.next_run_time: Supports =, !=, <, >, <=, and >=
comparisons. Values must be in RFC 3339 format.
Filter expressions can be combined together using logical operators
(NOT, AND & OR).
The syntax to define filter expression is based on
https://google.aip.dev/160.
Examples:
state="ACTIVE" AND display_name:"my_schedule_*"NOT display_name="my_schedule"create_time>"2021-05-18T00:00:00Z"end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*create_pipeline_job_request:*
string filter = 2;
| Returns |
| Type |
Description |
String |
The filter.
|
public ByteString getFilterBytes()
Lists the Schedules that match the filter expression. The following
fields are supported:
display_name: Supports =, != comparisons, and : wildcard.state: Supports = and != comparisons.request: Supports existence of the <request_type> check.
(e.g. create_pipeline_job_request:* --> Schedule has
create_pipeline_job_request).create_time: Supports =, !=, <, >, <=, and >= comparisons.
Values must be in RFC 3339 format.start_time: Supports =, !=, <, >, <=, and >= comparisons.
Values must be in RFC 3339 format.end_time: Supports =, !=, <, >, <=, >= comparisons and :*
existence check. Values must be in RFC 3339 format.next_run_time: Supports =, !=, <, >, <=, and >=
comparisons. Values must be in RFC 3339 format.
Filter expressions can be combined together using logical operators
(NOT, AND & OR).
The syntax to define filter expression is based on
https://google.aip.dev/160.
Examples:
state="ACTIVE" AND display_name:"my_schedule_*"NOT display_name="my_schedule"create_time>"2021-05-18T00:00:00Z"end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*create_pipeline_job_request:*
string filter = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
public String getOrderBy()
A comma-separated list of fields to order by. The default sort order is in
ascending order. Use "desc" after a field name for descending. You can have
multiple order_by fields provided.
For example, using "create_time desc, end_time" will order results by
create time in descending order, and if there are multiple schedules having
the same create time, order them by the end time in ascending order.
If order_by is not specified, it will order by default with create_time in
descending order.
Supported fields:
create_timestart_timeend_timenext_run_time
string order_by = 5;
| Returns |
| Type |
Description |
String |
The orderBy.
|
public ByteString getOrderByBytes()
A comma-separated list of fields to order by. The default sort order is in
ascending order. Use "desc" after a field name for descending. You can have
multiple order_by fields provided.
For example, using "create_time desc, end_time" will order results by
create time in descending order, and if there are multiple schedules having
the same create time, order them by the end time in ascending order.
If order_by is not specified, it will order by default with create_time in
descending order.
Supported fields:
create_timestart_timeend_timenext_run_time
string order_by = 5;
| Returns |
| Type |
Description |
ByteString |
The bytes for orderBy.
|
getPageSize()
The standard list page size.
Default to 100 if not specified.
int32 page_size = 3;
| Returns |
| Type |
Description |
int |
The pageSize.
|
getPageToken()
public String getPageToken()
The standard list page token.
Typically obtained via
ListSchedulesResponse.next_page_token
of the previous
ScheduleService.ListSchedules
call.
string page_token = 4;
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
The standard list page token.
Typically obtained via
ListSchedulesResponse.next_page_token
of the previous
ScheduleService.ListSchedules
call.
string page_token = 4;
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
public String getParent()
Required. The resource name of the Location to list the Schedules from.
Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
public ByteString getParentBytes()
Required. The resource name of the Location to list the Schedules from.
Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
public Parser<ListSchedulesRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListSchedulesRequest.Builder newBuilderForType()
protected ListSchedulesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ListSchedulesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
