- 4.45.0 (latest)
- 4.44.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public static final class ListBatchesRequest.Builder extends GeneratedMessageV3.Builder<ListBatchesRequest.Builder> implements ListBatchesRequestOrBuilder
A request to list batch workloads in a project.
Protobuf type google.cloud.dataproc.v1.ListBatchesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBatchesRequest.BuilderImplements
ListBatchesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListBatchesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
build()
public ListBatchesRequest build()
Returns | |
---|---|
Type | Description |
ListBatchesRequest |
buildPartial()
public ListBatchesRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListBatchesRequest |
clear()
public ListBatchesRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListBatchesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
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 | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListBatchesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
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 | |
---|---|
Type | Description |
ListBatchesRequest.Builder | 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 | |
---|---|
Type | Description |
ListBatchesRequest.Builder | 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 | |
---|---|
Type | Description |
ListBatchesRequest.Builder | 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 | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
clone()
public ListBatchesRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
getDefaultInstanceForType()
public ListBatchesRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListBatchesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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];
Returns | |
---|---|
Type | Description |
String | The filter. |
getFilterBytes()
public 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];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for filter. |
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];
Returns | |
---|---|
Type | Description |
String | The orderBy. |
getOrderByBytes()
public 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];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for orderBy. |
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];
Returns | |
---|---|
Type | Description |
int | The pageSize. |
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];
Returns | |
---|---|
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public 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];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
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) = { ... }
Returns | |
---|---|
Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. The parent, which owns this collection of batches.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListBatchesRequest other)
public ListBatchesRequest.Builder mergeFrom(ListBatchesRequest other)
Parameter | |
---|---|
Name | Description |
other | ListBatchesRequest |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListBatchesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListBatchesRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListBatchesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListBatchesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
setFilter(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The filter to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListBatchesRequest.Builder setFilterBytes(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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setOrderBy(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The orderBy to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public ListBatchesRequest.Builder setOrderByBytes(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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for orderBy to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setPageSize(int value)
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];
Parameter | |
---|---|
Name | Description |
value | int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setPageToken(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListBatchesRequest.Builder setPageTokenBytes(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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setParent(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The parent to set. |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListBatchesRequest.Builder setParentBytes(ByteString value)
Required. The parent, which owns this collection of batches.
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 |
ListBatchesRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListBatchesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListBatchesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListBatchesRequest.Builder |