Google Cloud Support V2 API - Class Google::Cloud::Support::V2::ListCasesRequest (v1.4.1)

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

The request message for the ListCases endpoint.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    An expression used to filter cases.

    If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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

    • 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.

    EXAMPLES:

    • state=CLOSED
    • state=OPEN AND creator.email="tester@example.com"
    • state=OPEN AND (priority=P0 OR priority=P1)

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    An expression used to filter cases.

    If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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

    • 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.

    EXAMPLES:

    • state=CLOSED
    • state=OPEN AND creator.email="tester@example.com"
    • state=OPEN AND (priority=P0 OR priority=P1)
Returns
  • (::String) —

    An expression used to filter cases.

    If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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

    • 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.

    EXAMPLES:

    • state=CLOSED
    • state=OPEN AND creator.email="tester@example.com"
    • state=OPEN AND (priority=P0 OR priority=P1)

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The maximum number of cases fetched with each request. Defaults to 10.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The maximum number of cases fetched with each request. Defaults to 10.
Returns
  • (::Integer) — The maximum number of cases fetched with each request. Defaults to 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) — Required. The name of a parent to list cases under.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The name of a parent to list cases under.
Returns
  • (::String) — Required. The name of a parent to list cases under.