Class ListSchedulesRequest.Builder (3.44.0)

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

Request message for ScheduleService.ListSchedules.

Protobuf type google.cloud.aiplatform.v1.ListSchedulesRequest

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

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

clearField(Descriptors.FieldDescriptor field)

public ListSchedulesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListSchedulesRequest.Builder
Overrides

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

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

getDefaultInstanceForType()

public ListSchedulesRequest getDefaultInstanceForType()
Returns
Type Description
ListSchedulesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListSchedulesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListSchedulesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListSchedulesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListSchedulesRequest.Builder
Overrides

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

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.

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;

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.

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;

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

setUnknownFields(UnknownFieldSet unknownFields)

public final ListSchedulesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListSchedulesRequest.Builder
Overrides