Class DiagnosticConfig.Builder (1.40.0)

public static final class DiagnosticConfig.Builder extends GeneratedMessageV3.Builder<DiagnosticConfig.Builder> implements DiagnosticConfigOrBuilder

Defines flags that are used to run the diagnostic tool

Protobuf type google.cloud.notebooks.v1.DiagnosticConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DiagnosticConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DiagnosticConfig.Builder
Overrides

build()

public DiagnosticConfig build()
Returns
Type Description
DiagnosticConfig

buildPartial()

public DiagnosticConfig buildPartial()
Returns
Type Description
DiagnosticConfig

clear()

public DiagnosticConfig.Builder clear()
Returns
Type Description
DiagnosticConfig.Builder
Overrides

clearCopyHomeFilesFlagEnabled()

public DiagnosticConfig.Builder clearCopyHomeFilesFlagEnabled()

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

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

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DiagnosticConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DiagnosticConfig.Builder
Overrides

clearGcsBucket()

public DiagnosticConfig.Builder clearGcsBucket()

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
DiagnosticConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DiagnosticConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DiagnosticConfig.Builder
Overrides

clearPacketCaptureFlagEnabled()

public DiagnosticConfig.Builder clearPacketCaptureFlagEnabled()

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

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

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

clearRelativePath()

public DiagnosticConfig.Builder clearRelativePath()

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
DiagnosticConfig.Builder

This builder for chaining.

clearRepairFlagEnabled()

public DiagnosticConfig.Builder clearRepairFlagEnabled()

Optional. Enables flag to repair service for instance

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

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

clone()

public DiagnosticConfig.Builder clone()
Returns
Type Description
DiagnosticConfig.Builder
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
Type Description
boolean

The copyHomeFilesFlagEnabled.

getDefaultInstanceForType()

public DiagnosticConfig getDefaultInstanceForType()
Returns
Type Description
DiagnosticConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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
Type Description
boolean

The packetCaptureFlagEnabled.

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.

getRepairFlagEnabled()

public boolean getRepairFlagEnabled()

Optional. Enables flag to repair service for instance

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

Returns
Type Description
boolean

The repairFlagEnabled.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DiagnosticConfig other)

public DiagnosticConfig.Builder mergeFrom(DiagnosticConfig other)
Parameter
Name Description
other DiagnosticConfig
Returns
Type Description
DiagnosticConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DiagnosticConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnosticConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DiagnosticConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DiagnosticConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DiagnosticConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DiagnosticConfig.Builder
Overrides

setCopyHomeFilesFlagEnabled(boolean value)

public DiagnosticConfig.Builder setCopyHomeFilesFlagEnabled(boolean value)

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

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

Parameter
Name Description
value boolean

The copyHomeFilesFlagEnabled to set.

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DiagnosticConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DiagnosticConfig.Builder
Overrides

setGcsBucket(String value)

public DiagnosticConfig.Builder setGcsBucket(String value)

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];

Parameter
Name Description
value String

The gcsBucket to set.

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

setGcsBucketBytes(ByteString value)

public DiagnosticConfig.Builder setGcsBucketBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for gcsBucket to set.

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

setPacketCaptureFlagEnabled(boolean value)

public DiagnosticConfig.Builder setPacketCaptureFlagEnabled(boolean value)

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

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

Parameter
Name Description
value boolean

The packetCaptureFlagEnabled to set.

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

setRelativePath(String value)

public DiagnosticConfig.Builder setRelativePath(String value)

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];

Parameter
Name Description
value String

The relativePath to set.

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

setRelativePathBytes(ByteString value)

public DiagnosticConfig.Builder setRelativePathBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for relativePath to set.

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

setRepairFlagEnabled(boolean value)

public DiagnosticConfig.Builder setRepairFlagEnabled(boolean value)

Optional. Enables flag to repair service for instance

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

Parameter
Name Description
value boolean

The repairFlagEnabled to set.

Returns
Type Description
DiagnosticConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DiagnosticConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DiagnosticConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DiagnosticConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DiagnosticConfig.Builder
Overrides