feat: Add new gcloud commands, API clients, and third-party libraries across various services.

gcloud auth application-default login/google-cloud-sdk/lib/surface/firestore/operations/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2018 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.
+"""The command group for Cloud Firestore operations."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.calliope import base
+
+
+class Operations(base.Group):
+  """Manage Long Running Operations for Cloud Firestore."""
+  pass

gcloud auth application-default login/google-cloud-sdk/lib/surface/firestore/operations/cancel.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2017 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.
+"""The gcloud firestore operations cancel command."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.firestore import api_utils
+from googlecloudsdk.api_lib.firestore import operations
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.firestore import flags
+from googlecloudsdk.core import properties
+from googlecloudsdk.core import resources
+from googlecloudsdk.core.console import console_io
+
+
+class Cancel(base.Command):
+  """Cancel a currently-running Cloud Firestore admin operation."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To cancel the currently-running `exampleOperationId` operation, run:
+
+            $ {command} exampleOperationId
+      """
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    parser.add_argument(
+        'name',
+        type=str,
+        default=None,
+        help="""
+        The unique name of the Operation to cancel, formatted as either the full
+        or relative resource path:
+
+          projects/my-app-id/databases/(default)/operations/foo
+
+        or:
+
+          foo
+        """)
+    flags.AddDatabaseIdFlag(parser)
+
+  def Run(self, args):
+    name = resources.REGISTRY.Parse(
+        args.name,
+        params={
+            'projectsId': properties.VALUES.core.project.GetOrFail,
+            'databasesId': args.database,
+        },
+        api_version=api_utils.FIRESTORE_API_VERSION,
+        collection='firestore.projects.databases.operations').RelativeName()
+    console_io.PromptContinue(
+        message='The operation [{}] will be cancelled.'.format(name),
+        cancel_on_no=True)
+
+    return operations.CancelOperation(name)

gcloud auth application-default login/google-cloud-sdk/lib/surface/firestore/operations/delete.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2018 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.
+"""The gcloud firestore operations delete command."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.firestore import api_utils
+from googlecloudsdk.api_lib.firestore import operations
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.firestore import flags
+from googlecloudsdk.core import properties
+from googlecloudsdk.core import resources
+from googlecloudsdk.core.console import console_io
+
+
+class Delete(base.DeleteCommand):
+  """Delete a completed Cloud Firestore admin operation."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To delete the completed `exampleOperationId` operation, run:
+
+            $ {command} exampleOperationId
+      """
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    parser.add_argument(
+        'name',
+        type=str,
+        default=None,
+        help="""
+        The unique name of the operation to delete, formatted as either the full
+        or relative resource path:
+
+          projects/my-app-id/databases/(default)/operations/foo
+
+        or:
+
+          foo
+        """)
+    flags.AddDatabaseIdFlag(parser)
+
+  def Run(self, args):
+    name = resources.REGISTRY.Parse(
+        args.name,
+        params={
+            'projectsId': properties.VALUES.core.project.GetOrFail,
+            'databasesId': args.database,
+        },
+        api_version=api_utils.FIRESTORE_API_VERSION,
+        collection='firestore.projects.databases.operations').RelativeName()
+    console_io.PromptContinue(
+        message='The operation [{}] will be deleted.'.format(name),
+        cancel_on_no=True)
+
+    return operations.DeleteOperation(name)

gcloud auth application-default login/google-cloud-sdk/lib/surface/firestore/operations/describe.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2018 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.
+"""The gcloud firestore operations describe command."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.firestore import api_utils
+from googlecloudsdk.api_lib.firestore import operations
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.firestore import flags
+from googlecloudsdk.core import properties
+from googlecloudsdk.core import resources
+
+
+class Describe(base.DescribeCommand):
+  """Retrieves information about a Cloud Firestore admin operation."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To retrieve information about the `exampleOperationId` operation, run:
+
+            $ {command} exampleOperationId
+      """
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    parser.add_argument(
+        'name',
+        type=str,
+        default=None,
+        help="""
+        The unique name of the Operation to retrieve, formatted as either the
+        full or relative resource path:
+
+          projects/my-app-id/databases/(default)/operations/foo
+
+        or:
+
+          foo
+        """)
+    flags.AddDatabaseIdFlag(parser)
+
+  def Run(self, args):
+    name = resources.REGISTRY.Parse(
+        args.name,
+        params={
+            'projectsId': properties.VALUES.core.project.GetOrFail,
+            'databasesId': args.database,
+        },
+        api_version=api_utils.FIRESTORE_API_VERSION,
+        collection='firestore.projects.databases.operations').RelativeName()
+    return operations.GetOperation(name)

gcloud auth application-default login/google-cloud-sdk/lib/surface/firestore/operations/list.py

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2018 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.
+"""The gcloud firestore operations list command."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.firestore import operations
+from googlecloudsdk.api_lib.firestore import rewrite_backend
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.firestore import flags
+from googlecloudsdk.core import properties
+from googlecloudsdk.core.resource import resource_projection_spec
+
+
+class List(base.ListCommand):
+  """List pending Cloud Firestore admin operations and their status.
+
+  Filters are case-sensitive and have the following syntax:
+
+    field = value [AND [field = value]] ...
+
+  Only the logical `AND` operator is
+  supported; space-separated items are treated as having an implicit `AND`
+  operator.
+  """
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To retrieve information about recent operations, run:
+
+            $ {command}
+
+          To only list operations that are done, run:
+
+            $ {command} --filter="done:true"
+      """
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    base.PAGE_SIZE_FLAG.SetDefault(parser, operations.DEFAULT_PAGE_SIZE)
+    base.LIMIT_FLAG.SetDefault(parser, operations.DEFAULT_PAGE_SIZE)
+    flags.AddDatabaseIdFlag(parser)
+
+  def Run(self, args):
+    frontend_filter, backend_filter = self._ConvertFilter(args.filter, args)
+    # Override existing filter with frontend filter.
+    args.filter = frontend_filter
+    return operations.ListOperations(
+        project=properties.VALUES.core.project.Get(required=True),
+        database=args.database,
+        limit=args.limit,
+        operation_filter=backend_filter)
+
+  def _ConvertFilter(self, expression, args):
+    """Translates user-provided filter spec into one our backend understands.
+
+    Args:
+      expression: a filter spec to translate
+      args: the args namespace object
+    Returns:
+      A tuple of string filter specs. The first is the frontend spec for post
+      filtering, the second is a spec that the Firestore Admin API understands.
+    """
+    operation_rewrite_backend = rewrite_backend.OperationsRewriteBackend()
+    display_info = args.GetDisplayInfo()
+    defaults = resource_projection_spec.ProjectionSpec(
+        symbols=display_info.transforms, aliases=display_info.aliases)
+    return operation_rewrite_backend.Rewrite(expression, defaults=defaults)

gcloud auth application-default login/google-cloud-sdk/lib/surface/firestore/operations/wait.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2024 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.
+"""The gcloud firestore operations wait command."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.firestore import operations
+from googlecloudsdk.calliope import base
+
+
+@base.ReleaseTracks(
+    base.ReleaseTrack.ALPHA
+)
+class Wait(base.Command):
+  """Waits a Cloud Firestore admin operation to complete."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To wait a Cloud Firestore admin operation `exampleOperationId` to
+          complete, run:
+
+            $ {command} exampleOperationId
+      """
+  }
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    parser.add_argument(
+        'name',
+        type=str,
+        default=None,
+        help="""
+        The unique name of the Operation to retrieve, formatted as full resource
+        path:
+
+          projects/my-app-id/databases/(default)/operations/foo
+        """)
+
+  def Run(self, args):
+    return operations.WaitForOperationWithName(args.name)