Google Cloud Ai Platform V1 Client - Class UpdateContextRequest (1.13.1)

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

Request message for MetadataService.UpdateContext.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ context`	`Context` Required. The Context containing updates. The Context's Context.name field is used to identify the Context to be updated. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`↳ update_mask`	`Google\Protobuf\FieldMask` Optional. A FieldMask indicating which fields should be updated.
`↳ allow_missing`	`bool` If set to true, and the Context is not found, a new Context is created.

getContext

Required. The Context containing updates.

The Context's Context.name field is used to identify the Context to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

Returns
Type	Description
`Context\|null`

hasContext

clearContext

setContext

Required. The Context containing updates.

The Context's Context.name field is used to identify the Context to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

Parameter
Name	Description
`var`	`Context`

Returns
Type	Description
`$this`

getUpdateMask

Optional. A FieldMask indicating which fields should be updated.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. A FieldMask indicating which fields should be updated.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getAllowMissing

If set to true, and the Context is not found, a new Context is created.

Returns
Type	Description
`bool`

setAllowMissing

If set to true, and the Context is not found, a new Context is created.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`context`	`Context` Required. The Context containing updates. The Context's Context.name field is used to identify the Context to be updated. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`updateMask`	`Google\Protobuf\FieldMask` Optional. A FieldMask indicating which fields should be updated.

Returns
Type	Description
`UpdateContextRequest`