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.
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: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
↳ 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}
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}
var
string
$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.
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.
var
bool
$this
static::build
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: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
Please see RuleServiceClient::ruleName()
for help formatting this field.
