Reference documentation and code samples for the Google Cloud Notebooks V2 Client class DiagnosticConfig.
Defines flags that are used to run the diagnostic tool
Generated from protobuf messagegoogle.cloud.notebooks.v2.DiagnosticConfig
Namespace
Google \ Cloud \ Notebooks \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ gcs_bucket
string
Required. User Cloud Storage bucket location (REQUIRED). Must be formatted with path prefix (gs://$GCS_BUCKET). Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account or user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written togs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
↳ relative_path
string
Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of full path where Log file will be written:gs://$GCS_BUCKET/$RELATIVE_PATH/
↳ enable_repair_flag
bool
Optional. Enables flag to repair service for instance
↳ enable_packet_capture_flag
bool
Optional. Enables flag to capture packets from the instance for 30 seconds
↳ enable_copy_home_files_flag
bool
Optional. Enables flag to copy all/home/jupyterfolder contents
getGcsBucket
Required. User Cloud Storage bucket location (REQUIRED).
Must be formatted with path prefix (gs://$GCS_BUCKET).
Permissions:
User Managed Notebooks:
storage.buckets.writer: Must be given to the project's service account
attached to VM.
Google Managed Notebooks:
storage.buckets.writer: Must be given to the project's service account or
user credentials attached to VM depending on authentication mode.
Cloud Storage bucket Log file will be written togs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
Returns
Type
Description
string
setGcsBucket
Required. User Cloud Storage bucket location (REQUIRED).
Must be formatted with path prefix (gs://$GCS_BUCKET).
Permissions:
User Managed Notebooks:
storage.buckets.writer: Must be given to the project's service account
attached to VM.
Google Managed Notebooks:
storage.buckets.writer: Must be given to the project's service account or
user credentials attached to VM depending on authentication mode.
Cloud Storage bucket Log file will be written togs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRelativePath
Optional. Defines the relative storage path in the Cloud Storage bucket
where the diagnostic logs will be written: Default path will be the root
directory of the Cloud Storage bucket
(gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of full path where Log file
will be written:gs://$GCS_BUCKET/$RELATIVE_PATH/
Returns
Type
Description
string
setRelativePath
Optional. Defines the relative storage path in the Cloud Storage bucket
where the diagnostic logs will be written: Default path will be the root
directory of the Cloud Storage bucket
(gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of full path where Log file
will be written:gs://$GCS_BUCKET/$RELATIVE_PATH/
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEnableRepairFlag
Optional. Enables flag to repair service for instance
Returns
Type
Description
bool
setEnableRepairFlag
Optional. Enables flag to repair service for instance
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getEnablePacketCaptureFlag
Optional. Enables flag to capture packets from the instance for 30 seconds
Returns
Type
Description
bool
setEnablePacketCaptureFlag
Optional. Enables flag to capture packets from the instance for 30 seconds
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getEnableCopyHomeFilesFlag
Optional. Enables flag to copy all/home/jupyterfolder contents
Returns
Type
Description
bool
setEnableCopyHomeFilesFlag
Optional. Enables flag to copy all/home/jupyterfolder contents
[[["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 Notebooks V2 Client - Class DiagnosticConfig (1.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.5 (latest)](/php/docs/reference/cloud-notebooks/latest/V2.DiagnosticConfig)\n- [1.0.4](/php/docs/reference/cloud-notebooks/1.0.4/V2.DiagnosticConfig)\n- [0.7.5](/php/docs/reference/cloud-notebooks/0.7.5/V2.DiagnosticConfig)\n- [0.6.2](/php/docs/reference/cloud-notebooks/0.6.2/V2.DiagnosticConfig)\n- [0.5.0](/php/docs/reference/cloud-notebooks/0.5.0/V2.DiagnosticConfig)\n- [0.4.1](/php/docs/reference/cloud-notebooks/0.4.1/V2.DiagnosticConfig)\n- [0.3.6](/php/docs/reference/cloud-notebooks/0.3.6/V2.DiagnosticConfig) \nReference documentation and code samples for the Google Cloud Notebooks V2 Client class DiagnosticConfig.\n\nDefines flags that are used to run the diagnostic tool\n\nGenerated from protobuf message `google.cloud.notebooks.v2.DiagnosticConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Notebooks \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getGcsBucket\n\nRequired. User Cloud Storage bucket location (REQUIRED).\n\nMust be formatted with path prefix (`gs://$GCS_BUCKET`).\nPermissions:\nUser Managed Notebooks:\n\n- storage.buckets.writer: Must be given to the project's service account attached to VM. Google Managed Notebooks:\n- storage.buckets.writer: Must be given to the project's service account or user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`\n\n### setGcsBucket\n\nRequired. User Cloud Storage bucket location (REQUIRED).\n\nMust be formatted with path prefix (`gs://$GCS_BUCKET`).\nPermissions:\nUser Managed Notebooks:\n\n- storage.buckets.writer: Must be given to the project's service account attached to VM. Google Managed Notebooks:\n- storage.buckets.writer: Must be given to the project's service account or user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`\n\n### getRelativePath\n\nOptional. Defines the relative storage path in the Cloud Storage bucket\nwhere the diagnostic logs will be written: Default path will be the root\ndirectory of the Cloud Storage bucket\n(`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file\nwill be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`\n\n### setRelativePath\n\nOptional. Defines the relative storage path in the Cloud Storage bucket\nwhere the diagnostic logs will be written: Default path will be the root\ndirectory of the Cloud Storage bucket\n(`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file\nwill be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`\n\n### getEnableRepairFlag\n\nOptional. Enables flag to repair service for instance\n\n### setEnableRepairFlag\n\nOptional. Enables flag to repair service for instance\n\n### getEnablePacketCaptureFlag\n\nOptional. Enables flag to capture packets from the instance for 30 seconds\n\n### setEnablePacketCaptureFlag\n\nOptional. Enables flag to capture packets from the instance for 30 seconds\n\n### getEnableCopyHomeFilesFlag\n\nOptional. Enables flag to copy all `/home/jupyter` folder contents\n\n### setEnableCopyHomeFilesFlag\n\nOptional. Enables flag to copy all `/home/jupyter` folder contents"]]
