Google Cloud Ces V1 Client - Class DeleteGuardrailRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class DeleteGuardrailRequest.

Request message for AgentService.DeleteGuardrail.

Generated from protobuf message google.cloud.ces.v1.DeleteGuardrailRequest

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the guardrail to delete.

↳ force bool

Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. * * If force = false, the deletion fails if any apps/agents still reference the guardrail. * * If force = true, all existing references from apps/agents will be removed and the guardrail will be deleted.

↳ etag string

Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.

getName

Required. The resource name of the guardrail to delete.

Returns
Type Description
string

setName

Required. The resource name of the guardrail to delete.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents.

  • If force = false, the deletion fails if any apps/agents still reference the guardrail.
  • If force = true, all existing references from apps/agents will be removed and the guardrail will be deleted.
Returns
Type Description
bool

setForce

Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents.

  • If force = false, the deletion fails if any apps/agents still reference the guardrail.
  • If force = true, all existing references from apps/agents will be removed and the guardrail will be deleted.
Parameter
Name Description
var bool
Returns
Type Description
$this

getEtag

Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.

Returns
Type Description
string

setEtag

Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The resource name of the guardrail to delete. Please see AgentServiceClient::guardrailName() for help formatting this field.

Returns
Type Description
DeleteGuardrailRequest