public final class ListPipelineJobsRequest extends GeneratedMessageV3 implements ListPipelineJobsRequestOrBuilder
Request message for PipelineService.ListPipelineJobs.
Protobuf type google.cloud.aiplatform.v1.ListPipelineJobsRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
Field Value
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
public static ListPipelineJobsRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ListPipelineJobsRequest.Builder newBuilder()
Returns
public static ListPipelineJobsRequest.Builder newBuilder(ListPipelineJobsRequest prototype)
Parameter
Returns
public static ListPipelineJobsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListPipelineJobsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListPipelineJobsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListPipelineJobsRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public ListPipelineJobsRequest getDefaultInstanceForType()
Returns
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;
| Type | Description |
| String | The filter.
|
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;
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;
| Type | Description |
| String | The orderBy.
|
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;
getPageSize()
The standard list page size.
int32 page_size = 3;
| 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;
| 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;
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) = { ... }
| Type | Description |
| String | The parent.
|
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) = { ... }
public Parser<ListPipelineJobsRequest> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ListPipelineJobsRequest.Builder newBuilderForType()
Returns
protected ListPipelineJobsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ListPipelineJobsRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
