Class: Google::Cloud::Support::V2beta::SearchCasesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/support/v2beta/case_service.rb

Overview

The request message for the SearchCases endpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

Returns The maximum number of cases fetched with each request. The default page size is 10.

Returns:

  • (::Integer) —

    The maximum number of cases fetched with each request. The default page size is 10.



147
148
149
150
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 147

class SearchCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns A token identifying the page of results to return. If unspecified, the first page is retrieved.

Returns:

  • (::String) —

    A token identifying the page of results to return. If unspecified, the first page is retrieved.



147
148
149
150
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 147

class SearchCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns The name of the parent resource to search for cases under.

Returns:

  • (::String) —

    The name of the parent resource to search for cases under.



147
148
149
150
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 147

class SearchCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::String

Returns An expression used to filter cases.

Expressions use the following fields separated by AND and specified with =:

  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • state: Can be OPEN or CLOSED.
  • priority: Can be 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.

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"
  • organization="organizations/123456789" AND state=CLOSED
  • project="projects/my-project-id" AND creator.email="[email protected]"
  • project="projects/my-project-id" AND (priority=P0 OR priority=P1).

Returns:

  • (::String) —

    An expression used to filter cases.

    Expressions use the following fields separated by AND and specified with =:

    • organization: An organization name in the form organizations/<organization_id>.
    • project: A project name in the form projects/<project_id>.
    • state: Can be OPEN or CLOSED.
    • priority: Can be 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.

    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"
    • organization="organizations/123456789" AND state=CLOSED
    • project="projects/my-project-id" AND creator.email="[email protected]"
    • project="projects/my-project-id" AND (priority=P0 OR priority=P1)


147
148
149
150
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 147

class SearchCasesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end