Google Cloud Ai Platform V1 Client - Class UpdateTensorboardTimeSeriesRequest (1.13.0)

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

Request message for TensorboardService.UpdateTensorboardTimeSeries.

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

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 TensorboardTimeSeries 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_time_series TensorboardTimeSeries

Required. The TensorboardTimeSeries' name field is used to identify the TensorboardTimeSeries to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

getUpdateMask

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

getTensorboardTimeSeries

Required. The TensorboardTimeSeries' name field is used to identify the TensorboardTimeSeries to be updated.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns
Type Description
TensorboardTimeSeries|null

hasTensorboardTimeSeries

clearTensorboardTimeSeries

setTensorboardTimeSeries

Required. The TensorboardTimeSeries' name field is used to identify the TensorboardTimeSeries to be updated.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Parameter
Name Description
var TensorboardTimeSeries
Returns
Type Description
$this

static::build

Parameters
Name Description
tensorboardTimeSeries TensorboardTimeSeries

Required. The TensorboardTimeSeries' name field is used to identify the TensorboardTimeSeries to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
updateMask Google\Protobuf\FieldMask

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