com.google.api.services.notebooks.v1.model

Class DiagnosticConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.notebooks.v1.model.DiagnosticConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DiagnosticConfig
extends com.google.api.client.json.GenericJson

Defines flags that are used to run the diagnostic tool

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Notebooks API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DiagnosticConfig()

Method Summary

Modifier and Type	Method and Description
DiagnosticConfig	clone()
Boolean	getCopyHomeFilesFlagEnabled() Optional.
String	getGcsBucket() Required.
Boolean	getPacketCaptureFlagEnabled() Optional.
String	getRelativePath() Optional.
Boolean	getRepairFlagEnabled() Optional.
DiagnosticConfig	set(String fieldName, Object value)
DiagnosticConfig	setCopyHomeFilesFlagEnabled(Boolean copyHomeFilesFlagEnabled) Optional.
DiagnosticConfig	setGcsBucket(String gcsBucket) Required.
DiagnosticConfig	setPacketCaptureFlagEnabled(Boolean packetCaptureFlagEnabled) Optional.
DiagnosticConfig	setRelativePath(String relativePath) Optional.
DiagnosticConfig	setRepairFlagEnabled(Boolean repairFlagEnabled) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DiagnosticConfig

public DiagnosticConfig()

Method Detail

getCopyHomeFilesFlagEnabled

public Boolean getCopyHomeFilesFlagEnabled()

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

Returns:

value or null for none

setCopyHomeFilesFlagEnabled

public DiagnosticConfig setCopyHomeFilesFlagEnabled(Boolean copyHomeFilesFlagEnabled)

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

Parameters:

copyHomeFilesFlagEnabled - copyHomeFilesFlagEnabled or null for none

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`

Returns:

value or null for none

setGcsBucket

public DiagnosticConfig setGcsBucket(String gcsBucket)

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`

Parameters:

gcsBucket - gcsBucket or null for none

getPacketCaptureFlagEnabled

public Boolean getPacketCaptureFlagEnabled()

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

Returns:

value or null for none

setPacketCaptureFlagEnabled

public DiagnosticConfig setPacketCaptureFlagEnabled(Boolean packetCaptureFlagEnabled)

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

Parameters:

packetCaptureFlagEnabled - packetCaptureFlagEnabled or null for none

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/`

Returns:

value or null for none

setRelativePath

public DiagnosticConfig setRelativePath(String relativePath)

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/`

Parameters:

relativePath - relativePath or null for none

getRepairFlagEnabled

public Boolean getRepairFlagEnabled()

Optional. Enables flag to repair service for instance

Returns:

value or null for none

setRepairFlagEnabled

public DiagnosticConfig setRepairFlagEnabled(Boolean repairFlagEnabled)

Optional. Enables flag to repair service for instance

Parameters:

repairFlagEnabled - repairFlagEnabled or null for none

set

public DiagnosticConfig set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public DiagnosticConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson