File: //snap/google-cloud-cli/396/lib/googlecloudsdk/api_lib/workbench/util.py
# -*- coding: utf-8 -*- #
# Copyright 2023 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.
"""A library that is used to support trace commands."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.util import apis as core_apis
from googlecloudsdk.api_lib.util import waiter
from googlecloudsdk.calliope import base
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
def ApiVersionSelector(release_track):
"""Returns the correct API version.
Args:
release_track: base.ReleaseTrack object
"""
del release_track
return 'v2'
def GetClient(release_track=base.ReleaseTrack.GA):
"""Returns the client for the trace API."""
return core_apis.GetClientInstance('notebooks',
ApiVersionSelector(release_track))
def GetMessages(release_track=base.ReleaseTrack.GA):
"""Returns the messages for the trace API."""
return core_apis.GetMessagesModule('notebooks',
ApiVersionSelector(release_track))
def GetLocationResource(location, project=None):
if not project:
project = properties.VALUES.core.project.Get(required=True)
return resources.REGISTRY.Parse(
location,
params={'projectsId': project},
collection='notebooks.projects.locations')
def GetParentForInstance(args):
if args.IsSpecified('instance'):
instance = args.CONCEPTS.instance.Parse()
return GetLocationResource(instance.locationsId,
instance.projectsId).RelativeName()
def GetProjectResource(project):
"""Returns the resource for the current project."""
return resources.REGISTRY.Parse(
project or properties.VALUES.core.project.Get(required=True),
collection='notebooks.projects')
def GetParentFromArgs(args):
"""Gets the parent resource for the command.
Args:
args: The args object containing the command arguments.
Returns:
The resource name of the parent resource.
Raises:
ValueError: If neither `--location` nor the `location` property is
specified.
"""
project = properties.VALUES.core.project.Get(required=True)
if args.IsSpecified('location'):
return GetLocationResource(args.location, project).RelativeName()
elif properties.VALUES.notebooks.location.IsExplicitlySet():
return GetLocationResource(
properties.VALUES.notebooks.location.Get(required=True), project
).RelativeName()
else:
raise ValueError(
'One of --location or location property must be specified.'
)
def GetOperationResource(name, release_track=None):
return resources.REGISTRY.ParseRelativeName(
name,
collection='notebooks.projects.locations.operations',
api_version=ApiVersionSelector(release_track),
)
def WaitForOperation(
operation, message, service, release_track, is_delete=False
):
"""Waits for the given google.longrunning.Operation to complete.
Args:
operation: The operation to poll.
message: String to display for default progress_tracker.
service: The service to get the resource after the long running operation
completes.
release_track: base.ReleaseTrack object.
is_delete: Bool indicating is Poller should fetch resource post operation.
Raises:
apitools.base.py.HttpError: if the request returns an HTTP error
Returns:
The created Environment resource.
"""
operation_ref = GetOperationResource(operation.name, release_track)
client = GetClient(release_track)
if is_delete:
poller = waiter.CloudOperationPollerNoResources(
client.projects_locations_operations)
else:
poller = waiter.CloudOperationPoller(
service, client.projects_locations_operations)
return waiter.WaitFor(poller, operation_ref, message)