Stackdriver Debugger V2 Client - Class Debuggee (1.4.16)

Reference documentation and code samples for the Stackdriver Debugger V2 Client class Debuggee.

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.

Generated from protobuf message google.devtools.clouddebugger.v2.Debuggee

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

Unique identifier for the debuggee generated by the controller service.

↳ project string

Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project.

↳ uniquifier string

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.

↳ description string

Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.

↳ is_inactive bool

If set to true, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.

↳ agent_version string

Version ID of the agent. Schema: domain/language-platform/vmajor.minor (for example google.com/java-gcp/v1.1).

↳ is_disabled bool

If set to true, indicates that the agent should disable itself and detach from the debuggee.

↳ status Google\Cloud\Debugger\V2\StatusMessage

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.

↳ source_contexts array<Google\Cloud\DevTools\Source\V1\SourceContext>

References to the locations and revisions of the source code used in the deployed application.

↳ ext_source_contexts array<Google\Cloud\DevTools\Source\V1\ExtendedSourceContext>

References to the locations and revisions of the source code used in the deployed application.

↳ labels array|Google\Protobuf\Internal\MapField

A set of custom debuggee properties, populated by the agent, to be displayed to the user.

getId

Unique identifier for the debuggee generated by the controller service.

Returns
TypeDescription
string

setId

Unique identifier for the debuggee generated by the controller service.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProject

Project the debuggee is associated with.

Use project number or id when registering a Google Cloud Platform project.

Returns
TypeDescription
string

setProject

Project the debuggee is associated with.

Use project number or id when registering a Google Cloud Platform project.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setUniquifier

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Human readable description of the debuggee.

Including a human-readable project name, environment name and version information is recommended.

Returns
TypeDescription
string

setDescription

Human readable description of the debuggee.

Including a human-readable project name, environment name and version information is recommended.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIsInactive

If set to true, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.

Returns
TypeDescription
bool

setIsInactive

If set to true, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAgentVersion

Version ID of the agent.

Schema: domain/language-platform/vmajor.minor (for example google.com/java-gcp/v1.1).

Returns
TypeDescription
string

setAgentVersion

Version ID of the agent.

Schema: domain/language-platform/vmajor.minor (for example google.com/java-gcp/v1.1).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIsDisabled

If set to true, indicates that the agent should disable itself and detach from the debuggee.

Returns
TypeDescription
bool

setIsDisabled

If set to true, indicates that the agent should disable itself and detach from the debuggee.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

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.

Returns
TypeDescription
Google\Cloud\Debugger\V2\StatusMessage|null

hasStatus

clearStatus

setStatus

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.

Parameter
NameDescription
var Google\Cloud\Debugger\V2\StatusMessage
Returns
TypeDescription
$this

getSourceContexts

References to the locations and revisions of the source code used in the deployed application.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSourceContexts

References to the locations and revisions of the source code used in the deployed application.

Parameter
NameDescription
var array<Google\Cloud\DevTools\Source\V1\SourceContext>
Returns
TypeDescription
$this

getExtSourceContexts

References to the locations and revisions of the source code used in the deployed application.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setExtSourceContexts

References to the locations and revisions of the source code used in the deployed application.

Parameter
NameDescription
var array<Google\Cloud\DevTools\Source\V1\ExtendedSourceContext>
Returns
TypeDescription
$this

getLabels

A set of custom debuggee properties, populated by the agent, to be displayed to the user.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

A set of custom debuggee properties, populated by the agent, to be displayed to the user.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this