Class: Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb

Overview

A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when this NotebookRuntimeTemplate was created.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#data_persistent_disk_spec ⇒ ::Google::Cloud::AIPlatform::V1::PersistentDiskSpec

Returns Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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 The description of the NotebookRuntimeTemplate.

Returns:

  • (::String) —

    The description of the NotebookRuntimeTemplate.



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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 the notebook runtime.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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 consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

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



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#euc_config ⇒ ::Google::Cloud::AIPlatform::V1::NotebookEucConfig

Returns EUC configuration of the NotebookRuntimeTemplate.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#idle_shutdown_config ⇒ ::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig

Returns The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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 (readonly)

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead.

The default template to use if not specified.

Returns:

  • (::Boolean) —

    Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead.

    The default template to use if not specified.



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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 the NotebookRuntimeTemplates.

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.

See https://goo.gl/xmQnxf for more information and examples of labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The labels with user-defined metadata to organize the NotebookRuntimeTemplates.

    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.

    See https://goo.gl/xmQnxf for more information and examples of labels.



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#machine_spec ⇒ ::Google::Cloud::AIPlatform::V1::MachineSpec

Returns Optional. Immutable. The specification of a single machine for the template.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

Returns The resource name of the NotebookRuntimeTemplate.

Returns:

  • (::String) —

    The resource name of the NotebookRuntimeTemplate.



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#network_spec ⇒ ::Google::Cloud::AIPlatform::V1::NetworkSpec

Returns Optional. Network spec.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#network_tags ⇒ ::Array<::String>

Returns Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Returns:

  • (::Array<::String>) —

    Optional. The Compute Engine tags to add to runtime (see Tagging instances).



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#notebook_runtime_type ⇒ ::Google::Cloud::AIPlatform::V1::NotebookRuntimeType

Returns Optional. Immutable. The type of the notebook runtime template.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#service_account ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead.

The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#shielded_vm_config ⇒ ::Google::Cloud::AIPlatform::V1::ShieldedVmConfig

Returns Optional. Immutable. Runtime Shielded VM spec.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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

#software_config ⇒ ::Google::Cloud::AIPlatform::V1::NotebookSoftwareConfig

Returns Optional. The notebook software configuration of the notebook runtime.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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 NotebookRuntimeTemplate was most recently updated.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 120

class NotebookRuntimeTemplate
  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