Package com.google.cloud.debugger.v2

Class Debugger2Client

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class Debugger2Client
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service 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: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   String debuggeeId = "debuggeeId-1833285553";
   Breakpoint breakpoint = Breakpoint.newBuilder().build();
   String clientVersion = "clientVersion771880589";
   SetBreakpointResponse response =
       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:

    1. 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.
    2. 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.
    3. 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: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 Debugger2Settings debugger2Settings =
     Debugger2Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);

    To customize the endpoint: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 Debugger2Settings debugger2Settings =
     Debugger2Settings.newBuilder().setEndpoint(myEndpoint).build();
 Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);

    To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 Debugger2Settings debugger2Settings = Debugger2Settings.newHttpJsonBuilder().build();
 Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);

    Please refer to the GitHub repository's samples for more quickstart code snippets.

    • Constructor Detail

      • Debugger2Client

        protected Debugger2Client​(Debugger2Settings settings)
                   throws IOException
        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.
        Throws:
        IOException

      • Debugger2Client

        protected Debugger2Client​(Debugger2Stub stub)

    • Method Detail

      • create

        public static final Debugger2Client create​(Debugger2Settings settings)
                                    throws IOException
        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.
        Throws:
        IOException

      • create

        public static final Debugger2Client create​(Debugger2Stub stub)
        Constructs an instance of Debugger2Client, using the given stub for making calls. This is for advanced usage - prefer using create(Debugger2Settings).

      • setBreakpoint

        public final SetBreakpointResponse setBreakpoint​(String debuggeeId,
                                                 Breakpoint breakpoint,
                                                 String clientVersion)
        Sets the breakpoint to the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   String debuggeeId = "debuggeeId-1833285553";
   Breakpoint breakpoint = Breakpoint.newBuilder().build();
   String clientVersion = "clientVersion771880589";
   SetBreakpointResponse response =
       debugger2Client.setBreakpoint(debuggeeId, breakpoint, clientVersion);
 }
        Parameters:
        debuggeeId - Required. ID of the debuggee where the breakpoint is to be set.
        breakpoint - Required. Breakpoint specification to set. The field `location` of the breakpoint must be set.
        clientVersion - Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • setBreakpoint

        public final SetBreakpointResponse setBreakpoint​(SetBreakpointRequest request)
        Sets the breakpoint to the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   SetBreakpointRequest request =
       SetBreakpointRequest.newBuilder()
           .setDebuggeeId("debuggeeId-1833285553")
           .setBreakpoint(Breakpoint.newBuilder().build())
           .setClientVersion("clientVersion771880589")
           .build();
   SetBreakpointResponse response = debugger2Client.setBreakpoint(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • setBreakpointCallable

        public final com.google.api.gax.rpc.UnaryCallable<SetBreakpointRequest,​SetBreakpointResponse> setBreakpointCallable()
        Sets the breakpoint to the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   SetBreakpointRequest request =
       SetBreakpointRequest.newBuilder()
           .setDebuggeeId("debuggeeId-1833285553")
           .setBreakpoint(Breakpoint.newBuilder().build())
           .setClientVersion("clientVersion771880589")
           .build();
   ApiFuture<SetBreakpointResponse> future =
       debugger2Client.setBreakpointCallable().futureCall(request);
   // Do something.
   SetBreakpointResponse response = future.get();
 }

      • getBreakpoint

        public final GetBreakpointResponse getBreakpoint​(String debuggeeId,
                                                 String breakpointId,
                                                 String clientVersion)
        Gets breakpoint information.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   String debuggeeId = "debuggeeId-1833285553";
   String breakpointId = "breakpointId570266860";
   String clientVersion = "clientVersion771880589";
   GetBreakpointResponse response =
       debugger2Client.getBreakpoint(debuggeeId, breakpointId, clientVersion);
 }
        Parameters:
        debuggeeId - Required. ID of the debuggee whose breakpoint to get.
        breakpointId - Required. ID of the breakpoint to get.
        clientVersion - Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getBreakpoint

        public final GetBreakpointResponse getBreakpoint​(GetBreakpointRequest request)
        Gets breakpoint information.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   GetBreakpointRequest request =
       GetBreakpointRequest.newBuilder()
           .setDebuggeeId("debuggeeId-1833285553")
           .setBreakpointId("breakpointId570266860")
           .setClientVersion("clientVersion771880589")
           .build();
   GetBreakpointResponse response = debugger2Client.getBreakpoint(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getBreakpointCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetBreakpointRequest,​GetBreakpointResponse> getBreakpointCallable()
        Gets breakpoint information.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   GetBreakpointRequest request =
       GetBreakpointRequest.newBuilder()
           .setDebuggeeId("debuggeeId-1833285553")
           .setBreakpointId("breakpointId570266860")
           .setClientVersion("clientVersion771880589")
           .build();
   ApiFuture<GetBreakpointResponse> future =
       debugger2Client.getBreakpointCallable().futureCall(request);
   // Do something.
   GetBreakpointResponse response = future.get();
 }

      • deleteBreakpoint

        public final void deleteBreakpoint​(String debuggeeId,
                                   String breakpointId,
                                   String clientVersion)
        Deletes the breakpoint from the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   String debuggeeId = "debuggeeId-1833285553";
   String breakpointId = "breakpointId570266860";
   String clientVersion = "clientVersion771880589";
   debugger2Client.deleteBreakpoint(debuggeeId, breakpointId, clientVersion);
 }
        Parameters:
        debuggeeId - Required. ID of the debuggee whose breakpoint to delete.
        breakpointId - Required. ID of the breakpoint to delete.
        clientVersion - Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteBreakpoint

        public final void deleteBreakpoint​(DeleteBreakpointRequest request)
        Deletes the breakpoint from the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   DeleteBreakpointRequest request =
       DeleteBreakpointRequest.newBuilder()
           .setDebuggeeId("debuggeeId-1833285553")
           .setBreakpointId("breakpointId570266860")
           .setClientVersion("clientVersion771880589")
           .build();
   debugger2Client.deleteBreakpoint(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteBreakpointCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteBreakpointRequest,​com.google.protobuf.Empty> deleteBreakpointCallable()
        Deletes the breakpoint from the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   DeleteBreakpointRequest request =
       DeleteBreakpointRequest.newBuilder()
           .setDebuggeeId("debuggeeId-1833285553")
           .setBreakpointId("breakpointId570266860")
           .setClientVersion("clientVersion771880589")
           .build();
   ApiFuture<Empty> future = debugger2Client.deleteBreakpointCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • listBreakpoints

        public final ListBreakpointsResponse listBreakpoints​(String debuggeeId,
                                                     String clientVersion)
        Lists all breakpoints for the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   String debuggeeId = "debuggeeId-1833285553";
   String clientVersion = "clientVersion771880589";
   ListBreakpointsResponse response = debugger2Client.listBreakpoints(debuggeeId, clientVersion);
 }
        Parameters:
        debuggeeId - Required. ID of the debuggee whose breakpoints to list.
        clientVersion - Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listBreakpoints

        public final ListBreakpointsResponse listBreakpoints​(ListBreakpointsRequest request)
        Lists all breakpoints for the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   ListBreakpointsRequest request =
       ListBreakpointsRequest.newBuilder()
           .setDebuggeeId("debuggeeId-1833285553")
           .setIncludeAllUsers(true)
           .setIncludeInactive(true)
           .setAction(ListBreakpointsRequest.BreakpointActionValue.newBuilder().build())
           .setStripResults(true)
           .setWaitToken("waitToken-984229500")
           .setClientVersion("clientVersion771880589")
           .build();
   ListBreakpointsResponse response = debugger2Client.listBreakpoints(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listBreakpointsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListBreakpointsRequest,​ListBreakpointsResponse> listBreakpointsCallable()
        Lists all breakpoints for the debuggee.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   ListBreakpointsRequest request =
       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.
   ListBreakpointsResponse response = future.get();
 }

      • listDebuggees

        public final ListDebuggeesResponse listDebuggees​(String project,
                                                 String clientVersion)
        Lists all the debuggees that the user has access to.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   String project = "project-309310695";
   String clientVersion = "clientVersion771880589";
   ListDebuggeesResponse response = debugger2Client.listDebuggees(project, clientVersion);
 }
        Parameters:
        project - Required. Project number of a Google Cloud project whose debuggees to list.
        clientVersion - Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDebuggees

        public final ListDebuggeesResponse listDebuggees​(ListDebuggeesRequest request)
        Lists all the debuggees that the user has access to.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   ListDebuggeesRequest request =
       ListDebuggeesRequest.newBuilder()
           .setProject("project-309310695")
           .setIncludeInactive(true)
           .setClientVersion("clientVersion771880589")
           .build();
   ListDebuggeesResponse response = debugger2Client.listDebuggees(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDebuggeesCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListDebuggeesRequest,​ListDebuggeesResponse> listDebuggeesCallable()
        Lists all the debuggees that the user has access to.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (Debugger2Client debugger2Client = Debugger2Client.create()) {
   ListDebuggeesRequest request =
       ListDebuggeesRequest.newBuilder()
           .setProject("project-309310695")
           .setIncludeInactive(true)
           .setClientVersion("clientVersion771880589")
           .build();
   ApiFuture<ListDebuggeesResponse> future =
       debugger2Client.listDebuggeesCallable().futureCall(request);
   // Do something.
   ListDebuggeesResponse response = future.get();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource