com.google.cloud.aiplatform.v1

Class ListBatchPredictionJobsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<ListBatchPredictionJobsRequest.Builder>

com.google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ListBatchPredictionJobsRequest

public static final class ListBatchPredictionJobsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListBatchPredictionJobsRequest.Builder>
implements ListBatchPredictionJobsRequestOrBuilder

 Request message for
 [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs].
 

Protobuf type google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest

Method Summary

Modifier and Type	Method and Description
ListBatchPredictionJobsRequest	build()
ListBatchPredictionJobsRequest	buildPartial()
ListBatchPredictionJobsRequest.Builder	clear()
ListBatchPredictionJobsRequest.Builder	clearFilter() The standard list filter.
ListBatchPredictionJobsRequest.Builder	clearPageSize() The standard list page size.
ListBatchPredictionJobsRequest.Builder	clearPageToken() The standard list page token.
ListBatchPredictionJobsRequest.Builder	clearParent() Required.
ListBatchPredictionJobsRequest.Builder	clearReadMask() Mask specifying which fields to read.
ListBatchPredictionJobsRequest	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.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListBatchPredictionJobsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListBatchPredictionJobsRequest.Builder	mergeFrom(ListBatchPredictionJobsRequest other)
ListBatchPredictionJobsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListBatchPredictionJobsRequest.Builder	mergeReadMask(com.google.protobuf.FieldMask value) Mask specifying which fields to read.
ListBatchPredictionJobsRequest.Builder	setFilter(String value) The standard list filter.
ListBatchPredictionJobsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) The standard list filter.
ListBatchPredictionJobsRequest.Builder	setPageSize(int value) The standard list page size.
ListBatchPredictionJobsRequest.Builder	setPageToken(String value) The standard list page token.
ListBatchPredictionJobsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) The standard list page token.
ListBatchPredictionJobsRequest.Builder	setParent(String value) Required.
ListBatchPredictionJobsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
ListBatchPredictionJobsRequest.Builder	setReadMask(com.google.protobuf.FieldMask.Builder builderForValue) Mask specifying which fields to read.
ListBatchPredictionJobsRequest.Builder	setReadMask(com.google.protobuf.FieldMask value) Mask specifying which fields to read.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, mergeFrom, 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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListBatchPredictionJobsRequest.Builder>

clear

public ListBatchPredictionJobsRequest.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.GeneratedMessage.Builder<ListBatchPredictionJobsRequest.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.GeneratedMessage.Builder<ListBatchPredictionJobsRequest.Builder>

getDefaultInstanceForType

public ListBatchPredictionJobsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListBatchPredictionJobsRequest build()

Specified by:

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

Specified by:

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

buildPartial

public ListBatchPredictionJobsRequest buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

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

mergeFrom

public ListBatchPredictionJobsRequest.Builder mergeFrom(ListBatchPredictionJobsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListBatchPredictionJobsRequest.Builder>

mergeFrom

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

Throws:

IOException

getParent

public String getParent()

 Required. The resource name of the Location to list the BatchPredictionJobs
 from. Format: `projects/{project}/locations/{location}`
 

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

Specified by:

getParent in interface ListBatchPredictionJobsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The resource name of the Location to list the BatchPredictionJobs
 from. Format: `projects/{project}/locations/{location}`
 

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

Specified by:

getParentBytes in interface ListBatchPredictionJobsRequestOrBuilder

Returns:

The bytes for parent.

setParent

public ListBatchPredictionJobsRequest.Builder setParent(String value)

 Required. The resource name of the Location to list the BatchPredictionJobs
 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 ListBatchPredictionJobsRequest.Builder clearParent()

 Required. The resource name of the Location to list the BatchPredictionJobs
 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 ListBatchPredictionJobsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

 Required. The resource name of the Location to list the BatchPredictionJobs
 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.
 * `model_display_name` supports `=`, `!=` comparisons.
 * `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 ListBatchPredictionJobsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 The standard list filter.

 Supported fields:

 * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
 * `model_display_name` supports `=`, `!=` comparisons.
 * `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 ListBatchPredictionJobsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListBatchPredictionJobsRequest.Builder setFilter(String value)

 The standard list filter.

 Supported fields:

 * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
 * `model_display_name` supports `=`, `!=` comparisons.
 * `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 ListBatchPredictionJobsRequest.Builder clearFilter()

 The standard list filter.

 Supported fields:

 * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
 * `model_display_name` supports `=`, `!=` comparisons.
 * `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 ListBatchPredictionJobsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

 The standard list filter.

 Supported fields:

 * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
 * `model_display_name` supports `=`, `!=` comparisons.
 * `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 ListBatchPredictionJobsRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListBatchPredictionJobsRequest.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 ListBatchPredictionJobsRequest.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
 [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token]
 of the previous
 [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
 call.
 

string page_token = 4;

Specified by:

getPageToken in interface ListBatchPredictionJobsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

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

string page_token = 4;

Specified by:

getPageTokenBytes in interface ListBatchPredictionJobsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListBatchPredictionJobsRequest.Builder setPageToken(String value)

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

string page_token = 4;

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListBatchPredictionJobsRequest.Builder clearPageToken()

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

string page_token = 4;

Returns:

This builder for chaining.

setPageTokenBytes

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

 The standard list page token.
 Typically obtained via
 [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token]
 of the previous
 [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
 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 ListBatchPredictionJobsRequestOrBuilder

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 ListBatchPredictionJobsRequestOrBuilder

Returns:

The readMask.

setReadMask

public ListBatchPredictionJobsRequest.Builder setReadMask(com.google.protobuf.FieldMask value)

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

setReadMask

public ListBatchPredictionJobsRequest.Builder setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

mergeReadMask

public ListBatchPredictionJobsRequest.Builder mergeReadMask(com.google.protobuf.FieldMask value)

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

clearReadMask

public ListBatchPredictionJobsRequest.Builder clearReadMask()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

getReadMaskBuilder

public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

getReadMaskOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

Specified by:

getReadMaskOrBuilder in interface ListBatchPredictionJobsRequestOrBuilder