Google Cloud Ai Platform V1 Client - Class Tensorboard (0.39.0)

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

Tensorboard is a physical database that stores users' training metrics.

A default Tensorboard is provided in each region of a Google Cloud project. If needed users can also create extra Tensorboards in their projects.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
↳ display_name string

Required. User provided name of this Tensorboard.
↳ description string

Description of this Tensorboard.
↳ encryption_spec Google\Cloud\AIPlatform\V1\EncryptionSpec

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
↳ blob_storage_path_prefix string

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
↳ run_count int

Output only. The number of Runs stored in this Tensorboard.
↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this Tensorboard was created.
↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this Tensorboard was last updated.
↳ labels array|Google\Protobuf\Internal\MapField

The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
↳ etag string

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

Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.

getName

Output only. Name of the Tensorboard.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns
Type Description
string

setName

Output only. Name of the Tensorboard.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. User provided name of this Tensorboard.

Returns
Type Description
string

setDisplayName

Required. User provided name of this Tensorboard.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Description of this Tensorboard.

Returns
Type Description
string

setDescription

Description of this Tensorboard.

Parameter
Name Description
var string
Returns
Type Description
$this

getEncryptionSpec

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

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

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\EncryptionSpec
Returns
Type Description
$this

getBlobStoragePathPrefix

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

Returns
Type Description
string

setBlobStoragePathPrefix

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

Parameter
Name Description
var string
Returns
Type Description
$this

getRunCount

Output only. The number of Runs stored in this Tensorboard.

Returns
Type Description
int

setRunCount

Output only. The number of Runs stored in this Tensorboard.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this Tensorboard was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this Tensorboard was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp when this Tensorboard was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this Tensorboard was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

The labels with user-defined metadata to organize your Tensorboards.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

The labels with user-defined metadata to organize your Tensorboards.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
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

getIsDefault

Used to indicate if the TensorBoard instance is the default one.

Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.

Returns
Type Description
bool

setIsDefault

Used to indicate if the TensorBoard instance is the default one.

Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.

Parameter
Name Description
var bool
Returns
Type Description
$this