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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListPipelineJobsRequest.Builder

Implements

ListPipelineJobsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListPipelineJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListPipelineJobsRequest build()

Returns

Type	Description
ListPipelineJobsRequest

buildPartial()

public ListPipelineJobsRequest buildPartial()

Returns

Type	Description
ListPipelineJobsRequest

clear()

public ListPipelineJobsRequest.Builder clear()

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListPipelineJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Type	Description
ListPipelineJobsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListPipelineJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Type	Description
ListPipelineJobsRequest.Builder	This builder for chaining.

clearPageSize()

public ListPipelineJobsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns

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

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

Type	Description
ListPipelineJobsRequest.Builder	This builder for chaining.

clone()

public ListPipelineJobsRequest.Builder clone()

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListPipelineJobsRequest getDefaultInstanceForType()

Returns

Type	Description
ListPipelineJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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

Type	Description
ByteString	The bytes for filter.

getOrderBy()

public String getOrderBy()

create_time
update_time
end_time
start_time

string order_by = 6;

Returns

Type	Description
String	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

create_time
update_time
end_time
start_time

string order_by = 6;

Returns

Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns

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

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

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

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

Type	Description
ByteString	The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListPipelineJobsRequest other)

public ListPipelineJobsRequest.Builder mergeFrom(ListPipelineJobsRequest other)

Parameter

Name	Description
other	`ListPipelineJobsRequest`

Returns

Type	Description
ListPipelineJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListPipelineJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListPipelineJobsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListPipelineJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListPipelineJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	`String` The filter to set.

Returns

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

Name	Description
value	`ByteString` The bytes for filter to set.

Returns

Type	Description
ListPipelineJobsRequest.Builder	This builder for chaining.

setOrderBy(String value)

public ListPipelineJobsRequest.Builder setOrderBy(String value)

create_time
update_time
end_time
start_time

string order_by = 6;

Parameter

Name	Description
value	`String` The orderBy to set.

Returns

Type	Description
ListPipelineJobsRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListPipelineJobsRequest.Builder setOrderByBytes(ByteString value)

create_time
update_time
end_time
start_time

string order_by = 6;

Parameter

Name	Description
value	`ByteString` The bytes for orderBy to set.

Returns

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

Name	Description
value	`int` The pageSize to set.

Returns

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

Name	Description
value	`String` The pageToken to set.

Returns

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

Name	Description
value	`ByteString` The bytes for pageToken to set.

Returns

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

Name	Description
value	`String` The parent to set.

Returns

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

Name	Description
value	`ByteString` The bytes for parent to set.

Returns

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

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListPipelineJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ListPipelineJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)