1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\CloudDebugger\Resource;
19
20use Google\Service\CloudDebugger\Breakpoint;
21use Google\Service\CloudDebugger\ClouddebuggerEmpty;
22use Google\Service\CloudDebugger\GetBreakpointResponse;
23use Google\Service\CloudDebugger\ListBreakpointsResponse;
24use Google\Service\CloudDebugger\SetBreakpointResponse;
25
26/**
27 * The "breakpoints" collection of methods.
28 * Typical usage is:
29 *  <code>
30 *   $clouddebuggerService = new Google\Service\CloudDebugger(...);
31 *   $breakpoints = $clouddebuggerService->breakpoints;
32 *  </code>
33 */
34class DebuggerDebuggeesBreakpoints extends \Google\Service\Resource
35{
36  /**
37   * Deletes the breakpoint from the debuggee. (breakpoints.delete)
38   *
39   * @param string $debuggeeId Required. ID of the debuggee whose breakpoint to
40   * delete.
41   * @param string $breakpointId Required. ID of the breakpoint to delete.
42   * @param array $optParams Optional parameters.
43   *
44   * @opt_param string clientVersion Required. The client version making the call.
45   * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
46   * @return ClouddebuggerEmpty
47   */
48  public function delete($debuggeeId, $breakpointId, $optParams = [])
49  {
50    $params = ['debuggeeId' => $debuggeeId, 'breakpointId' => $breakpointId];
51    $params = array_merge($params, $optParams);
52    return $this->call('delete', [$params], ClouddebuggerEmpty::class);
53  }
54  /**
55   * Gets breakpoint information. (breakpoints.get)
56   *
57   * @param string $debuggeeId Required. ID of the debuggee whose breakpoint to
58   * get.
59   * @param string $breakpointId Required. ID of the breakpoint to get.
60   * @param array $optParams Optional parameters.
61   *
62   * @opt_param string clientVersion Required. The client version making the call.
63   * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
64   * @return GetBreakpointResponse
65   */
66  public function get($debuggeeId, $breakpointId, $optParams = [])
67  {
68    $params = ['debuggeeId' => $debuggeeId, 'breakpointId' => $breakpointId];
69    $params = array_merge($params, $optParams);
70    return $this->call('get', [$params], GetBreakpointResponse::class);
71  }
72  /**
73   * Lists all breakpoints for the debuggee.
74   * (breakpoints.listDebuggerDebuggeesBreakpoints)
75   *
76   * @param string $debuggeeId Required. ID of the debuggee whose breakpoints to
77   * list.
78   * @param array $optParams Optional parameters.
79   *
80   * @opt_param string action.value Only breakpoints with the specified action
81   * will pass the filter.
82   * @opt_param string clientVersion Required. The client version making the call.
83   * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
84   * @opt_param bool includeAllUsers When set to `true`, the response includes the
85   * list of breakpoints set by any user. Otherwise, it includes only breakpoints
86   * set by the caller.
87   * @opt_param bool includeInactive When set to `true`, the response includes
88   * active and inactive breakpoints. Otherwise, it includes only active
89   * breakpoints.
90   * @opt_param bool stripResults This field is deprecated. The following fields
91   * are always stripped out of the result: `stack_frames`,
92   * `evaluated_expressions` and `variable_table`.
93   * @opt_param string waitToken A wait token that, if specified, blocks the call
94   * until the breakpoints list has changed, or a server selected timeout has
95   * expired. The value should be set from the last response. The error code
96   * `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should be
97   * called again with the same `wait_token`.
98   * @return ListBreakpointsResponse
99   */
100  public function listDebuggerDebuggeesBreakpoints($debuggeeId, $optParams = [])
101  {
102    $params = ['debuggeeId' => $debuggeeId];
103    $params = array_merge($params, $optParams);
104    return $this->call('list', [$params], ListBreakpointsResponse::class);
105  }
106  /**
107   * Sets the breakpoint to the debuggee. (breakpoints.set)
108   *
109   * @param string $debuggeeId Required. ID of the debuggee where the breakpoint
110   * is to be set.
111   * @param Breakpoint $postBody
112   * @param array $optParams Optional parameters.
113   *
114   * @opt_param string canaryOption The canary option set by the user upon setting
115   * breakpoint.
116   * @opt_param string clientVersion Required. The client version making the call.
117   * Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
118   * @return SetBreakpointResponse
119   */
120  public function set($debuggeeId, Breakpoint $postBody, $optParams = [])
121  {
122    $params = ['debuggeeId' => $debuggeeId, 'postBody' => $postBody];
123    $params = array_merge($params, $optParams);
124    return $this->call('set', [$params], SetBreakpointResponse::class);
125  }
126}
127
128// Adding a class alias for backwards compatibility with the previous class name.
129class_alias(DebuggerDebuggeesBreakpoints::class, 'Google_Service_CloudDebugger_Resource_DebuggerDebuggeesBreakpoints');
130