Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Tensorboard

Returns a new instance of GoogleCloudAiplatformV1beta1Tensorboard.



31236
31237
31238
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31236

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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 '/'. Corresponds to the JSON property blobStoragePathPrefix

Returns:

  • (String) 


31171
31172
31173
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31171

def blob_storage_path_prefix
  @blob_storage_path_prefix
end

#create_time ⇒ String

Output only. Timestamp when this Tensorboard was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


31176
31177
31178
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31176

def create_time
  @create_time
end

#description ⇒ String

Description of this Tensorboard. Corresponds to the JSON property description

Returns:

  • (String) 


31181
31182
31183
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31181

def description
  @description
end

#display_name ⇒ String

Required. User provided name of this Tensorboard. Corresponds to the JSON property displayName

Returns:

  • (String) 


31186
31187
31188
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31186

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



31192
31193
31194
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31192

def encryption_spec
  @encryption_spec
end

#etag ⇒ String

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

Returns:

  • (String) 


31198
31199
31200
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31198

def etag
  @etag
end

#is_default ⇒ Boolean Also known as: is_default?

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. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


31206
31207
31208
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31206

def is_default
  @is_default
end

#labels ⇒ Hash<String,String>

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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


31218
31219
31220
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31218

def labels
  @labels
end

#name ⇒ String

Output only. Name of the Tensorboard. Format: projects/project/locations/ location/tensorboards/tensorboard` Corresponds to the JSON propertyname`

Returns:

  • (String) 


31224
31225
31226
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31224

def name
  @name
end

#run_count ⇒ Fixnum

Output only. The number of Runs stored in this Tensorboard. Corresponds to the JSON property runCount

Returns:

  • (Fixnum) 


31229
31230
31231
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31229

def run_count
  @run_count
end

#update_time ⇒ String

Output only. Timestamp when this Tensorboard was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


31234
31235
31236
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31234

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31241
31242
31243
31244
31245
31246
31247
31248
31249
31250
31251
31252
31253
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31241

def update!(**args)
  @blob_storage_path_prefix = args[:blob_storage_path_prefix] if args.key?(:blob_storage_path_prefix)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @etag = args[:etag] if args.key?(:etag)
  @is_default = args[:is_default] if args.key?(:is_default)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @run_count = args[:run_count] if args.key?(:run_count)
  @update_time = args[:update_time] if args.key?(:update_time)
end