Class Controller2Client (0.1.5)
Stay organized with collections
Save and categorize content based on your preferences.
Controller2Client(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.debugger_v2.services.controller2.transports.base.Controller2Transport]] = None, 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 Controller service provides the API for orchestrating a collection of debugger agents to perform debugging tasks. These agents are each attached to a process of an application which may include one or more replicas.
The debugger agents register with the Controller to identify the
application being debugged, the Debuggee. All agents that register
with the same data, represent the same Debuggee, and are assigned
the same debuggee_id.
The debugger agents call the Controller to retrieve the list of
active Breakpoints. Agents with the same debuggee_id get the
same breakpoints list. An agent that can fulfill the breakpoint
request updates the Controller with the breakpoint result. The
controller selects the first result received and discards the rest
of the results. Agents that poll again for active breakpoints will
no longer have the completed breakpoint in the list and should
remove that breakpoint from their attached process.
The Controller service does not provide a way to retrieve the results of a completed breakpoint. This functionality is available using the Debugger service.
Properties
transport
Returns the transport used by the client instance.
Controller2Transport
The transport used by the client instance.
Methods
Controller2Client
Controller2Client(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.debugger_v2.services.controller2.transports.base.Controller2Transport]] = None, 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 controller2 client.
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, Controller2Transport]
The transport to use. If set to None, a transport is chosen automatically.
client_options
google.api_core.client_options.ClientOptions
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.
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.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
Controller2Client
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.
info
dict
The service account private key info.
Controller2Client
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.
filename
str
The path to the service account private key json file.
Controller2Client
The constructed client.
list_active_breakpoints
list_active_breakpoints(request: Optional[google.cloud.debugger_v2.types.controller.ListActiveBreakpointsRequest] = None, *, debuggee_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns the list of all active breakpoints for the debuggee.
The breakpoint specification (location, condition, and
expressions fields) is semantically immutable, although the
field values may change. For example, an agent may update the
location line number to reflect the actual line where the
breakpoint was set, but this doesn't change the breakpoint
semantics.
This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.
request
google.cloud.debugger_v2.types.ListActiveBreakpointsRequest
The request object. Request to list active breakpoints.
debuggee_id
str
Required. Identifies the debuggee. This corresponds to the debuggee_id 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.
google.cloud.debugger_v2.types.ListActiveBreakpointsResponse
Response for listing active breakpoints.
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.
register_debuggee
register_debuggee(request: Optional[google.cloud.debugger_v2.types.controller.RegisterDebuggeeRequest] = None, *, debuggee: Optional[google.cloud.debugger_v2.types.data.Debuggee] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Registers the debuggee with the controller service.
All agents attached to the same application must call this
method with exactly the same request content to get back the
same stable debuggee_id. Agents should call this method
again whenever google.rpc.Code.NOT_FOUND is returned from
any controller method.
This protocol allows the controller service to disable
debuggees, recover from data loss, or change the debuggee_id
format. Agents must handle debuggee_id value changing upon
re-registration.
request
google.cloud.debugger_v2.types.RegisterDebuggeeRequest
The request object. Request to register a debuggee.
debuggee
google.cloud.debugger_v2.types.Debuggee
Required. Debuggee information to register. The fields project, uniquifier, description and agent_version of the debuggee must be set. This corresponds to the debuggee 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.
google.cloud.debugger_v2.types.RegisterDebuggeeResponse
Response for registering a debuggee.
update_active_breakpoint
update_active_breakpoint(request: Optional[google.cloud.debugger_v2.types.controller.UpdateActiveBreakpointRequest] = None, *, debuggee_id: Optional[str] = None, breakpoint_: Optional[google.cloud.debugger_v2.types.data.Breakpoint] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service.
Updates to active breakpoint fields are only allowed if the new
value does not change the breakpoint specification. Updates to
the location, condition and expressions fields
should not alter the breakpoint semantics. These may only make
changes such as canonicalizing a value or snapping the location
to the correct line of code.
request
google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest
The request object. Request to update an active breakpoint.
debuggee_id
str
Required. Identifies the debuggee being debugged. 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. Updated breakpoint information. The field id must be set. The agent must echo all Breakpoint specification fields in the update. This corresponds to the breakpoint_ 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.
google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse
Response for updating an active breakpoint. The message is defined to allow future extensions.