Class ListSchedulesRequest.Builder (3.23.0)

public static final class ListSchedulesRequest.Builder extends GeneratedMessageV3.Builder<ListSchedulesRequest.Builder> implements ListSchedulesRequestOrBuilder

Request message for ScheduleService.ListSchedules.

Protobuf type google.cloud.aiplatform.v1beta1.ListSchedulesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListSchedulesRequest.Builder

Implements

ListSchedulesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListSchedulesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListSchedulesRequest build()

Returns
Type	Description
`ListSchedulesRequest`

buildPartial()

public ListSchedulesRequest buildPartial()

Returns
Type	Description
`ListSchedulesRequest`

clear()

public ListSchedulesRequest.Builder clear()

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListSchedulesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

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;

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListSchedulesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

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;

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

clearPageSize()

public ListSchedulesRequest.Builder clearPageSize()

The standard list page size. Default to 100 if not specified.

int32 page_size = 3;

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

clearPageToken()

public ListSchedulesRequest.Builder clearPageToken()

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
`ListSchedulesRequest.Builder`	This builder for chaining.

clearParent()

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) = { ... }

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

clone()

public ListSchedulesRequest.Builder clone()

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListSchedulesRequest getDefaultInstanceForType()

Returns
Type	Description
`ListSchedulesRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

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.

getFilterBytes()

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.

getOrderBy()

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.

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;

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

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.

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;

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPageSize()

public int 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.

getParent()

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.

getParentBytes()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListSchedulesRequest other)

public ListSchedulesRequest.Builder mergeFrom(ListSchedulesRequest other)

Parameter
Name	Description
`other`	`ListSchedulesRequest`

Returns
Type	Description
`ListSchedulesRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListSchedulesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ListSchedulesRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListSchedulesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListSchedulesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public 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;

Parameter
Name	Description
`value`	`String` The filter to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

public ListSchedulesRequest.Builder setFilterBytes(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;

Parameter
Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setOrderBy(String value)

public 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.

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;

Parameter
Name	Description
`value`	`String` The orderBy to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setOrderByBytes(ByteString value)

public ListSchedulesRequest.Builder setOrderByBytes(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.

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for orderBy to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setPageSize(int value)

public ListSchedulesRequest.Builder setPageSize(int value)

The standard list page size. Default to 100 if not specified.

int32 page_size = 3;

Parameter
Name	Description
`value`	`int` The pageSize to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setPageToken(String value)

public ListSchedulesRequest.Builder setPageToken(String value)

The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.

string page_token = 4;

Parameter
Name	Description
`value`	`String` The pageToken to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSchedulesRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.

string page_token = 4;

Parameter
Name	Description
`value`	`ByteString` The bytes for pageToken to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setParent(String value)

public 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) = { ... }

Parameter
Name	Description
`value`	`String` The parent to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setParentBytes(ByteString value)

public ListSchedulesRequest.Builder setParentBytes(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) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for parent to set.

Returns
Type	Description
`ListSchedulesRequest.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListSchedulesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListSchedulesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ListSchedulesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)