Interface QueryFolderContentsRequestOrBuilder

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

@Generated public interface QueryFolderContentsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Optional.
    com.google.protobuf.ByteString
    Optional.
    Required.
    com.google.protobuf.ByteString
    Required.
    Optional.
    com.google.protobuf.ByteString
    Optional.
    int
    Optional.
    Optional.
    com.google.protobuf.ByteString
    Optional.

    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 Details

    • getFolder

      String getFolder()
       Required. Name of the folder whose contents to list.
       Format: projects/*/locations/*/folders/*
       
      string folder = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The folder.
    • getFolderBytes

      com.google.protobuf.ByteString getFolderBytes()
       Required. Name of the folder whose contents to list.
       Format: projects/*/locations/*/folders/*
       
      string folder = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for folder.
    • getPageSize

      int getPageSize()
       Optional. Maximum number of paths to return. The server may return fewer
       items than requested. If unspecified, the server will pick an appropriate
       default.
       
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.
    • getPageToken

      String getPageToken()
       Optional. Page token received from a previous `QueryFolderContents` call.
       Provide this to retrieve the subsequent page.
      
       When paginating, all other parameters provided to
       `QueryFolderContents`, with the exception of `page_size`, 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 `QueryFolderContents` call.
       Provide this to retrieve the subsequent page.
      
       When paginating, all other parameters provided to
       `QueryFolderContents`, with the exception of `page_size`, must match the
       call that provided the page token.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.
    • getOrderBy

      String getOrderBy()
       Optional. Field to additionally sort results by.
       Will order Folders before Repositories, and then by `order_by` in ascending
       order. Supported keywords: display_name (default), create_time,
       last_modified_time.
       Examples:
       - `orderBy="display_name"`
       - `orderBy="display_name desc"`
       
      string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The orderBy.
    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes()
       Optional. Field to additionally sort results by.
       Will order Folders before Repositories, and then by `order_by` in ascending
       order. Supported keywords: display_name (default), create_time,
       last_modified_time.
       Examples:
       - `orderBy="display_name"`
       - `orderBy="display_name desc"`
       
      string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for orderBy.
    • getFilter

      String getFilter()
       Optional. Optional filtering for the returned list. Filtering is currently
       only supported on the `display_name` field.
      
       Example:
       - `filter="display_name="MyFolder""`
       
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.
    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. Optional filtering for the returned list. Filtering is currently
       only supported on the `display_name` field.
      
       Example:
       - `filter="display_name="MyFolder""`
       
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.