- 1.67.0 (latest)
- 1.66.0
- 1.65.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
NotebookExecutionJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
NotebookExecutionJob represents an instance of a notebook execution.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
---|---|
Name | Description |
dataform_repository_source |
google.cloud.aiplatform_v1.types.NotebookExecutionJob.DataformRepositorySource
The Dataform Repository pointing to a single file notebook repository. This field is a member of oneof _ notebook_source .
|
gcs_notebook_source |
google.cloud.aiplatform_v1.types.NotebookExecutionJob.GcsNotebookSource
The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
This field is a member of oneof _ notebook_source .
|
direct_notebook_source |
google.cloud.aiplatform_v1.types.NotebookExecutionJob.DirectNotebookSource
The contents of an input notebook file. This field is a member of oneof _ notebook_source .
|
notebook_runtime_template_resource_name |
str
The NotebookRuntimeTemplate to source compute configuration from. This field is a member of oneof _ environment_spec .
|
gcs_output_uri |
str
The Cloud Storage location to upload the result to. Format: gs://bucket-name
This field is a member of oneof _ execution_sink .
|
execution_user |
str
The user email to run the execution as. Only supported by Colab runtimes. This field is a member of oneof _ execution_identity .
|
service_account |
str
The service account to run the execution as. This field is a member of oneof _ execution_identity .
|
name |
str
Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
|
display_name |
str
The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
execution_timeout |
google.protobuf.duration_pb2.Duration
Max running time of the execution job in seconds (default 86400s / 24 hrs). |
schedule_resource_name |
str
Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
|
job_state |
google.cloud.aiplatform_v1.types.JobState
Output only. The state of the NotebookExecutionJob. |
status |
google.rpc.status_pb2.Status
Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this NotebookExecutionJob was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this NotebookExecutionJob was most recently updated. |
labels |
MutableMapping[str, str]
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. |
encryption_spec |
google.cloud.aiplatform_v1.types.EncryptionSpec
Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookService.NotebookRuntimeTemplate][] has an encryption spec. |
Classes
DataformRepositorySource
DataformRepositorySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Dataform Repository containing the input notebook.
DirectNotebookSource
DirectNotebookSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The content of the input notebook in ipynb format.
GcsNotebookSource
GcsNotebookSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The Cloud Storage uri for the input notebook.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
Methods
NotebookExecutionJob
NotebookExecutionJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)
NotebookExecutionJob represents an instance of a notebook execution.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields