Google Cloud Ai Platform V1 Client - Class UpdateTensorboardExperimentRequest (0.28.0)

Version 0.28.0

• 0.39.0 (latest)
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

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

Request message for TensorboardService.UpdateTensorboardExperiment.

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

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 TensorboardExperiment 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_experiment	Google\Cloud\AIPlatform\V1\TensorboardExperiment Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment 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 TensorboardExperiment 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

getTensorboardExperiment

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

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

hasTensorboardExperiment

clearTensorboardExperiment

setTensorboardExperiment

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

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\TensorboardExperiment

Returns
Type	Description
$this

static::build

Parameters
Name	Description
tensorboardExperiment	Google\Cloud\AIPlatform\V1\TensorboardExperiment Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
updateMask	Google\Protobuf\FieldMask Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment 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\UpdateTensorboardExperimentRequest