Google Cloud Ai Platform V1 Client - Class TensorboardTimeSeries (0.31.0)

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

Output only. Name of the TensorboardTimeSeries.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Description of this TensorboardTimeSeries.

Returns
TypeDescription
string

setDescription

Description of this TensorboardTimeSeries.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValueType

Required. Immutable. Type of TensorboardTimeSeries value.

Returns
TypeDescription
int

setValueType

Required. Immutable. Type of TensorboardTimeSeries value.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. Timestamp when this TensorboardTimeSeries was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this TensorboardTimeSeries was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Timestamp when this TensorboardTimeSeries was last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this TensorboardTimeSeries was last updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEtag

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns
TypeDescription
string

setEtag

Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPluginName

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

Returns
TypeDescription
string

setPluginName

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPluginData

Data of the current plugin, with the size limited to 65KB.

Returns
TypeDescription
string

setPluginData

Data of the current plugin, with the size limited to 65KB.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMetadata

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata|null

hasMetadata

clearMetadata

setMetadata

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata
Returns
TypeDescription
$this