File: //lib/google-cloud-sdk/lib/surface/debug/snapshots/describe.py
# -*- coding: utf-8 -*- #
# Copyright 2016 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""List command for gcloud debug snapshots command group."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.debug import debug
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.debug import flags
from googlecloudsdk.core import properties
DETAILED_HELP = {
'brief':
"""\
Describe the debug snapshots for a Cloud Debugger debug target
(debuggee).
""",
'DESCRIPTION':
"""\
*{command}* is used to describe the debug snapshots for a Cloud Debugger
debug target (debuggee). If the snapshot has completed, the output will
include details on the stack trace and local variables, stored in a
compact form which is primarily intended to be machine-readable rather
than human-readable.
""",
'EXAMPLES':
"""\
To describe the debug snapshots for snapshots with IDs 'ID1' and 'ID2'
of the debug target (debuggee), run:
$ {command} ID1 ID2 --target=<debuggee_id>
To describe all active snapshots in file main.py of the debug target
(debuggee), run:
$ {command} --target=<debuggee_id> --location="main.py:.*"
"""
}
class Describe(base.DescribeCommand):
"""Describe debug snapshots."""
detailed_help = DETAILED_HELP
@staticmethod
def Args(parser):
flags.AddIdOptions(parser, 'snapshot', 'snapshots', 'displayed')
def Run(self, args):
"""Run the describe command."""
project_id = properties.VALUES.core.project.Get(required=True)
self.user_email = properties.VALUES.core.account.Get(required=True)
debugger = debug.Debugger(project_id)
debuggee = debugger.FindDebuggee(args.target)
return debuggee.ListBreakpoints(args.location,
include_all_users=True,
resource_ids=args.ids,
restrict_to_type=debugger.SNAPSHOT_TYPE,
full_details=True)