com.google.cloud.dataproc.v1

Class ListBatchesRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<ListBatchesRequest.Builder>

com.google.cloud.dataproc.v1.ListBatchesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ListBatchesRequest

public static final class ListBatchesRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListBatchesRequest.Builder>
implements ListBatchesRequestOrBuilder

 A request to list batch workloads in a project.
 

Protobuf type google.cloud.dataproc.v1.ListBatchesRequest

Method Summary

Modifier and Type	Method and Description
ListBatchesRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListBatchesRequest	build()
ListBatchesRequest	buildPartial()
ListBatchesRequest.Builder	clear()
ListBatchesRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ListBatchesRequest.Builder	clearFilter() Optional.
ListBatchesRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ListBatchesRequest.Builder	clearOrderBy() Optional.
ListBatchesRequest.Builder	clearPageSize() Optional.
ListBatchesRequest.Builder	clearPageToken() Optional.
ListBatchesRequest.Builder	clearParent() Required.
ListBatchesRequest.Builder	clone()
ListBatchesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
String	getOrderBy() Optional.
com.google.protobuf.ByteString	getOrderByBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListBatchesRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListBatchesRequest.Builder	mergeFrom(ListBatchesRequest other)
ListBatchesRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListBatchesRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ListBatchesRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListBatchesRequest.Builder	setFilter(String value) Optional.
ListBatchesRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) Optional.
ListBatchesRequest.Builder	setOrderBy(String value) Optional.
ListBatchesRequest.Builder	setOrderByBytes(com.google.protobuf.ByteString value) Optional.
ListBatchesRequest.Builder	setPageSize(int value) Optional.
ListBatchesRequest.Builder	setPageToken(String value) Optional.
ListBatchesRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) Optional.
ListBatchesRequest.Builder	setParent(String value) Required.
ListBatchesRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
ListBatchesRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ListBatchesRequest.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<ListBatchesRequest.Builder>

clear

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

getDefaultInstanceForType

public ListBatchesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListBatchesRequest build()

Specified by:

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

Specified by:

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

buildPartial

public ListBatchesRequest buildPartial()

Specified by:

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

Specified by:

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

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

public ListBatchesRequest.Builder mergeFrom(ListBatchesRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

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

Throws:

IOException

getParent

public String getParent()

 Required. The parent, which owns this collection of batches.
 

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

Specified by:

getParent in interface ListBatchesRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The parent, which owns this collection of batches.
 

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

Specified by:

getParentBytes in interface ListBatchesRequestOrBuilder

Returns:

The bytes for parent.

setParent

public ListBatchesRequest.Builder setParent(String value)

 Required. The parent, which owns this collection of batches.
 

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 ListBatchesRequest.Builder clearParent()

 Required. The parent, which owns this collection of batches.
 

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

Returns:

This builder for chaining.

setParentBytes

public ListBatchesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

 Required. The parent, which owns this collection of batches.
 

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.

getPageSize

public int getPageSize()

 Optional. The maximum number of batches to return in each response.
 The service may return fewer than this value.
 The default page size is 20; the maximum page size is 1000.
 

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageSize in interface ListBatchesRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListBatchesRequest.Builder setPageSize(int value)

 Optional. The maximum number of batches to return in each response.
 The service may return fewer than this value.
 The default page size is 20; the maximum page size is 1000.
 

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListBatchesRequest.Builder clearPageSize()

 Optional. The maximum number of batches to return in each response.
 The service may return fewer than this value.
 The default page size is 20; the maximum page size is 1000.
 

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

getPageToken

public String getPageToken()

 Optional. A page token received from a previous `ListBatches` call.
 Provide this token to retrieve the subsequent page.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageToken in interface ListBatchesRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Optional. A page token received from a previous `ListBatches` call.
 Provide this token to retrieve the subsequent page.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageTokenBytes in interface ListBatchesRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListBatchesRequest.Builder setPageToken(String value)

 Optional. A page token received from a previous `ListBatches` call.
 Provide this token to retrieve the subsequent page.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListBatchesRequest.Builder clearPageToken()

 Optional. A page token received from a previous `ListBatches` call.
 Provide this token to retrieve the subsequent page.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setPageTokenBytes

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

 Optional. A page token received from a previous `ListBatches` call.
 Provide this token to retrieve the subsequent page.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

getFilter

public String getFilter()

 Optional. A filter for the batches to return in the response.

 A filter is a logical expression constraining the values of various fields
 in each batch resource. Filters are case sensitive, and may contain
 multiple clauses combined with logical operators (AND/OR).
 Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.

 e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"`
 filters for batches in state RUNNING that were created before 2023-01-01

 See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
 description of the filter syntax and a list of supported comparisons.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilter in interface ListBatchesRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Optional. A filter for the batches to return in the response.

 A filter is a logical expression constraining the values of various fields
 in each batch resource. Filters are case sensitive, and may contain
 multiple clauses combined with logical operators (AND/OR).
 Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.

 e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"`
 filters for batches in state RUNNING that were created before 2023-01-01

 See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
 description of the filter syntax and a list of supported comparisons.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilterBytes in interface ListBatchesRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListBatchesRequest.Builder setFilter(String value)

 Optional. A filter for the batches to return in the response.

 A filter is a logical expression constraining the values of various fields
 in each batch resource. Filters are case sensitive, and may contain
 multiple clauses combined with logical operators (AND/OR).
 Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.

 e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"`
 filters for batches in state RUNNING that were created before 2023-01-01

 See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
 description of the filter syntax and a list of supported comparisons.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ListBatchesRequest.Builder clearFilter()

 Optional. A filter for the batches to return in the response.

 A filter is a logical expression constraining the values of various fields
 in each batch resource. Filters are case sensitive, and may contain
 multiple clauses combined with logical operators (AND/OR).
 Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.

 e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"`
 filters for batches in state RUNNING that were created before 2023-01-01

 See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
 description of the filter syntax and a list of supported comparisons.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setFilterBytes

public ListBatchesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

 Optional. A filter for the batches to return in the response.

 A filter is a logical expression constraining the values of various fields
 in each batch resource. Filters are case sensitive, and may contain
 multiple clauses combined with logical operators (AND/OR).
 Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.

 e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"`
 filters for batches in state RUNNING that were created before 2023-01-01

 See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
 description of the filter syntax and a list of supported comparisons.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

getOrderBy

public String getOrderBy()

 Optional. Field(s) on which to sort the list of batches.

 Currently the only supported sort orders are unspecified (empty) and
 `create_time desc` to sort by most recently created batches first.

 See https://google.aip.dev/132#ordering for more details.
 

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getOrderBy in interface ListBatchesRequestOrBuilder

Returns:

The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 Optional. Field(s) on which to sort the list of batches.

 Currently the only supported sort orders are unspecified (empty) and
 `create_time desc` to sort by most recently created batches first.

 See https://google.aip.dev/132#ordering for more details.
 

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getOrderByBytes in interface ListBatchesRequestOrBuilder

Returns:

The bytes for orderBy.

setOrderBy

public ListBatchesRequest.Builder setOrderBy(String value)

 Optional. Field(s) on which to sort the list of batches.

 Currently the only supported sort orders are unspecified (empty) and
 `create_time desc` to sort by most recently created batches first.

 See https://google.aip.dev/132#ordering for more details.
 

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The orderBy to set.

Returns:

This builder for chaining.

clearOrderBy

public ListBatchesRequest.Builder clearOrderBy()

 Optional. Field(s) on which to sort the list of batches.

 Currently the only supported sort orders are unspecified (empty) and
 `create_time desc` to sort by most recently created batches first.

 See https://google.aip.dev/132#ordering for more details.
 

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setOrderByBytes

public ListBatchesRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)

 Optional. Field(s) on which to sort the list of batches.

 Currently the only supported sort orders are unspecified (empty) and
 `create_time desc` to sort by most recently created batches first.

 See https://google.aip.dev/132#ordering for more details.
 

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for orderBy to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListBatchesRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListBatchesRequest.Builder>

mergeUnknownFields

public final ListBatchesRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListBatchesRequest.Builder>