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
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 will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified. |
↳ tensorboard_time_series |
Google\Cloud\AIPlatform\V1\TensorboardTimeSeries
Required. The TensorboardTimeSeries' |
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 will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
| 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 will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
| 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}
Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardTimeSeries tensorboard_time_series = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\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}
Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardTimeSeries tensorboard_time_series = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\TensorboardTimeSeries
|
| Returns | |
|---|---|
| Type | Description |
$this | |