Class Debugger2Client (1.7.0)

Debugger2Client(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.debugger_v2.services.debugger2.transports.base.Debugger2Transport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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

Debugger2Client

Debugger2Client(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.debugger_v2.services.debugger2.transports.base.Debugger2Transport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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, Debugger2Transport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

delete_breakpoint

delete_breakpoint(
    request: typing.Optional[
        typing.Union[
            google.cloud.debugger_v2.types.debugger.DeleteBreakpointRequest, dict
        ]
    ] = None,
    *,
    debuggee_id: typing.Optional[str] = None,
    breakpoint_id: typing.Optional[str] = None,
    client_version: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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

def sample_delete_breakpoint():
    # Create a client
    client = debugger_v2.Debugger2Client()

    # 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
    client.delete_breakpoint(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.debugger_v2.types.DeleteBreakpointRequest, dict]` The request object. Request to delete a breakpoint.
`debuggee_id`	`str` Required. ID of the debuggee whose breakpoint to delete. This corresponds to the `debuggee_id` field on the `request` instance; if `request` is provided, this should not be set.
`breakpoint_id`	`str` Required. ID of the breakpoint to delete. This corresponds to the `breakpoint_id` field on the `request` instance; if `request` is provided, this should not be set.
`client_version`	`str` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). This corresponds to the `client_version` field on the `request` instance; if `request` is provided, this should not be set.
`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
`Debugger2Client`	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
`Debugger2Client`	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
`Debugger2Client`	The constructed client.

get_breakpoint

get_breakpoint(
    request: typing.Optional[
        typing.Union[google.cloud.debugger_v2.types.debugger.GetBreakpointRequest, dict]
    ] = None,
    *,
    debuggee_id: typing.Optional[str] = None,
    breakpoint_id: typing.Optional[str] = None,
    client_version: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.debugger_v2.types.debugger.GetBreakpointResponse

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

def sample_get_breakpoint():
    # Create a client
    client = debugger_v2.Debugger2Client()

    # 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 = client.get_breakpoint(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.debugger_v2.types.GetBreakpointRequest, dict]` The request object. Request to get breakpoint information.
`debuggee_id`	`str` Required. ID of the debuggee whose breakpoint to get. This corresponds to the `debuggee_id` field on the `request` instance; if `request` is provided, this should not be set.
`breakpoint_id`	`str` Required. ID of the breakpoint to get. This corresponds to the `breakpoint_id` field on the `request` instance; if `request` is provided, this should not be set.
`client_version`	`str` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). This corresponds to the `client_version` field on the `request` instance; if `request` is provided, this should not be set.
`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: typing.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 `api_endpoint` and `client_cert_source` properties may be used in this method.

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.

list_breakpoints

list_breakpoints(
    request: typing.Optional[
        typing.Union[
            google.cloud.debugger_v2.types.debugger.ListBreakpointsRequest, dict
        ]
    ] = None,
    *,
    debuggee_id: typing.Optional[str] = None,
    client_version: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.debugger_v2.types.debugger.ListBreakpointsResponse

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

def sample_list_breakpoints():
    # Create a client
    client = debugger_v2.Debugger2Client()

    # Initialize request argument(s)
    request = debugger_v2.ListBreakpointsRequest(
        debuggee_id="debuggee_id_value",
        client_version="client_version_value",
    )

    # Make the request
    response = client.list_breakpoints(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.debugger_v2.types.ListBreakpointsRequest, dict]` The request object. Request to list breakpoints.
`debuggee_id`	`str` Required. ID of the debuggee whose breakpoints to list. This corresponds to the `debuggee_id` field on the `request` instance; if `request` is provided, this should not be set.
`client_version`	`str` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). This corresponds to the `client_version` field on the `request` instance; if `request` is provided, this should not be set.
`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: typing.Optional[
        typing.Union[google.cloud.debugger_v2.types.debugger.ListDebuggeesRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    client_version: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.debugger_v2.types.debugger.ListDebuggeesResponse

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

def sample_list_debuggees():
    # Create a client
    client = debugger_v2.Debugger2Client()

    # Initialize request argument(s)
    request = debugger_v2.ListDebuggeesRequest(
        project="project_value",
        client_version="client_version_value",
    )

    # Make the request
    response = client.list_debuggees(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.debugger_v2.types.ListDebuggeesRequest, dict]` The request object. Request to list debuggees.
`project`	`str` Required. Project number of a Google Cloud project whose debuggees to list. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`client_version`	`str` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). This corresponds to the `client_version` field on the `request` instance; if `request` is provided, this should not be set.
`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) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

set_breakpoint

set_breakpoint(
    request: typing.Optional[
        typing.Union[google.cloud.debugger_v2.types.debugger.SetBreakpointRequest, dict]
    ] = None,
    *,
    debuggee_id: typing.Optional[str] = None,
    breakpoint_: typing.Optional[google.cloud.debugger_v2.types.data.Breakpoint] = None,
    client_version: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.debugger_v2.types.debugger.SetBreakpointResponse

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

def sample_set_breakpoint():
    # Create a client
    client = debugger_v2.Debugger2Client()

    # Initialize request argument(s)
    request = debugger_v2.SetBreakpointRequest(
        debuggee_id="debuggee_id_value",
        client_version="client_version_value",
    )

    # Make the request
    response = client.set_breakpoint(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.debugger_v2.types.SetBreakpointRequest, dict]` The request object. Request to set a breakpoint
`debuggee_id`	`str` Required. ID of the debuggee where the breakpoint is to be set. This corresponds to the `debuggee_id` field on the `request` instance; if `request` is provided, this should not be set.
`breakpoint_`	`google.cloud.debugger_v2.types.Breakpoint` Required. Breakpoint specification to set. The field `location` of the breakpoint must be set. This corresponds to the `breakpoint_` field on the `request` instance; if `request` is provided, this should not be set.
`client_version`	`str` Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). This corresponds to the `client_version` field on the `request` instance; if `request` is provided, this should not be set.
`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.