- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class ListPipelineJobsRequest.Builder extends GeneratedMessageV3.Builder<ListPipelineJobsRequest.Builder> implements ListPipelineJobsRequestOrBuilderRequest message for PipelineService.ListPipelineJobs.
Protobuf type google.cloud.aiplatform.v1.ListPipelineJobsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListPipelineJobsRequest.BuilderImplements
ListPipelineJobsRequestOrBuilderStatic 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 |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public ListPipelineJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
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: 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 |
|
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_timeupdate_timeend_timestart_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. |
clearReadMask()
public ListPipelineJobsRequest.Builder clearReadMask()Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
clone()
public ListPipelineJobsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
getDefaultInstanceForType()
public ListPipelineJobsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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: 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: 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()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_timeupdate_timeend_timestart_time
string order_by = 6;
| Returns | |
|---|---|
| Type | Description |
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_timeupdate_timeend_timestart_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. |
getReadMask()
public FieldMask getReadMask()Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The readMask. |
getReadMaskBuilder()
public FieldMask.Builder getReadMaskBuilder()Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getReadMaskOrBuilder()
public FieldMaskOrBuilder getReadMaskOrBuilder()Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
hasReadMask()
public boolean hasReadMask()Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the readMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListPipelineJobsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
mergeReadMask(FieldMask value)
public ListPipelineJobsRequest.Builder mergeReadMask(FieldMask value)Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListPipelineJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
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 |
|
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: 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 |
StringThe 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: 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 |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
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_timeupdate_timeend_timestart_time
string order_by = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
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_timeupdate_timeend_timestart_time
string order_by = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
intThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
This builder for chaining. |
setReadMask(FieldMask value)
public ListPipelineJobsRequest.Builder setReadMask(FieldMask value)Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
setReadMask(FieldMask.Builder builderForValue)
public ListPipelineJobsRequest.Builder setReadMask(FieldMask.Builder builderForValue)Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|
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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListPipelineJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListPipelineJobsRequest.Builder |
|