gogol-debugger-0.0.1: Google Cloud Debugger SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Debugger

Contents

Description

Lets you examine the stack and variables of your running application without stopping or slowing it down.

See: Google Cloud Debugger API Reference

Synopsis

Service Configuration

debuggerService :: Service Source

Default request referring to version v2 of the Google Cloud Debugger API. This contains the host and root path used as a starting point for constructing service requests.

API Declaration

Resources

clouddebugger.controller.debuggees.breakpoints.list

clouddebugger.controller.debuggees.breakpoints.update

clouddebugger.controller.debuggees.register

clouddebugger.debugger.debuggees.breakpoints.delete

clouddebugger.debugger.debuggees.breakpoints.get

clouddebugger.debugger.debuggees.breakpoints.list

clouddebugger.debugger.debuggees.breakpoints.set

clouddebugger.debugger.debuggees.list

Types

RegisterDebuggeeResponse

registerDebuggeeResponse :: RegisterDebuggeeResponse Source

Creates a value of RegisterDebuggeeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rdrDebuggee :: Lens' RegisterDebuggeeResponse (Maybe Debuggee) Source

The debuggee resource. The field 'id' is guranteed to be set (in addition to the echoed fields).

SourceContext

data SourceContext Source

A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

See: sourceContext smart constructor.

sourceContext :: SourceContext Source

Creates a value of SourceContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scCloudWorkspace :: Lens' SourceContext (Maybe CloudWorkspaceSourceContext) Source

A SourceContext referring to a snapshot in a cloud workspace.

scCloudRepo :: Lens' SourceContext (Maybe CloudRepoSourceContext) Source

A SourceContext referring to a revision in a cloud repo.

scGerrit :: Lens' SourceContext (Maybe GerritSourceContext) Source

A SourceContext referring to a Gerrit project.

scGit :: Lens' SourceContext (Maybe GitSourceContext) Source

A SourceContext referring to any third party Git repo (e.g. GitHub).

SetBreakpointResponse

setBreakpointResponse :: SetBreakpointResponse Source

Creates a value of SetBreakpointResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sbrBreakpoint :: Lens' SetBreakpointResponse (Maybe Breakpoint) Source

The breakpoint resource. The field 'id' is guranteed to be set (in addition to the echoed fileds).

Empty

data Empty Source

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

See: empty smart constructor.

empty :: Empty Source

Creates a value of Empty with the minimum fields required to make a request.

UpdateActiveBreakpointResponse

updateActiveBreakpointResponse :: UpdateActiveBreakpointResponse Source

Creates a value of UpdateActiveBreakpointResponse with the minimum fields required to make a request.

GerritSourceContext

gerritSourceContext :: GerritSourceContext Source

Creates a value of GerritSourceContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gscGerritProject :: Lens' GerritSourceContext (Maybe Text) Source

The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.

gscAliasName :: Lens' GerritSourceContext (Maybe Text) Source

The name of an alias (branch, tag, etc.).

gscHostURI :: Lens' GerritSourceContext (Maybe Text) Source

The URI of a running Gerrit instance.

RepoId

data RepoId Source

A unique identifier for a cloud repo.

See: repoId smart constructor.

repoId :: RepoId Source

Creates a value of RepoId with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

riUid :: Lens' RepoId (Maybe Text) Source

A server-assigned, globally unique identifier.

riProjectRepoId :: Lens' RepoId (Maybe ProjectRepoId) Source

A combination of a project ID and a repo name.

ProjectRepoId

data ProjectRepoId Source

Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project.

See: projectRepoId smart constructor.

projectRepoId :: ProjectRepoId Source

Creates a value of ProjectRepoId with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

priRepoName :: Lens' ProjectRepoId (Maybe Text) Source

The name of the repo. Leave empty for the default repo.

priProjectId :: Lens' ProjectRepoId (Maybe Text) Source

The ID of the project.

FormatMessage

formatMessage :: FormatMessage Source

Creates a value of FormatMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fmFormat :: Lens' FormatMessage (Maybe Text) Source

Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."

fmParameters :: Lens' FormatMessage [Text] Source

Optional parameters to be embedded into the message.

Breakpoint

data Breakpoint Source

Represents the breakpoint specification, status and results.

See: breakpoint smart constructor.

breakpoint :: Breakpoint Source

Creates a value of Breakpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bStatus :: Lens' Breakpoint (Maybe StatusMessage) Source

Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ...

bLogLevel :: Lens' Breakpoint (Maybe Text) Source

Indicates the severity of the log. Only relevant when action is "LOG".

bLocation :: Lens' Breakpoint (Maybe SourceLocation) Source

The breakpoint source location.

bAction :: Lens' Breakpoint (Maybe Text) Source

Defines what to do when the breakpoint hits.

bFinalTime :: Lens' Breakpoint (Maybe Text) Source

The time this breakpoint was finalized as seen by the server. The value is in seconds resolution.

bExpressions :: Lens' Breakpoint [Text] Source

A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is "LOG", the evaluated expressions are included in log statements.

bLogMessageFormat :: Lens' Breakpoint (Maybe Text) Source

Only relevant when action is "LOG". Defines the message to log when the breakpoint hits. The message may include parameter placeholders "$0", "$1", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in "log_message_format" will not be logged. Example: "Poisonous message received, id = $0, count = $1" with expressions = [ "message.id", "message.count" ].

bId :: Lens' Breakpoint (Maybe Text) Source

Breakpoint identifier, unique in the scope of the debuggee.

bUserEmail :: Lens' Breakpoint (Maybe Text) Source

The e-mail of the user that created this breakpoint

bVariableTable :: Lens' Breakpoint [Variable] Source

The variable_table exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the variable_table itself. For example, the object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_index field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing veariable and the referenced variable.

bStackFrames :: Lens' Breakpoint [StackFrame] Source

The stack at breakpoint time.

bCondition :: Lens' Breakpoint (Maybe Text) Source

A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.

bEvaluatedExpressions :: Lens' Breakpoint [Variable] Source

The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field.

bCreateTime :: Lens' Breakpoint (Maybe Text) Source

The time this breakpoint was created by the server. The value is in seconds resolution.

bIsFinalState :: Lens' Breakpoint (Maybe Bool) Source

When true, indicates that this is a final result and the breakpoint state will not change from here on.

GetBreakpointResponse

getBreakpointResponse :: GetBreakpointResponse Source

Creates a value of GetBreakpointResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gbrBreakpoint :: Lens' GetBreakpointResponse (Maybe Breakpoint) Source

The complete breakpoint state. The fields 'id' and 'location' are guranteed to be set.

Variable

data Variable Source

Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.

See: variable smart constructor.

variable :: Variable Source

Creates a value of Variable with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vStatus :: Lens' Variable (Maybe StatusMessage) Source

Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".

vVarTableIndex :: Lens' Variable (Maybe Int32) Source

This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.

vMembers :: Lens' Variable [Variable] Source

The members contained or pointed to by the variable.

vValue :: Lens' Variable (Maybe Text) Source

The simple value of the variable.

vName :: Lens' Variable (Maybe Text) Source

The name of the variable, if any.

ListBreakpointsResponse

listBreakpointsResponse :: ListBreakpointsResponse Source

Creates a value of ListBreakpointsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lbrNextWaitToken :: Lens' ListBreakpointsResponse (Maybe Text) Source

A wait token that can be used in the next call to ListBreakpoints to block until the list of breakpoints has changes.

lbrBreakpoints :: Lens' ListBreakpointsResponse [Breakpoint] Source

List of all breakpoints with complete state. The fields 'id' and 'location' are guranteed to be set on each breakpoint.

ListDebuggeesResponse

listDebuggeesResponse :: ListDebuggeesResponse Source

Creates a value of ListDebuggeesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ldrDebuggees :: Lens' ListDebuggeesResponse [Debuggee] Source

The list of debuggees accessible to the calling user. Note that the description field is the only human readable field that should be displayed to the user. The fields 'debuggee.id' and 'description' are guranteed to be set on each debuggee.

UpdateActiveBreakpointRequest

updateActiveBreakpointRequest :: UpdateActiveBreakpointRequest Source

Creates a value of UpdateActiveBreakpointRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

uabrBreakpoint :: Lens' UpdateActiveBreakpointRequest (Maybe Breakpoint) Source

The updated breakpoint information. The field 'id' must be set.

StatusMessage

data StatusMessage Source

Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found".

See: statusMessage smart constructor.

statusMessage :: StatusMessage Source

Creates a value of StatusMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

smRefersTo :: Lens' StatusMessage (Maybe Text) Source

Reference to which the message applies.

smIsError :: Lens' StatusMessage (Maybe Bool) Source

Distinguishes errors from informational messages.

ListActiveBreakpointsResponse

listActiveBreakpointsResponse :: ListActiveBreakpointsResponse Source

Creates a value of ListActiveBreakpointsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

labrNextWaitToken :: Lens' ListActiveBreakpointsResponse (Maybe Text) Source

A wait token that can be used in the next method call to block until the list of breakpoints changes.

labrBreakpoints :: Lens' ListActiveBreakpointsResponse [Breakpoint] Source

List of all active breakpoints. The fields 'id' and 'location' are guranteed to be set on each breakpoint.

GitSourceContext

data GitSourceContext Source

A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub).

See: gitSourceContext smart constructor.

gitSourceContext :: GitSourceContext Source

Creates a value of GitSourceContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gURL :: Lens' GitSourceContext (Maybe Text) Source

Git repository URL.

gRevisionId :: Lens' GitSourceContext (Maybe Text) Source

Git commit hash. required.

SourceLocation

sourceLocation :: SourceLocation Source

Creates a value of SourceLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

slPath :: Lens' SourceLocation (Maybe Text) Source

A path to the source file within the source context of the target binary.

slLine :: Lens' SourceLocation (Maybe Int32) Source

The line inside the file (first line value is '1').

StackFrame

stackFrame :: StackFrame Source

Creates a value of StackFrame with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sfFunction :: Lens' StackFrame (Maybe Text) Source

The unmangled function name at the call site.

sfLocation :: Lens' StackFrame (Maybe SourceLocation) Source

The source location of the call site.

sfArguments :: Lens' StackFrame [Variable] Source

The set of arguments passed to this function Note that this might not be populated for all stack frames.

sfLocals :: Lens' StackFrame [Variable] Source

The set of local variables at the stack frame location. Note that this might not be populated for all stack frames.

CloudRepoSourceContext

data CloudRepoSourceContext Source

A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform).

See: cloudRepoSourceContext smart constructor.

cloudRepoSourceContext :: CloudRepoSourceContext Source

Creates a value of CloudRepoSourceContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

crscAliasName :: Lens' CloudRepoSourceContext (Maybe Text) Source

The name of an alias (branch, tag, etc.).

DebuggeeLabels

data DebuggeeLabels Source

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

See: debuggeeLabels smart constructor.

debuggeeLabels Source

Creates a value of DebuggeeLabels with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Debuggee

data Debuggee Source

Represents the application to debug. 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. The agents attached to the same debuggee are identified by using exactly the same fields' values when registering.

See: debuggee smart constructor.

debuggee :: Debuggee Source

Creates a value of Debuggee with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dStatus :: Lens' Debuggee (Maybe StatusMessage) Source

Human readable message to be displayed to the user about this debuggee. Absense of this field indicates no message. The message can be either informational or error.

dUniquifier :: Lens' Debuggee (Maybe Text) Source

The debuggee uniqifier within the project. Any string that id the application within the project can be used. Recomended to include environement and version or build id's.

dProject :: Lens' Debuggee (Maybe Text) Source

The project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.

dAgentVersion :: Lens' Debuggee (Maybe Text) Source

Version ID of the agent release. The version ID is structured as following: "domain/type/vmajor.minor" (for example "google.com/gcp-java/v1.1").

dIsDisabled :: Lens' Debuggee (Maybe Bool) Source

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

dId :: Lens' Debuggee (Maybe Text) Source

Debuggee unique identifer generated by the server.

dLabels :: Lens' Debuggee (Maybe DebuggeeLabels) Source

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

dDescription :: Lens' Debuggee (Maybe Text) Source

A human readable description of the debuggee. Recommended to include human readable project name, environment name, and version information .

dIsInactive :: Lens' Debuggee (Maybe Bool) Source

If set to true indicates that the debuggee has not been seen by the Controller service in the last active time period (defined by the server).

dSourceContexts :: Lens' Debuggee [SourceContext] Source

Repository snapshots containing the source code of the project.

CloudWorkspaceSourceContext

cloudWorkspaceSourceContext :: CloudWorkspaceSourceContext Source

Creates a value of CloudWorkspaceSourceContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cwscSnapshotId :: Lens' CloudWorkspaceSourceContext (Maybe Text) Source

The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.

RegisterDebuggeeRequest

registerDebuggeeRequest :: RegisterDebuggeeRequest Source

Creates a value of RegisterDebuggeeRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rDebuggee :: Lens' RegisterDebuggeeRequest (Maybe Debuggee) Source

The debuggee information to register. The fields 'project', 'uniquifier', 'description' and 'agent_version' of the debuggee must be set.

CloudWorkspaceId

data CloudWorkspaceId Source

A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed.

See: cloudWorkspaceId smart constructor.

cloudWorkspaceId :: CloudWorkspaceId Source

Creates a value of CloudWorkspaceId with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cwiRepoId :: Lens' CloudWorkspaceId (Maybe RepoId) Source

The ID of the repo containing the workspace.

cwiName :: Lens' CloudWorkspaceId (Maybe Text) Source

The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.