Class DiagnosticConfig (1.37.0)

public final class DiagnosticConfig extends GeneratedMessageV3 implements DiagnosticConfigOrBuilder

Defines flags that are used to run the diagnostic tool

Protobuf type google.cloud.notebooks.v1.DiagnosticConfig

Static Fields

COPY_HOME_FILES_FLAG_ENABLED_FIELD_NUMBER

public static final int COPY_HOME_FILES_FLAG_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_BUCKET_FIELD_NUMBER

public static final int GCS_BUCKET_FIELD_NUMBER
Field Value
TypeDescription
int

PACKET_CAPTURE_FLAG_ENABLED_FIELD_NUMBER

public static final int PACKET_CAPTURE_FLAG_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

RELATIVE_PATH_FIELD_NUMBER

public static final int RELATIVE_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

REPAIR_FLAG_ENABLED_FIELD_NUMBER

public static final int REPAIR_FLAG_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DiagnosticConfig getDefaultInstance()
Returns
TypeDescription
DiagnosticConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DiagnosticConfig.Builder newBuilder()
Returns
TypeDescription
DiagnosticConfig.Builder

newBuilder(DiagnosticConfig prototype)

public static DiagnosticConfig.Builder newBuilder(DiagnosticConfig prototype)
Parameter
NameDescription
prototypeDiagnosticConfig
Returns
TypeDescription
DiagnosticConfig.Builder

parseDelimitedFrom(InputStream input)

public static DiagnosticConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DiagnosticConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DiagnosticConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DiagnosticConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DiagnosticConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DiagnosticConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DiagnosticConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnosticConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DiagnosticConfig> parser()
Returns
TypeDescription
Parser<DiagnosticConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCopyHomeFilesFlagEnabled()

public boolean getCopyHomeFilesFlagEnabled()

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

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

Returns
TypeDescription
boolean

The copyHomeFilesFlagEnabled.

getDefaultInstanceForType()

public DiagnosticConfig getDefaultInstanceForType()
Returns
TypeDescription
DiagnosticConfig

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
TypeDescription
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
TypeDescription
ByteString

The bytes for gcsBucket.

getPacketCaptureFlagEnabled()

public boolean getPacketCaptureFlagEnabled()

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

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

Returns
TypeDescription
boolean

The packetCaptureFlagEnabled.

getParserForType()

public Parser<DiagnosticConfig> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for relativePath.

getRepairFlagEnabled()

public boolean getRepairFlagEnabled()

Optional. Enables flag to repair service for instance

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

Returns
TypeDescription
boolean

The repairFlagEnabled.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DiagnosticConfig.Builder newBuilderForType()
Returns
TypeDescription
DiagnosticConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DiagnosticConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DiagnosticConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DiagnosticConfig.Builder toBuilder()
Returns
TypeDescription
DiagnosticConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException