Google Cloud Support V2 API - Class Google::Cloud::Support::V2::SearchCasesRequest (v1.4.0)

Reference documentation and code samples for the Google Cloud Support V2 API class Google::Cloud::Support::V2::SearchCasesRequest.

The request message for the SearchCases endpoint.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The maximum number of cases fetched with each request. The default page size is 10.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — A token identifying the page of results to return. If unspecified, the first page is retrieved.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — The name of the parent resource to search for cases under.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — The name of the parent resource to search for cases under.
Returns
  • (::String) — The name of the parent resource to search for cases under.

#query

def query() -> ::String
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="tester@example.com"
    • project="projects/my-project-id" AND (priority=P0 OR priority=P1)

#query=

def query=(value) -> ::String
Parameter
  • value (::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="tester@example.com"
    • 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="tester@example.com"
    • project="projects/my-project-id" AND (priority=P0 OR priority=P1)