ListCustomJobsRequest.Builder (proto-google-cloud-aiplatform-v1 3.32.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>
    - - com.google.cloud.aiplatform.v1.ListCustomJobsRequest.Builder

All Implemented Interfaces:

ListCustomJobsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListCustomJobsRequest
```
public static final class ListCustomJobsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>
implements ListCustomJobsRequestOrBuilder
```
```
 Request message for
 [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs].
 
```
Protobuf type google.cloud.aiplatform.v1.ListCustomJobsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListCustomJobsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListCustomJobsRequest`	`build()`
`ListCustomJobsRequest`	`buildPartial()`
`ListCustomJobsRequest.Builder`	`clear()`
`ListCustomJobsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListCustomJobsRequest.Builder`	`clearFilter()` The standard list filter.
`ListCustomJobsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListCustomJobsRequest.Builder`	`clearPageSize()` The standard list page size.
`ListCustomJobsRequest.Builder`	`clearPageToken()` The standard list page token.
`ListCustomJobsRequest.Builder`	`clearParent()` Required.
`ListCustomJobsRequest.Builder`	`clearReadMask()` Mask specifying which fields to read.
`ListCustomJobsRequest.Builder`	`clone()`
`ListCustomJobsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFilter()` The standard list filter.
`com.google.protobuf.ByteString`	`getFilterBytes()` The standard list filter.
`int`	`getPageSize()` The standard list page size.
`String`	`getPageToken()` The standard list page token.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` The standard list page token.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`com.google.protobuf.FieldMask`	`getReadMask()` Mask specifying which fields to read.
`com.google.protobuf.FieldMask.Builder`	`getReadMaskBuilder()` Mask specifying which fields to read.
`com.google.protobuf.FieldMaskOrBuilder`	`getReadMaskOrBuilder()` Mask specifying which fields to read.
`boolean`	`hasReadMask()` Mask specifying which fields to read.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListCustomJobsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListCustomJobsRequest.Builder`	`mergeFrom(ListCustomJobsRequest other)`
`ListCustomJobsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListCustomJobsRequest.Builder`	`mergeReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read.
`ListCustomJobsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListCustomJobsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListCustomJobsRequest.Builder`	`setFilter(String value)` The standard list filter.
`ListCustomJobsRequest.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` The standard list filter.
`ListCustomJobsRequest.Builder`	`setPageSize(int value)` The standard list page size.
`ListCustomJobsRequest.Builder`	`setPageToken(String value)` The standard list page token.
`ListCustomJobsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` The standard list page token.
`ListCustomJobsRequest.Builder`	`setParent(String value)` Required.
`ListCustomJobsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListCustomJobsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)` Mask specifying which fields to read.
`ListCustomJobsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read.
`ListCustomJobsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListCustomJobsRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

clear
```
public ListCustomJobsRequest.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

getDefaultInstanceForType
```
public ListCustomJobsRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ListCustomJobsRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ListCustomJobsRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public ListCustomJobsRequest.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

setField

public ListCustomJobsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

clearField
```
public ListCustomJobsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

clearOneof
```
public ListCustomJobsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

setRepeatedField

public ListCustomJobsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

addRepeatedField

public ListCustomJobsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

mergeFrom
```
public ListCustomJobsRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListCustomJobsRequest.Builder>

mergeFrom

public ListCustomJobsRequest.Builder mergeFrom(ListCustomJobsRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListCustomJobsRequest.Builder>

mergeFrom
```
public ListCustomJobsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListCustomJobsRequest.Builder>

Throws:

IOException

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

getParent in interface ListCustomJobsRequestOrBuilder

Returns:

The parent.

getParentBytes
```
public com.google.protobuf.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) = { ... }
Specified by:

getParentBytes in interface ListCustomJobsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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

Parameters:: value - The parent to set.
Returns:: 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:: This builder for chaining.

setParentBytes

public ListCustomJobsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:: value - The bytes for parent to set.
Returns:: This builder for chaining.

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;

Specified by:: getFilter in interface ListCustomJobsRequestOrBuilder
Returns:: The filter.

getFilterBytes

public com.google.protobuf.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;

Specified by:: getFilterBytes in interface ListCustomJobsRequestOrBuilder
Returns:: The bytes for filter.

setFilter

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;

Parameters:: value - The filter to set.
Returns:: This builder for chaining.

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:: This builder for chaining.

setFilterBytes

public ListCustomJobsRequest.Builder setFilterBytes(com.google.protobuf.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;

Parameters:: value - The bytes for filter to set.
Returns:: This builder for chaining.

getPageSize
```
public int getPageSize()
```
```
 The standard list page size.
 
```
int32 page_size = 3;
Specified by:

getPageSize in interface ListCustomJobsRequestOrBuilder

Returns:

The pageSize.

setPageSize
```
public ListCustomJobsRequest.Builder setPageSize(int value)
```
```
 The standard list page size.
 
```
int32 page_size = 3;
Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListCustomJobsRequest.Builder clearPageSize()

 The standard list page size.

int32 page_size = 3;

Returns:: This builder for chaining.

getPageToken

public String getPageToken()

 The standard list page token.
 Typically obtained via
 [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
 of the previous
 [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
 call.

string page_token = 4;

Specified by:: getPageToken in interface ListCustomJobsRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 The standard list page token.
 Typically obtained via
 [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
 of the previous
 [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
 call.

string page_token = 4;

Specified by:: getPageTokenBytes in interface ListCustomJobsRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

public ListCustomJobsRequest.Builder setPageToken(String value)

 The standard list page token.
 Typically obtained via
 [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
 of the previous
 [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
 call.

string page_token = 4;

Parameters:: value - The pageToken to set.
Returns:: This builder for chaining.

clearPageToken

public ListCustomJobsRequest.Builder clearPageToken()

 The standard list page token.
 Typically obtained via
 [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
 of the previous
 [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
 call.

string page_token = 4;

Returns:: This builder for chaining.

setPageTokenBytes

public ListCustomJobsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 The standard list page token.
 Typically obtained via
 [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
 of the previous
 [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
 call.

string page_token = 4;

Parameters:: value - The bytes for pageToken to set.
Returns:: This builder for chaining.

hasReadMask
```
public boolean hasReadMask()
```
```
 Mask specifying which fields to read.
 
```
.google.protobuf.FieldMask read_mask = 5;
Specified by:

hasReadMask in interface ListCustomJobsRequestOrBuilder

Returns:

Whether the readMask field is set.

getReadMask
```
public com.google.protobuf.FieldMask getReadMask()
```
```
 Mask specifying which fields to read.
 
```
.google.protobuf.FieldMask read_mask = 5;
Specified by:

getReadMask in interface ListCustomJobsRequestOrBuilder

Returns:

The readMask.