Package com.google.cloud.dataproc.v1

Interface ListBatchesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListBatchesRequest, ListBatchesRequest.Builder
    public interface ListBatchesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. The parent, which owns this collection of batches.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        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) = { ... }
        Returns:
        The bytes for parent.

      • getPageSize

        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:
        The pageSize.

      • getPageToken

        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:
        The pageToken.

      • getPageTokenBytes

        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];
        Returns:
        The bytes for pageToken.

      • getFilter

        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:
        The filter.

      • getFilterBytes

        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];
        Returns:
        The bytes for filter.

      • getOrderBy

        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:
        The orderBy.

      • getOrderByBytes

        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];
        Returns:
        The bytes for orderBy.