Interface ListCasesRequestOrBuilder

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

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      An expression written in filter language.
      com.google.protobuf.ByteString getFilterBytes()
      An expression written in filter language.
      int getPageSize()
      The maximum number of cases fetched with each request.
      String getPageToken()
      A token identifying the page of results to return.
      com.google.protobuf.ByteString getPageTokenBytes()
      A token identifying the page of results to return.
      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 fully qualified name of parent resource to list cases under.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.
      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The fully qualified name of parent resource to list cases under.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.
      • getFilter

        String getFilter()
         An expression written in filter language. If non-empty, the query returns
         the cases that match the filter. Else, the query doesn't filter the cases.
        
         Filter expressions use the following fields with the operators equals (`=`)
         and `AND`:
        
         - `state`: The accepted values are `OPEN` or `CLOSED`.
         - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
         can specify multiple values for priority using the `OR` operator. For
         example, `priority=P1 OR priority=P2`.
         - `creator.email`: The email address of the case creator.
        
         Examples:
        
         - `state=CLOSED`
         - `state=OPEN AND creator.email="tester@example.com"`
         - `state=OPEN AND (priority=P0 OR priority=P1)`
         
        string filter = 2;
        Returns:
        The filter.
      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         An expression written in filter language. If non-empty, the query returns
         the cases that match the filter. Else, the query doesn't filter the cases.
        
         Filter expressions use the following fields with the operators equals (`=`)
         and `AND`:
        
         - `state`: The accepted values are `OPEN` or `CLOSED`.
         - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
         can specify multiple values for priority using the `OR` operator. For
         example, `priority=P1 OR priority=P2`.
         - `creator.email`: The email address of the case creator.
        
         Examples:
        
         - `state=CLOSED`
         - `state=OPEN AND creator.email="tester@example.com"`
         - `state=OPEN AND (priority=P0 OR priority=P1)`
         
        string filter = 2;
        Returns:
        The bytes for filter.
      • getPageSize

        int getPageSize()
         The maximum number of cases fetched with each request. Defaults to 10.
         
        int32 page_size = 4;
        Returns:
        The pageSize.
      • getPageToken

        String getPageToken()
         A token identifying the page of results to return. If unspecified, the
         first page is retrieved.
         
        string page_token = 5;
        Returns:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         A token identifying the page of results to return. If unspecified, the
         first page is retrieved.
         
        string page_token = 5;
        Returns:
        The bytes for pageToken.