Notebooks v2 API - Class DiagnosticConfig (1.0.0) 

public sealed class DiagnosticConfig : IMessage<DiagnosticConfig>, IEquatable<DiagnosticConfig>, IDeepCloneable<DiagnosticConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Notebooks v2 API class DiagnosticConfig.

Defines flags that are used to run the diagnostic tool

Inheritance

object > DiagnosticConfig

Namespace

Google.Cloud.Notebooks.V2

Assembly

Google.Cloud.Notebooks.V2.dll

Constructors

DiagnosticConfig()

public DiagnosticConfig()

DiagnosticConfig(DiagnosticConfig)

public DiagnosticConfig(DiagnosticConfig other)
Parameter
NameDescription
otherDiagnosticConfig

Properties

EnableCopyHomeFilesFlag

public bool EnableCopyHomeFilesFlag { get; set; }

Optional. Enables flag to copy all /home/jupyter folder contents

Property Value
TypeDescription
bool

EnablePacketCaptureFlag

public bool EnablePacketCaptureFlag { get; set; }

Optional. Enables flag to capture packets from the instance for 30 seconds

Property Value
TypeDescription
bool

EnableRepairFlag

public bool EnableRepairFlag { get; set; }

Optional. Enables flag to repair service for instance

Property Value
TypeDescription
bool

GcsBucket

public string GcsBucket { get; set; }

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 to gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz

Property Value
TypeDescription
string

RelativePath

public string RelativePath { get; set; }

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/

Property Value
TypeDescription
string