Package com.google.cloud.aiplatform.v1

Class ListSchedulesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListSchedulesRequest.Builder>
com.google.cloud.aiplatform.v1.ListSchedulesRequest.Builder
All Implemented Interfaces:
ListSchedulesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListSchedulesRequest
public static final class ListSchedulesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListSchedulesRequest.Builder> implements ListSchedulesRequestOrBuilder
 Request message for
 [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules].
Protobuf type google.cloud.aiplatform.v1.ListSchedulesRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListSchedulesRequest.Builder>

    • clear

      public ListSchedulesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListSchedulesRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListSchedulesRequest.Builder>

    • getDefaultInstanceForType

      public ListSchedulesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListSchedulesRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListSchedulesRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListSchedulesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSchedulesRequest.Builder>

    • mergeFrom

      public ListSchedulesRequest.Builder mergeFrom(ListSchedulesRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListSchedulesRequest.Builder>

    • mergeFrom

      public ListSchedulesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSchedulesRequest.Builder>
      Throws:
      IOException

    • 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) = { ... }
      Specified by:
      getParent in interface ListSchedulesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListSchedulesRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      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:
      This builder for chaining.

    • setParentBytes

      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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getFilter in interface ListSchedulesRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ListSchedulesRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setFilterBytes

      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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       The standard list page size.
 Default to 100 if not specified.
      int32 page_size = 3;
      Specified by:
      getPageSize in interface ListSchedulesRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListSchedulesRequest.Builder setPageSize(int value)
       The standard list page size.
 Default to 100 if not specified.
      int32 page_size = 3;
      Parameters:
      value - The pageSize to set.
      Returns:
      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:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       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.
      string page_token = 4;
      Specified by:
      getPageToken in interface ListSchedulesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       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.
      string page_token = 4;
      Specified by:
      getPageTokenBytes in interface ListSchedulesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListSchedulesRequest.Builder setPageToken(String value)
       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.
      string page_token = 4;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListSchedulesRequest.Builder clearPageToken()
       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.
      string page_token = 4;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListSchedulesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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.
      string page_token = 4;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getOrderBy in interface ListSchedulesRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public 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;
      Specified by:
      getOrderByBytes in interface ListSchedulesRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      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;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setOrderByBytes

      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;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.