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
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Name of the Tensorboard. Format: |
↳ 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. |
getName
Output only. Name of the Tensorboard.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
string |
setName
Output only. Name of the Tensorboard.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDisplayName
Required. User provided name of this Tensorboard.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
string |
setDisplayName
Required. User provided name of this Tensorboard.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDescription
Description of this Tensorboard.
Generated from protobuf field string description = 3;
Returns | |
---|---|
Type | Description |
string |
setDescription
Description of this Tensorboard.
Generated from protobuf field string description = 3;
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
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 '/'.
Generated from protobuf field string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 '/'.
Generated from protobuf field string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getRunCount
Output only. The number of Runs stored in this Tensorboard.
Generated from protobuf field int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
setRunCount
Output only. The number of Runs stored in this Tensorboard.
Generated from protobuf field int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
Output only. Timestamp when this Tensorboard was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Tensorboard was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateTime
Output only. Timestamp when this Tensorboard was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Tensorboard was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field map<string, string> labels = 8;
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.
Generated from protobuf field map<string, string> labels = 8;
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.
Generated from protobuf field string etag = 9;
Returns | |
---|---|
Type | Description |
string |
setEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 9;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |