Class ListCustomJobsRequest.Builder (3.38.0)

public static final class ListCustomJobsRequest.Builder extends GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder> implements ListCustomJobsRequestOrBuilder

Request message for JobService.ListCustomJobs.

Protobuf type google.cloud.aiplatform.v1.ListCustomJobsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListCustomJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

build()

public ListCustomJobsRequest build()
Returns
TypeDescription
ListCustomJobsRequest

buildPartial()

public ListCustomJobsRequest buildPartial()
Returns
TypeDescription
ListCustomJobsRequest

clear()

public ListCustomJobsRequest.Builder clear()
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListCustomJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

clearFilter()

public ListCustomJobsRequest.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
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListCustomJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

clearPageSize()

public ListCustomJobsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListCustomJobsRequest.Builder clearPageToken()

The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

string page_token = 4;

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

clearParent()

public ListCustomJobsRequest.Builder clearParent()

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
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

clearReadMask()

public ListCustomJobsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
ListCustomJobsRequest.Builder

clone()

public ListCustomJobsRequest.Builder clone()
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListCustomJobsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListCustomJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageToken.

getParent()

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
TypeDescription
String

The parent.

getParentBytes()

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
TypeDescription
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListCustomJobsRequest other)

public ListCustomJobsRequest.Builder mergeFrom(ListCustomJobsRequest other)
Parameter
NameDescription
otherListCustomJobsRequest
Returns
TypeDescription
ListCustomJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListCustomJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListCustomJobsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListCustomJobsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListCustomJobsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListCustomJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListCustomJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

setFilter(String value)

public ListCustomJobsRequest.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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListCustomJobsRequest.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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListCustomJobsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCustomJobsRequest.Builder setPageToken(String value)

The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCustomJobsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListCustomJobsRequest.Builder setParent(String value)

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) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListCustomJobsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListCustomJobsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListCustomJobsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListCustomJobsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListCustomJobsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListCustomJobsRequest.Builder

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

public ListCustomJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListCustomJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListCustomJobsRequest.Builder
Overrides