- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.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 \ V1Methods
__construct
Constructor.
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
↳ update_time
↳ 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.
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ satisfies_pzi
bool
Output only. Reserved for future use.
getName
Output only. Name of the Tensorboard.
Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
string
setName
Output only. Name of the Tensorboard.
Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
var
string
$this
getDisplayName
Required. User provided name of this Tensorboard.
string
setDisplayName
Required. User provided name of this Tensorboard.
var
string
$this
getDescription
Description of this Tensorboard.
string
setDescription
Description of this Tensorboard.
var
string
$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.
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.
$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 '/'.
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 '/'.
var
string
$this
getRunCount
Output only. The number of Runs stored in this Tensorboard.
int
setRunCount
Output only. The number of Runs stored in this Tensorboard.
var
int
$this
getCreateTime
Output only. Timestamp when this Tensorboard was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Tensorboard was created.
$this
getUpdateTime
Output only. Timestamp when this Tensorboard was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Tensorboard was last updated.
$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.
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.
$this
getEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string
setEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
var
string
$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.
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.
var
bool
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this