Google Cloud Ai Platform V1 Client - Class DeleteContextRequest (0.26.2)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DeleteContextRequest.

Request message for MetadataService.DeleteContext.

Generated from protobuf message google.cloud.aiplatform.v1.DeleteContextRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the Context to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

↳ force bool

The force deletion semantics is still undefined. Users should not use this field.

↳ etag string

Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.

getName

Required. The resource name of the Context to delete.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

Returns
TypeDescription
string

setName

Required. The resource name of the Context to delete.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getForce

The force deletion semantics is still undefined.

Users should not use this field.

Returns
TypeDescription
bool

setForce

The force deletion semantics is still undefined.

Users should not use this field.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEtag

Optional. The etag of the Context to delete.

If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.

Returns
TypeDescription
string

setEtag

Optional. The etag of the Context to delete.

If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The resource name of the Context to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} Please see Google\Cloud\AIPlatform\V1\MetadataServiceClient::contextName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\DeleteContextRequest