Interface ListInstancesRequestOrBuilder

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

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      List filter.
      com.google.protobuf.ByteString getFilterBytes()
      List filter.
      String getOrderBy()
      Sort results.
      com.google.protobuf.ByteString getOrderByBytes()
      Sort results.
      int getPageSize()
      The maximum number of items to return.
      String getPageToken()
      The `next_page_token` value returned from a previous List request, if any.
      com.google.protobuf.ByteString getPageTokenBytes()
      The `next_page_token` value returned from a previous List request, if any.
      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 instance location using the form:
             `projects/{project_id}/locations/{location_id}`
         where `location_id` refers to a GCP region
         
        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 instance location using the form:
             `projects/{project_id}/locations/{location_id}`
         where `location_id` refers to a GCP region
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.
      • getPageSize

        int getPageSize()
         The maximum number of items to return.
        
         If not specified, a default value of 1000 will be used by the service.
         Regardless of the `page_size` value, the response may include a partial
         list and a caller should only rely on response's
         [`next_page_token`][google.cloud.memcache.v1beta2.ListInstancesResponse.next_page_token]
         to determine if there are more instances left to be queried.
         
        int32 page_size = 2;
        Returns:
        The pageSize.
      • getPageToken

        String getPageToken()
         The `next_page_token` value returned from a previous List request, if any.
         
        string page_token = 3;
        Returns:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         The `next_page_token` value returned from a previous List request, if any.
         
        string page_token = 3;
        Returns:
        The bytes for pageToken.
      • getFilter

        String getFilter()
         List filter. For example, exclude all Memcached instances with name as
         my-instance by specifying `"name != my-instance"`.
         
        string filter = 4;
        Returns:
        The filter.
      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         List filter. For example, exclude all Memcached instances with name as
         my-instance by specifying `"name != my-instance"`.
         
        string filter = 4;
        Returns:
        The bytes for filter.
      • getOrderBy

        String getOrderBy()
         Sort results. Supported values are "name", "name desc" or "" (unsorted).
         
        string order_by = 5;
        Returns:
        The orderBy.
      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         Sort results. Supported values are "name", "name desc" or "" (unsorted).
         
        string order_by = 5;
        Returns:
        The bytes for orderBy.