Class: Google::Cloud::AIPlatform::V1::NotebookExecutionJob

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

Overview

NotebookExecutionJob represents an instance of a notebook execution.

Defined Under Namespace

Classes: CustomEnvironmentSpec, DataformRepositorySource, DirectNotebookSource, GcsNotebookSource, LabelsEntry, WorkbenchRuntime

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when this NotebookExecutionJob was created.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#custom_environment_spec ⇒ ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec

Returns The custom compute configuration for an execution job.

Note: The following fields are mutually exclusive: custom_environment_spec, notebook_runtime_template_resource_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#dataform_repository_source ⇒ ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource

Returns The Dataform Repository pointing to a single file notebook repository.

Note: The following fields are mutually exclusive: dataform_repository_source, gcs_notebook_source, direct_notebook_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#direct_notebook_source ⇒ ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource

Returns The contents of an input notebook file.

Note: The following fields are mutually exclusive: direct_notebook_source, dataform_repository_source, gcs_notebook_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

Returns:

  • (::String) —

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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 execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#execution_timeout ⇒ ::Google::Protobuf::Duration

Returns Max running time of the execution job in seconds (default 86400s / 24 hrs).

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#execution_user ⇒ ::String

Returns The user email to run the execution as. Only supported by Colab runtimes.

Note: The following fields are mutually exclusive: execution_user, service_account. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The user email to run the execution as. Only supported by Colab runtimes.

    Note: The following fields are mutually exclusive: execution_user, service_account. If a field in that set is populated, all other fields in the set will automatically be cleared.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#gcs_notebook_source ⇒ ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource

Returns The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

Note: The following fields are mutually exclusive: gcs_notebook_source, dataform_repository_source, direct_notebook_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource) —

    The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

    Note: The following fields are mutually exclusive: gcs_notebook_source, dataform_repository_source, direct_notebook_source. If a field in that set is populated, all other fields in the set will automatically be cleared.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#gcs_output_uri ⇒ ::String

Returns The Cloud Storage location to upload the result to. Format: gs://bucket-name.

Returns:

  • (::String) —

    The Cloud Storage location to upload the result to. Format: gs://bucket-name



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#job_state ⇒ ::Google::Cloud::AIPlatform::V1::JobState (readonly)

Returns Output only. The state of the NotebookExecutionJob.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#kernel_name ⇒ ::String

Returns The name of the kernel to use during notebook execution. If unset, the default kernel is used.

Returns:

  • (::String) —

    The name of the kernel to use during notebook execution. If unset, the default kernel is used.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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 NotebookExecutionJobs.

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. 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 NotebookExecutionJobs.

    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. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}.

Returns:

  • (::String) —

    Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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_template_resource_name ⇒ ::String

Returns The NotebookRuntimeTemplate to source compute configuration from.

Note: The following fields are mutually exclusive: notebook_runtime_template_resource_name, custom_environment_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The NotebookRuntimeTemplate to source compute configuration from.

    Note: The following fields are mutually exclusive: notebook_runtime_template_resource_name, custom_environment_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#schedule_resource_name ⇒ ::String

Returns The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}.

Returns:

  • (::String) —

    The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

Returns The service account to run the execution as.

Note: The following fields are mutually exclusive: service_account, execution_user. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The service account to run the execution as.

    Note: The following fields are mutually exclusive: service_account, execution_user. If a field in that set is populated, all other fields in the set will automatically be cleared.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#status ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

Returns:

  • (::Google::Rpc::Status) —

    Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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 NotebookExecutionJob was most recently updated.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#workbench_runtime ⇒ ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::WorkbenchRuntime

Returns The Workbench runtime configuration to use for the notebook execution.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb', line 119

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

  # The Dataform Repository containing the input notebook.
  # @!attribute [rw] dataform_repository_resource_name
  #   @return [::String]
  #     The resource name of the Dataform Repository. Format:
  #     `projects/{project_id}/locations/{location}/repositories/{repository_id}`
  # @!attribute [rw] commit_sha
  #   @return [::String]
  #     The commit SHA to read repository with. If unset, the file will be read
  #     at HEAD.
  class DataformRepositorySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Cloud Storage uri for the input notebook.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The Cloud Storage uri pointing to the ipynb file. Format:
  #     `gs://bucket/notebook_file.ipynb`
  # @!attribute [rw] generation
  #   @return [::String]
  #     The version of the Cloud Storage object to read. If unset, the current
  #     version of the object is read. See
  #     https://cloud.google.com/storage/docs/metadata#generation-number.
  class GcsNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The content of the input notebook in ipynb format.
  # @!attribute [rw] content
  #   @return [::String]
  #     The base64-encoded contents of the input notebook file.
  class DirectNotebookSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compute configuration to use for an execution job.
  # @!attribute [rw] machine_spec
  #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
  #     The specification of a single machine for the execution job.
  # @!attribute [rw] persistent_disk_spec
  #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
  #     The specification of a persistent disk to attach for the execution job.
  # @!attribute [rw] network_spec
  #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
  #     The network configuration to use for the execution job.
  class CustomEnvironmentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for a Workbench Instances-based environment.
  class WorkbenchRuntime
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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