Class: Google::Cloud::AIPlatform::V1::Tensorboard

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/tensorboard.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.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#blob_storage_path_prefix ⇒ ::String (readonly)

Returns 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:

  • (::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 '/'.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Tensorboard was created.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Description of this Tensorboard.

Returns:

  • (::String) —

    Description of this Tensorboard.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. User provided name of this Tensorboard.

Returns:

  • (::String) —

    Required. User provided name of this Tensorboard.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns 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:



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

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

Returns:

  • (::String) —

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



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#is_default ⇒ ::Boolean

Returns 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:

  • (::Boolean) —

    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.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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:

  • (::Google::Protobuf::Map{::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.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#run_count ⇒ ::Integer (readonly)

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

Returns:

  • (::Integer) —

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



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Tensorboard was last updated.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard.rb', line 86

class Tensorboard
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end