Class: Google::Cloud::Support::V2::ListCasesRequest

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

Overview

The request message for the ListCases endpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases.

Filter expressions use the following fields with the operators equals (=) and AND:

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

Examples:

  • state=CLOSED
  • state=OPEN AND creator.email="[email protected]"
  • state=OPEN AND (priority=P0 OR priority=P1).

Returns:

  • (::String) —

    An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases.

    Filter expressions use the following fields with the operators equals (=) and AND:

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

    Examples:

    • state=CLOSED
    • state=OPEN AND creator.email="[email protected]"
    • state=OPEN AND (priority=P0 OR priority=P1)


76
77
78
79
 
# File 'proto_docs/google/cloud/support/v2/case_service.rb', line 76

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.



76
77
78
79
 
# File 'proto_docs/google/cloud/support/v2/case_service.rb', line 76

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.



76
77
78
79
 
# File 'proto_docs/google/cloud/support/v2/case_service.rb', line 76

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

#parent ⇒ ::String

Returns Required. The fully qualified name of parent resource to list cases under.

Returns:

  • (::String) —

    Required. The fully qualified name of parent resource to list cases under.



76
77
78
79
 
# File 'proto_docs/google/cloud/support/v2/case_service.rb', line 76

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