- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class NotebookExecutionJob.
NotebookExecutionJob represents an instance of a notebook execution.
Generated from protobuf message google.cloud.aiplatform.v1.NotebookExecutionJob
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ dataform_repository_source
NotebookExecutionJob\DataformRepositorySource
The Dataform Repository pointing to a single file notebook repository.
↳ gcs_notebook_source
NotebookExecutionJob\GcsNotebookSource
The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
↳ direct_notebook_source
↳ notebook_runtime_template_resource_name
string
The NotebookRuntimeTemplate to source compute configuration from.
↳ custom_environment_spec
↳ gcs_output_uri
string
The Cloud Storage location to upload the result to. Format: gs://bucket-name
↳ execution_user
string
The user email to run the execution as. Only supported by Colab runtimes.
↳ service_account
string
The service account to run the execution as.
↳ workbench_runtime
NotebookExecutionJob\WorkbenchRuntime
The Workbench runtime configuration to use for the notebook execution.
↳ name
string
Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
↳ display_name
string
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
Max running time of the execution job in seconds (default 86400s / 24 hrs).
↳ schedule_resource_name
string
Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
↳ job_state
int
Output only. The state of the NotebookExecutionJob.
↳ status
Google\Rpc\Status
Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
↳ create_time
↳ update_time
Google\Protobuf\Timestamp
Output only. Timestamp when this NotebookExecutionJob was most recently updated.
↳ labels
array| Google\Protobuf\Internal\MapField
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.
↳ kernel_name
string
The name of the kernel to use during notebook execution. If unset, the default kernel is used.
↳ encryption_spec
EncryptionSpec
Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
getDataformRepositorySource
The Dataform Repository pointing to a single file notebook repository.
hasDataformRepositorySource
setDataformRepositorySource
The Dataform Repository pointing to a single file notebook repository.
$this
getGcsNotebookSource
The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
hasGcsNotebookSource
setGcsNotebookSource
The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
$this
getDirectNotebookSource
The contents of an input notebook file.
hasDirectNotebookSource
setDirectNotebookSource
The contents of an input notebook file.
$this
getNotebookRuntimeTemplateResourceName
The NotebookRuntimeTemplate to source compute configuration from.
string
hasNotebookRuntimeTemplateResourceName
setNotebookRuntimeTemplateResourceName
The NotebookRuntimeTemplate to source compute configuration from.
var
string
$this
getCustomEnvironmentSpec
The custom compute configuration for an execution job.
hasCustomEnvironmentSpec
setCustomEnvironmentSpec
The custom compute configuration for an execution job.
$this
getGcsOutputUri
The Cloud Storage location to upload the result to. Format: gs://bucket-name
string
hasGcsOutputUri
setGcsOutputUri
The Cloud Storage location to upload the result to. Format: gs://bucket-name
var
string
$this
getExecutionUser
The user email to run the execution as. Only supported by Colab runtimes.
string
hasExecutionUser
setExecutionUser
The user email to run the execution as. Only supported by Colab runtimes.
var
string
$this
getServiceAccount
The service account to run the execution as.
string
hasServiceAccount
setServiceAccount
The service account to run the execution as.
var
string
$this
getWorkbenchRuntime
The Workbench runtime configuration to use for the notebook execution.
hasWorkbenchRuntime
setWorkbenchRuntime
The Workbench runtime configuration to use for the notebook execution.
$this
getName
Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
string
setName
Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
var
string
$this
getDisplayName
The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string
setDisplayName
The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
var
string
$this
getExecutionTimeout
Max running time of the execution job in seconds (default 86400s / 24 hrs).
hasExecutionTimeout
clearExecutionTimeout
setExecutionTimeout
Max running time of the execution job in seconds (default 86400s / 24 hrs).
$this
getScheduleResourceName
Output only. The Schedule resource name if this job is triggered by one.
Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
string
setScheduleResourceName
Output only. The Schedule resource name if this job is triggered by one.
Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
var
string
$this
getJobState
Output only. The state of the NotebookExecutionJob.
int
setJobState
Output only. The state of the NotebookExecutionJob.
var
int
$this
getStatus
Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
hasStatus
clearStatus
setStatus
Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
$this
getCreateTime
Output only. Timestamp when this NotebookExecutionJob was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this NotebookExecutionJob was created.
$this
getUpdateTime
Output only. Timestamp when this NotebookExecutionJob was most recently updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this NotebookExecutionJob was most recently updated.
$this
getLabels
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.
setLabels
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.
$this
getKernelName
The name of the kernel to use during notebook execution. If unset, the default kernel is used.
string
setKernelName
The name of the kernel to use during notebook execution. If unset, the default kernel is used.
var
string
$this
getEncryptionSpec
Customer-managed encryption key spec for the notebook execution job.
This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
Customer-managed encryption key spec for the notebook execution job.
This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
$this
getNotebookSource
string
getEnvironmentSpec
string
getExecutionSink
string
getExecutionIdentity
string
getRuntimeEnvironment
string
