Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DeleteRuleRequest.
Request message for the DeleteRule method.
Generated from protobuf message google.cloud.chronicle.v1.DeleteRuleRequest
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: |
↳ force |
bool
Optional. If set to true, any retrohunts and any detections associated with the rule will also be deleted. If set to false, the call will only succeed if the rule has no associated retrohunts, including completed retrohunts, and no associated detections. Regardless of this field's value, the rule deployment associated with this rule will also be deleted. |
getName
Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
Optional. If set to true, any retrohunts and any detections associated with the rule will also be deleted. If set to false, the call will only succeed if the rule has no associated retrohunts, including completed retrohunts, and no associated detections. Regardless of this field's value, the rule deployment associated with this rule will also be deleted.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
Optional. If set to true, any retrohunts and any detections associated with the rule will also be deleted. If set to false, the call will only succeed if the rule has no associated retrohunts, including completed retrohunts, and no associated detections. Regardless of this field's value, the rule deployment associated with this rule will also be deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The name of the rule to delete. A rule revision timestamp cannot
be specified as part of the name, as deleting specific revisions is not
supported.
Format:
|
| Returns | |
|---|---|
| Type | Description |
DeleteRuleRequest |
|