Class DeleteRuleRequest.Builder (0.21.0)

public static final class DeleteRuleRequest.Builder extends GeneratedMessage.Builder<DeleteRuleRequest.Builder> implements DeleteRuleRequestOrBuilder

Request message for the DeleteRule method.

Protobuf type google.cloud.chronicle.v1.DeleteRuleRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public DeleteRuleRequest build()
Returns
Type Description
DeleteRuleRequest

buildPartial()

public DeleteRuleRequest buildPartial()
Returns
Type Description
DeleteRuleRequest

clear()

public DeleteRuleRequest.Builder clear()
Returns
Type Description
DeleteRuleRequest.Builder
Overrides

clearForce()

public DeleteRuleRequest.Builder clearForce()

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 force = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeleteRuleRequest.Builder

This builder for chaining.

clearName()

public DeleteRuleRequest.Builder clearName()

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 name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
DeleteRuleRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public DeleteRuleRequest getDefaultInstanceForType()
Returns
Type Description
DeleteRuleRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getForce()

public boolean 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 force = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The force.

getName()

public String 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 name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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 name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeleteRuleRequest other)

public DeleteRuleRequest.Builder mergeFrom(DeleteRuleRequest other)
Parameter
Name Description
other DeleteRuleRequest
Returns
Type Description
DeleteRuleRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeleteRuleRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRuleRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DeleteRuleRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DeleteRuleRequest.Builder
Overrides

setForce(boolean value)

public DeleteRuleRequest.Builder setForce(boolean value)

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 force = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The force to set.

Returns
Type Description
DeleteRuleRequest.Builder

This builder for chaining.

setName(String value)

public DeleteRuleRequest.Builder setName(String value)

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 name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DeleteRuleRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeleteRuleRequest.Builder setNameBytes(ByteString value)

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 name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DeleteRuleRequest.Builder

This builder for chaining.