Class NotebookExecutionJob (1.51.0)

Version 1.51.0

• 1.56.0 (latest)
• 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_v1beta1.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_v1beta1.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.
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_v1beta1.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.

Classes

DataformRepositorySource

DataformRepositorySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The Dataform Repository containing the input notebook.

GcsNotebookSource

GcsNotebookSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The Cloud Storage uri for the input notebook.

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