File: //snap/google-cloud-cli/396/lib/surface/storage/buckets/anywhere_caches/create.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.
"""Implementation of create command for creating Anywhere Cache Instances."""
from googlecloudsdk.calliope import arg_parsers
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.storage import errors_util
from googlecloudsdk.command_lib.storage import flags
from googlecloudsdk.command_lib.storage import plurality_checkable_iterator
from googlecloudsdk.command_lib.storage import progress_callbacks
from googlecloudsdk.command_lib.storage import storage_url
from googlecloudsdk.command_lib.storage.tasks import task_executor
from googlecloudsdk.command_lib.storage.tasks import task_graph_executor
from googlecloudsdk.command_lib.storage.tasks import task_status
from googlecloudsdk.command_lib.storage.tasks.buckets.anywhere_caches import create_anywhere_cache_task
@base.DefaultUniverseOnly
class Create(base.CreateCommand):
"""Create Anywhere Cache instances for a bucket."""
detailed_help = {
'DESCRIPTION': """
Create Anywhere Cache instances.
Only one cache instance per zone can be created for each bucket.
""",
'EXAMPLES': """
The following command creates an anywhere cache instance for bucket
in ``asia-south2-b'' zone:
$ {command} gs://my-bucket asia-south2-b
The following command creates anywhere cache instances for bucket
in ``asia-south2-b'', and ``asia-east1-a'' zone:
$ {command} gs://my-bucket asia-south2-b asia-east1-a
The following command creates an anywhere cache instance for bucket
in ``asia-south2-b'' zone, with ttl for cache entry as 6 hours, and
admission policy as ``ADMIT_ON_SECOND_MISS'':
$ {command} gs://my-bucket asia-south2-b --ttl=6h --admission-policy='ADMIT_ON_SECOND_MISS'
""",
}
@classmethod
def Args(cls, parser):
parser.add_argument(
'url',
type=str,
help=(
'Specifies the URL of the bucket where the Anywhere Cache should be'
' created.'
),
)
parser.add_argument(
'zone',
type=str,
nargs='+',
help=(
'Specifies the name of the zonal locations where the Anywhere Cache'
' should be created.'
),
)
parser.add_argument(
'--ttl',
type=arg_parsers.Duration(),
help='Cache entry time-to-live. Default to 24h if not provided.',
)
flags.add_admission_policy_flag(parser)
def get_task_iterator(self, args, task_status_queue):
url = storage_url.storage_url_from_string(args.url)
errors_util.raise_error_if_not_gcs_bucket(args.command_path, url)
progress_callbacks.workload_estimator_callback(
task_status_queue, len(args.zone)
)
if args.ttl is not None:
args.ttl = str(args.ttl)+'s'
for zone in args.zone:
yield create_anywhere_cache_task.CreateAnywhereCacheTask(
url, zone, admission_policy=args.admission_policy, ttl=args.ttl
)
def Run(self, args):
task_status_queue = task_graph_executor.multiprocessing_context.Queue()
task_iterator = self.get_task_iterator(args, task_status_queue)
plurality_checkable_task_iterator = (
plurality_checkable_iterator.PluralityCheckableIterator(task_iterator)
)
self.exit_code = task_executor.execute_tasks(
plurality_checkable_task_iterator,
parallelizable=True,
task_status_queue=task_status_queue,
progress_manager_args=task_status.ProgressManagerArgs(
increment_type=task_status.IncrementType.INTEGER, manifest_path=None
),
)