Package com.google.cloud.support.v2

Interface SearchCasesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchCasesRequest, SearchCasesRequest.Builder
    public interface SearchCasesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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()
      The fully qualified name of parent resource to search cases under.
      com.google.protobuf.ByteString getParentBytes()
      The fully qualified name of parent resource to search cases under.
      String getQuery()
      An expression written in filter language.
      com.google.protobuf.ByteString getQueryBytes()
      An expression written in filter language.

      • 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()
         The fully qualified name of parent resource to search cases under.
        string parent = 4;
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         The fully qualified name of parent resource to search cases under.
        string parent = 4;
        Returns:
        The bytes for parent.

      • getQuery

        String getQuery()
         An expression written in filter language.

 A query uses the following fields with the operators equals (`=`) and
 `AND`:

 - `organization`: An organization name in the form
 `organizations/<organization_id>`.
 - `project`: A project name in the form `projects/<project_id>`.
 - `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.
 - `billingAccount`: A billing account in the form
 `billingAccounts/<billing_account_id>`

 You must specify either `organization` or `project`.

 To search across `displayName`, `description`, and comments, use a global
 restriction with no keyword or operator. For example, `"my search"`.

 To search only cases updated after a certain date, use `update_time`
 restricted with that particular date, time, and timezone in ISO datetime
 format. For example, `update_time>"2020-01-01T00:00:00-05:00"`.
 `update_time` only supports the greater than operator (`>`).

 Examples:

 - `organization="organizations/123456789"`
 - `project="projects/my-project-id"`
 - `project="projects/123456789"`
 - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"`
 - `organization="organizations/123456789" AND state=CLOSED`
 - `project="projects/my-project-id" AND creator.email="tester@example.com"`
 - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
        string query = 1;
        Returns:
        The query.

      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         An expression written in filter language.

 A query uses the following fields with the operators equals (`=`) and
 `AND`:

 - `organization`: An organization name in the form
 `organizations/<organization_id>`.
 - `project`: A project name in the form `projects/<project_id>`.
 - `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.
 - `billingAccount`: A billing account in the form
 `billingAccounts/<billing_account_id>`

 You must specify either `organization` or `project`.

 To search across `displayName`, `description`, and comments, use a global
 restriction with no keyword or operator. For example, `"my search"`.

 To search only cases updated after a certain date, use `update_time`
 restricted with that particular date, time, and timezone in ISO datetime
 format. For example, `update_time>"2020-01-01T00:00:00-05:00"`.
 `update_time` only supports the greater than operator (`>`).

 Examples:

 - `organization="organizations/123456789"`
 - `project="projects/my-project-id"`
 - `project="projects/123456789"`
 - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"`
 - `organization="organizations/123456789" AND state=CLOSED`
 - `project="projects/my-project-id" AND creator.email="tester@example.com"`
 - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
        string query = 1;
        Returns:
        The bytes for query.

      • getPageSize

        int getPageSize()
         The maximum number of cases fetched with each request. The default page
 size is 10.
        int32 page_size = 2;
        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 = 3;
        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 = 3;
        Returns:
        The bytes for pageToken.