Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ListRuleDeploymentsRequest.
Request message for ListRuleDeployments.
Generated from protobuf message google.cloud.chronicle.v1.ListRuleDeploymentsRequest
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The collection of all parents which own all rule deployments. The "-" wildcard token must be used as the rule identifier in the resource path. Format: |
↳ page_size |
int
The maximum number of rule deployments to return. The service may return fewer than this value. If unspecified, at most 100 rule deployments 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 |
↳ filter |
string
A filter that can be used to retrieve specific rule deployments. The following fields are filterable: archived, name |
getParent
Required. The collection of all parents which own all rule deployments. The
"-" wildcard token must be used as the rule identifier in the resource
path. Format:
projects/{project}/locations/{location}/instances/{instance}/rules/-
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The collection of all parents which own all rule deployments. The
"-" wildcard token must be used as the rule identifier in the resource
path. Format:
projects/{project}/locations/{location}/instances/{instance}/rules/-
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of rule deployments to return. The service may return fewer than this value. If unspecified, at most 100 rule deployments 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 rule deployments to return. The service may return fewer than this value. If unspecified, at most 100 rule deployments 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 ListRuleDeployments call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListRuleDeployments
must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A page token, received from a previous ListRuleDeployments call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListRuleDeployments
must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
A filter that can be used to retrieve specific rule deployments.
The following fields are filterable: archived, name
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
A filter that can be used to retrieve specific rule deployments.
The following fields are filterable: archived, name
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The collection of all parents which own all rule deployments. The
"-" wildcard token must be used as the rule identifier in the resource
path. Format:
|
| Returns | |
|---|---|
| Type | Description |
ListRuleDeploymentsRequest |
|