Interface ListFoldersRequestOrBuilder

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

    public interface ListFoldersRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getPageSize()
      Optional.
      String getPageToken()
      Optional.
      com.google.protobuf.ByteString getPageTokenBytes()
      Optional.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      boolean getShowDeleted()
      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 Detail

      • getParent

        String getParent()
         Required. The name of the parent resource whose folders are being listed.
         Only children of this parent resource are listed; descendants are not
         listed.
        
         If the parent is a folder, use the value `folders/{folder_id}`. If the
         parent is an organization, use the value `organizations/{org_id}`.
        
         Access to this method is controlled by checking the
         `resourcemanager.folders.list` permission on the `parent`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.
      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The name of the parent resource whose folders are being listed.
         Only children of this parent resource are listed; descendants are not
         listed.
        
         If the parent is a folder, use the value `folders/{folder_id}`. If the
         parent is an organization, use the value `organizations/{org_id}`.
        
         Access to this method is controlled by checking the
         `resourcemanager.folders.list` permission on the `parent`.
         
        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 folders to return in the response. The
         server can return fewer folders than requested. If unspecified, server
         picks an appropriate default.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageSize.
      • getPageToken

        String getPageToken()
         Optional. A pagination token returned from a previous call to `ListFolders`
         that indicates where this listing should continue from.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         Optional. A pagination token returned from a previous call to `ListFolders`
         that indicates where this listing should continue from.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for pageToken.
      • getShowDeleted

        boolean getShowDeleted()
         Optional. Controls whether folders in the
         [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED]
         state should be returned. Defaults to false.
         
        bool show_deleted = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The showDeleted.