| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Debugger.Types
Contents
- Service Configuration
- OAuth Scopes
- RegisterDebuggeeResponse
- SourceContext
- SetBreakpointResponse
- Empty
- UpdateActiveBreakpointResponse
- GerritSourceContext
- RepoId
- ExtendedSourceContextLabels
- ProjectRepoId
- FormatMessage
- Breakpoint
- BreakpointLabels
- GetBreakpointResponse
- Variable
- ListBreakpointsResponse
- StatusMessageRefersTo
- BreakpointLogLevel
- ListDebuggeesResponse
- UpdateActiveBreakpointRequest
- StatusMessage
- Xgafv
- BreakpointAction
- ListActiveBreakpointsResponse
- ExtendedSourceContext
- GitSourceContext
- SourceLocation
- StackFrame
- CloudRepoSourceContext
- DebuggeeLabels
- Debuggee
- CloudWorkspaceSourceContext
- RegisterDebuggeeRequest
- AliasContext
- AliasContextKind
- CloudWorkspaceId
Description
Synopsis
- debuggerService :: ServiceConfig
- cloudDebuggerScope :: Proxy '["https://www.googleapis.com/auth/cloud_debugger"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- data RegisterDebuggeeResponse
- registerDebuggeeResponse :: RegisterDebuggeeResponse
- rdrDebuggee :: Lens' RegisterDebuggeeResponse (Maybe Debuggee)
- data SourceContext
- sourceContext :: SourceContext
- scCloudWorkspace :: Lens' SourceContext (Maybe CloudWorkspaceSourceContext)
- scCloudRepo :: Lens' SourceContext (Maybe CloudRepoSourceContext)
- scGerrit :: Lens' SourceContext (Maybe GerritSourceContext)
- scGit :: Lens' SourceContext (Maybe GitSourceContext)
- data SetBreakpointResponse
- setBreakpointResponse :: SetBreakpointResponse
- sbrBreakpoint :: Lens' SetBreakpointResponse (Maybe Breakpoint)
- data Empty
- empty :: Empty
- data UpdateActiveBreakpointResponse
- updateActiveBreakpointResponse :: UpdateActiveBreakpointResponse
- data GerritSourceContext
- gerritSourceContext :: GerritSourceContext
- gscGerritProject :: Lens' GerritSourceContext (Maybe Text)
- gscAliasName :: Lens' GerritSourceContext (Maybe Text)
- gscRevisionId :: Lens' GerritSourceContext (Maybe Text)
- gscHostURI :: Lens' GerritSourceContext (Maybe Text)
- gscAliasContext :: Lens' GerritSourceContext (Maybe AliasContext)
- data RepoId
- repoId :: RepoId
- riUid :: Lens' RepoId (Maybe Text)
- riProjectRepoId :: Lens' RepoId (Maybe ProjectRepoId)
- data ExtendedSourceContextLabels
- extendedSourceContextLabels :: HashMap Text Text -> ExtendedSourceContextLabels
- esclAddtional :: Lens' ExtendedSourceContextLabels (HashMap Text Text)
- data ProjectRepoId
- projectRepoId :: ProjectRepoId
- priRepoName :: Lens' ProjectRepoId (Maybe Text)
- priProjectId :: Lens' ProjectRepoId (Maybe Text)
- data FormatMessage
- formatMessage :: FormatMessage
- fmFormat :: Lens' FormatMessage (Maybe Text)
- fmParameters :: Lens' FormatMessage [Text]
- data Breakpoint
- breakpoint :: Breakpoint
- bStatus :: Lens' Breakpoint (Maybe StatusMessage)
- bLogLevel :: Lens' Breakpoint (Maybe BreakpointLogLevel)
- bLocation :: Lens' Breakpoint (Maybe SourceLocation)
- bAction :: Lens' Breakpoint (Maybe BreakpointAction)
- bFinalTime :: Lens' Breakpoint (Maybe UTCTime)
- bExpressions :: Lens' Breakpoint [Text]
- bLogMessageFormat :: Lens' Breakpoint (Maybe Text)
- bId :: Lens' Breakpoint (Maybe Text)
- bLabels :: Lens' Breakpoint (Maybe BreakpointLabels)
- bUserEmail :: Lens' Breakpoint (Maybe Text)
- bVariableTable :: Lens' Breakpoint [Variable]
- bStackFrames :: Lens' Breakpoint [StackFrame]
- bCondition :: Lens' Breakpoint (Maybe Text)
- bEvaluatedExpressions :: Lens' Breakpoint [Variable]
- bCreateTime :: Lens' Breakpoint (Maybe UTCTime)
- bIsFinalState :: Lens' Breakpoint (Maybe Bool)
- data BreakpointLabels
- breakpointLabels :: HashMap Text Text -> BreakpointLabels
- blAddtional :: Lens' BreakpointLabels (HashMap Text Text)
- data GetBreakpointResponse
- getBreakpointResponse :: GetBreakpointResponse
- gbrBreakpoint :: Lens' GetBreakpointResponse (Maybe Breakpoint)
- data Variable
- variable :: Variable
- vStatus :: Lens' Variable (Maybe StatusMessage)
- vVarTableIndex :: Lens' Variable (Maybe Int32)
- vMembers :: Lens' Variable [Variable]
- vValue :: Lens' Variable (Maybe Text)
- vName :: Lens' Variable (Maybe Text)
- vType :: Lens' Variable (Maybe Text)
- data ListBreakpointsResponse
- listBreakpointsResponse :: ListBreakpointsResponse
- lbrNextWaitToken :: Lens' ListBreakpointsResponse (Maybe Text)
- lbrBreakpoints :: Lens' ListBreakpointsResponse [Breakpoint]
- data StatusMessageRefersTo
- data BreakpointLogLevel
- data ListDebuggeesResponse
- listDebuggeesResponse :: ListDebuggeesResponse
- ldrDebuggees :: Lens' ListDebuggeesResponse [Debuggee]
- data UpdateActiveBreakpointRequest
- updateActiveBreakpointRequest :: UpdateActiveBreakpointRequest
- uabrBreakpoint :: Lens' UpdateActiveBreakpointRequest (Maybe Breakpoint)
- data StatusMessage
- statusMessage :: StatusMessage
- smRefersTo :: Lens' StatusMessage (Maybe StatusMessageRefersTo)
- smIsError :: Lens' StatusMessage (Maybe Bool)
- smDescription :: Lens' StatusMessage (Maybe FormatMessage)
- data Xgafv
- data BreakpointAction
- data ListActiveBreakpointsResponse
- listActiveBreakpointsResponse :: ListActiveBreakpointsResponse
- labrNextWaitToken :: Lens' ListActiveBreakpointsResponse (Maybe Text)
- labrBreakpoints :: Lens' ListActiveBreakpointsResponse [Breakpoint]
- labrWaitExpired :: Lens' ListActiveBreakpointsResponse (Maybe Bool)
- data ExtendedSourceContext
- extendedSourceContext :: ExtendedSourceContext
- escContext :: Lens' ExtendedSourceContext (Maybe SourceContext)
- escLabels :: Lens' ExtendedSourceContext (Maybe ExtendedSourceContextLabels)
- data GitSourceContext
- gitSourceContext :: GitSourceContext
- gURL :: Lens' GitSourceContext (Maybe Text)
- gRevisionId :: Lens' GitSourceContext (Maybe Text)
- data SourceLocation
- sourceLocation :: SourceLocation
- slPath :: Lens' SourceLocation (Maybe Text)
- slLine :: Lens' SourceLocation (Maybe Int32)
- slColumn :: Lens' SourceLocation (Maybe Int32)
- data StackFrame
- stackFrame :: StackFrame
- sfFunction :: Lens' StackFrame (Maybe Text)
- sfLocation :: Lens' StackFrame (Maybe SourceLocation)
- sfArguments :: Lens' StackFrame [Variable]
- sfLocals :: Lens' StackFrame [Variable]
- data CloudRepoSourceContext
- cloudRepoSourceContext :: CloudRepoSourceContext
- crscRepoId :: Lens' CloudRepoSourceContext (Maybe RepoId)
- crscAliasName :: Lens' CloudRepoSourceContext (Maybe Text)
- crscRevisionId :: Lens' CloudRepoSourceContext (Maybe Text)
- crscAliasContext :: Lens' CloudRepoSourceContext (Maybe AliasContext)
- data DebuggeeLabels
- debuggeeLabels :: HashMap Text Text -> DebuggeeLabels
- dlAddtional :: Lens' DebuggeeLabels (HashMap Text Text)
- data Debuggee
- debuggee :: Debuggee
- dStatus :: Lens' Debuggee (Maybe StatusMessage)
- dUniquifier :: Lens' Debuggee (Maybe Text)
- dProject :: Lens' Debuggee (Maybe Text)
- dExtSourceContexts :: Lens' Debuggee [ExtendedSourceContext]
- dAgentVersion :: Lens' Debuggee (Maybe Text)
- dIsDisabled :: Lens' Debuggee (Maybe Bool)
- dId :: Lens' Debuggee (Maybe Text)
- dLabels :: Lens' Debuggee (Maybe DebuggeeLabels)
- dDescription :: Lens' Debuggee (Maybe Text)
- dIsInactive :: Lens' Debuggee (Maybe Bool)
- dSourceContexts :: Lens' Debuggee [SourceContext]
- data CloudWorkspaceSourceContext
- cloudWorkspaceSourceContext :: CloudWorkspaceSourceContext
- cwscWorkspaceId :: Lens' CloudWorkspaceSourceContext (Maybe CloudWorkspaceId)
- cwscSnapshotId :: Lens' CloudWorkspaceSourceContext (Maybe Text)
- data RegisterDebuggeeRequest
- registerDebuggeeRequest :: RegisterDebuggeeRequest
- rDebuggee :: Lens' RegisterDebuggeeRequest (Maybe Debuggee)
- data AliasContext
- aliasContext :: AliasContext
- acKind :: Lens' AliasContext (Maybe AliasContextKind)
- acName :: Lens' AliasContext (Maybe Text)
- data AliasContextKind
- data CloudWorkspaceId
- cloudWorkspaceId :: CloudWorkspaceId
- cwiRepoId :: Lens' CloudWorkspaceId (Maybe RepoId)
- cwiName :: Lens' CloudWorkspaceId (Maybe Text)
Service Configuration
debuggerService :: ServiceConfig Source #
Default request referring to version v2 of the Stackdriver Debugger API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudDebuggerScope :: Proxy '["https://www.googleapis.com/auth/cloud_debugger"] Source #
Use Stackdriver Debugger
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
RegisterDebuggeeResponse
data RegisterDebuggeeResponse Source #
Response for registering a debuggee.
See: registerDebuggeeResponse smart constructor.
Instances
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 #
Debuggee resource. The field `id` is guaranteed to be set (in addition to the echoed fields). If the field `is_disabled` is set to `true`, the agent should disable itself by removing all breakpoints and detaching from the application. It should however continue to poll `RegisterDebuggee` until reenabled.
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.
Instances
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
data SetBreakpointResponse Source #
Response for setting a breakpoint.
See: setBreakpointResponse smart constructor.
Instances
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 #
Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fileds).
Empty
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.
Instances
| Eq Empty Source # | |
| Data Empty Source # | |
Defined in Network.Google.Debugger.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
| Show Empty Source # | |
| Generic Empty Source # | |
| ToJSON Empty Source # | |
Defined in Network.Google.Debugger.Types.Product | |
| FromJSON Empty Source # | |
| type Rep Empty Source # | |
UpdateActiveBreakpointResponse
data UpdateActiveBreakpointResponse Source #
Response for updating an active breakpoint. The message is defined to allow future extensions.
See: updateActiveBreakpointResponse smart constructor.
Instances
updateActiveBreakpointResponse :: UpdateActiveBreakpointResponse Source #
Creates a value of UpdateActiveBreakpointResponse with the minimum fields required to make a request.
GerritSourceContext
data GerritSourceContext Source #
A SourceContext referring to a Gerrit project.
See: gerritSourceContext smart constructor.
Instances
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.).
gscRevisionId :: Lens' GerritSourceContext (Maybe Text) Source #
A revision (commit) ID.
gscHostURI :: Lens' GerritSourceContext (Maybe Text) Source #
The URI of a running Gerrit instance.
gscAliasContext :: Lens' GerritSourceContext (Maybe AliasContext) Source #
An alias, which may be a branch or tag.
RepoId
A unique identifier for a cloud repo.
See: repoId smart constructor.
Instances
| Eq RepoId Source # | |
| Data RepoId Source # | |
Defined in Network.Google.Debugger.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RepoId -> c RepoId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RepoId # toConstr :: RepoId -> Constr # dataTypeOf :: RepoId -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RepoId) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RepoId) # gmapT :: (forall b. Data b => b -> b) -> RepoId -> RepoId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RepoId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RepoId -> r # gmapQ :: (forall d. Data d => d -> u) -> RepoId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RepoId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RepoId -> m RepoId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoId -> m RepoId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoId -> m RepoId # | |
| Show RepoId Source # | |
| Generic RepoId Source # | |
| ToJSON RepoId Source # | |
Defined in Network.Google.Debugger.Types.Product | |
| FromJSON RepoId Source # | |
| type Rep RepoId Source # | |
Defined in Network.Google.Debugger.Types.Product type Rep RepoId = D1 (MetaData "RepoId" "Network.Google.Debugger.Types.Product" "gogol-debugger-0.4.0-BwqAhQeYXdICGCX47imh4S" False) (C1 (MetaCons "RepoId'" PrefixI True) (S1 (MetaSel (Just "_riUid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_riProjectRepoId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProjectRepoId)))) | |
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:
riProjectRepoId :: Lens' RepoId (Maybe ProjectRepoId) Source #
A combination of a project ID and a repo name.
ExtendedSourceContextLabels
data ExtendedSourceContextLabels Source #
Labels with user defined metadata.
See: extendedSourceContextLabels smart constructor.
Instances
extendedSourceContextLabels Source #
Arguments
| :: HashMap Text Text | |
| -> ExtendedSourceContextLabels |
Creates a value of ExtendedSourceContextLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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.
Instances
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
data FormatMessage Source #
Represents a message with parameters.
See: formatMessage smart constructor.
Instances
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:
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.
Instances
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 is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
bLogLevel :: Lens' Breakpoint (Maybe BreakpointLogLevel) Source #
Indicates the severity of the log. Only relevant when action is `LOG`.
bLocation :: Lens' Breakpoint (Maybe SourceLocation) Source #
Breakpoint source location.
bAction :: Lens' Breakpoint (Maybe BreakpointAction) Source #
Action that the agent should perform when the code at the breakpoint location is hit.
bFinalTime :: Lens' Breakpoint (Maybe UTCTime) Source #
Time this breakpoint was finalized as seen by the server in seconds resolution.
bExpressions :: Lens' Breakpoint [Text] Source #
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.
bId :: Lens' Breakpoint (Maybe Text) Source #
Breakpoint identifier, unique in the scope of the debuggee.
bLabels :: Lens' Breakpoint (Maybe BreakpointLabels) Source #
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
bUserEmail :: Lens' Breakpoint (Maybe Text) Source #
E-mail address 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 same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_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 variable and the referenced variable.
bStackFrames :: Lens' Breakpoint [StackFrame] Source #
The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
bCondition :: Lens' Breakpoint (Maybe Text) Source #
Condition that triggers 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 #
Values of evaluated expressions 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` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
bCreateTime :: Lens' Breakpoint (Maybe UTCTime) Source #
Time this breakpoint was created by the server 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.
BreakpointLabels
data BreakpointLabels Source #
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
See: breakpointLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> BreakpointLabels |
Creates a value of BreakpointLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
GetBreakpointResponse
data GetBreakpointResponse Source #
Response for getting breakpoint information.
See: getBreakpointResponse smart constructor.
Instances
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 #
Complete breakpoint state. The fields `id` and `location` are guaranteed to be set.
Variable
Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ``. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } 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_table_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, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
See: variable smart constructor.
Instances
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 #
Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
vType :: Lens' Variable (Maybe Text) Source #
Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
ListBreakpointsResponse
data ListBreakpointsResponse Source #
Response for listing breakpoints.
See: listBreakpointsResponse smart constructor.
Instances
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 `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakpoints has changes.
lbrBreakpoints :: Lens' ListBreakpointsResponse [Breakpoint] Source #
List of breakpoints matching the request. The fields `id` and `location` are guaranteed to be set on each breakpoint. The fields: `stack_frames`, `evaluated_expressions` and `variable_table` are cleared on each breakpoint regardless of its status.
StatusMessageRefersTo
data StatusMessageRefersTo Source #
Reference to which the message applies.
Constructors
| Unspecified |
|
| BreakpointSourceLocation |
|
| BreakpointCondition |
|
| BreakpointExpression |
|
| BreakpointAge |
|
| VariableName |
|
| VariableValue |
|
Instances
BreakpointLogLevel
data BreakpointLogLevel Source #
Indicates the severity of the log. Only relevant when action is `LOG`.
Constructors
| Info |
|
| Warning |
|
| Error' |
|
Instances
ListDebuggeesResponse
data ListDebuggeesResponse Source #
Response for listing debuggees.
See: listDebuggeesResponse smart constructor.
Instances
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 #
List of debuggees accessible to the calling user. The fields `debuggee.id` and `description` are guaranteed to be set. The `description` field is a human readable field provided by agents and can be displayed to users.
UpdateActiveBreakpointRequest
data UpdateActiveBreakpointRequest Source #
Request to update an active breakpoint.
See: updateActiveBreakpointRequest smart constructor.
Instances
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 #
Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update.
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.
Instances
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 StatusMessageRefersTo) Source #
Reference to which the message applies.
smIsError :: Lens' StatusMessage (Maybe Bool) Source #
Distinguishes errors from informational messages.
smDescription :: Lens' StatusMessage (Maybe FormatMessage) Source #
Status message text.
Xgafv
V1 error format.
Instances
BreakpointAction
data BreakpointAction Source #
Action that the agent should perform when the code at the breakpoint location is hit.
Constructors
| Capture |
|
| Log |
|
Instances
ListActiveBreakpointsResponse
data ListActiveBreakpointsResponse Source #
Response for listing active breakpoints.
See: listActiveBreakpointsResponse smart constructor.
Instances
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 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 guaranteed to be set on each breakpoint.
labrWaitExpired :: Lens' ListActiveBreakpointsResponse (Maybe Bool) Source #
If set to `true`, indicates that there is no change to the list of active breakpoints and the server-selected timeout has expired. The `breakpoints` field would be empty and should be ignored.
ExtendedSourceContext
data ExtendedSourceContext Source #
An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
See: extendedSourceContext smart constructor.
Instances
extendedSourceContext :: ExtendedSourceContext Source #
Creates a value of ExtendedSourceContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
escContext :: Lens' ExtendedSourceContext (Maybe SourceContext) Source #
Any source context.
escLabels :: Lens' ExtendedSourceContext (Maybe ExtendedSourceContextLabels) Source #
Labels with user defined metadata.
GitSourceContext
data GitSourceContext Source #
A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub).
See: gitSourceContext smart constructor.
Instances
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:
gRevisionId :: Lens' GitSourceContext (Maybe Text) Source #
Git commit hash. required.
SourceLocation
data SourceLocation Source #
Represents a location in the source code.
See: sourceLocation smart constructor.
Instances
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 #
Path to the source file within the source context of the target binary.
slLine :: Lens' SourceLocation (Maybe Int32) Source #
Line inside the file. The first line in the file has the value `1`.
slColumn :: Lens' SourceLocation (Maybe Int32) Source #
Column within a line. The first column in a line as the value `1`. Agents that do not support setting breakpoints on specific columns ignore this field.
StackFrame
data StackFrame Source #
Represents a stack frame context.
See: stackFrame smart constructor.
Instances
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 #
Demangled function name at the call site.
sfLocation :: Lens' StackFrame (Maybe SourceLocation) Source #
Source location of the call site.
sfArguments :: Lens' StackFrame [Variable] Source #
Set of arguments passed to this function. Note that this might not be populated for all stack frames.
sfLocals :: Lens' StackFrame [Variable] Source #
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.
Instances
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:
crscRepoId :: Lens' CloudRepoSourceContext (Maybe RepoId) Source #
The ID of the repo.
crscAliasName :: Lens' CloudRepoSourceContext (Maybe Text) Source #
The name of an alias (branch, tag, etc.).
crscRevisionId :: Lens' CloudRepoSourceContext (Maybe Text) Source #
A revision ID.
crscAliasContext :: Lens' CloudRepoSourceContext (Maybe AliasContext) Source #
An alias, which may be a branch or tag.
DebuggeeLabels
data DebuggeeLabels Source #
A set of custom debuggee properties, populated by the agent, to be displayed to the user.
See: debuggeeLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> DebuggeeLabels |
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
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.
See: debuggee smart constructor.
Instances
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. Absence of this field indicates no status. The message can be either informational or an error status.
dUniquifier :: Lens' Debuggee (Maybe Text) Source #
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.
dProject :: Lens' Debuggee (Maybe Text) Source #
Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project.
dExtSourceContexts :: Lens' Debuggee [ExtendedSourceContext] Source #
References to the locations and revisions of the source code used in the deployed application.
dAgentVersion :: Lens' Debuggee (Maybe Text) Source #
Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/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 #
Unique identifier for the debuggee generated by the controller service.
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 #
Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
dIsInactive :: Lens' Debuggee (Maybe Bool) Source #
If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.
dSourceContexts :: Lens' Debuggee [SourceContext] Source #
References to the locations and revisions of the source code used in the deployed application.
CloudWorkspaceSourceContext
data CloudWorkspaceSourceContext Source #
A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.
See: cloudWorkspaceSourceContext smart constructor.
Instances
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:
cwscWorkspaceId :: Lens' CloudWorkspaceSourceContext (Maybe CloudWorkspaceId) Source #
The ID of the workspace.
cwscSnapshotId :: Lens' CloudWorkspaceSourceContext (Maybe Text) Source #
The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
RegisterDebuggeeRequest
data RegisterDebuggeeRequest Source #
Request to register a debuggee.
See: registerDebuggeeRequest smart constructor.
Instances
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 #
Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set.
AliasContext
data AliasContext Source #
An alias to a repo revision.
See: aliasContext smart constructor.
Instances
aliasContext :: AliasContext Source #
Creates a value of AliasContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acKind :: Lens' AliasContext (Maybe AliasContextKind) Source #
The alias kind.
AliasContextKind
data AliasContextKind Source #
The alias kind.
Constructors
| Any |
|
| Fixed |
|
| Movable |
|
| Other |
|
Instances
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.
Instances
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: