View Source GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJob (google_api_ai_platform v0.13.0)

NotebookExecutionJob represents an instance of a notebook execution.

Attributes

  • createTime (type: DateTime.t, default: nil) - Output only. Timestamp when this NotebookExecutionJob was created.
  • dataformRepositorySource (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource.t, default: nil) - The Dataform Repository pointing to a single file notebook repository.
  • directNotebookSource (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource.t, default: nil) - The contents of an input notebook file.
  • displayName (type: String.t, default: nil) - The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  • encryptionSpec (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1EncryptionSpec.t, default: nil) - Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookService.NotebookRuntimeTemplate has an encryption spec.
  • executionTimeout (type: String.t, default: nil) - Max running time of the execution job in seconds (default 86400s / 24 hrs).
  • executionUser (type: String.t, default: nil) - The user email to run the execution as. Only supported by Colab runtimes.
  • gcsNotebookSource (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource.t, default: nil) - The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
  • gcsOutputUri (type: String.t, default: nil) - The Cloud Storage location to upload the result to. Format: gs://bucket-name
  • jobState (type: String.t, default: nil) - Output only. The state of the NotebookExecutionJob.
  • labels (type: map(), default: nil) - 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.
  • name (type: String.t, default: nil) - Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
  • notebookRuntimeTemplateResourceName (type: String.t, default: nil) - The NotebookRuntimeTemplate to source compute configuration from.
  • scheduleResourceName (type: String.t, default: nil) - Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
  • serviceAccount (type: String.t, default: nil) - The service account to run the execution as.
  • status (type: GoogleApi.AIPlatform.V1.Model.GoogleRpcStatus.t, default: nil) - Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
  • updateTime (type: DateTime.t, default: nil) - Output only. Timestamp when this NotebookExecutionJob was most recently updated.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJob{
    createTime: DateTime.t() | nil,
    dataformRepositorySource:
      GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource.t()
      | nil,
    directNotebookSource:
      GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource.t()
      | nil,
    displayName: String.t() | nil,
    encryptionSpec:
      GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1EncryptionSpec.t()
      | nil,
    executionTimeout: String.t() | nil,
    executionUser: String.t() | nil,
    gcsNotebookSource:
      GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource.t()
      | nil,
    gcsOutputUri: String.t() | nil,
    jobState: String.t() | nil,
    labels: map() | nil,
    name: String.t() | nil,
    notebookRuntimeTemplateResourceName: String.t() | nil,
    scheduleResourceName: String.t() | nil,
    serviceAccount: String.t() | nil,
    status: GoogleApi.AIPlatform.V1.Model.GoogleRpcStatus.t() | nil,
    updateTime: DateTime.t() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.