Package com.google.devtools.clouddebugger.v2

Class Debuggee

  • All Implemented Interfaces:
    DebuggeeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Debuggee
extends com.google.protobuf.GeneratedMessageV3
implements DebuggeeOrBuilder
     Represents the debugged application. The application may include one or more
 replicated processes executing the same code. Each of these processes is
 attached with a debugger agent, carrying out the debugging commands.
 Agents attached to the same debuggee identify themselves as such by using
 exactly the same Debuggee message value when registering.
    Protobuf type google.devtools.clouddebugger.v2.Debuggee
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getId

        public String getId()
         Unique identifier for the debuggee generated by the controller service.
        string id = 1;
        Specified by:
        getId in interface DebuggeeOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Unique identifier for the debuggee generated by the controller service.
        string id = 1;
        Specified by:
        getIdBytes in interface DebuggeeOrBuilder
        Returns:
        The bytes for id.

      • getProject

        public String getProject()
         Project the debuggee is associated with.
 Use project number or id when registering a Google Cloud Platform project.
        string project = 2;
        Specified by:
        getProject in interface DebuggeeOrBuilder
        Returns:
        The project.

      • getProjectBytes

        public com.google.protobuf.ByteString getProjectBytes()
         Project the debuggee is associated with.
 Use project number or id when registering a Google Cloud Platform project.
        string project = 2;
        Specified by:
        getProjectBytes in interface DebuggeeOrBuilder
        Returns:
        The bytes for project.

      • getUniquifier

        public String getUniquifier()
         Uniquifier to further distinguish the application.
 It is possible that different applications might have identical values in
 the debuggee message, thus, incorrectly identified as a single application
 by the Controller service. This field adds salt to further distinguish the
 application. Agents should consider seeding this field with value that
 identifies the code, binary, configuration and environment.
        string uniquifier = 3;
        Specified by:
        getUniquifier in interface DebuggeeOrBuilder
        Returns:
        The uniquifier.

      • getUniquifierBytes

        public com.google.protobuf.ByteString getUniquifierBytes()
         Uniquifier to further distinguish the application.
 It is possible that different applications might have identical values in
 the debuggee message, thus, incorrectly identified as a single application
 by the Controller service. This field adds salt to further distinguish the
 application. Agents should consider seeding this field with value that
 identifies the code, binary, configuration and environment.
        string uniquifier = 3;
        Specified by:
        getUniquifierBytes in interface DebuggeeOrBuilder
        Returns:
        The bytes for uniquifier.

      • getDescription

        public String getDescription()
         Human readable description of the debuggee.
 Including a human-readable project name, environment name and version
 information is recommended.
        string description = 4;
        Specified by:
        getDescription in interface DebuggeeOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Human readable description of the debuggee.
 Including a human-readable project name, environment name and version
 information is recommended.
        string description = 4;
        Specified by:
        getDescriptionBytes in interface DebuggeeOrBuilder
        Returns:
        The bytes for description.

      • getIsInactive

        public boolean getIsInactive()
         If set to `true`, indicates that Controller service does not detect any
 activity from the debuggee agents and the application is possibly stopped.
        bool is_inactive = 5;
        Specified by:
        getIsInactive in interface DebuggeeOrBuilder
        Returns:
        The isInactive.

      • getAgentVersion

        public String getAgentVersion()
         Version ID of the agent.
 Schema: `domain/language-platform/vmajor.minor` (for example
 `google.com/java-gcp/v1.1`).
        string agent_version = 6;
        Specified by:
        getAgentVersion in interface DebuggeeOrBuilder
        Returns:
        The agentVersion.

      • getAgentVersionBytes

        public com.google.protobuf.ByteString getAgentVersionBytes()
         Version ID of the agent.
 Schema: `domain/language-platform/vmajor.minor` (for example
 `google.com/java-gcp/v1.1`).
        string agent_version = 6;
        Specified by:
        getAgentVersionBytes in interface DebuggeeOrBuilder
        Returns:
        The bytes for agentVersion.

      • getIsDisabled

        public boolean getIsDisabled()
         If set to `true`, indicates that the agent should disable itself and
 detach from the debuggee.
        bool is_disabled = 7;
        Specified by:
        getIsDisabled in interface DebuggeeOrBuilder
        Returns:
        The isDisabled.

      • hasStatus

        public boolean hasStatus()
         Human readable message to be displayed to the user about this debuggee.
 Absence of this field indicates no status. The message can be either
 informational or an error status.
        .google.devtools.clouddebugger.v2.StatusMessage status = 8;
        Specified by:
        hasStatus in interface DebuggeeOrBuilder
        Returns:
        Whether the status field is set.

      • getStatus

        public StatusMessage getStatus()
         Human readable message to be displayed to the user about this debuggee.
 Absence of this field indicates no status. The message can be either
 informational or an error status.
        .google.devtools.clouddebugger.v2.StatusMessage status = 8;
        Specified by:
        getStatus in interface DebuggeeOrBuilder
        Returns:
        The status.

      • getStatusOrBuilder

        public StatusMessageOrBuilder getStatusOrBuilder()
         Human readable message to be displayed to the user about this debuggee.
 Absence of this field indicates no status. The message can be either
 informational or an error status.
        .google.devtools.clouddebugger.v2.StatusMessage status = 8;
        Specified by:
        getStatusOrBuilder in interface DebuggeeOrBuilder

      • getSourceContextsList

        public List<SourceContext> getSourceContextsList()
         References to the locations and revisions of the source code used in the
 deployed application.
        repeated .google.devtools.source.v1.SourceContext source_contexts = 9;
        Specified by:
        getSourceContextsList in interface DebuggeeOrBuilder

      • getSourceContextsCount

        public int getSourceContextsCount()
         References to the locations and revisions of the source code used in the
 deployed application.
        repeated .google.devtools.source.v1.SourceContext source_contexts = 9;
        Specified by:
        getSourceContextsCount in interface DebuggeeOrBuilder

      • getSourceContexts

        public SourceContext getSourceContexts​(int index)
         References to the locations and revisions of the source code used in the
 deployed application.
        repeated .google.devtools.source.v1.SourceContext source_contexts = 9;
        Specified by:
        getSourceContexts in interface DebuggeeOrBuilder

      • getSourceContextsOrBuilder

        public SourceContextOrBuilder getSourceContextsOrBuilder​(int index)
         References to the locations and revisions of the source code used in the
 deployed application.
        repeated .google.devtools.source.v1.SourceContext source_contexts = 9;
        Specified by:
        getSourceContextsOrBuilder in interface DebuggeeOrBuilder

      • getExtSourceContextsList

        @Deprecated
public List<ExtendedSourceContext> getExtSourceContextsList()
        Deprecated.
         References to the locations and revisions of the source code used in the
 deployed application.
        repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];
        Specified by:
        getExtSourceContextsList in interface DebuggeeOrBuilder

      • getExtSourceContextsCount

        @Deprecated
public int getExtSourceContextsCount()
        Deprecated.
         References to the locations and revisions of the source code used in the
 deployed application.
        repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];
        Specified by:
        getExtSourceContextsCount in interface DebuggeeOrBuilder

      • getExtSourceContexts

        @Deprecated
public ExtendedSourceContext getExtSourceContexts​(int index)
        Deprecated.
         References to the locations and revisions of the source code used in the
 deployed application.
        repeated .google.devtools.source.v1.ExtendedSourceContext ext_source_contexts = 13 [deprecated = true];
        Specified by:
        getExtSourceContexts in interface DebuggeeOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: DebuggeeOrBuilder
         A set of custom debuggee properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 11;
        Specified by:
        getLabelsCount in interface DebuggeeOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         A set of custom debuggee properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 11;
        Specified by:
        containsLabels in interface DebuggeeOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         A set of custom debuggee properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 11;
        Specified by:
        getLabelsMap in interface DebuggeeOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         A set of custom debuggee properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 11;
        Specified by:
        getLabelsOrDefault in interface DebuggeeOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         A set of custom debuggee properties, populated by the agent, to be
 displayed to the user.
        map<string, string> labels = 11;
        Specified by:
        getLabelsOrThrow in interface DebuggeeOrBuilder

      • 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 Debuggee parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Debuggee getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Debuggee> parser()

      • getParserForType

        public com.google.protobuf.Parser<Debuggee> 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 Debuggee getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder