Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class TensorboardTimeSeries.
TensorboardTimeSeries maps to times series produced in training runs
Generated from protobuf message google.cloud.aiplatform.v1.TensorboardTimeSeries
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Name of the TensorboardTimeSeries. |
↳ display_name |
string
Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource). |
↳ description |
string
Description of this TensorboardTimeSeries. |
↳ value_type |
int
Required. Immutable. Type of TensorboardTimeSeries value. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this TensorboardTimeSeries was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this TensorboardTimeSeries was last updated. |
↳ etag |
string
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
↳ plugin_name |
string
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob |
↳ plugin_data |
string
Data of the current plugin, with the size limited to 65KB. |
↳ metadata |
Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata
Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries. |
getName
Output only. Name of the TensorboardTimeSeries.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Name of the TensorboardTimeSeries.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. User provided name of this TensorboardTimeSeries.
This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. User provided name of this TensorboardTimeSeries.
This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of this TensorboardTimeSeries.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of this TensorboardTimeSeries.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValueType
Required. Immutable. Type of TensorboardTimeSeries value.
| Returns | |
|---|---|
| Type | Description |
int | |
setValueType
Required. Immutable. Type of TensorboardTimeSeries value.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this TensorboardTimeSeries was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this TensorboardTimeSeries was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when this TensorboardTimeSeries was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this TensorboardTimeSeries was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPluginName
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
| Returns | |
|---|---|
| Type | Description |
string | |
setPluginName
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPluginData
Data of the current plugin, with the size limited to 65KB.
| Returns | |
|---|---|
| Type | Description |
string | |
setPluginData
Data of the current plugin, with the size limited to 65KB.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetadata
Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata|null | |
hasMetadata
clearMetadata
setMetadata
Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata
|
| Returns | |
|---|---|
| Type | Description |
$this | |