Google Cloud Ai Platform V1 Client - Class NotebookExecutionJob (1.13.1)

Version latest

• 1.13.1 (latest)
• 1.13.0
• 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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
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	NotebookExecutionJob\DirectNotebookSource The contents of an input notebook file.
↳ notebook_runtime_template_resource_name	string The NotebookRuntimeTemplate to source compute configuration from.
↳ custom_environment_spec	NotebookExecutionJob\CustomEnvironmentSpec The custom compute configuration for an execution job.
↳ 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	Google\Protobuf\Timestamp Output only. Timestamp when this NotebookExecutionJob was created.
↳ 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.

Returns
Type	Description
NotebookExecutionJob\DataformRepositorySource|null

hasDataformRepositorySource

setDataformRepositorySource

The Dataform Repository pointing to a single file notebook repository.

Parameter
Name	Description
var	NotebookExecutionJob\DataformRepositorySource

Returns
Type	Description
$this

getGcsNotebookSource

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

Returns
Type	Description
NotebookExecutionJob\GcsNotebookSource|null

hasGcsNotebookSource

setGcsNotebookSource

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

Parameter
Name	Description
var	NotebookExecutionJob\GcsNotebookSource

Returns
Type	Description
$this

getDirectNotebookSource

The contents of an input notebook file.

Returns
Type	Description
NotebookExecutionJob\DirectNotebookSource|null

hasDirectNotebookSource

setDirectNotebookSource

The contents of an input notebook file.

Parameter
Name	Description
var	NotebookExecutionJob\DirectNotebookSource

Returns
Type	Description
$this

getNotebookRuntimeTemplateResourceName

The NotebookRuntimeTemplate to source compute configuration from.

Returns
Type	Description
string

hasNotebookRuntimeTemplateResourceName

setNotebookRuntimeTemplateResourceName

The NotebookRuntimeTemplate to source compute configuration from.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCustomEnvironmentSpec

The custom compute configuration for an execution job.

Returns
Type	Description
NotebookExecutionJob\CustomEnvironmentSpec|null

hasCustomEnvironmentSpec

setCustomEnvironmentSpec

The custom compute configuration for an execution job.

Parameter
Name	Description
var	NotebookExecutionJob\CustomEnvironmentSpec

Returns
Type	Description
$this

getGcsOutputUri

The Cloud Storage location to upload the result to. Format: gs://bucket-name

Returns
Type	Description
string

hasGcsOutputUri

setGcsOutputUri

The Cloud Storage location to upload the result to. Format: gs://bucket-name

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getExecutionUser

The user email to run the execution as. Only supported by Colab runtimes.

Returns
Type	Description
string

hasExecutionUser

setExecutionUser

The user email to run the execution as. Only supported by Colab runtimes.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getServiceAccount

The service account to run the execution as.

Returns
Type	Description
string

hasServiceAccount

setServiceAccount

The service account to run the execution as.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getWorkbenchRuntime

The Workbench runtime configuration to use for the notebook execution.

Returns
Type	Description
NotebookExecutionJob\WorkbenchRuntime|null

hasWorkbenchRuntime

setWorkbenchRuntime

The Workbench runtime configuration to use for the notebook execution.

Parameter
Name	Description
var	NotebookExecutionJob\WorkbenchRuntime

Returns
Type	Description
$this

getName

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

Returns
Type	Description
string

setName

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getExecutionTimeout

Max running time of the execution job in seconds (default 86400s / 24 hrs).

Returns
Type	Description
Google\Protobuf\Duration|null

hasExecutionTimeout

clearExecutionTimeout

setExecutionTimeout

Max running time of the execution job in seconds (default 86400s / 24 hrs).

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getScheduleResourceName

Output only. The Schedule resource name if this job is triggered by one.

Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

Returns
Type	Description
string

setScheduleResourceName

Output only. The Schedule resource name if this job is triggered by one.

Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getJobState

Output only. The state of the NotebookExecutionJob.

Returns
Type	Description
int

setJobState

Output only. The state of the NotebookExecutionJob.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStatus

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

Returns
Type	Description
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

Parameter
Name	Description
var	Google\Rpc\Status

Returns
Type	Description
$this

getCreateTime

Output only. Timestamp when this NotebookExecutionJob was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this NotebookExecutionJob was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getKernelName

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

Returns
Type	Description
string

setKernelName

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEncryptionSpec

Customer-managed encryption key spec for the notebook execution job.

This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

Returns
Type	Description
EncryptionSpec|null

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.

Parameter
Name	Description
var	EncryptionSpec

Returns
Type	Description
$this

getNotebookSource

Returns
Type	Description
string

getEnvironmentSpec

Returns
Type	Description
string

getExecutionSink

Returns
Type	Description
string

getExecutionIdentity

Returns
Type	Description
string

getRuntimeEnvironment

Returns
Type	Description
string