docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/clouddebugger_v2.controller.debuggees.html b/docs/dyn/clouddebugger_v2.controller.debuggees.html
index 055d794..ec5f36e 100644
--- a/docs/dyn/clouddebugger_v2.controller.debuggees.html
+++ b/docs/dyn/clouddebugger_v2.controller.debuggees.html
@@ -108,6 +108,69 @@
# attached with a debugger agent, carrying out the debugging commands.
# Agents attached to the same debuggee identify themselves as such by using
# exactly the same Debuggee message value when registering.
+ "sourceContexts": [ # References to the locations and revisions of the source code used in the
+ # deployed application.
+ { # A SourceContext is a reference to a tree of files. A SourceContext together
+ # with a path point to a unique revision of a single file or directory.
+ "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
+ # repository (e.g. GitHub).
+ "revisionId": "A String", # Git commit hash.
+ # required.
+ "url": "A String", # Git repository URL.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
+ # "project/subproject" is a valid project name.
+ # The "repo name" is hostURI/project.
+ "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
+ "name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
+ },
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "revisionId": "A String", # A revision (commit) ID.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
+ },
+ "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
+ # repo (a repo hosted by the Google Cloud Platform).
+ "revisionId": "A String", # A revision ID.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
+ "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
+ "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
+ # (e.g. winged-cargo-31) and a repo name within that project.
+ "projectId": "A String", # The ID of the project.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
+ "name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
+ },
+ },
+ "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
+ "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
+ # A cloud workspace is a place associated with a repo where modified files
+ # can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
+ "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
+ "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
+ # (e.g. winged-cargo-31) and a repo name within that project.
+ "projectId": "A String", # The ID of the project.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "snapshotId": "A String", # The ID of the snapshot.
+ # An empty snapshot_id refers to the most recent snapshot.
+ },
+ },
+ ],
+ "labels": { # A set of custom debuggee properties, populated by the agent, to be
+ # displayed to the user.
+ "a_key": "A String",
+ },
"project": "A String", # Project the debuggee is associated with.
# Use project number or id when registering a Google Cloud Platform project.
"isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and
@@ -125,9 +188,6 @@
# deployed application.
{ # An ExtendedSourceContext is a SourceContext combined with additional
# details describing the context.
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
"context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.
# with a path point to a unique revision of a single file or directory.
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -137,16 +197,16 @@
"url": "A String", # Git repository URL.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "revisionId": "A String", # A revision (commit) ID.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
"name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
},
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "revisionId": "A String", # A revision (commit) ID.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
# repo (a repo hosted by the Google Cloud Platform).
@@ -161,16 +221,16 @@
"uid": "A String", # A server-assigned, globally unique identifier.
},
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
"name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
},
},
"cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
- "snapshotId": "A String", # The ID of the snapshot.
- # An empty snapshot_id refers to the most recent snapshot.
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
@@ -179,15 +239,16 @@
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
+ "snapshotId": "A String", # The ID of the snapshot.
+ # An empty snapshot_id refers to the most recent snapshot.
},
},
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
},
],
- "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any
- # activity from the debuggee agents and the application is possibly stopped.
"status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee.
# Absence of this field indicates no status. The message can be either
# informational or an error status.
@@ -197,9 +258,6 @@
# to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
"isError": True or False, # Distinguishes errors from informational messages.
"description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
"format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
# `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
# character.
@@ -209,77 +267,19 @@
# * `Failed to load '$0' which helps debug $1 the first time it
# is loaded. Again, $0 is very important.`
# * `Please pay $$10 to use $0 instead of $1.`
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
},
"refersTo": "A String", # Reference to which the message applies.
},
+ "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any
+ # activity from the debuggee agents and the application is possibly stopped.
"canaryMode": "A String", # Used when setting breakpoint canary for this debuggee.
"id": "A String", # Unique identifier for the debuggee generated by the controller service.
"agentVersion": "A String", # Version ID of the agent.
# Schema: `domain/language-platform/vmajor.minor` (for example
# `google.com/java-gcp/v1.1`).
- "sourceContexts": [ # References to the locations and revisions of the source code used in the
- # deployed application.
- { # A SourceContext is a reference to a tree of files. A SourceContext together
- # with a path point to a unique revision of a single file or directory.
- "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
- # repository (e.g. GitHub).
- "revisionId": "A String", # Git commit hash.
- # required.
- "url": "A String", # Git repository URL.
- },
- "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "revisionId": "A String", # A revision (commit) ID.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
- "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
- # "project/subproject" is a valid project name.
- # The "repo name" is hostURI/project.
- "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
- "name": "A String", # The alias name.
- },
- },
- "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
- # repo (a repo hosted by the Google Cloud Platform).
- "revisionId": "A String", # A revision ID.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
- "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
- # (e.g. winged-cargo-31) and a repo name within that project.
- "projectId": "A String", # The ID of the project.
- "repoName": "A String", # The name of the repo. Leave empty for the default repo.
- },
- "uid": "A String", # A server-assigned, globally unique identifier.
- },
- "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
- "name": "A String", # The alias name.
- },
- },
- "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
- "snapshotId": "A String", # The ID of the snapshot.
- # An empty snapshot_id refers to the most recent snapshot.
- "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
- # A cloud workspace is a place associated with a repo where modified files
- # can be stored before they are committed.
- "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
- # (e.g. winged-cargo-31) and a repo name within that project.
- "projectId": "A String", # The ID of the project.
- "repoName": "A String", # The name of the repo. Leave empty for the default repo.
- },
- "uid": "A String", # A server-assigned, globally unique identifier.
- },
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
- },
- },
- },
- ],
- "labels": { # A set of custom debuggee properties, populated by the agent, to be
- # displayed to the user.
- "a_key": "A String",
- },
},
}
@@ -301,6 +301,69 @@
# attached with a debugger agent, carrying out the debugging commands.
# Agents attached to the same debuggee identify themselves as such by using
# exactly the same Debuggee message value when registering.
+ "sourceContexts": [ # References to the locations and revisions of the source code used in the
+ # deployed application.
+ { # A SourceContext is a reference to a tree of files. A SourceContext together
+ # with a path point to a unique revision of a single file or directory.
+ "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
+ # repository (e.g. GitHub).
+ "revisionId": "A String", # Git commit hash.
+ # required.
+ "url": "A String", # Git repository URL.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
+ # "project/subproject" is a valid project name.
+ # The "repo name" is hostURI/project.
+ "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
+ "name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
+ },
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "revisionId": "A String", # A revision (commit) ID.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
+ },
+ "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
+ # repo (a repo hosted by the Google Cloud Platform).
+ "revisionId": "A String", # A revision ID.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
+ "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
+ "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
+ # (e.g. winged-cargo-31) and a repo name within that project.
+ "projectId": "A String", # The ID of the project.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
+ "name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
+ },
+ },
+ "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
+ "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
+ # A cloud workspace is a place associated with a repo where modified files
+ # can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
+ "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
+ "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
+ # (e.g. winged-cargo-31) and a repo name within that project.
+ "projectId": "A String", # The ID of the project.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "snapshotId": "A String", # The ID of the snapshot.
+ # An empty snapshot_id refers to the most recent snapshot.
+ },
+ },
+ ],
+ "labels": { # A set of custom debuggee properties, populated by the agent, to be
+ # displayed to the user.
+ "a_key": "A String",
+ },
"project": "A String", # Project the debuggee is associated with.
# Use project number or id when registering a Google Cloud Platform project.
"isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and
@@ -318,9 +381,6 @@
# deployed application.
{ # An ExtendedSourceContext is a SourceContext combined with additional
# details describing the context.
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
"context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.
# with a path point to a unique revision of a single file or directory.
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -330,16 +390,16 @@
"url": "A String", # Git repository URL.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "revisionId": "A String", # A revision (commit) ID.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
"name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
},
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "revisionId": "A String", # A revision (commit) ID.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
# repo (a repo hosted by the Google Cloud Platform).
@@ -354,16 +414,16 @@
"uid": "A String", # A server-assigned, globally unique identifier.
},
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
"name": "A String", # The alias name.
+ "kind": "A String", # The alias kind.
},
},
"cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
- "snapshotId": "A String", # The ID of the snapshot.
- # An empty snapshot_id refers to the most recent snapshot.
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
@@ -372,15 +432,16 @@
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
+ "snapshotId": "A String", # The ID of the snapshot.
+ # An empty snapshot_id refers to the most recent snapshot.
},
},
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
},
],
- "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any
- # activity from the debuggee agents and the application is possibly stopped.
"status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee.
# Absence of this field indicates no status. The message can be either
# informational or an error status.
@@ -390,9 +451,6 @@
# to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
"isError": True or False, # Distinguishes errors from informational messages.
"description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
"format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
# `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
# character.
@@ -402,77 +460,19 @@
# * `Failed to load '$0' which helps debug $1 the first time it
# is loaded. Again, $0 is very important.`
# * `Please pay $$10 to use $0 instead of $1.`
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
},
"refersTo": "A String", # Reference to which the message applies.
},
+ "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any
+ # activity from the debuggee agents and the application is possibly stopped.
"canaryMode": "A String", # Used when setting breakpoint canary for this debuggee.
"id": "A String", # Unique identifier for the debuggee generated by the controller service.
"agentVersion": "A String", # Version ID of the agent.
# Schema: `domain/language-platform/vmajor.minor` (for example
# `google.com/java-gcp/v1.1`).
- "sourceContexts": [ # References to the locations and revisions of the source code used in the
- # deployed application.
- { # A SourceContext is a reference to a tree of files. A SourceContext together
- # with a path point to a unique revision of a single file or directory.
- "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
- # repository (e.g. GitHub).
- "revisionId": "A String", # Git commit hash.
- # required.
- "url": "A String", # Git repository URL.
- },
- "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "revisionId": "A String", # A revision (commit) ID.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
- "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
- # "project/subproject" is a valid project name.
- # The "repo name" is hostURI/project.
- "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
- "name": "A String", # The alias name.
- },
- },
- "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
- # repo (a repo hosted by the Google Cloud Platform).
- "revisionId": "A String", # A revision ID.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
- "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
- # (e.g. winged-cargo-31) and a repo name within that project.
- "projectId": "A String", # The ID of the project.
- "repoName": "A String", # The name of the repo. Leave empty for the default repo.
- },
- "uid": "A String", # A server-assigned, globally unique identifier.
- },
- "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
- "kind": "A String", # The alias kind.
- "name": "A String", # The alias name.
- },
- },
- "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
- "snapshotId": "A String", # The ID of the snapshot.
- # An empty snapshot_id refers to the most recent snapshot.
- "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
- # A cloud workspace is a place associated with a repo where modified files
- # can be stored before they are committed.
- "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
- # (e.g. winged-cargo-31) and a repo name within that project.
- "projectId": "A String", # The ID of the project.
- "repoName": "A String", # The name of the repo. Leave empty for the default repo.
- },
- "uid": "A String", # A server-assigned, globally unique identifier.
- },
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
- },
- },
- },
- ],
- "labels": { # A set of custom debuggee properties, populated by the agent, to be
- # displayed to the user.
- "a_key": "A String",
- },
},
"agentId": "A String", # A unique ID generated for the agent.
# Each RegisterDebuggee request will generate a new agent ID.