Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ListRulesRequest.
Request message for ListRules method.
Generated from protobuf message google.cloud.chronicle.v1.ListRulesRequest
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of rules. Format: |
↳ page_size |
int
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 |
string
A page token, received from a previous |
↳ view |
int
view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC. |
↳ filter |
string
Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}" |
getParent
Required. The parent, which owns this collection of rules.
Format:
projects/{project}/locations/{location}/instances/{instance}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which owns this collection of rules.
Format:
projects/{project}/locations/{location}/instances/{instance}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
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 | |
|---|---|
| Type | Description |
int |
|
setPageSize
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
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 | |
|---|---|
| Type | Description |
string |
|
setPageToken
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getView
view indicates the scope of fields to populate for the Rule being returned.
If unspecified, defaults to BASIC.
| Returns | |
|---|---|
| Type | Description |
int |
|
setView
view indicates the scope of fields to populate for the Rule being returned.
If unspecified, defaults to BASIC.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of rules.
Format:
|
| Returns | |
|---|---|
| Type | Description |
ListRulesRequest |
|