public final class ListBatchesRequest extends GeneratedMessageV3 implements ListBatchesRequestOrBuilder
A request to list batch workloads in a project.
Protobuf type google.cloud.dataproc.v1.ListBatchesRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ListBatchesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListBatchesRequest.Builder newBuilder()
newBuilder(ListBatchesRequest prototype)
public static ListBatchesRequest.Builder newBuilder(ListBatchesRequest prototype)
public static ListBatchesRequest parseDelimitedFrom(InputStream input)
public static ListBatchesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListBatchesRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListBatchesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListBatchesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBatchesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBatchesRequest parseFrom(CodedInputStream input)
public static ListBatchesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListBatchesRequest parseFrom(InputStream input)
public static ListBatchesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListBatchesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListBatchesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListBatchesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public ListBatchesRequest getDefaultInstanceForType()
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()
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.
|
getParserForType()
public Parser<ListBatchesRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListBatchesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListBatchesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ListBatchesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
