Class DiagnosticConfig (1.40.0) 

public final class DiagnosticConfig extends GeneratedMessageV3 implements DiagnosticConfigOrBuilder

Defines flags that are used to run the diagnostic tool

Protobuf type google.cloud.notebooks.v2.DiagnosticConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DiagnosticConfig

Static Fields

ENABLE_COPY_HOME_FILES_FLAG_FIELD_NUMBER

public static final int ENABLE_COPY_HOME_FILES_FLAG_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PACKET_CAPTURE_FLAG_FIELD_NUMBER

public static final int ENABLE_PACKET_CAPTURE_FLAG_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_REPAIR_FLAG_FIELD_NUMBER

public static final int ENABLE_REPAIR_FLAG_FIELD_NUMBER
Field Value
Type Description
int

GCS_BUCKET_FIELD_NUMBER

public static final int GCS_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

RELATIVE_PATH_FIELD_NUMBER

public static final int RELATIVE_PATH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DiagnosticConfig getDefaultInstance()
Returns
Type Description
DiagnosticConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DiagnosticConfig.Builder newBuilder()
Returns
Type Description
DiagnosticConfig.Builder

newBuilder(DiagnosticConfig prototype)

public static DiagnosticConfig.Builder newBuilder(DiagnosticConfig prototype)
Parameter
Name Description
prototype DiagnosticConfig
Returns
Type Description
DiagnosticConfig.Builder

parseDelimitedFrom(InputStream input)

public static DiagnosticConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DiagnosticConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DiagnosticConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DiagnosticConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DiagnosticConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DiagnosticConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnosticConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DiagnosticConfig> parser()
Returns
Type Description
Parser<DiagnosticConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DiagnosticConfig getDefaultInstanceForType()
Returns
Type Description
DiagnosticConfig

getEnableCopyHomeFilesFlag()

public boolean getEnableCopyHomeFilesFlag()

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

bool enable_copy_home_files_flag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableCopyHomeFilesFlag.

getEnablePacketCaptureFlag()

public boolean getEnablePacketCaptureFlag()

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

bool enable_packet_capture_flag = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enablePacketCaptureFlag.

getEnableRepairFlag()

public boolean getEnableRepairFlag()

Optional. Enables flag to repair service for instance

bool enable_repair_flag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableRepairFlag.

getGcsBucket()

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

string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The gcsBucket.

getGcsBucketBytes()

public ByteString getGcsBucketBytes()

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

string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for gcsBucket.

getParserForType()

public Parser<DiagnosticConfig> getParserForType()
Returns
Type Description
Parser<DiagnosticConfig>
Overrides

getRelativePath()

public String 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/

string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The relativePath.

getRelativePathBytes()

public ByteString getRelativePathBytes()

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/

string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for relativePath.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DiagnosticConfig.Builder newBuilderForType()
Returns
Type Description
DiagnosticConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DiagnosticConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DiagnosticConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DiagnosticConfig.Builder toBuilder()
Returns
Type Description
DiagnosticConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException