com.google.cloud.aiplatform.v1beta1

Interface ListPipelineJobsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListPipelineJobsRequest, ListPipelineJobsRequest.Builder

public interface ListPipelineJobsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Lists the PipelineJobs that match the filter expression.
com.google.protobuf.ByteString	getFilterBytes() Lists the PipelineJobs 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.
com.google.protobuf.FieldMask	getReadMask() Mask specifying which fields to read.
com.google.protobuf.FieldMaskOrBuilder	getReadMaskOrBuilder() Mask specifying which fields to read.
boolean	hasReadMask() Mask specifying which fields to read.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getFilter

String getFilter()

 Lists the PipelineJobs that match the filter expression. The following
 fields are supported:

 * `pipeline_name`: Supports `=` and `!=` comparisons.
 * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
   for example, can check if pipeline's display_name contains *step* by
   doing display_name:\"*step*\"
 * `state`: Supports `=` and `!=` comparisons.
 * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `labels`: Supports key-value equality and key presence.
 * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
   wildcard.

 Filter expressions can be combined together using logical operators
 (`AND` & `OR`).
 For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.

 The syntax to define filter expression is based on
 https://google.aip.dev/160.

 Examples:

 * `create_time>"2021-05-18T00:00:00Z" OR
   update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
   after 2020-05-18 00:00:00 UTC.
 * `labels.env = "prod"`
   PipelineJobs with label "env" set to "prod".
 

string filter = 2;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Lists the PipelineJobs that match the filter expression. The following
 fields are supported:

 * `pipeline_name`: Supports `=` and `!=` comparisons.
 * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
   for example, can check if pipeline's display_name contains *step* by
   doing display_name:\"*step*\"
 * `state`: Supports `=` and `!=` comparisons.
 * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `labels`: Supports key-value equality and key presence.
 * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
   wildcard.

 Filter expressions can be combined together using logical operators
 (`AND` & `OR`).
 For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.

 The syntax to define filter expression is based on
 https://google.aip.dev/160.

 Examples:

 * `create_time>"2021-05-18T00:00:00Z" OR
   update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
   after 2020-05-18 00:00:00 UTC.
 * `labels.env = "prod"`
   PipelineJobs with label "env" set to "prod".
 

string filter = 2;

Returns:

The bytes for filter.

getPageSize

int getPageSize()

 The standard list page size.
 

int32 page_size = 3;

Returns:

The pageSize.

getPageToken

String getPageToken()

 The standard list page token.
 Typically obtained via
 [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token]
 of the previous
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
 call.
 

string page_token = 4;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 The standard list page token.
 Typically obtained via
 [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token]
 of the previous
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
 call.
 

string page_token = 4;

Returns:

The bytes for pageToken.

getOrderBy

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 e.g. "create_time desc, end_time",
 "end_time, start_time, update_time" For example, using "create_time desc,
 end_time" will order results by create time in descending order, and if
 there are multiple jobs 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 order is create time in descending order. Supported fields:

   * `create_time`
   * `update_time`
   * `end_time`
   * `start_time`
 

string order_by = 6;

Returns:

The orderBy.

getOrderByBytes

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 e.g. "create_time desc, end_time",
 "end_time, start_time, update_time" For example, using "create_time desc,
 end_time" will order results by create time in descending order, and if
 there are multiple jobs 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 order is create time in descending order. Supported fields:

   * `create_time`
   * `update_time`
   * `end_time`
   * `start_time`
 

string order_by = 6;

Returns:

The bytes for orderBy.

hasReadMask

boolean hasReadMask()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 7;

Returns:

Whether the readMask field is set.

getReadMask

com.google.protobuf.FieldMask getReadMask()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 7;

Returns:

The readMask.

getReadMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 7;