Package com.google.cloud.notebooks.v1

Class DiagnosticConfig

  • All Implemented Interfaces:
    DiagnosticConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DiagnosticConfig
extends com.google.protobuf.GeneratedMessageV3
implements DiagnosticConfigOrBuilder
     Defines flags that are used to run the diagnostic tool
    Protobuf type google.cloud.notebooks.v1.DiagnosticConfig
    See Also:
    Serialized Form

    • Field Detail

      • GCS_BUCKET_FIELD_NUMBER

        public static final int GCS_BUCKET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RELATIVE_PATH_FIELD_NUMBER

        public static final int RELATIVE_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPAIR_FLAG_ENABLED_FIELD_NUMBER

        public static final int REPAIR_FLAG_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PACKET_CAPTURE_FLAG_ENABLED_FIELD_NUMBER

        public static final int PACKET_CAPTURE_FLAG_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COPY_HOME_FILES_FLAG_ENABLED_FIELD_NUMBER

        public static final int COPY_HOME_FILES_FLAG_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getGcsBucket in interface DiagnosticConfigOrBuilder
        Returns:
        The gcsBucket.

      • getGcsBucketBytes

        public com.google.protobuf.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];
        Specified by:
        getGcsBucketBytes in interface DiagnosticConfigOrBuilder
        Returns:
        The bytes for gcsBucket.

      • 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];
        Specified by:
        getRelativePath in interface DiagnosticConfigOrBuilder
        Returns:
        The relativePath.

      • getRelativePathBytes

        public com.google.protobuf.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];
        Specified by:
        getRelativePathBytes in interface DiagnosticConfigOrBuilder
        Returns:
        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];
        Specified by:
        getRepairFlagEnabled in interface DiagnosticConfigOrBuilder
        Returns:
        The repairFlagEnabled.

      • 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];
        Specified by:
        getPacketCaptureFlagEnabled in interface DiagnosticConfigOrBuilder
        Returns:
        The packetCaptureFlagEnabled.

      • 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];
        Specified by:
        getCopyHomeFilesFlagEnabled in interface DiagnosticConfigOrBuilder
        Returns:
        The copyHomeFilesFlagEnabled.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static DiagnosticConfig parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiagnosticConfig parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiagnosticConfig parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiagnosticConfig parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiagnosticConfig parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiagnosticConfig parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiagnosticConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public DiagnosticConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public DiagnosticConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected DiagnosticConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<DiagnosticConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public DiagnosticConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder