Class Debugger2Client (1.1.10)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.60.0 (latest)
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.1.10
publicclass Debugger2ClientimplementsBackgroundResourceService Description: The Debugger service provides the API that allows users to collect run-time information from a running application, without stopping or slowing it down and without modifying its state. An application may include one or more replicated processes performing the same work.
A debugged application is represented using the Debuggee concept. The Debugger service provides a way to query for available debuggees, but does not provide a way to create one. A debuggee is created using the Controller service, usually by running a debugger agent with the application.
The Debugger service enables the client to set one or more Breakpoints on a Debuggee and collect the results of the set Breakpoints.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
StringdebuggeeId="debuggeeId-1833285553";
Breakpointbreakpoint=Breakpoint.newBuilder().build();
StringclientVersion="clientVersion771880589";
SetBreakpointResponseresponse=
debugger2Client.setBreakpoint(debuggeeId,breakpoint,clientVersion);
}
Note: close() needs to be called on the Debugger2Client object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of Debugger2Settings to create(). For example:
To customize credentials:
Debugger2Settingsdebugger2Settings=
Debugger2Settings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
Debugger2Clientdebugger2Client=Debugger2Client.create(debugger2Settings);
To customize the endpoint:
Debugger2Settingsdebugger2Settings=
Debugger2Settings.newBuilder().setEndpoint(myEndpoint).build();
Debugger2Clientdebugger2Client=Debugger2Client.create(debugger2Settings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceInherited Members
Static Methods
create()
publicstaticfinalDebugger2Clientcreate()Constructs an instance of Debugger2Client with default settings.
create(Debugger2Settings settings)
publicstaticfinalDebugger2Clientcreate(Debugger2Settingssettings)Constructs an instance of Debugger2Client, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
create(Debugger2Stub stub)
publicstaticfinalDebugger2Clientcreate(Debugger2Stubstub)Constructs an instance of Debugger2Client, using the given stub for making calls. This is for advanced usage - prefer using create(Debugger2Settings).
Constructors
Debugger2Client(Debugger2Settings settings)
protectedDebugger2Client(Debugger2Settingssettings)Constructs an instance of Debugger2Client, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Debugger2Client(Debugger2Stub stub)
protectedDebugger2Client(Debugger2Stubstub)Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)close()
publicfinalvoidclose()deleteBreakpoint(DeleteBreakpointRequest request)
publicfinalvoiddeleteBreakpoint(DeleteBreakpointRequestrequest)Deletes the breakpoint from the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
DeleteBreakpointRequestrequest=
DeleteBreakpointRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setBreakpointId("breakpointId570266860")
.setClientVersion("clientVersion771880589")
.build();
debugger2Client.deleteBreakpoint(request);
}
DeleteBreakpointRequest The request object containing all of the parameters for the API call.
deleteBreakpoint(String debuggeeId, String breakpointId, String clientVersion)
publicfinalvoiddeleteBreakpoint(StringdebuggeeId,StringbreakpointId,StringclientVersion)Deletes the breakpoint from the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
StringdebuggeeId="debuggeeId-1833285553";
StringbreakpointId="breakpointId570266860";
StringclientVersion="clientVersion771880589";
debugger2Client.deleteBreakpoint(debuggeeId,breakpointId,clientVersion);
}
String Required. The client version making the call. Schema:
domain/type/version (e.g., google.com/intellij/v1).
deleteBreakpointCallable()
publicfinalUnaryCallable<DeleteBreakpointRequest,Empty>deleteBreakpointCallable()Deletes the breakpoint from the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
DeleteBreakpointRequestrequest=
DeleteBreakpointRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setBreakpointId("breakpointId570266860")
.setClientVersion("clientVersion771880589")
.build();
ApiFuture<Empty>future=debugger2Client.deleteBreakpointCallable().futureCall(request);
// Do something.
future.get();
}
getBreakpoint(GetBreakpointRequest request)
publicfinalGetBreakpointResponsegetBreakpoint(GetBreakpointRequestrequest)Gets breakpoint information.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
GetBreakpointRequestrequest=
GetBreakpointRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setBreakpointId("breakpointId570266860")
.setClientVersion("clientVersion771880589")
.build();
GetBreakpointResponseresponse=debugger2Client.getBreakpoint(request);
}
getBreakpoint(String debuggeeId, String breakpointId, String clientVersion)
publicfinalGetBreakpointResponsegetBreakpoint(StringdebuggeeId,StringbreakpointId,StringclientVersion)Gets breakpoint information.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
StringdebuggeeId="debuggeeId-1833285553";
StringbreakpointId="breakpointId570266860";
StringclientVersion="clientVersion771880589";
GetBreakpointResponseresponse=
debugger2Client.getBreakpoint(debuggeeId,breakpointId,clientVersion);
}
String Required. The client version making the call. Schema:
domain/type/version (e.g., google.com/intellij/v1).
getBreakpointCallable()
publicfinalUnaryCallable<GetBreakpointRequest,GetBreakpointResponse>getBreakpointCallable()Gets breakpoint information.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
GetBreakpointRequestrequest=
GetBreakpointRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setBreakpointId("breakpointId570266860")
.setClientVersion("clientVersion771880589")
.build();
ApiFuture<GetBreakpointResponse>future=
debugger2Client.getBreakpointCallable().futureCall(request);
// Do something.
GetBreakpointResponseresponse=future.get();
}
getSettings()
publicfinalDebugger2SettingsgetSettings()getStub()
publicDebugger2StubgetStub()isShutdown()
publicbooleanisShutdown()isTerminated()
publicbooleanisTerminated()listBreakpoints(ListBreakpointsRequest request)
publicfinalListBreakpointsResponselistBreakpoints(ListBreakpointsRequestrequest)Lists all breakpoints for the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
ListBreakpointsRequestrequest=
ListBreakpointsRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setIncludeAllUsers(true)
.setIncludeInactive(true)
.setAction(ListBreakpointsRequest.BreakpointActionValue.newBuilder().build())
.setStripResults(true)
.setWaitToken("waitToken-984229500")
.setClientVersion("clientVersion771880589")
.build();
ListBreakpointsResponseresponse=debugger2Client.listBreakpoints(request);
}
ListBreakpointsRequest The request object containing all of the parameters for the API call.
listBreakpoints(String debuggeeId, String clientVersion)
publicfinalListBreakpointsResponselistBreakpoints(StringdebuggeeId,StringclientVersion)Lists all breakpoints for the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
StringdebuggeeId="debuggeeId-1833285553";
StringclientVersion="clientVersion771880589";
ListBreakpointsResponseresponse=debugger2Client.listBreakpoints(debuggeeId,clientVersion);
}
String Required. The client version making the call. Schema:
domain/type/version (e.g., google.com/intellij/v1).
listBreakpointsCallable()
publicfinalUnaryCallable<ListBreakpointsRequest,ListBreakpointsResponse>listBreakpointsCallable()Lists all breakpoints for the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
ListBreakpointsRequestrequest=
ListBreakpointsRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setIncludeAllUsers(true)
.setIncludeInactive(true)
.setAction(ListBreakpointsRequest.BreakpointActionValue.newBuilder().build())
.setStripResults(true)
.setWaitToken("waitToken-984229500")
.setClientVersion("clientVersion771880589")
.build();
ApiFuture<ListBreakpointsResponse>future=
debugger2Client.listBreakpointsCallable().futureCall(request);
// Do something.
ListBreakpointsResponseresponse=future.get();
}
listDebuggees(ListDebuggeesRequest request)
publicfinalListDebuggeesResponselistDebuggees(ListDebuggeesRequestrequest)Lists all the debuggees that the user has access to.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
ListDebuggeesRequestrequest=
ListDebuggeesRequest.newBuilder()
.setProject("project-309310695")
.setIncludeInactive(true)
.setClientVersion("clientVersion771880589")
.build();
ListDebuggeesResponseresponse=debugger2Client.listDebuggees(request);
}
listDebuggees(String project, String clientVersion)
publicfinalListDebuggeesResponselistDebuggees(Stringproject,StringclientVersion)Lists all the debuggees that the user has access to.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
Stringproject="project-309310695";
StringclientVersion="clientVersion771880589";
ListDebuggeesResponseresponse=debugger2Client.listDebuggees(project,clientVersion);
}
String Required. The client version making the call. Schema:
domain/type/version (e.g., google.com/intellij/v1).
listDebuggeesCallable()
publicfinalUnaryCallable<ListDebuggeesRequest,ListDebuggeesResponse>listDebuggeesCallable()Lists all the debuggees that the user has access to.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
ListDebuggeesRequestrequest=
ListDebuggeesRequest.newBuilder()
.setProject("project-309310695")
.setIncludeInactive(true)
.setClientVersion("clientVersion771880589")
.build();
ApiFuture<ListDebuggeesResponse>future=
debugger2Client.listDebuggeesCallable().futureCall(request);
// Do something.
ListDebuggeesResponseresponse=future.get();
}
setBreakpoint(SetBreakpointRequest request)
publicfinalSetBreakpointResponsesetBreakpoint(SetBreakpointRequestrequest)Sets the breakpoint to the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
SetBreakpointRequestrequest=
SetBreakpointRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setBreakpoint(Breakpoint.newBuilder().build())
.setClientVersion("clientVersion771880589")
.build();
SetBreakpointResponseresponse=debugger2Client.setBreakpoint(request);
}
setBreakpoint(String debuggeeId, Breakpoint breakpoint, String clientVersion)
publicfinalSetBreakpointResponsesetBreakpoint(StringdebuggeeId,Breakpointbreakpoint,StringclientVersion)Sets the breakpoint to the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
StringdebuggeeId="debuggeeId-1833285553";
Breakpointbreakpoint=Breakpoint.newBuilder().build();
StringclientVersion="clientVersion771880589";
SetBreakpointResponseresponse=
debugger2Client.setBreakpoint(debuggeeId,breakpoint,clientVersion);
}
Breakpoint Required. Breakpoint specification to set. The field location of the
breakpoint must be set.
String Required. The client version making the call. Schema:
domain/type/version (e.g., google.com/intellij/v1).
setBreakpointCallable()
publicfinalUnaryCallable<SetBreakpointRequest,SetBreakpointResponse>setBreakpointCallable()Sets the breakpoint to the debuggee.
Sample code:
try(Debugger2Clientdebugger2Client=Debugger2Client.create()){
SetBreakpointRequestrequest=
SetBreakpointRequest.newBuilder()
.setDebuggeeId("debuggeeId-1833285553")
.setBreakpoint(Breakpoint.newBuilder().build())
.setClientVersion("clientVersion771880589")
.build();
ApiFuture<SetBreakpointResponse>future=
debugger2Client.setBreakpointCallable().futureCall(request);
// Do something.
SetBreakpointResponseresponse=future.get();
}
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()