anyscale 0.26.47__py3-none-any.whl → 0.26.49__py3-none-any.whl

anyscale/commands/cloud_commands.py

@@ -244,21 +244,26 @@ def list_cloud(name: Optional[str], cloud_id: Optional[str], max_items: int,) ->
     )
 
 
+@cloud_cli.group("deployment", help="Manage the configuration for a cloud deployment.")
+def cloud_deployment_group() -> None:
+    pass
+
+
 @cloud_cli.group("config", help="Manage the configuration for a cloud.")
 def cloud_config_group() -> None:
     pass
 
 
-@cloud_cli.command(
-    name="add-deployment",
-    help="Add a new cloud deployment to an existing cloud.",
+@cloud_deployment_group.command(
+    name="create",
+    help="Create a new cloud deployment in an existing cloud.",
     cls=AnyscaleCommand,
-    example=command_examples.CLOUD_ADD_DEPLOYMENT_EXAMPLE,
+    example=command_examples.CLOUD_DEPLOYMENT_CREATE_EXAMPLE,
+    is_alpha=True,
 )
 @click.option(
-    "--cloud-name",
-    "-n",
-    help="The name of the cloud to add the new deployment to.",
+    "--cloud",
+    help="The name of the cloud to create the new deployment in.",
     type=str,
     required=True,
 )
@@ -274,20 +279,85 @@ def cloud_config_group() -> None:
 @click.option(
     "--yes", "-y", is_flag=True, default=False, help="Skip asking for confirmation."
 )
-def cloud_add_deployment(
-    cloud_name: str, file: str, skip_verification: bool, yes: bool,
+def cloud_deployment_create(
+    cloud: str, file: str, skip_verification: bool, yes: bool,
 ) -> None:
     try:
-        CloudController().add_cloud_deployment(cloud_name, file, skip_verification, yes)
+        CloudController().create_cloud_deployment(cloud, file, skip_verification, yes)
     except click.ClickException as e:
         print(e)
 
 
-@cloud_cli.command(
-    name="remove-deployment",
+@cloud_deployment_group.command(
+    name="get",
+    help="Get a cloud deployment for a cloud.",
+    cls=AnyscaleCommand,
+    example=command_examples.CLOUD_DEPLOYMENT_GET_EXAMPLE,
+    is_alpha=True,
+)
+@click.option(
+    "--cloud",
+    help="The name of the cloud that the cloud deployment belongs to.",
+    type=str,
+    required=True,
+)
+@click.option(
+    "--deployment",
+    help="The name of the cloud deployment. If not provided, the primary cloud deployment will be returned.",
+    type=str,
+    required=False,
+)
+def cloud_deployment_get(cloud: str, deployment: Optional[str]) -> None:
+    try:
+        result = CloudController().get_cloud_deployment_dict_by_name(cloud, deployment)
+        print(yaml.dump(result, sort_keys=False))
+    except click.ClickException as e:
+        print(e)
+
+
+@cloud_deployment_group.command(
+    name="update",
+    help="Update a cloud deployment in an existing cloud.",
+    cls=AnyscaleCommand,
+    example=command_examples.CLOUD_DEPLOYMENT_UPDATE_EXAMPLE,
+    is_alpha=True,
+)
+@click.option(
+    "--cloud",
+    help="The name of the cloud that the cloud deployment belongs to.",
+    type=str,
+    required=True,
+)
+@click.option(
+    "--file",
+    "-f",
+    help="Path to a YAML file defining the cloud deployment. Schema: https://docs.anyscale.com/reference/cloud-api#clouddeployment.",  # TODO(janet): check link
+    required=True,
+)
+@click.option(
+    "--skip-verification",
+    is_flag=True,
+    default=False,
+    help="Skip cloud deployment verification.",
+)
+@click.option(
+    "--yes", "-y", is_flag=True, default=False, help="Skip asking for confirmation."
+)
+def cloud_deployment_update(
+    cloud: str, file: str, skip_verification: bool, yes: bool
+) -> None:
+    try:
+        CloudController().update_cloud_deployment(cloud, file, skip_verification, yes)
+    except click.ClickException as e:
+        print(e)
+
+
+@cloud_deployment_group.command(
+    name="delete",
     help="Remove a cloud deployment from an existing cloud.",
     cls=AnyscaleCommand,
-    example=command_examples.CLOUD_REMOVE_DEPLOYMENT_EXAMPLE,
+    example=command_examples.CLOUD_DEPLOYMENT_DELETE_EXAMPLE,
+    is_alpha=True,
 )
 @click.option(
     "--cloud",
@@ -304,7 +374,7 @@ def cloud_add_deployment(
 @click.option(
     "--yes", "-y", is_flag=True, default=False, help="Skip asking for confirmation."
 )
-def cloud_remove_deployment(cloud: str, deployment: str, yes: bool,) -> None:
+def cloud_deployment_delete(cloud: str, deployment: str, yes: bool,) -> None:
     try:
         CloudController().remove_cloud_deployment(cloud, deployment, yes)
     except click.ClickException as e:
@@ -314,7 +384,6 @@ def cloud_remove_deployment(cloud: str, deployment: str, yes: bool,) -> None:
 @cloud_cli.command(
     name="update",
     help=(
-        # TODO(janet): Update this help text when the -o option is un-hidden.
         "Update a managed cloud to the latest configuration. Only applicable for anyscale managed clouds."
     ),
 )
@@ -353,19 +422,6 @@ def cloud_remove_deployment(cloud: str, deployment: str, yes: bool,) -> None:
         "are manually granted permissions to access the cloud. No existing cloud permissions are altered by specifying this flag."
     ),
 )
-@click.option(
-    "--file",
-    "-f",
-    help="YAML file containing the updated cloud spec.",
-    required=False,
-    hidden=True,
-)
-@click.option(
-    "--skip-verification",
-    is_flag=True,
-    default=False,
-    help="Skip cloud deployment verification.",
-)
 def cloud_update(  # noqa: PLR0913
     cloud_name: Optional[str],
     name: Optional[str],
@@ -374,16 +430,7 @@ def cloud_update(  # noqa: PLR0913
     enable_head_node_fault_tolerance: bool,
     yes: bool,
     enable_auto_add_user: Optional[bool],
-    file: Optional[str],
-    skip_verification: bool,
 ) -> None:
-    if file:
-        try:
-            CloudController().update_cloud_deployments(file, skip_verification)
-        except click.ClickException as e:
-            print(e)
-        return
-
     if cloud_name and name and cloud_name != name:
         raise click.ClickException(
             "The positional argument CLOUD_NAME and the keyword argument --name "
@@ -432,14 +479,17 @@ def cloud_config_get(
 
 
 @cloud_config_group.command(
-    "update", help="Update the current configuration for a cloud."
+    "update",
+    help="Update the current configuration for a cloud.",
+    cls=AnyscaleCommand,
+    example=command_examples.CLOUD_CONFIG_UPDATE_EXAMPLE,
 )
 @click.argument("cloud-name", required=False)
 @click.option("--name", "-n", help="Update configuration of cloud by name.", type=str)
 @click.option(
     "--cloud-id",
     "--id",
-    help="Cloud id to get details about. Alternative to cloud name.",
+    help="Cloud id to update. Alternative to cloud name.",
     required=False,
 )
 @click.option(
@@ -457,6 +507,12 @@ def cloud_config_get(
         "extra data transfer cost from the cloud provider by enabling this feature."
     ),
 )
+@click.option(
+    "--enable-system-cluster/--disable-system-cluster",
+    default=None,
+    help="Enable or disable system cluster functionality.",
+    required=False,
+)
 @click.option(
     "--spec-file",
     type=str,
@@ -468,14 +524,25 @@ def cloud_config_update(
     name: Optional[str],
     cloud_id: Optional[str],
     enable_log_ingestion: Optional[bool],
+    enable_system_cluster: Optional[bool],
     spec_file: Optional[str],
 ) -> None:
-    if any([enable_log_ingestion is not None]) and spec_file:
+    if cloud_name and name and cloud_name != name:
+        raise click.ClickException(
+            "The positional argument CLOUD_NAME and the keyword argument --name "
+            "were both provided. Please only provide one of these two arguments."
+        )
+
+    passed_enable_disable_flags = any(
+        [enable_log_ingestion is not None, enable_system_cluster is not None]
+    )
+    if passed_enable_disable_flags and spec_file:
         raise click.ClickException(
-            "Please provide only one of the following arguments: --enable-log-ingestion, --disable-log-ingestion, --spec-file."
+            "Invalid combination of arguments: --spec-file should not be provided with any other enable/disable flags."
         )
 
-    if any([enable_log_ingestion is not None]):
+    if passed_enable_disable_flags:
+        # Handle log ingestion configuration
         # TODO: enable_log_ingestion should be unified into cloud deployment config.
         if enable_log_ingestion is True:
             consent_message = click.prompt(
@@ -490,7 +557,7 @@ def cloud_config_update(
                 raise click.ClickException(
                     'You must type "consent" to enable log ingestion.'
                 )
-        if enable_log_ingestion is False:
+        elif enable_log_ingestion is False:
             confirm_response = click.confirm(
                 "--disable-log-ingestion is specified. Please note the logs that's "
                 "already ingested will not be deleted. Existing clusters will not stop"
@@ -506,13 +573,38 @@ def cloud_config_update(
             cloud_id=cloud_id,
             enable_log_ingestion=enable_log_ingestion,
         )
+
+        # Handle system cluster configuration
+        if enable_system_cluster is True:
+            confirm_response = click.confirm(
+                "--enable-system-cluster is specified. Please note that this will enable "
+                "system cluster functionality for the cloud and will incur extra cost. "
+                "Are you sure you want to enable system cluster?"
+            )
+        elif enable_system_cluster is False:
+            confirm_response = click.confirm(
+                "--disable-system-cluster is specified. This will disable system cluster "
+                "functionality for the cloud. Please note that this will not terminate "
+                "the system cluster if it is currently running. "
+                "Are you sure you want to disable system cluster?"
+            )
+        if enable_system_cluster is not None and not confirm_response:
+            raise click.ClickException(
+                f"You must confirm to {'enable' if enable_system_cluster else 'disable'} system cluster."
+            )
+
+        CloudController().update_system_cluster_config(
+            cloud_name=cloud_name or name,
+            cloud_id=cloud_id,
+            system_cluster_enabled=enable_system_cluster,
+        )
     elif spec_file:
         CloudController().update_cloud_config(
             cloud_name=cloud_name or name, cloud_id=cloud_id, spec_file=spec_file,
         )
     else:
         raise click.ClickException(
-            "Please provide at least one of the following arguments: --enable-log-ingestion, --disable-log-ingestion."
+            "Please provide at least one of the following arguments: --enable-log-ingestion, --disable-log-ingestion, --enable-system-cluster, --disable-system-cluster, --spec-file."
         )
 
 

anyscale/commands/command_examples.py

@@ -322,135 +322,6 @@ $ anyscale machine-pool detach --name can-testing --cloud my-cloud
 Detached machine pool 'can-testing' from cloud 'my-cloud'.
 """
 
-LLM_MODELS_GET_EXAMPLE = """
-$ anyscale llm model get --model-id my-model-id
-Output
-{
-    'id': 'my-model-id',
-    'base_model_id': 'meta-llama/Meta-Llama-3-8B',
-    'storage_uri': 'gs://my_bucket/my_folder',
-    'ft_type': 'LORA',
-    'cloud_id': 'cld_tffbxe9ia5phqr1unxhz4f7e1e',
-    'project_id': 'prj_dqb6ha67zubz3gdlvn2tmmglb8',
-    'created_at': 1725563985,
-    'creator': 'test@anyscale.com',
-    'job_id': 'N/A',
-    'workspace_id': 'expwrk_yje3t8twim18iuta9r45gwcgcn',
-    'generation_config': {
-        'prompt_format': {
-            'system': '<|start_header_id|>system<|end_header_id|>\\n\\n{instruction}<|eot_id|>',
-            'assistant': '<|start_header_id|>assistant<|end_header_id|>\\n\\n{instruction}<|eot_id|>',
-            'trailing_assistant': '<|start_header_id|>assistant<|end_header_id|>\\n\\n',
-            'user': '<|start_header_id|>user<|end_header_id|>\\n\\n{instruction}<|eot_id|>',
-            'bos': '<|begin_of_text|>',
-            'default_system_message': '',
-            'add_system_tags_even_if_message_is_empty': False,
-            'system_in_user': False,
-            'system_in_last_user': False,
-            'strip_whitespace': True
-        },
-        'stopping_sequences': None
-    }
-}
-"""
-
-LLM_MODELS_LIST_EXAMPLE = """
-$ anyscale llm model list --cloud-id cld_1j41ls4gwkga4pwp8nbql6f239 --project_id prj_i4wy1t442cbe2sthxp61dmtkbh --max-items 2
-Output
-[
-    {
-        'id': 'meta-llama/Meta-Llama-3-8B-Instruct:test:bnkve',
-        'base_model_id': 'meta-llama/Meta-Llama-3-8B-Instruct',
-        'storage_uri': 's3://anyscale-production-data-cld-1j41ls4gwkga4pwp...',
-        'ft_type': 'LORA',
-        'cloud_id': 'cld_1j41ls4gwkga4pwp8nbql6f239',
-        'project_id': 'prj_i4wy1t442cbe2sthxp61dmtkbh',
-        'created_at': 1725572462,
-        'creator': 'test@anyscale.com',
-        'job_id': 'N/A',
-        'workspace_id': 'expwrk_bqld1y579g3clukr49rsnd7i5m',
-        'generation_config': '{"prompt_format": {"system": "<|start_header_id|>s...'
-    },
-    {
-        'id': 'neuralmagic/Meta-Llama-3.1-8B-Instruct-FP8:test:czcal',
-        'base_model_id': 'neuralmagic/Meta-Llama-3.1-8B-Instruct-FP8',
-        'storage_uri': 'gs://storage-bucket-cld-tffbxe9ia5phqr1unxhz4f7e1e...',
-        'ft_type': 'LORA',
-        'cloud_id': 'cld_1j41ls4gwkga4pwp8nbql6f239',
-        'project_id': 'prj_i4wy1t442cbe2sthxp61dmtkbh',
-        'created_at': 1725563985,
-        'creator': 'test@anyscale.com',
-        'job_id': 'N/A',
-        'workspace_id': 'expwrk_yje3t8twim18iuta9r45gwcgcn',
-        'generation_config': '{"prompt_format": {"system": "<|start_header_id|>s...'
-    }
-]
-"""
-
-LLM_MODELS_DELETE_EXAMPLE = """
-$ anyscale llm model delete --model-id my-model-id
-Output
-{'id': 'my-model-id', 'deleted_at': 1725572462}
-"""
-
-LLM_DATASET_GET_EXAMPLE = """
-$ anyscale llm dataset get john_doe/viggo/train.jsonl
-Dataset(
-    id='dataset_123',
-    name='john_doe/viggo/train.jsonl',
-    filename='train.jsonl',
-    storage_uri='s3://anyscale-test-data-cld-123/org_123/cld_123/datasets/dataset_123/3/john_doe/viggo/train.jsonl',
-    version=3,
-    num_versions=3,
-    created_at=datetime.datetime(2024, 1, 1, 0, 0, tzinfo=tzutc()),
-    creator_id='usr_123',
-    project_id='prj_123',
-    cloud_id='cld_123',
-    description=None
-)
-"""
-
-LLM_DATASET_UPLOAD_EXAMPLE = """
-$ anyscale llm dataset upload path/to/my_dataset.jsonl -n my_first_dataset
-
-0:00:00 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 5.1 MB / 5.1 MB Uploading '/path/to/my_dataset.jsonl'
-
-Upload complete!
-
-Dataset(
-    id='dataset_123',
-    name='my_first_dataset',
-    filename='my_dataset.jsonl',
-    storage_uri='s3://anyscale-test-data-cld-123/org_123/cld_123/datasets/dataset_123/1/my_dataset.jsonl',
-    version=1,
-    num_versions=1,
-    created_at=datetime.datetime(2024, 1, 1, 0, 0, tzinfo=tzutc()),
-    creator_id='usr_123',
-    project_id='prj_123',
-    cloud_id='cld_123',
-    description=None
-)
-"""
-
-LLM_DATASET_DOWNLOAD_EXAMPLE = """
-$ anyscale llm dataset download train.jsonl
-0:00:00 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 711.0 kB / 711.0 kB Downloading 'train.jsonl'
-
-Download complete!
-
-{"messages":[{"content":"hi","role":"user"},{"content":"Hi! How can I help?","role":"assistant"}]}
-...
-{"messages":[{"content":"bye","role":"user"},{"content":"Goodbye!","role":"assistant"}]}
-"""
-
-LLM_DATASET_LIST_EXAMPLE = """
-$ anyscale llm dataset list
-ID         Name                   Description                       Created At             Num Versions
----------  ---------------------  --------------------------------  -------------------  --------------
-dataset_2  second                 second upload                     1/2/2024 12:00 PM              23
-dataset_1  first                  first upload                      1/1/2024 12:00 PM              13
-"""
-
 RESOURCE_QUOTAS_CREATE_EXAMPLE = """
 $ anyscale resource-quota create -n my-resource-quota --cloud my-cloud --project my-project --user-email someone@myorg.com --num-instances 100 --num-cpus 1000 --num-gpus 50 --num-accelerators A10G 10 --num-accelerators A100-80G 0
 (anyscale +2.5s) Name: my-resource-quota
@@ -651,9 +522,9 @@ collaborators:
     permission_level: "readonly"
 """
 
-CLOUD_ADD_DEPLOYMENT_EXAMPLE = """\
-$ anyscale cloud add-deployment --cloud my-cloud --file new-cloud-deployment.yaml
-Successfully added deployment my-new-deployment to cloud my-cloud.
+CLOUD_DEPLOYMENT_CREATE_EXAMPLE = """\
+$ anyscale cloud deployment create --cloud my-cloud --file new-cloud-deployment.yaml
+Successfully created cloud deployment my-new-deployment in cloud my-cloud.
 
 $ cat new-cloud-deployment.yaml
 name: my-new-deployment
@@ -676,9 +547,48 @@ aws_config:
   memorydb_cluster_name: my-memorydb-cluster
 """
 
+CLOUD_DEPLOYMENT_GET_EXAMPLE = """\
+$ anyscale cloud deployment get --cloud my-cloud --deployment my-deployment
+name: my-deployment
+provider: AWS
+compute_stack: VM
+region: us-west-2
+networking_mode: PUBLIC
+object_storage:
+  bucket_name: s3://my-bucket
+file_storage:
+  file_storage_id: fs-123
+aws_config:
+  vpc_id: vpc-123
+  subnet_ids:
+  - subnet-123
+  security_group_ids:
+  - sg-123
+  anyscale_iam_role_id: arn:aws:iam::123456789012:role/anyscale-role-123
+  cluster_iam_role_id: arn:aws:iam::123456789012:role/cluster-role-123
+  memorydb_cluster_name: my-memorydb-cluster
+"""
+
 
-CLOUD_REMOVE_DEPLOYMENT_EXAMPLE = """\
-$ anyscale cloud remove-deployment --cloud my-cloud --deployment my-deployment
+CLOUD_DEPLOYMENT_UPDATE_EXAMPLE = """\
+$ anyscale cloud deployment update --cloud my-cloud --file updated-cloud-deployment.yaml
+Output
+(anyscale +3.7s) Detected the following changes:
+--- +++ @@ -15,9 +15,9 @@   file_storage_id: fs-123
+-name: my-cloud-deployment
++name: my-updated-cloud-deployment
+ networking_mode: PUBLIC
+ object_storage:
+-  bucket_name: s3://my-bucket
++  bucket_name: s3://my-updated-bucket
+ provider: AWS
+Would you like to proceed with updating this cloud deployment? [y/N]: y
+(anyscale +10.2s) Successfully updated cloud deployment my-updated-cloud-deployment in cloud my-cloud.
+"""
+
+
+CLOUD_DEPLOYMENT_DELETE_EXAMPLE = """\
+$ anyscale cloud deployment delete --cloud my-cloud --deployment my-deployment
 Output
 Please confirm that you would like to remove deployment my-deployment from cloud my-cloud. [y/N]: y
 (anyscale +3.5s) Successfully removed deployment my-deployment from cloud my-cloud!
@@ -723,6 +633,16 @@ is_default: true
 compute_stack: VM
 """
 
+CLOUD_CONFIG_UPDATE_EXAMPLE = """\
+$ anyscale cloud config update --cloud-id cloud_id --enable-log-ingestion --enable-system-cluster
+--enable-log-ingestion is specified. [...] If you are sure you want to enable this feature, please type "consent": consent
+Output
+(anyscale +7.3s) Successfully updated log ingestion configuration for cloud, cloud_id to True
+--enable-system-cluster is specified. [...] Are you sure you want to enable system cluster? [y/N]: y
+Output
+(anyscale +11.4s) Successfully enabled system cluster for cloud cloud_id
+"""
+
 CLOUD_TERMINATE_SYSTEM_CLUSTER_EXAMPLE = """\
 $ anyscale cloud terminate-system-cluster --cloud-id cloud_id --wait
 (anyscale +1.3s) Waiting for system cluster termination............

anyscale/commands/compute_config_commands.py

@@ -8,7 +8,10 @@ import anyscale
 from anyscale.cli_logger import BlockLogger
 from anyscale.commands import command_examples
 from anyscale.commands.util import AnyscaleCommand, LegacyAnyscaleCommand
-from anyscale.compute_config import ComputeConfig, MultiDeploymentComputeConfig
+from anyscale.compute_config.models import (
+    compute_config_type_from_yaml,
+    ComputeConfigVersion,
+)
 from anyscale.controllers.compute_config_controller import ComputeConfigController
 from anyscale.util import validate_non_negative_arg
 
@@ -105,15 +108,8 @@ def create_compute_config(
     if compute_config_file is not None:
         ComputeConfigController().create(compute_config_file, name)
     elif config_file is not None:
-        try:
-            config = ComputeConfig.from_yaml(config_file)
-        except TypeError:
-            config = MultiDeploymentComputeConfig.from_yaml(config_file)
-
-        if isinstance(config, ComputeConfig):
-            anyscale.compute_config.create(config, name=name)
-        elif isinstance(config, MultiDeploymentComputeConfig):
-            anyscale.compute_config.create_multi_deployment(config, name=name)
+        config = compute_config_type_from_yaml(config_file)
+        anyscale.compute_config.create(config, name=name)
     else:
         raise click.ClickException(
             "Either the --config-file flag or [COMPUTE_CONFIG_FILE] argument must be provided."
@@ -251,7 +247,7 @@ def get_compute_config(
             include_archived=include_archived,
         )
     else:
-        config: ComputeConfig = anyscale.compute_config.get(
+        config: ComputeConfigVersion = anyscale.compute_config.get(
             name=name, _id=cc_id, include_archived=include_archived,
         )
         stream = StringIO()

anyscale/compute_config/__init__.py

@@ -10,17 +10,15 @@ from anyscale.compute_config.commands import (
     _ARCHIVE_EXAMPLE,
     _CREATE_ARG_DOCSTRINGS,
     _CREATE_EXAMPLE,
-    _CREATE_MULTI_DEPLOYMENT_ARG_DOCSTRINGS,
-    _CREATE_MULTI_DEPLOYMENT_EXAMPLE,
     _GET_ARG_DOCSTRINGS,
     _GET_EXAMPLE,
     archive,
     create,
-    create_multi_deployment,
     get,
 )
 from anyscale.compute_config.models import (
     ComputeConfig,
+    ComputeConfigType,
     ComputeConfigVersion,
     HeadNodeConfig,
     MultiDeploymentComputeConfig,
@@ -44,7 +42,7 @@ class ComputeConfigSDK:
         doc_py_example=_CREATE_EXAMPLE, arg_docstrings=_CREATE_ARG_DOCSTRINGS,
     )
     def create(  # noqa: F811
-        self, config: ComputeConfig, *, name: Optional[str],
+        self, config: ComputeConfigType, *, name: Optional[str],
     ) -> str:
         """Create a new version of a compute config.
 
@@ -53,18 +51,6 @@ class ComputeConfigSDK:
         full_name, _ = self._private_sdk.create_compute_config(config, name=name)
         return full_name
 
-    @sdk_docs(
-        doc_py_example=_CREATE_MULTI_DEPLOYMENT_EXAMPLE,
-        arg_docstrings=_CREATE_MULTI_DEPLOYMENT_ARG_DOCSTRINGS,
-    )
-    def create_multi_deployment(  # noqa: F811
-        self, config: MultiDeploymentComputeConfig, *, name: Optional[str],
-    ) -> str:
-        full_name, _ = self._private_sdk.create_multi_deployment_compute_config(
-            config, name=name
-        )
-        return full_name
-
     @sdk_docs(
         doc_py_example=_GET_EXAMPLE, arg_docstrings=_GET_ARG_DOCSTRINGS,
     )