Interface ListPartitionsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListPartitionsRequest, ListPartitionsRequest.Builder

    public interface ListPartitionsRequestOrBuilder
    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.
      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 resource name of the parent entity:
         `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.
      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the parent entity:
         `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.
      • getPageSize

        int getPageSize()
         Optional. Maximum number of partitions to return. The service may return
         fewer than this value. If unspecified, 100 partitions will be returned by
         default. The maximum page size is 500; larger values will will be truncated
         to 500.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageSize.
      • getPageToken

        String getPageToken()
         Optional. Page token received from a previous `ListPartitions` call.
         Provide this to retrieve the subsequent page. When paginating, all other
         parameters provided to `ListPartitions` must match the call that provided
         the page token.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         Optional. Page token received from a previous `ListPartitions` call.
         Provide this to retrieve the subsequent page. When paginating, all other
         parameters provided to `ListPartitions` must match the call that provided
         the page token.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for pageToken.
      • getFilter

        String getFilter()
         Optional. Filter the partitions returned to the caller using a key value
         pair expression. Supported operators and syntax:
        
         - logic operators: AND, OR
         - comparison operators: <, >, >=, <= ,=, !=
         - LIKE operators:
           - The right hand of a LIKE operator supports "." and
             "*" for wildcard searches, for example "value1 LIKE ".*oo.*"
         - parenthetical grouping: ( )
        
         Sample filter expression: `?filter="key1 < value1 OR key2 > value2"
        
         **Notes:**
        
         - Keys to the left of operators are case insensitive.
         - Partition results are sorted first by creation time, then by
           lexicographic order.
         - Up to 20 key value filter pairs are allowed, but due to performance
           considerations, only the first 10 will be used as a filter.
         
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The filter.
      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Optional. Filter the partitions returned to the caller using a key value
         pair expression. Supported operators and syntax:
        
         - logic operators: AND, OR
         - comparison operators: <, >, >=, <= ,=, !=
         - LIKE operators:
           - The right hand of a LIKE operator supports "." and
             "*" for wildcard searches, for example "value1 LIKE ".*oo.*"
         - parenthetical grouping: ( )
        
         Sample filter expression: `?filter="key1 < value1 OR key2 > value2"
        
         **Notes:**
        
         - Keys to the left of operators are case insensitive.
         - Partition results are sorted first by creation time, then by
           lexicographic order.
         - Up to 20 key value filter pairs are allowed, but due to performance
           considerations, only the first 10 will be used as a filter.
         
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for filter.