public static final class ListSchedulesRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder> implements ListSchedulesRequestOrBuilder
Request message for [ScheduleService.ListSchedules][google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules].Protobuf type
google.cloud.aiplatform.v1beta1.ListSchedulesRequest| Modifier and Type | Method and Description |
|---|---|
ListSchedulesRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListSchedulesRequest |
build() |
ListSchedulesRequest |
buildPartial() |
ListSchedulesRequest.Builder |
clear() |
ListSchedulesRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ListSchedulesRequest.Builder |
clearFilter()
Lists the Schedules that match the filter expression.
|
ListSchedulesRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ListSchedulesRequest.Builder |
clearOrderBy()
A comma-separated list of fields to order by.
|
ListSchedulesRequest.Builder |
clearPageSize()
The standard list page size.
|
ListSchedulesRequest.Builder |
clearPageToken()
The standard list page token.
|
ListSchedulesRequest.Builder |
clearParent()
Required.
|
ListSchedulesRequest.Builder |
clone() |
ListSchedulesRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getFilter()
Lists the Schedules that match the filter expression.
|
com.google.protobuf.ByteString |
getFilterBytes()
Lists the Schedules that match the filter expression.
|
String |
getOrderBy()
A comma-separated list of fields to order by.
|
com.google.protobuf.ByteString |
getOrderByBytes()
A comma-separated list of fields to order by.
|
int |
getPageSize()
The standard list page size.
|
String |
getPageToken()
The standard list page token.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
The standard list page token.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ListSchedulesRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ListSchedulesRequest.Builder |
mergeFrom(ListSchedulesRequest other) |
ListSchedulesRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ListSchedulesRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ListSchedulesRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListSchedulesRequest.Builder |
setFilter(String value)
Lists the Schedules that match the filter expression.
|
ListSchedulesRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Lists the Schedules that match the filter expression.
|
ListSchedulesRequest.Builder |
setOrderBy(String value)
A comma-separated list of fields to order by.
|
ListSchedulesRequest.Builder |
setOrderByBytes(com.google.protobuf.ByteString value)
A comma-separated list of fields to order by.
|
ListSchedulesRequest.Builder |
setPageSize(int value)
The standard list page size.
|
ListSchedulesRequest.Builder |
setPageToken(String value)
The standard list page token.
|
ListSchedulesRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
The standard list page token.
|
ListSchedulesRequest.Builder |
setParent(String value)
Required.
|
ListSchedulesRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
ListSchedulesRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ListSchedulesRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ListSchedulesRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ListSchedulesRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ListSchedulesRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder mergeFrom(ListSchedulesRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public ListSchedulesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSchedulesRequest.Builder>IOExceptionpublic 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) = { ... }
getParent in interface ListSchedulesRequestOrBuilderpublic com.google.protobuf.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) = { ... }
getParentBytes in interface ListSchedulesRequestOrBuilderpublic ListSchedulesRequest.Builder setParent(String value)
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) = { ... }
value - The parent to set.public ListSchedulesRequest.Builder clearParent()
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) = { ... }
public ListSchedulesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
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) = { ... }
value - The bytes for parent to set.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;getFilter in interface ListSchedulesRequestOrBuilderpublic com.google.protobuf.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;getFilterBytes in interface ListSchedulesRequestOrBuilderpublic ListSchedulesRequest.Builder setFilter(String value)
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;value - The filter to set.public ListSchedulesRequest.Builder clearFilter()
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;public ListSchedulesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
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;value - The bytes for filter to set.public int getPageSize()
The standard list page size. Default to 100 if not specified.
int32 page_size = 3;getPageSize in interface ListSchedulesRequestOrBuilderpublic ListSchedulesRequest.Builder setPageSize(int value)
The standard list page size. Default to 100 if not specified.
int32 page_size = 3;value - The pageSize to set.public ListSchedulesRequest.Builder clearPageSize()
The standard list page size. Default to 100 if not specified.
int32 page_size = 3;public String getPageToken()
The standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token] of the previous [ScheduleService.ListSchedules][google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules] call.
string page_token = 4;getPageToken in interface ListSchedulesRequestOrBuilderpublic com.google.protobuf.ByteString getPageTokenBytes()
The standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token] of the previous [ScheduleService.ListSchedules][google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules] call.
string page_token = 4;getPageTokenBytes in interface ListSchedulesRequestOrBuilderpublic ListSchedulesRequest.Builder setPageToken(String value)
The standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token] of the previous [ScheduleService.ListSchedules][google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules] call.
string page_token = 4;value - The pageToken to set.public ListSchedulesRequest.Builder clearPageToken()
The standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token] of the previous [ScheduleService.ListSchedules][google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules] call.
string page_token = 4;public ListSchedulesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
The standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token] of the previous [ScheduleService.ListSchedules][google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules] call.
string page_token = 4;value - The bytes for pageToken to set.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_time` * `start_time` * `end_time` * `next_run_time`
string order_by = 5;getOrderBy in interface ListSchedulesRequestOrBuilderpublic com.google.protobuf.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_time` * `start_time` * `end_time` * `next_run_time`
string order_by = 5;getOrderByBytes in interface ListSchedulesRequestOrBuilderpublic ListSchedulesRequest.Builder setOrderBy(String value)
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_time` * `start_time` * `end_time` * `next_run_time`
string order_by = 5;value - The orderBy to set.public ListSchedulesRequest.Builder clearOrderBy()
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_time` * `start_time` * `end_time` * `next_run_time`
string order_by = 5;public ListSchedulesRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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_time` * `start_time` * `end_time` * `next_run_time`
string order_by = 5;value - The bytes for orderBy to set.public final ListSchedulesRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>public final ListSchedulesRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListSchedulesRequest.Builder>Copyright © 2025 Google LLC. All rights reserved.