Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/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) ⇒ GoogleCloudAiplatformV1Tensorboard

Returns a new instance of GoogleCloudAiplatformV1Tensorboard.



37027
37028
37029
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37027

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) 


36950
36951
36952
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36950

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) 


36955
36956
36957
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36955

def create_time
  @create_time
end

#description ⇒ String

Description of this Tensorboard. Corresponds to the JSON property description

Returns:

  • (String) 


36960
36961
36962
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36960

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


36965
36966
36967
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36965

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

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

Returns:



36971
36972
36973
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36971

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) 


36977
36978
36979
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36977

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) 


36985
36986
36987
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36985

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>) 


36997
36998
36999
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36997

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) 


37003
37004
37005
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37003

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) 


37008
37009
37010
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37008

def run_count
  @run_count
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


37013
37014
37015
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37013

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


37019
37020
37021
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37019

def satisfies_pzs
  @satisfies_pzs
end

#update_time ⇒ String

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

Returns:

  • (String) 


37025
37026
37027
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37025

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



37032
37033
37034
37035
37036
37037
37038
37039
37040
37041
37042
37043
37044
37045
37046
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37032

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)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @update_time = args[:update_time] if args.key?(:update_time)
end