Google Cloud Ai Platform V1 Client - Class UpdateTensorboardRequest (0.37.1)

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

Request message for TensorboardService.UpdateTensorboard.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ update_mask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
↳ tensorboard Google\Cloud\AIPlatform\V1\Tensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getTensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns
Type Description
Google\Cloud\AIPlatform\V1\Tensorboard|null

hasTensorboard

clearTensorboard

setTensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\Tensorboard
Returns
Type Description
$this

static::build

Parameters
Name Description
tensorboard Google\Cloud\AIPlatform\V1\Tensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
updateMask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
Returns
Type Description
Google\Cloud\AIPlatform\V1\UpdateTensorboardRequest