Class ListDataLabelingJobsRequest.Builder (3.42.0)

public static final class ListDataLabelingJobsRequest.Builder extends GeneratedMessageV3.Builder<ListDataLabelingJobsRequest.Builder> implements ListDataLabelingJobsRequestOrBuilder

Request message for JobService.ListDataLabelingJobs.

Protobuf type google.cloud.aiplatform.v1.ListDataLabelingJobsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDataLabelingJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

build()

public ListDataLabelingJobsRequest build()
Returns
Type Description
ListDataLabelingJobsRequest

buildPartial()

public ListDataLabelingJobsRequest buildPartial()
Returns
Type Description
ListDataLabelingJobsRequest

clear()

public ListDataLabelingJobsRequest.Builder clear()
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListDataLabelingJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

clearFilter()

public ListDataLabelingJobsRequest.Builder clearFilter()

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
ListDataLabelingJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDataLabelingJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

clearOrderBy()

public ListDataLabelingJobsRequest.Builder clearOrderBy()

A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

string order_by = 6;

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

clearPageSize()

public ListDataLabelingJobsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListDataLabelingJobsRequest.Builder clearPageToken()

The standard list page token.

string page_token = 4;

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

clearParent()

public ListDataLabelingJobsRequest.Builder clearParent()

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

clearReadMask()

public ListDataLabelingJobsRequest.Builder clearReadMask()

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
ListDataLabelingJobsRequest.Builder

clone()

public ListDataLabelingJobsRequest.Builder clone()
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListDataLabelingJobsRequest getDefaultInstanceForType()
Returns
Type Description
ListDataLabelingJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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.

getFilterBytes()

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.

getOrderBy()

public String getOrderBy()

A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

string order_by = 6;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

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.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The standard list page token.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent of the DataLabelingJob. 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 parent of the DataLabelingJob. 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. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListDataLabelingJobsRequest other)

public ListDataLabelingJobsRequest.Builder mergeFrom(ListDataLabelingJobsRequest other)
Parameter
Name Description
other ListDataLabelingJobsRequest
Returns
Type Description
ListDataLabelingJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDataLabelingJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListDataLabelingJobsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListDataLabelingJobsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListDataLabelingJobsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDataLabelingJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListDataLabelingJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

setFilter(String value)

public ListDataLabelingJobsRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListDataLabelingJobsRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListDataLabelingJobsRequest.Builder setOrderBy(String value)

A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

string order_by = 6;

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListDataLabelingJobsRequest.Builder setOrderByBytes(ByteString value)

A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

string order_by = 6;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListDataLabelingJobsRequest.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
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListDataLabelingJobsRequest.Builder setPageToken(String value)

The standard list page token.

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDataLabelingJobsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token.

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListDataLabelingJobsRequest.Builder setParent(String value)

Required. The parent of the DataLabelingJob. 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
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListDataLabelingJobsRequest.Builder setParentBytes(ByteString value)

Required. The parent of the DataLabelingJob. 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
ListDataLabelingJobsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListDataLabelingJobsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListDataLabelingJobsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListDataLabelingJobsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListDataLabelingJobsRequest.Builder

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

public ListDataLabelingJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDataLabelingJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListDataLabelingJobsRequest.Builder
Overrides