Chronicle V1 API - Class Google::Cloud::Chronicle::V1::ListRulesRequest (v0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::ListRulesRequest.
Request message for ListRules method.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) — Only the following filters are allowed:
"reference_lists:{reference_list_name}"
"data_tables:{data_table_name}"
"display_name:{display_name}"
#filter=
deffilter=(value)->::String
Parameter
value (::String) — Only the following filters are allowed:
"reference_lists:{reference_list_name}"
"data_tables:{data_table_name}"
"display_name:{display_name}"
Returns
(::String) — Only the following filters are allowed:
"reference_lists:{reference_list_name}"
"data_tables:{data_table_name}"
"display_name:{display_name}"
#page_size
defpage_size()->::Integer
Returns
(::Integer) — The maximum number of rules to return. The service may return fewer than
this value. If unspecified, at most 100 rules will be returned. The
maximum value is 1000; values above 1000 will be coerced to 1000.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — The maximum number of rules to return. The service may return fewer than
this value. If unspecified, at most 100 rules will be returned. The
maximum value is 1000; values above 1000 will be coerced to 1000.
Returns
(::Integer) — The maximum number of rules to return. The service may return fewer than
this value. If unspecified, at most 100 rules will be returned. The
maximum value is 1000; values above 1000 will be coerced to 1000.
#page_token
defpage_token()->::String
Returns
(::String) — A page token, received from a previous ListRules call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListRules
must match the call that provided the page token.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — A page token, received from a previous ListRules call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListRules
must match the call that provided the page token.
Returns
(::String) — A page token, received from a previous ListRules call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListRules
must match the call that provided the page token.
#parent
defparent()->::String
Returns
(::String) — Required. The parent, which owns this collection of rules.
Format:
projects/{project}/locations/{location}/instances/{instance}
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The parent, which owns this collection of rules.
Format:
projects/{project}/locations/{location}/instances/{instance}
Returns
(::String) — Required. The parent, which owns this collection of rules.
Format:
projects/{project}/locations/{location}/instances/{instance}
value (::Google::Cloud::Chronicle::V1::RuleView) — view indicates the scope of fields to populate for the Rule being returned.
If unspecified, defaults to BASIC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Chronicle V1 API - Class Google::Cloud::Chronicle::V1::ListRulesRequest (v0.1.0)\n\nReference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::ListRulesRequest.\n\nRequest message for ListRules method. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Only the following filters are allowed: \"reference_lists:{reference_list_name}\" \"data_tables:{data_table_name}\" \"display_name:{display_name}\"\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Only the following filters are allowed: \"reference_lists:{reference_list_name}\" \"data_tables:{data_table_name}\" \"display_name:{display_name}\" \n**Returns**\n\n- (::String) --- Only the following filters are allowed: \"reference_lists:{reference_list_name}\" \"data_tables:{data_table_name}\" \"display_name:{display_name}\"\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. \n**Returns**\n\n- (::Integer) --- The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A page token, received from a previous `ListRules` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListRules`\n must match the call that provided the page token.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A page token, received from a previous `ListRules` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListRules`\nmust match the call that provided the page token. \n**Returns**\n\n- (::String) --- A page token, received from a previous `ListRules` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListRules`\n must match the call that provided the page token.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent, which owns this collection of rules. Format: `projects/{project}/locations/{location}/instances/{instance}`\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent, which owns this collection of rules. Format: `projects/{project}/locations/{location}/instances/{instance}` \n**Returns**\n\n- (::String) --- Required. The parent, which owns this collection of rules. Format: `projects/{project}/locations/{location}/instances/{instance}`\n\n### #view\n\n def view() -\u003e ::Google::Cloud::Chronicle::V1::RuleView\n\n**Returns**\n\n- ([::Google::Cloud::Chronicle::V1::RuleView](./Google-Cloud-Chronicle-V1-RuleView)) --- view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC.\n\n### #view=\n\n def view=(value) -\u003e ::Google::Cloud::Chronicle::V1::RuleView\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Chronicle::V1::RuleView](./Google-Cloud-Chronicle-V1-RuleView)) --- view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC. \n**Returns**\n\n- ([::Google::Cloud::Chronicle::V1::RuleView](./Google-Cloud-Chronicle-V1-RuleView)) --- view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC."]]