Class ListPipelineJobsRequest.Builder (2.9.8)

public static final class ListPipelineJobsRequest.Builder extends GeneratedMessageV3.Builder<ListPipelineJobsRequest.Builder> implements ListPipelineJobsRequestOrBuilder

Request message for PipelineService.ListPipelineJobs.

Protobuf type google.cloud.aiplatform.v1beta1.ListPipelineJobsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListPipelineJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

build()

public ListPipelineJobsRequest build()
Returns
TypeDescription
ListPipelineJobsRequest

buildPartial()

public ListPipelineJobsRequest buildPartial()
Returns
TypeDescription
ListPipelineJobsRequest

clear()

public ListPipelineJobsRequest.Builder clear()
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListPipelineJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

clearFilter()

public ListPipelineJobsRequest.Builder clearFilter()

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_name: 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
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListPipelineJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

clearOrderBy()

public ListPipelineJobsRequest.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 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
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

clearPageSize()

public ListPipelineJobsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListPipelineJobsRequest.Builder clearPageToken()

The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.

string page_token = 4;

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

clearParent()

public ListPipelineJobsRequest.Builder clearParent()

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
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

clone()

public ListPipelineJobsRequest.Builder clone()
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListPipelineJobsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListPipelineJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public 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_name: 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
TypeDescription
String

The filter.

getFilterBytes()

public 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_name: 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
TypeDescription
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 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
TypeDescription
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 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
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

public 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
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListPipelineJobsRequest other)

public ListPipelineJobsRequest.Builder mergeFrom(ListPipelineJobsRequest other)
Parameter
NameDescription
otherListPipelineJobsRequest
Returns
TypeDescription
ListPipelineJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListPipelineJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListPipelineJobsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListPipelineJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListPipelineJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

setFilter(String value)

public ListPipelineJobsRequest.Builder setFilter(String value)

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_name: 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;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListPipelineJobsRequest.Builder setFilterBytes(ByteString value)

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_name: 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;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setOrderBy(String value)

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

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListPipelineJobsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListPipelineJobsRequest.Builder setPageToken(String value)

The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListPipelineJobsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListPipelineJobsRequest.Builder setParent(String value)

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListPipelineJobsRequest.Builder setParentBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListPipelineJobsRequest.Builder

This builder for chaining.

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

public ListPipelineJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListPipelineJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListPipelineJobsRequest.Builder
Overrides