Cloud AI Platform v1 API - Class ListSchedulesRequest (3.10.0) 

public sealed class ListSchedulesRequest : IMessage<ListSchedulesRequest>, IEquatable<ListSchedulesRequest>, IDeepCloneable<ListSchedulesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud AI Platform v1 API class ListSchedulesRequest.

Request message for [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules].

Inheritance

object > ListSchedulesRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListSchedulesRequest()

public ListSchedulesRequest()

ListSchedulesRequest(ListSchedulesRequest)

public ListSchedulesRequest(ListSchedulesRequest other)
Parameter
Name Description
other ListSchedulesRequest

Properties

Filter

public string Filter { get; set; }

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:*
Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

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
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

The standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token] of the previous [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName