Reference documentation and code samples for the Google Cloud Dataform V1 Client class NotebookAction.
Represents a workflow action that will run against a Notebook runtime.
Generated from protobuf message google.cloud.dataform.v1.WorkflowInvocationAction.NotebookAction
Namespace
Google \ Cloud \ Dataform \ V1 \ WorkflowInvocationAction
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ contents
string
Output only. The code contents of a Notebook to be run.
↳ job_id
string
Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.
getContents
Output only. The code contents of a Notebook to be run.
Returns
Type
Description
string
setContents
Output only. The code contents of a Notebook to be run.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getJobId
Output only. The ID of the Vertex job that executed the notebook in
contents and also the ID used for the outputs created in Google Cloud
Storage buckets. Only set once the job has started to run.
Returns
Type
Description
string
setJobId
Output only. The ID of the Vertex job that executed the notebook in
contents and also the ID used for the outputs created in Google Cloud
Storage buckets. Only set once the job has started to run.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataform V1 Client - Class NotebookAction (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dataform/latest/V1.WorkflowInvocationAction.NotebookAction)\n- [0.8.0](/php/docs/reference/cloud-dataform/0.8.0/V1.WorkflowInvocationAction.NotebookAction)\n- [0.7.0](/php/docs/reference/cloud-dataform/0.7.0/V1.WorkflowInvocationAction.NotebookAction)\n- [0.6.0](/php/docs/reference/cloud-dataform/0.6.0/V1.WorkflowInvocationAction.NotebookAction)\n- [0.5.1](/php/docs/reference/cloud-dataform/0.5.1/V1.WorkflowInvocationAction.NotebookAction)\n- [0.4.7](/php/docs/reference/cloud-dataform/0.4.7/V1.WorkflowInvocationAction.NotebookAction)\n- [0.3.0](/php/docs/reference/cloud-dataform/0.3.0/V1.WorkflowInvocationAction.NotebookAction)\n- [0.2.3](/php/docs/reference/cloud-dataform/0.2.3/V1.WorkflowInvocationAction.NotebookAction)\n- [0.1.6](/php/docs/reference/cloud-dataform/0.1.6/V1.WorkflowInvocationAction.NotebookAction) \nReference documentation and code samples for the Google Cloud Dataform V1 Client class NotebookAction.\n\nRepresents a workflow action that will run against a Notebook runtime.\n\nGenerated from protobuf message `google.cloud.dataform.v1.WorkflowInvocationAction.NotebookAction`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataform \\\\ V1 \\\\ WorkflowInvocationAction\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getContents\n\nOutput only. The code contents of a Notebook to be run.\n\n### setContents\n\nOutput only. The code contents of a Notebook to be run.\n\n### getJobId\n\nOutput only. The ID of the Vertex job that executed the notebook in\ncontents and also the ID used for the outputs created in Google Cloud\nStorage buckets. Only set once the job has started to run.\n\n### setJobId\n\nOutput only. The ID of the Vertex job that executed the notebook in\ncontents and also the ID used for the outputs created in Google Cloud\nStorage buckets. Only set once the job has started to run."]]