Class NotebookExecutionJob (1.53.0)

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`.
`direct_notebook_source`	`google.cloud.aiplatform_v1beta1.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_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.
`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.

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, .Message]` 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 `mapping` is a mapping type or there are keyword parameters.

Methods

NotebookExecutionJob

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