Debugger2AsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.debugger_v2.services.debugger2.transports.base.Debugger2Transport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
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.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
Debugger2Transport | The transport used by the client instance. |
Methods
Debugger2AsyncClient
Debugger2AsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.debugger_v2.services.debugger2.transports.base.Debugger2Transport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the debugger2 client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
delete_breakpoint
delete_breakpoint(request: Optional[Union[google.cloud.debugger_v2.types.debugger.DeleteBreakpointRequest, dict]] = None, *, debuggee_id: Optional[str] = None, breakpoint_id: Optional[str] = None, client_version: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes the breakpoint from the debuggee.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import debugger_v2
async def sample_delete_breakpoint():
# Create a client
client = debugger_v2.Debugger2AsyncClient()
# Initialize request argument(s)
request = debugger_v2.DeleteBreakpointRequest(
debuggee_id="debuggee_id_value",
breakpoint_id="breakpoint_id_value",
client_version="client_version_value",
)
# Make the request
await client.delete_breakpoint(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.debugger_v2.types.DeleteBreakpointRequest, dict]]
The request object. Request to delete a breakpoint. |
debuggee_id |
Required. ID of the debuggee whose breakpoint to delete. This corresponds to the |
breakpoint_id |
Required. ID of the breakpoint to delete. This corresponds to the |
client_version |
Required. The client version making the call. Schema: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
Debugger2AsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
Debugger2AsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
Debugger2AsyncClient | The constructed client. |
get_breakpoint
get_breakpoint(request: Optional[Union[google.cloud.debugger_v2.types.debugger.GetBreakpointRequest, dict]] = None, *, debuggee_id: Optional[str] = None, breakpoint_id: Optional[str] = None, client_version: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets breakpoint information.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import debugger_v2
async def sample_get_breakpoint():
# Create a client
client = debugger_v2.Debugger2AsyncClient()
# Initialize request argument(s)
request = debugger_v2.GetBreakpointRequest(
debuggee_id="debuggee_id_value",
breakpoint_id="breakpoint_id_value",
client_version="client_version_value",
)
# Make the request
response = await client.get_breakpoint(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.debugger_v2.types.GetBreakpointRequest, dict]]
The request object. Request to get breakpoint information. |
debuggee_id |
Required. ID of the debuggee whose breakpoint to get. This corresponds to the |
breakpoint_id |
Required. ID of the breakpoint to get. This corresponds to the |
client_version |
Required. The client version making the call. Schema: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.debugger_v2.types.GetBreakpointResponse | Response for getting breakpoint information. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_breakpoints
list_breakpoints(request: Optional[Union[google.cloud.debugger_v2.types.debugger.ListBreakpointsRequest, dict]] = None, *, debuggee_id: Optional[str] = None, client_version: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists all breakpoints for the debuggee.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import debugger_v2
async def sample_list_breakpoints():
# Create a client
client = debugger_v2.Debugger2AsyncClient()
# Initialize request argument(s)
request = debugger_v2.ListBreakpointsRequest(
debuggee_id="debuggee_id_value",
client_version="client_version_value",
)
# Make the request
response = await client.list_breakpoints(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.debugger_v2.types.ListBreakpointsRequest, dict]]
The request object. Request to list breakpoints. |
debuggee_id |
Required. ID of the debuggee whose breakpoints to list. This corresponds to the |
client_version |
Required. The client version making the call. Schema: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.debugger_v2.types.ListBreakpointsResponse | Response for listing breakpoints. |
list_debuggees
list_debuggees(request: Optional[Union[google.cloud.debugger_v2.types.debugger.ListDebuggeesRequest, dict]] = None, *, project: Optional[str] = None, client_version: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists all the debuggees that the user has access to.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import debugger_v2
async def sample_list_debuggees():
# Create a client
client = debugger_v2.Debugger2AsyncClient()
# Initialize request argument(s)
request = debugger_v2.ListDebuggeesRequest(
project="project_value",
client_version="client_version_value",
)
# Make the request
response = await client.list_debuggees(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.debugger_v2.types.ListDebuggeesRequest, dict]]
The request object. Request to list debuggees. |
project |
Required. Project number of a Google Cloud project whose debuggees to list. This corresponds to the |
client_version |
Required. The client version making the call. Schema: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.debugger_v2.types.ListDebuggeesResponse | Response for listing debuggees. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
set_breakpoint
set_breakpoint(request: Optional[Union[google.cloud.debugger_v2.types.debugger.SetBreakpointRequest, dict]] = None, *, debuggee_id: Optional[str] = None, breakpoint_: Optional[google.cloud.debugger_v2.types.data.Breakpoint] = None, client_version: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Sets the breakpoint to the debuggee.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import debugger_v2
async def sample_set_breakpoint():
# Create a client
client = debugger_v2.Debugger2AsyncClient()
# Initialize request argument(s)
request = debugger_v2.SetBreakpointRequest(
debuggee_id="debuggee_id_value",
client_version="client_version_value",
)
# Make the request
response = await client.set_breakpoint(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.debugger_v2.types.SetBreakpointRequest, dict]]
The request object. Request to set a breakpoint |
debuggee_id |
Required. ID of the debuggee where the breakpoint is to be set. This corresponds to the |
breakpoint_ |
Breakpoint
Required. Breakpoint specification to set. The field |
client_version |
Required. The client version making the call. Schema: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.debugger_v2.types.SetBreakpointResponse | Response for setting a breakpoint. |