Class: Google::Cloud::Support::V2beta::ListCasesRequest

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 ListCases endpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::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="[email protected]"
  • 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="[email protected]"
    • state=OPEN AND (priority=P0 OR priority=P1)


81
82
83
84
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 81

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

#page_size ⇒ ::Integer

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



81
82
83
84
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 81

class ListCasesRequest
  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.



81
82
83
84
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 81

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

#parent ⇒ ::String

Returns Required. The name of a parent to list cases under.

Returns:

  • (::String) —

    Required. The name of a parent to list cases under.



81
82
83
84
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 81

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

#product_line ⇒ ::Google::Cloud::Support::V2beta::ProductLine

Returns The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

Returns:



81
82
83
84
 
# File 'proto_docs/google/cloud/support/v2beta/case_service.rb', line 81

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