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

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
Name Description
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
Type Description
string

setName

Required. The resource name of the Context to delete.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

The force deletion semantics is still undefined.

Users should not use this field.

Returns
Type Description
bool

setForce

The force deletion semantics is still undefined.

Users should not use this field.

Parameter
Name Description
var bool
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
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
Type Description
Google\Cloud\AIPlatform\V1\DeleteContextRequest