public final class ListCustomJobsRequest extends GeneratedMessageV3 implements ListCustomJobsRequestOrBuilder
Request message for
JobService.ListCustomJobs.
Protobuf type google.cloud.aiplatform.v1beta1.ListCustomJobsRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int READ_MASK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static ListCustomJobsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListCustomJobsRequest.Builder newBuilder()
public static ListCustomJobsRequest.Builder newBuilder(ListCustomJobsRequest prototype)
public static ListCustomJobsRequest parseDelimitedFrom(InputStream input)
public static ListCustomJobsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListCustomJobsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static ListCustomJobsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListCustomJobsRequest parseFrom(ByteString data)
public static ListCustomJobsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListCustomJobsRequest parseFrom(CodedInputStream input)
public static ListCustomJobsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListCustomJobsRequest parseFrom(InputStream input)
public static ListCustomJobsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListCustomJobsRequest parseFrom(ByteBuffer data)
public static ListCustomJobsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListCustomJobsRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public ListCustomJobsRequest getDefaultInstanceForType()
public String getFilter()
The standard list filter.
Supported fields:
display_name supports =, != comparisons, and : wildcard.state supports =, != comparisons.create_time supports =, !=,<, <=,>, >= comparisons.
create_time must be in RFC 3339 format.labels supports general map functions that is:
labels.key=value - key:value equality
labels.key:* - key existence
Some examples of using the filter are:- state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
- state!="JOB_STATE_FAILED" OR display_name="my_job"
- NOT display_name="my_job"
- create_time>"2021-05-18T00:00:00Z"
- labels.keyA=valueA
- labels.keyB:*`
string filter = 2;
| Returns |
|---|
| Type | Description |
String | The filter.
|
public ByteString getFilterBytes()
The standard list filter.
Supported fields:
display_name supports =, != comparisons, and : wildcard.state supports =, != comparisons.create_time supports =, !=,<, <=,>, >= comparisons.
create_time must be in RFC 3339 format.labels supports general map functions that is:
labels.key=value - key:value equality
labels.key:* - key existence
Some examples of using the filter are:- state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
- state!="JOB_STATE_FAILED" OR display_name="my_job"
- NOT display_name="my_job"
- create_time>"2021-05-18T00:00:00Z"
- labels.keyA=valueA
- labels.keyB:*`
string filter = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
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
ListCustomJobsResponse.next_page_token
of the previous
JobService.ListCustomJobs
call.
string page_token = 4;
| Returns |
|---|
| Type | Description |
String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
The standard list page token.
Typically obtained via
ListCustomJobsResponse.next_page_token
of the previous
JobService.ListCustomJobs
call.
string page_token = 4;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for pageToken.
|
public String getParent()
Required. The resource name of the Location to list the CustomJobs from.
Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The parent.
|
public ByteString getParentBytes()
Required. The resource name of the Location to list the CustomJobs 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.
|
public Parser<ListCustomJobsRequest> getParserForType()
Overrides
public FieldMask getReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
public FieldMaskOrBuilder getReadMaskOrBuilder()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
Overrides
public boolean hasReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the readMask field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListCustomJobsRequest.Builder newBuilderForType()
protected ListCustomJobsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public ListCustomJobsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
