# -*- 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.
#
# NOTE: This file is autogenerated and should not be edited by hand.
# AUTOGEN_CLI_VERSION: HEAD
- release_tracks:
  - GA
  auto_generated: true
  hidden: true
  help_text:
    brief: Exports data from Parallelstore instance to Cloud Storage.
    description: |
      Exports data from Parallelstore instance to Cloud Storage.
    examples: |-
      To export data from `my-instance` to `gs://my-bucket` storage  run:

      $ {command} my-instance --location=us-central-a --destination-gcs-bucket-uri=gs://my-bucket --source-parallelstore-path='/'
  arguments:
    params:
    - arg_name: source-parallelstore-path
      api_field: exportDataRequest.sourceParallelstore.path
      required: false
      repeated: false
      help_text: |-
        Root directory path to the Paralellstore filesystem, starting with `/`.
        Defaults to `/` if unset.
    - arg_name: destination-gcs-bucket-uri
      api_field: exportDataRequest.destinationGcsBucket.uri
      required: true
      repeated: false
      help_text: |-
        URI to a Cloud Storage bucket in the format:
        `gs://<bucket_name>/<path_inside_bucket>`. The path inside the bucket is
        optional.
    - help_text: |-
        Name of the resource.
      is_positional: true
      is_primary_resource: true
      resource_spec: !REF googlecloudsdk.command_lib.parallelstore.v1_resources:project_location_instance
      required: true
    - arg_name: request-id
      api_field: exportDataRequest.requestId
      required: false
      repeated: false
      help_text: |-
        An optional request ID to identify requests. Specify a unique request ID
        so that if you must retry your request, the server will know to ignore
        the request if it has already been completed. The server will guarantee
        that for at least 60 minutes since the first request.

        For example, consider a situation where you make an initial request and t
        he request times out. If you make the request again with the same request
        ID, the server can check if original operation with the same request ID
        was received, and if so, will ignore the second request. This prevents
        clients from accidentally creating duplicate commitments.

        The request ID must be a valid UUID with the exception that zero UUID is
        not supported (00000000-0000-0000-0000-000000000000).
    - arg_name: service-account
      help_text: |-
        User-specified Service Account (SA) credentials to be used when
        performing the transfer.
        Use one of the following formats:

        * `{EMAIL_ADDRESS_OR_UNIQUE_ID}`
        * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}`
        * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}`

        If unspecified, the Parallelstore service agent is used:
        `service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com`
      is_positional: false
      is_primary_resource: false
      resource_spec: !REF googlecloudsdk.command_lib.parallelstore.v1_resources:project_service_account
      resource_method_params:
        exportDataRequest.serviceAccount: '{__relative_name__}'
      required: false
    - arg_name: metadata-options-uid
      api_field: exportDataRequest.metadataOptions.uid
      required: false
      help_text: |-
        The UID preservation behavior.
      choices:
      - arg_value: uid-skip
        enum_value: UID_SKIP
        help_text: |-
          Do not preserve UID during a transfer job.
      - arg_value: uid-number-preserve
        enum_value: UID_NUMBER_PRESERVE
        help_text: |-
          Preserve UID that is in number format during a transfer job.
    - arg_name: metadata-options-gid
      api_field: exportDataRequest.metadataOptions.gid
      required: false
      help_text: |-
        The GID preservation behavior.
      choices:
      - arg_value: gid-skip
        enum_value: GID_SKIP
        help_text: |-
          Do not preserve GID during a transfer job.
      - arg_value: gid-number-preserve
        enum_value: GID_NUMBER_PRESERVE
        help_text: |-
          Preserve GID that is in number format during a transfer job.
    - arg_name: metadata-options-mode
      api_field: exportDataRequest.metadataOptions.mode
      required: false
      help_text: |-
        The mode preservation behavior.
      choices:
      - arg_value: mode-skip
        enum_value: MODE_SKIP
        help_text: |-
          Do not preserve mode during a transfer job.
      - arg_value: mode-preserve
        enum_value: MODE_PRESERVE
        help_text: |-
          Preserve mode during a transfer job.
  request:
    api_version: v1
    collection:
    - parallelstore.projects.locations.instances
    method: exportData
  async:
    collection:
    - parallelstore.projects.locations.operations
    extract_resource_result: false
