Package com.google.cloud.support.v2

Class SearchCasesRequest

  • All Implemented Interfaces:
    SearchCasesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchCasesRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchCasesRequestOrBuilder
     The request message for the SearchCases endpoint.
    Protobuf type google.cloud.support.v2.SearchCasesRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SearchCasesRequest.Builder
      The request message for the SearchCases endpoint.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PAGE_SIZE_FIELD_NUMBER  
      static int PAGE_TOKEN_FIELD_NUMBER  
      static int PARENT_FIELD_NUMBER  
      static int QUERY_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public String getParent()
         The fully qualified name of parent resource to search cases under.
        string parent = 4;
        Specified by:
        getParent in interface SearchCasesRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

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

      • getQuery

        public 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;
        Specified by:
        getQuery in interface SearchCasesRequestOrBuilder
        Returns:
        The query.

      • getQueryBytes

        public 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;
        Specified by:
        getQueryBytes in interface SearchCasesRequestOrBuilder
        Returns:
        The bytes for query.

      • getPageSize

        public int getPageSize()
         The maximum number of cases fetched with each request. The default page
 size is 10.
        int32 page_size = 2;
        Specified by:
        getPageSize in interface SearchCasesRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         A token identifying the page of results to return. If unspecified, the
 first page is retrieved.
        string page_token = 3;
        Specified by:
        getPageToken in interface SearchCasesRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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;
        Specified by:
        getPageTokenBytes in interface SearchCasesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SearchCasesRequest parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCasesRequest parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCasesRequest parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCasesRequest parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCasesRequest parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCasesRequest parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCasesRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public SearchCasesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SearchCasesRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SearchCasesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SearchCasesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SearchCasesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder