Interface ListWorkspacesRequestOrBuilder

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

    public interface ListWorkspacesRequestOrBuilder
    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 repository in which to list workspaces. Must be in the
         format `projects/*/locations/*/repositories/*`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.
      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The repository in which to list workspaces. Must be in the
         format `projects/*/locations/*/repositories/*`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.
      • getPageSize

        int getPageSize()
         Optional. Maximum number of workspaces 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 `ListWorkspaces` call.
         Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to `ListWorkspaces`
         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 `ListWorkspaces` call.
         Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to `ListWorkspaces`
         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. This field only supports ordering by `name`. If unspecified, the server
         will choose the ordering. If specified, the default order is ascending for
         the `name` field.
         
        string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The orderBy.
      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         Optional. This field only supports ordering by `name`. If unspecified, the server
         will choose the ordering. If specified, the default order is ascending for
         the `name` field.
         
        string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for orderBy.
      • getFilter

        String getFilter()
         Optional. Filter for the returned list.
         
        string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The filter.
      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Optional. Filter for the returned list.
         
        string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for filter.