openapi: 3.2.0
info:
  description: Cohesity API provides a RESTful interface to access the various data management operations on Cohesity cluster and Helios.
  title: Cohesity REST Recoveries API
  version: '2.0'
servers:
- url: /v2
tags:
- name: Recoveries
paths:
  /data-protect/recoveries:
    get:
      description: Lists the Recoveries.
      tags:
      - Recoveries
      summary: Lists the Recoveries
      operationId: GetRecoveries
      parameters:
      - description: Filter Recoveries for given ids.
        name: ids
        in: query
        schema:
          type: array
          items:
            pattern: ^\d+:\d+:\d+$
            type: string
      - description: 'Returns only child recoveries if passed as true. This filter should always be used along with ''ids'' filter. '
        name: returnOnlyChildRecoveries
        in: query
        schema:
          type: boolean
      - description: TenantIds contains ids of the organizations for which recoveries are to be returned.
        name: tenantIds
        in: query
        schema:
          type: array
          items:
            type: string
      - description: Specifies if objects of all the organizations under the hierarchy of the logged in user's organization should be returned.
        name: includeTenants
        in: query
        schema:
          type: boolean
      - description: Returns the recoveries which are started after the specific time. This value should be in Unix timestamp epoch in microseconds.
        name: startTimeUsecs
        in: query
        schema:
          type: integer
          format: int64
      - description: Returns the recoveries which are started before the specific time. This value should be in Unix timestamp epoch in microseconds.
        name: endTimeUsecs
        in: query
        schema:
          type: integer
          format: int64
      - description: Filter by Storage Domain id. Only recoveries writing data to this Storage Domain will be returned.
        name: storageDomainId
        in: query
        schema:
          type: integer
          format: int64
      - description: Specifies the snapshot's target type from which recovery has been performed.
        name: snapshotTargetType
        in: query
        schema:
          type: array
          items:
            enum:
            - Local
            - Archival
            type: string
          uniqueItems: true
      - description: Specifies the snapshot's archival target type from which recovery has been performed. This parameter applies only if 'snapshotTargetType' is 'Archival'.
        name: archivalTargetType
        in: query
        schema:
          type: array
          items:
            enum:
            - Tape
            - Cloud
            - Nas
            type: string
          uniqueItems: true
      - description: Specifies the list of snapshot environment types to filter Recoveries. If empty, Recoveries related to all environments will be returned.
        name: snapshotEnvironments
        in: query
        schema:
          type: array
          items:
            enum:
            - kVMware
            - kHyperV
            - kAzure
            - kGCP
            - kKVM
            - kAcropolis
            - kAWS
            - kPhysical
            - kGPFS
            - kElastifile
            - kNetapp
            - kGenericNas
            - kIsilon
            - kFlashBlade
            - kPure
            - kSQL
            - kExchange
            - kAD
            - kOracle
            - kView
            - kRemoteAdapter
            - kO365
            - kKubernetes
            - kCassandra
            - kMongoDB
            - kCouchbase
            - kHdfs
            - kHive
            - kHBase
            - kUDA
            type: string
          uniqueItems: true
      - description: Specifies the list of run status to filter Recoveries. If empty, Recoveries with all run status will be returned.
        name: status
        in: query
        schema:
          type: array
          items:
            enum:
            - Accepted
            - Running
            - Canceled
            - Canceling
            - Failed
            - Missed
            - Succeeded
            - SucceededWithWarning
            - OnHold
            type: string
          uniqueItems: true
      - description: Specifies the list of recovery actions to filter Recoveries. If empty, Recoveries related to all actions will be returned.
        name: recoveryActions
        in: query
        schema:
          type: array
          items:
            enum:
            - RecoverVMs
            - RecoverFiles
            - InstantVolumeMount
            - RecoverVmDisks
            - RecoverVApps
            - RecoverVAppTemplates
            - RecoverRDS
            - RecoverAurora
            - RecoverApps
            - RecoverNasVolume
            - RecoverPhysicalVolumes
            - RecoverSystem
            - CloneAppView
            - RecoverSanVolumes
            - RecoverMailbox
            - RecoverOneDrive
            - RecoverSharePoint
            - RecoverPublicFolders
            - RecoverMsGroup
            - RecoverMsTeam
            - RecoverNamespaces
            - RecoverObjects
            - DownloadFilesAndFolders
            type: string
      responses:
        '200':
          $ref: '#/components/responses/GetRecoveries'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
    post:
      description: Performs a Recovery.
      tags:
      - Recoveries
      summary: Performs a Recovery
      operationId: CreateRecovery
      responses:
        '201':
          $ref: '#/components/responses/CreateRecoveryResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
      requestBody:
        content:
          application/json:
            schema:
              x-cohesity-discriminator-ref: CommonRecoveryRequestParams
              $ref: '#/components/schemas/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
        description: Specifies the parameters to create a Recovery.
        required: true
  /data-protect/recoveries/downloadFilesAndFoldersRecovery:
    post:
      description: Creates a download files and folders recovery.
      tags:
      - Recoveries
      summary: Create a download files and folders recovery
      operationId: CreateDownloadFilesAndFoldersRecovery
      responses:
        '201':
          $ref: '#/components/responses/CreateDownloadFilesAndFoldersRecoveryResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadFilesAndFoldersRequestParams'
        description: Specifies the parameters to create a download files and folder recovery.
        required: true
  /data-protect/recoveries/{id}:
    get:
      description: Get Recovery for a given id.
      tags:
      - Recoveries
      summary: Get Recovery for a given id
      operationId: GetRecoveryById
      parameters:
      - description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
        schema:
          type: string
          pattern: ^\d+:\d+:\d+$
      - description: Specifies if objects of all the organizations under the hierarchy of the logged in user's organization should be returned.
        name: includeTenants
        in: query
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/GetRecovery'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
  /data-protect/recoveries/{id}/cancel:
    post:
      description: Cancel Recovery for a given id.
      tags:
      - Recoveries
      summary: Cancel Recovery for a given id
      operationId: CancelRecoveryById
      parameters:
      - description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
        schema:
          type: string
          pattern: ^\d+:\d+:\d+$
      responses:
        '204':
          $ref: '#/components/responses/NoContentResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
  /data-protect/recoveries/{id}/debug-logs:
    get:
      description: Get the debug logs for a particular recovery operation.
      tags:
      - Recoveries
      summary: Get the debug logs for a particular recovery operation
      operationId: GetRecoveryDebugLogs
      parameters:
      - description: Specifies the id of a Recovery job.
        name: id
        in: path
        required: true
        schema:
          type: string
          pattern: ^\d+:\d+:\d+$
      responses:
        '200':
          $ref: '#/components/responses/NoContentResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
  /data-protect/recoveries/{id}/downloadFiles:
    get:
      description: Download files from the given download file recovery.
      tags:
      - Recoveries
      summary: Download files from the given download file recovery
      operationId: DownloadFilesFromRecovery
      parameters:
      - description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
        schema:
          type: string
          pattern: ^\d+:\d+:\d+$
      - description: Specifies the start offset of file chunk to be downloaded.
        name: startOffset
        in: query
        schema:
          type: integer
          format: int64
      - description: Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets)
        name: length
        in: query
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/NoContentResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
  /data-protect/recoveries/{id}/tearDown:
    post:
      description: Tear down Recovery for a given id.
      tags:
      - Recoveries
      summary: Tear down Recovery for a given id
      operationId: TearDownRecoveryById
      parameters:
      - description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
        schema:
          type: string
          pattern: ^\d+:\d+:\d+$
      responses:
        '204':
          $ref: '#/components/responses/NoContentResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
  /data-protect/snapshots/{snapshotsId}/downloadFile:
    get:
      description: Download an indexed file from a snapshot.
      tags:
      - Recoveries
      summary: Download an indexed file
      operationId: DownloadIndexedFile
      parameters:
      - description: Specifies the snapshot id to download from.
        name: snapshotsId
        in: path
        required: true
        schema:
          type: string
      - description: Specifies the path to the file to download. If no path is specified and snapshot environment is kVMWare, VMX file for VMware will be downloaded. For other snapshot environments, this field must be specified.
        name: filePath
        in: query
        schema:
          type: string
      - description: Specifies the number of attempts the protection run took to create this file.
        name: retryAttempt
        in: query
        schema:
          type: integer
          format: int64
      - description: Specifies the start offset of file chunk to be downloaded.
        name: startOffset
        in: query
        schema:
          type: integer
          format: int64
      - description: Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets)
        name: length
        in: query
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/NoContentResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - APIKeyHeader: []
components:
  schemas:
    VdcCatalog:
      description: Specifies a VDC Catalog.
      type: object
      title: VDC Catalog
      required:
      - uuid
      properties:
        uuid:
          description: Specifies the UUID of the catalog.
          type:
          - string
          - 'null'
          x-order: 0
        name:
          description: Specifies the name of the catalog.
          type:
          - string
          - 'null'
          x-order: 1
          readOnly: true
    NasQosPolicy:
      description: Specifies the QoS policy, which defines the principal and priority of a NAS recovery.
      type: object
      properties:
        id:
          description: Specifies the ID of the QoS Policy.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
    ArchivalTargetTierInfo:
      description: Specifies the tier info for archival.
      title: Archival Target Tier Info
      allOf:
      - $ref: '#/components/schemas/TierLevelSettings'
      - type: object
        properties:
          currentTierType:
            description: Specifies the type of the current tier where the snapshot resides. This will be specified if the run is a CAD run.
            type:
            - string
            - 'null'
            enum:
            - kAmazonS3Standard
            - kAmazonS3StandardIA
            - kAmazonS3OneZoneIA
            - kAmazonS3IntelligentTiering
            - kAmazonS3Glacier
            - kAmazonS3GlacierDeepArchive
            - kAzureTierHot
            - kAzureTierCool
            - kAzureTierArchive
            - kGoogleStandard
            - kGoogleRegional
            - kGoogleMultiRegional
            - kGoogleNearline
            - kGoogleColdline
            - kOracleTierStandard
            - kOracleTierArchive
            x-order: 0
    CommonRecoverSqlAppTargetParams:
      description: Specifies the snapshot parameters to recover Sql databases.
      type: object
      title: Recover Sql App Snapshot Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new sources or an original Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the destination Source configuration parameters where the databases will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverSqlAppNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if databases are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverSqlAppOriginalSourceConfig'
          - {}
          x-order: 2
    PhysicalTargetParamsForMountVolume:
      description: Specifies the parameters for a physical recovery target.
      type: object
      title: Physical Recovery Target Params
      required:
      - mountToOriginalTarget
      properties:
        mountToOriginalTarget:
          description: Specifies whether to mount to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for mounting to the original target.
          allOf:
          - $ref: '#/components/schemas/PhysicalMountVolumesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for mounting to a new target.
          allOf:
          - $ref: '#/components/schemas/PhysicalMountVolumesNewTargetConfig'
          - {}
          x-order: 2
        readOnlyMount:
          description: Specifies whether to perform a read-only mount. Default is false.
          type:
          - boolean
          - 'null'
          x-order: 3
        volumeNames:
          description: Specifies the names of volumes that need to be mounted. If this is not specified then all volumes that are part of the source VM will be mounted on the target VM.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 4
        mountedVolumeMapping:
          description: Specifies the mapping of original volumes and mounted volumes
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MountedVolumeMapping'
          x-order: 5
          readOnly: true
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    OriginalFlashbladeFilesTargetParams:
      description: Specifies the params of the original Flashblade recovery target.
      type: object
      title: Recover To Original Flashblade Files Target Params.
      required:
      - recoverToOriginalPath
      properties:
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoveryObjectIdentifier:
      description: Specifies the object identifier to perform recovery.
      type: object
      title: Recovery Object Identifier.
      required:
      - id
      properties:
        id:
          description: Specifies the id of the object.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        name:
          description: Specifies the name of the object.
          type:
          - string
          - 'null'
          x-order: 1
          readOnly: true
    OriginalGenericNasFilesTargetParams:
      description: Specifies the params of the original Generic Nas recovery target.
      type: object
      title: Recover To Original Generic Nas Files Target Params.
      required:
      - recoverToOriginalPath
      properties:
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 6
          $ref: '#/components/schemas/RecoveryVlanConfig'
    AzureRecoverFilesOriginalTargetConfig:
      description: Specifies the configuration for recovering files and folders to the original target.
      type: object
      title: Azure Recover Files Original Target Config.
      required:
      - targetVmCredentials
      - recoverToOriginalPath
      properties:
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 0
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 1
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverOracleNewTargetDatabaseConfig:
      description: Specifies recovery parameters when recovering to a database.
      type: object
      title: Recover Oracle App New Database Target Config.
      allOf:
      - $ref: '#/components/schemas/CommonOracleAppSourceConfig'
      properties:
        databaseName:
          description: Specifies a new name for the restored database. If this field is not specified, then the original database will be overwritten after recovery.
          type:
          - string
          - 'null'
          x-order: 0
        oracleBaseFolder:
          description: Specifies the oracle base folder at selected host.
          type:
          - string
          - 'null'
          x-order: 1
        oracleHomeFolder:
          description: Specifies the oracle home folder at selected host.
          type:
          - string
          - 'null'
          x-order: 2
        dbFilesDestination:
          description: Specifies the location to restore database files.
          type:
          - string
          - 'null'
          x-order: 3
        dbConfigFilePath:
          description: Specifies the config file path on selected host which configures the restored database.
          type:
          - string
          - 'null'
          x-order: 4
        enableArchiveLogMode:
          description: Specifies archive log mode for oracle restore.
          type:
          - boolean
          - 'null'
          x-order: 5
        pfileParameterMap:
          description: Specifies a key value pair for pfile parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/KeyValuePair'
          x-order: 6
        bctFilePath:
          description: Specifies BCT file path.
          type:
          - string
          - 'null'
          x-order: 7
        numTempfiles:
          description: Specifies no. of tempfiles to be used for the recovered database.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 8
        redoLogConfig:
          description: Specifies redo log config.
          type: object
          allOf:
          - $ref: '#/components/schemas/RedoLogGroupConfig'
          - {}
          x-order: 9
        isMultiStageRestore:
          description: Specifies whether this task is a multistage restore task. If set, we migrate the DB after clone completes.
          type:
          - boolean
          - 'null'
          x-order: 10
        oracleUpdateRestoreOptions:
          description: Specifies the parameters that are needed for updating oracle restore options.
          allOf:
          - $ref: '#/components/schemas/MigrateCloneParams'
          - {}
          x-order: 11
    RecoverOtherNasToNetappVolumeTargetParams:
      description: Specifies the params of the Netapp recovery target.
      type: object
      title: Recover To Netapp Volume Target Params.
      required:
      - volume
      properties:
        volume:
          description: Specifies the id and name of the volume to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    MongodbParams:
      description: Specifies the recovery options specific to MongoDB environment.
      type: object
      title: Recover MongoDB environment params.
      required:
      - recoveryAction
      - recoverMongodbParams
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverObjects
          x-order: 0
        recoverMongodbParams:
          description: Specifies the parameters to recover MongoDB objects.
          type:
          - object
          - 'null'
          title: Recover MongoDB params.
          allOf:
          - $ref: '#/components/schemas/RecoverMongodbParams'
          - {}
          x-order: 1
          $ref: '#/components/schemas/RecoverMongodbParams'
    AWSTiers:
      description: Specifies aws tiers.
      type: object
      required:
      - tiers
      properties:
        tiers:
          description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
          type:
          - array
          - 'null'
          minLength: 1
          items:
            $ref: '#/components/schemas/AWSTier'
          x-order: 0
    RecoverAcropolisFileAndFolderParams:
      description: Specifies the parameters to recover Acropolis files and folders.
      type: object
      title: Recover Acropolis Files and Folders Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAcropolis
          x-order: 1
        acropolisTargetParams:
          description: Specifies the params for recovering to an Acropolis target.
          allOf:
          - $ref: '#/components/schemas/AcropolisTargetParamsForRecoverFileAndFolder'
          - {}
          x-order: 2
    MailboxParam:
      description: Specifies parameters to recover a Mailbox.
      type: object
      properties:
        recoverEntireMailbox:
          description: Specifies whether to recover the whole Mailbox.
          type:
          - boolean
          - 'null'
          x-order: 0
        recoverFolders:
          description: Specifies a list of email folders to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FolderItem'
          x-order: 1
    RecoverAwsVmParams:
      description: Specifies the parameters to recover AWS VM.
      type: object
      title: Recover AWS VM params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAWS
          x-order: 1
        awsTargetParams:
          description: Specifies the params for recovering to an AWS target.
          allOf:
          - $ref: '#/components/schemas/AwsTargetParamsForRecoverVm'
          - {}
          x-order: 2
    RecoverKvmParams:
      description: Specifies the recovery options specific to KVM environment.
      type: object
      title: Recover KVM environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters. This property is mandatory for all recovery action types except recover vms. While recovering VMs, a user can specify snapshots of VM's or a Protection Group Run details to recover all the VM's that are backed up by that Run.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recovery action to be performed.
          type: string
          enum:
          - RecoverVMs
          x-order: 1
        recoverVmParams:
          description: Specifies the parameters to recover KVM VM.
          allOf:
          - $ref: '#/components/schemas/RecoverKvmVmParams'
          - {}
          x-order: 2
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 3
    RecoverHbaseParams:
      description: Specifies the parameters to recover Hbase objects.
      title: Recover Hbase params.
      allOf:
      - $ref: '#/components/schemas/CommonNoSqlRecoveryOptions'
      - type: object
        required:
        - snapshots
        properties:
          snapshots:
            description: Specifies the local snapshot ids of the Objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverHbaseSnapshotParams'
            x-order: 0
          suffix:
            description: A suffix that is to be applied to all recovered objects.
            type:
            - string
            - 'null'
            x-order: 1
    RecoverNetappFilesParams:
      description: Specifies the parameters to recover Netapp files.
      type: object
      title: Recover Netapp files Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          x-order: 1
        netappTargetParams:
          description: Specifies the params for a Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNetappToNetappFilesTargetParams'
          - {}
          x-order: 2
        elastifileTargetParams:
          description: Specifies the params for an Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileFilesTargetParams'
          - {}
          x-order: 3
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeFilesTargetParams'
          - {}
          x-order: 4
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasFilesTargetParams'
          - {}
          x-order: 5
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsFilesTargetParams'
          - {}
          x-order: 6
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonFilesTargetParams'
          - {}
          x-order: 7
    RecoveryOracleTaskInfo:
      description: Specifies the info about a recovery task.
      type: object
      title: Recovery Task Info
      properties:
        progressTaskId:
          description: Specifies the progress monitor id.
          type:
          - string
          - 'null'
          x-order: 0
          readOnly: true
        status:
          description: Specifies the status of the recovery.
          type:
          - string
          - 'null'
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-order: 1
          readOnly: true
        startTimeUsecs:
          description: Specifies the start time in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 2
          readOnly: true
        endTimeUsecs:
          description: Specifies the end time in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 3
          readOnly: true
    RecoverVmwareVAppOriginalSourceConfig:
      description: Specifies the Source configuration if vApps are being recovered to Original Source.
      type: object
      title: Recover VMware vApps Original Source Config.
      properties:
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered vApps.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmOriginalSourceNetworkConfig'
          - {}
          x-order: 0
    GcpTargetParamsForRecoverVm:
      description: Specifies the parameters for a GCP recovery target.
      type: object
      title: GCP Recovery Target Params
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/GcpVmRecoveryTargetConfig'
          - {}
          x-order: 1
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 2
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 3
    SqlTargetParamsForRecoverSqlApp:
      description: 'Specifies the params for recovering to a sql host. Specifiy seperate settings for each db object that need to be recovered. Provided sql backup should be recovered to same type of target host. For Example: If you have sql backup taken from a physical host then that should be recovered to physical host only.'
      type: object
      title: Sql Target Params For Recover Sql App.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverSqlAppTargetParams'
    RecoverGenericNasParams:
      description: Specifies the recovery options specific to Generic NAS environment.
      type: object
      title: Recover Generic NAS Params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverNasVolume
          - RecoverFiles
          x-order: 1
        recoverNasVolumeParams:
          description: Specifies the parameters to recover Nas Volumes.
          allOf:
          - $ref: '#/components/schemas/RecoverGenericNasNasVolumeParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files.
          allOf:
          - $ref: '#/components/schemas/RecoverGenericNasFilesParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    RecoverNetappNasVolumeParams:
      description: Specifies the parameters to recover Netapp NAS volumes.
      type: object
      title: Recover Netapp NAS Volume Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          - kView
          x-order: 0
        netappTargetParams:
          description: Specifies the params for a Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNetappToNetappVolumeTargetParams'
          - {}
          x-order: 1
        elastifileTargetParams:
          description: Specifies the params for an Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileVolumeTargetParams'
          - {}
          x-order: 2
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeVolumeTargetParams'
          - {}
          x-order: 3
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasVolumeTargetParams'
          - {}
          x-order: 4
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsVolumeTargetParams'
          - {}
          x-order: 5
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonVolumeTargetParams'
          - {}
          x-order: 6
        viewTargetParams:
          description: Specifies the params for a Cohesity view recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNasVolumeToViewParams'
          - {}
          x-order: 7
    HyperVMountVolumesOriginalTargetConfig:
      description: Specifies the configuration for mounting volumes to the original target.
      type: object
      title: HyperV Mount Volumes Original Target Config.
      required:
      - bringDisksOnline
      properties:
        bringDisksOnline:
          description: Specifies whether the volumes need to be online within the target environment after attaching the disks. For linux VMs, this should always be set to false because bring disks online is only supported for Windows VM. For Windows, this is optional. If this is set to true, HyperV Integration Services must be installed on the VM.
          type:
          - boolean
          - 'null'
          x-order: 0
        targetVmCredentials:
          description: Specifies credentials to access the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 1
    RecoverGcpVmParams:
      description: Specifies the parameters to recover GCP VM.
      type: object
      title: Recover GCP VM params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kGCP
          x-order: 1
        gcpTargetParams:
          description: Specifies the params for recovering to a GCP target.
          allOf:
          - $ref: '#/components/schemas/GcpTargetParamsForRecoverVm'
          - {}
          x-order: 2
    RecoverAwsRdsNewSourceConfig:
      description: Specifies the new destination Source configuration where the RDS instances will be recovered.
      type: object
      title: Recover AWS RDS New Source Config.
      required:
      - source
      - region
      - networkConfig
      properties:
        source:
          description: Specifies the id of the parent source to recover the RDS.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        region:
          description: Specifies the AWS region in which to deploy the RDS instance.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsRdsNewSourceNetworkConfig'
          - {}
          x-order: 2
    RecoverKvmVmNewSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover KVM VMs New Source Config.
      required:
      - source
      - cluster
      - dataCenter
      - storageDomain
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        cluster:
          description: Specifies the resource (KVMH host) to which the restored VM will be attached
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        dataCenter:
          description: Specifies the datacenter where the VM's files should be restored to.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        storageDomain:
          description: Specifies the Storage Domain where the VM's disk should be restored to.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 3
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverKvmVmNewSourceNetworkConfig'
          - {}
          x-order: 4
    ObjectTypeVCenterParams:
      type: object
      title: Object Type VCenter Params
      properties:
        isCloudEnv:
          description: Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
          type:
          - boolean
          - 'null'
          x-order: 0
    VmwareRecoverDisksOriginalSourceConfig:
      description: Specifies the configuration for restoring a disk to the original VM from which the snapshot was taken.
      type: object
      required:
      - disks
      properties:
        disks:
          description: Specifies the disks to be recovered and the location to which they will be recovered.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/VmwareRecoverOriginalSourceDiskParams'
          x-order: 0
    RecoverMsTeamParams:
      description: Specifies the parameters to recover Microsoft 365 Teams.
      type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies a list of Microsoft 365 Teams params associated with objects to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ObjectMsTeamParam'
          x-order: 0
        targetMsTeam:
          description: Specifies the target Team to recover to. If not specified, the objects will be recovered to original location.
          allOf:
          - $ref: '#/components/schemas/TargetMsTeamParam'
          - {}
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other teams, if some of the teams fail to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
    MountHyperVVolumeParams:
      description: Specifies the parameters to mount volumes.
      type: object
      title: Mount Volumes Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kHyperV
          x-order: 0
        hypervTargetParams:
          description: Specifies the params for recovering to a HyperV target.
          allOf:
          - $ref: '#/components/schemas/HyperVTargetParamsForMountVolume'
          - {}
          x-order: 1
    ObjectMailboxParam:
      description: Specifies Mailbox recovery parameters associated with a user.
      type: object
      required:
      - ownerInfo
      - mailboxParams
      properties:
        ownerInfo:
          description: Specifies the Mailbox owner info.
          allOf:
          - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          - {}
          x-order: 0
        mailboxParams:
          description: Specifies parameters to recover a Mailbox.
          allOf:
          - $ref: '#/components/schemas/MailboxParam'
          - {}
          x-order: 1
    MountPhysicalVolumeParams:
      description: Specifies the parameters to Mount Physical Volumes.
      type: object
      title: Mount Physical Volumes params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kPhysical
          x-order: 0
        physicalTargetParams:
          description: Specifies the params for recovering to a physical target.
          allOf:
          - $ref: '#/components/schemas/PhysicalTargetParamsForMountVolume'
          - {}
          x-order: 1
    RecoverOneDriveParams:
      description: Specifies the parameters to recover an Office 365 OneDrive.
      type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies a list of OneDrive params associated with the objects to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ObjectOneDriveParam'
          x-order: 0
        targetDrive:
          description: Specifies the target OneDrive to recover to. If not specified, the objects will be recovered to original location.
          allOf:
          - $ref: '#/components/schemas/TargetOneDriveParam'
          - {}
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other OneDrive items if one of items failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
    RecoverOtherNasToGpfsVolumeTargetParams:
      description: Specifies the params of the GPFS recovery target.
      type: object
      title: Recover To GPFS Nas Volume Target Params.
      required:
      - volume
      properties:
        volume:
          description: Specifies the id and name of the parent volume to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    AzureTier:
      description: Specifies the settings for a Azure tier.
      type: object
      allOf:
      - $ref: '#/components/schemas/CommonCloudTierSettings'
      - type: object
        required:
        - tierType
        properties:
          tierType:
            description: Specifies the Azure tier types.
            type:
            - string
            - 'null'
            enum:
            - kAzureTierHot
            - kAzureTierCool
            - kAzureTierArchive
            x-order: 0
    RecoverPureSanVolumeOriginalSourceConfig:
      description: Specifies the network config parameters to be applied for Pure volumes if recovering to original Source.
      type: object
      title: Recover Pure volume Original Source Network configuration.
      properties:
        renameRecoveredVolumeParams:
          description: Specifies params to rename the recovered SAN volumes. If not specified, the original names of the volumes are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
    VmwareRecoverOriginalSourceDiskParams:
      description: Specifies disk specific parameters for performing a disk recovery.
      type: object
      required:
      - diskUuid
      properties:
        diskUuid:
          description: Specifies the UUID of the source disk being recovered.
          type:
          - string
          - 'null'
          x-order: 0
        overwriteOriginalDisk:
          description: Specifies whether or not to overwrite the original disk. If this is set to true, then datastoreId should not be specified. Otherwise, datastoreId must be specified.
          type:
          - boolean
          - 'null'
          x-order: 1
        datastoreId:
          description: Specifies the ID of the datastore on which the specified disk will be spun up.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 2
    RecoverIsilonToIsilonFilesTargetParams:
      description: Specifies the params of the Isilon recovery target.
      type: object
      title: Recover Isilon To Isilon Files Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Isilon target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the files will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonFilesTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if files are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalIsilonFilesTargetParams'
          - {}
          x-order: 2
    RecoverPureParams:
      description: Specifies the recovery options specific to Pure environment.
      type: object
      title: Recover Pure Params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recovery action to be performed. The corresponding recovery action params must be filled out.
          type: string
          enum:
          - RecoverSanVolumes
          x-order: 1
        recoverSanVolumeParams:
          description: Specifies the parameters to recover SAN Volume.
          allOf:
          - $ref: '#/components/schemas/RecoverPureSanVolumeParams'
          - {}
          x-order: 2
    RecoverAcropolisVmTargetConfig:
      description: Specifies the target configuration source parameters.
      type: object
      title: Vm Target Configuration for Acropolis Recovery
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverAcropolisVmNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if VM's are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverAcropolisVmOriginalSourceConfig'
          - {}
          x-order: 2
    RecoverAcropolisVmOriginalSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for Acropolis VMs if recovering to original Source.
      type: object
      title: Recover Acropolis VMs Original Source Network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. All the other networking parameters set will be ignored if set to true. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
    HyperVVmRecoveryTargetConfig:
      description: Specifies the target object parameters to recover HyperV vms.
      type: object
      title: HyperV VMs Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVVmNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if VM's are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVVmOriginalSourceConfig'
          - {}
          x-order: 2
    KvmTargetParamsForRecoverVm:
      description: Specifies the parameters for a KVM recovery target.
      type: object
      title: KVM Target Params.
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Snource with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/KvmVmRecoveryTargetConfig'
          - {}
          x-order: 1
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 2
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
    OracleTargetParamsForRecoverOracleApp:
      description: 'Specifies the params for recovering to a oracle host. Provided oracle backup should be recovered to same type of target host. For Example: If you have oracle backup taken from a physical host then that should be recovered to physical host only.'
      type: object
      title: Oracle Target Params For Recover Oracle App.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverOracleAppTargetParams'
    RecoverOtherNasToElastifileVolumeTargetParams:
      description: Specifies the params of the Elastifile recovery target.
      type: object
      title: Recover To Elastifile Volume Target Params.
      required:
      - volume
      properties:
        volume:
          description: Specifies the id and name of the parent volume to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    OraclePdbRestoreParams:
      description: Specifies information about the list of pdbs to be restored.
      type: object
      properties:
        dropDuplicatePDB:
          description: Specifies if the PDB should be ignored if a PDB already exists with same name.
          type:
          - boolean
          - 'null'
          x-order: 0
        pdbObjects:
          description: Specifies list of PDB objects to restore.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OraclePdbObjectInfo'
          x-order: 1
        restoreToExistingCdb:
          description: Specifies if pdbs should be restored to an existing CDB.
          type:
          - boolean
          - 'null'
          x-order: 2
    RecoverVmwareVmNewSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover VMware VMs New Source Config.
      required:
      - sourceType
      properties:
        sourceType:
          description: Specifies the type of VMware source to which the VMs are being restored.
          type:
          - string
          - 'null'
          enum:
          - kVCenter
          - kStandaloneHost
          - kvCloudDirector
          x-order: 0
        standaloneHostParams:
          x-order: 1
          $ref: '#/components/schemas/RecoverVmwareVmEsxiSourceConfig'
        vCenterParams:
          x-order: 2
          $ref: '#/components/schemas/RecoverVmwareVmVCenterSourceConfig'
        vCloudDirectorParams:
          x-order: 3
          $ref: '#/components/schemas/RecoverVmwareVmVCDSourceConfig'
    VmwareVAppRecoveryTargetConfig:
      description: Specifies the target object parameters to recover VMware vApps.
      type: object
      title: Vmware VMs Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVAppNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if VM's are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVAppOriginalSourceConfig'
          - {}
          x-order: 2
    RecoverViewParams:
      description: Specifies the recovery options specific to View environment.
      type: object
      title: Recover View environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recovery action to be performed.
          type: string
          enum:
          - DownloadFilesAndFolders
          x-order: 1
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 2
    RecoverElastifileParams:
      description: Specifies the recovery options specific to Elastifile environment.
      type: object
      title: Recover Elastifile Params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverNasVolume
          - RecoverFiles
          x-order: 1
        recoverNasVolumeParams:
          description: Specifies the parameters to recover Nas Volumes.
          allOf:
          - $ref: '#/components/schemas/RecoverElastifileNasVolumeParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files.
          allOf:
          - $ref: '#/components/schemas/RecoverElastifileFilesParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    VmwareRecoverFilesNewTargetConfig:
      description: Specifies the configuration for recovering files and folders to a new target.
      type: object
      title: Vmware Recover Files New Target Config.
      required:
      - targetVm
      - recoverMethod
      - absolutePath
      properties:
        targetVm:
          description: Specifies the target VM to recover files and folders to.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        recoverMethod:
          description: Specifies the method to recover files and folders.
          type: string
          enum:
          - AutoDeploy
          - UseExistingAgent
          - UseHypervisorApis
          x-order: 1
        targetVmCredentials:
          description: Specifies the credentials for the target VM. This is mandatory if the recoverMethod is AutoDeploy or UseHypervisorApis.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 2
        absolutePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 3
    RecoverKvmVmNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for KVM VMs if recovering to new Source.
      type: object
      title: Recover KVM VMs New Source Network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. All the other networking parameters set will be ignored if set to true. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
        newNetworkConfig:
          description: Specifies the new network configuration of the Kvm recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverKvmVmNewNetworkConfig'
          - {}
          x-order: 1
    RecoverExchangeAppParams:
      description: Specifies the parameters to recover Sql databases.
      type: object
      title: Recover Exchange App params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kExchange
          x-order: 0
        exchangeTargetParams:
          description: Specifies the params for recovering to an Exchange host.
          allOf:
          - $ref: '#/components/schemas/ExchangeTargetParamsForRecoverExchangeApp'
          - {}
          x-order: 1
    RecoverSqlParams:
      description: Specifies the recovery options specific to Sql environment.
      type: object
      title: Recover Sql environment params.
      required:
      - recoveryAction
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverApps
          x-order: 0
        recoverAppParams:
          description: Specifies the parameters to recover Sql databases.
          type:
          - array
          - 'null'
          minItems: 1
          items:
            $ref: '#/components/schemas/RecoverSqlAppParams'
          x-order: 1
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 2
    RecoveredOrClonedVmsRenameConfig:
      description: Specifies the prefix and suffix to be added to VMs that are recovered or cloned.
      type: object
      title: Recover or Clone VMs Rename Config params.
      properties:
        prefix:
          description: Specifies the prefix string to be added to recovered or cloned object names.
          type:
          - string
          - 'null'
          x-order: 0
        suffix:
          description: Specifies the suffix string to be added to recovered or cloned object names.
          type:
          - string
          - 'null'
          x-order: 1
    Error:
      description: Specifies the error object with error code and a message.
      type: object
      title: Error.
      properties:
        errorCode:
          description: Specifies the error code.
          type:
          - string
          - 'null'
          x-order: 0
        message:
          description: Specifies the error message.
          type:
          - string
          - 'null'
          x-order: 1
    AzureVmRecoveryTargetConfig:
      description: Specifies the target object parameters to recover Azure vms.
      type: object
      title: Azure VMs Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverAzureVmNewSourceConfig'
          - {}
          x-order: 1
    RecoverCouchbaseSnapshotParams:
      description: Specifies the snapshot parameters for a protected Couchbase object.
      title: Recover Couchbase Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          objects:
            description: Specifies details of objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverCouchbaseNoSqlObjectParams'
            x-order: 0
    RecoverAwsRdsNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for AWS RDS if recovering to new Source.
      type: object
      title: Recover AWS RDS New Source Network configuration.
      required:
      - vpc
      - subnet
      properties:
        vpc:
          description: Specifies the Virtual Private Cloud to choose for the instance type.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        subnet:
          description: Specifies the subnet within above VPC.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        availabilityZone:
          description: Specifies the entity representing the availability zone to use while restoring the DB.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        securityGroups:
          description: Specifies the network security groups within above VPC.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 3
    RecoverOtherNasToFlashbladeFilesTargetParams:
      description: Specifies the params of the Flashblade recovery target.
      type: object
      title: Recover To Flashblade Files Target Params.
      required:
      - volume
      - alternatePath
      properties:
        volume:
          description: Specifies the id and name of the parent NAS to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        alternatePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 6
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 7
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 8
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverMongodbSnapshotParams:
      description: Specifies the snapshot parameters for a protected Mongodb object.
      title: Recover MongoDB Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          objects:
            description: Specifies details of objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverMongodbNoSqlObjectParams'
            x-order: 0
    RecoverVmwareVAppTemplateVCDSourceConfig:
      description: Specifies the new destination Source configuration where the vApp Templates will be recovered for vCloudDirector sources.
      type: object
      title: Recover VMware vApp Templates vCloudDirector Source Config.
      required:
      - source
      - vdc
      - catalog
      properties:
        source:
          description: Specifies the id of the parent source to recover the vApp templates.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        vdc:
          description: Specifies the VDC object where the recovered objects will be attached.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        catalog:
          description: Specifies the catalog where the vApp template should reside.
          allOf:
          - $ref: '#/components/schemas/VdcCatalog'
          - {}
          x-order: 2
        datastores:
          description: Specifies the datastore objects where the object's files should be recovered to.
          type:
          - array
          - 'null'
          maxItems: 1
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 3
        storageProfile:
          description: Specifies the storage profile to which the objects should be recovered. This should only be specified if datastores are not specified.
          allOf:
          - $ref: '#/components/schemas/VcdStorageProfileParams'
          - {}
          x-order: 4
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered vApp templates.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmNewSourceNetworkConfig'
          - {}
          x-order: 5
        orgVdcNetwork:
          description: Specifies the VDC organization network which will be attached with recoverd VM under current VApp template.
          type: object
          x-order: 6
          $ref: '#/components/schemas/OrgVDCNetwork'
    RecoverOracleNewTargetViewConfig:
      description: Specifies recovery parameters when recovering to a view.
      type: object
      title: Recover Oracle App New View Target Config.
      allOf:
      - $ref: '#/components/schemas/CommonOracleAppSourceConfig'
      properties:
        viewMountPath:
          description: Specifies the directory where cohesity view for app recovery will be mounted.
          type:
          - string
          - 'null'
          x-order: 0
    RecoverAcropolisVmParams:
      description: Specifies the recovery options specific to Acropolis environment.
      type: object
      title: Recover Acropolis params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAcropolis
          x-order: 1
        acropolisTargetParams:
          description: Specifies the params for recovering to a Acropolis target.
          allOf:
          - $ref: '#/components/schemas/AcropolisTargetParamsForRecoverVm'
          - {}
          x-order: 2
    AcropolisTargetParamsForRecoverFileAndFolder:
      description: Specifies the parameters for an Acropolis files and folders recovery target.
      type: object
      title: Acropolis Target Params for Recover Files
      required:
      - recoverToOriginalTarget
      properties:
        recoverToOriginalTarget:
          description: Specifies whether to recover to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for recovering to the original target.
          allOf:
          - $ref: '#/components/schemas/AcropolisRecoverFilesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for recovering to a new target.
          allOf:
          - $ref: '#/components/schemas/AcropolisRecoverFilesNewTargetConfig'
          - {}
          x-order: 2
        overwriteExisting:
          description: Specifies whether to overwrite the existing files. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveAttributes:
          description: Specifies whether to preserve original file/folder attributes. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the objects encounters an error. Default is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered files and folders. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    RecoverKvmVmNewNetworkConfig:
      description: Specifies the network config parameters to be applied for KVM VMs if recovering to a new source with a new network.
      type: object
      title: Recover KVM VMs New Network configuration.
      properties:
        networkPortGroup:
          description: Specifies the network port group (i.e, either a standard switch port group or a distributed port group) that will attached to the recovered Object. This parameter is mandatory if detach network is specified as false.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        vnicProfile:
          description: Specifies VNic profile that will be attached to the restored object.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
    RootPublicFolderParam:
      description: Specifies parameters to recover a RootPublicFolder.
      type: object
      required:
      - recoverObject
      properties:
        recoverObject:
          description: Specifies the RootPublicFolder recover Object info.
          allOf:
          - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          - {}
          x-order: 0
        recoverEntireRootPublicFolder:
          description: Specifies whether to recover the whole RootPublicFolder.
          type:
          - boolean
          - 'null'
          x-order: 1
        recoverFolders:
          description: Specifies a list of Public Folders to recover. This field is applicable only if 'recoverEntireRootPublicFolder' is false.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PublicFolder'
          x-order: 2
    CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e:
      description: Specifies the common request parameters to create a Recovery.
      type: object
      title: Common Recovery Request Params.
      required:
      - name
      - snapshotEnvironment
      properties:
        name:
          description: Specifies the name of the Recovery.
          type:
          - string
          - 'null'
          x-order: 0
        snapshotEnvironment:
          description: Specifies the type of environment of snapshots for which the Recovery has to be performed.
          type: string
          enum:
          - kVMware
          - kHyperV
          - kAzure
          - kGCP
          - kKVM
          - kAcropolis
          - kAWS
          - kPhysical
          - kGPFS
          - kElastifile
          - kNetapp
          - kGenericNas
          - kIsilon
          - kFlashBlade
          - kPure
          - kSQL
          - kExchange
          - kAD
          - kOracle
          - kView
          - kRemoteAdapter
          - kO365
          - kKubernetes
          - kCassandra
          - kMongoDB
          - kCouchbase
          - kHdfs
          - kHive
          - kHBase
          - kUDA
          x-order: 1
      x-cohesity-discriminator-details:
        propertyName: snapshotEnvironment
      x-discriminator:
        mapping:
          kVMware: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverVmwareParamsWrapper'
          kAWS: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverAwsParamsWrapper'
          kGCP: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverGcpParamsWrapper'
          kAzure: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverAzureParamsWrapper'
          kKVM: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverKvmParamsWrapper'
          kAcropolis: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverAcropolisParamsWrapper'
          kSQL: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverSqlParamsWrapper'
          kNetapp: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverNetappParamsWrapper'
          kGenericNas: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverGenericNasParamsWrapper'
          kIsilon: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverIsilonParamsWrapper'
          kFlashBlade: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverFlashbladeParamsWrapper'
          kElastifile: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverElastifileParamsWrapper'
          kGPFS: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverGpfsParamsWrapper'
          kPhysical: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverPhysicalParamsWrapper'
          kHyperV: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverHyperVParamsWrapper'
          kExchange: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverExchangeParamsWrapper'
          kCassandra: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eCassandraParamsWrapper'
          kUDA: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eUdaParamsWrapper'
          kCouchbase: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eCouchbaseParamsWrapper'
          kHbase: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eHbaseParamsWrapper'
          kHdfs: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eHdfsParamsWrapper'
          kHive: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eHiveParamsWrapper'
          kMongoDB: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eMongodbParamsWrapper'
          kPure: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverPureParamsWrapper'
          kKubernetes: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverKubernetesParamsWrapper'
          kO365: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverO365ParamsWrapper'
          kOracle: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverOracleParamsWrapper'
        propertyName: snapshotEnvironment
    RecoverOracleDbSnapshotParams:
      description: Specifies the snapshot parameters to recover Oracle databases.
      title: Recover Oracle database Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          instantRecoveryInfo:
            description: Specifies the info about instant recovery. This is only applicable for RecoverOracle.
            allOf:
            - $ref: '#/components/schemas/RecoveryOracleTaskInfo'
            - {}
            x-order: 0
            readOnly: true
    RecoverOracleGranularRestoreInfo:
      description: Specifies information about list of objects (PDBs) to restore.
      type: object
      title: Recover Oracle Granular Restore Information
      properties:
        granularityType:
          description: Specifies type of granular restore.
          type:
          - string
          - 'null'
          enum:
          - kPDB
          x-order: 0
        pdbRestoreParams:
          description: Specifies information about the list of pdbs to be restored.
          type: object
          allOf:
          - $ref: '#/components/schemas/OraclePdbRestoreParams'
          - {}
          x-order: 1
    RdsConfig:
      description: Specifies the parameters to recover AWS RDS.
      type: object
      title: Recover AWS RDS params.
      required:
      - dbPort
      - dbInstanceId
      - isMultiAzDeployment
      - enableIamDbAuthentication
      - enableCopyTagsToSnapshots
      - enableAutoMinorVersionUpgrade
      properties:
        dbPort:
          description: Specifies the port to use for the DB in the restored RDS instance.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 0
        dbInstanceId:
          description: Specifies the DB instance identifier to use for the restored DB.
          type:
          - string
          - 'null'
          x-order: 1
        isMultiAzDeployment:
          description: Specifies whether this is a multi-az deployment or not.
          type:
          - boolean
          - 'null'
          x-order: 2
        enablePublicAccessibility:
          description: Specifies whether this DB will be publicly accessible or not.
          type:
          - boolean
          - 'null'
          x-order: 3
        enableIamDbAuthentication:
          description: Specifies whether to enable IAM authentication for the DB.
          type:
          - boolean
          - 'null'
          x-order: 4
        enableCopyTagsToSnapshots:
          description: Specifies whether to enable copying of tags to snapshots of the DB.
          type:
          - boolean
          - 'null'
          x-order: 5
        enableAutoMinorVersionUpgrade:
          description: Specifies whether to enable auto minor version upgrade in the restored DB.
          type:
          - boolean
          - 'null'
          x-order: 6
        dbOptionGroup:
          description: Specifies entity representing the RDS option group to use while restoring the DB.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 7
        dbParameterGroup:
          description: Specifies the entity representing the RDS parameter group to use while restoring the DB.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 8
    AzureRecoverFilesNewTargetConfig:
      description: Specifies the configuration for recovering files and folders to the new target.
      type: object
      title: Azure Recover Files New Target Config.
      required:
      - targetVm
      - targetVmCredentials
      - absolutePath
      properties:
        targetVm:
          description: Specifies the target VM to recover files and folders to.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 1
        absolutePath:
          description: Specifies the absolute path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverAwsRdsParams:
      description: Specifies the parameters to recover AWS RDS.
      type: object
      title: Recover AWS RDS params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the RDS instances that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of RDS instances. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAWS
          x-order: 1
        awsTargetParams:
          description: Specifies the params for recovering to an AWS target.
          allOf:
          - $ref: '#/components/schemas/AwsTargetParamsForRecoverRds'
          - {}
          x-order: 2
    HiveParams:
      description: Specifies the recovery options specific to Hive environment.
      type: object
      title: Recover Hive environment params.
      required:
      - recoveryAction
      - recoverHiveParams
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverObjects
          x-order: 0
        recoverHiveParams:
          description: Specifies the parameters to recover Hive objects.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/RecoverHiveParams'
          - {}
          x-order: 1
          $ref: '#/components/schemas/RecoverHiveParams'
    RecoverPhysicalFileAndFolderParams:
      description: Specifies the parameters to recover files and folders.
      type: object
      title: Recover Physical File And Folder Params
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the information about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kPhysical
          x-order: 1
        physicalTargetParams:
          description: Specifies the parameters to recover to a Physical target.
          allOf:
          - $ref: '#/components/schemas/PhysicalTargetParamsForRecoverFileAndFolder'
          - {}
          x-order: 2
    RecoverHyperVVmNewSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover HyperV VMs New Source Config.
      required:
      - sourceType
      properties:
        sourceType:
          description: Specifies the type of HyperV source to which the VMs are being restored.
          type:
          - string
          - 'null'
          enum:
          - kSCVMMServer
          - kStandaloneHost
          - kStandaloneCluster
          x-order: 0
        scvmmServerParams:
          x-order: 1
          $ref: '#/components/schemas/RecoverHyperVVmSCVMMSourceConfig'
        standaloneHostParams:
          x-order: 2
          $ref: '#/components/schemas/RecoverHyperVVmStandaloneHostSourceConfig'
        standaloneClusterParams:
          x-order: 3
          $ref: '#/components/schemas/RecoverHyperVVmStandaloneClusterSourceConfig'
    RecoverOracleParams:
      description: Specifies the recovery options specific to oracle environment.
      type: object
      title: Recover Oracle environment params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of parameters for list of objects to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverOracleDbSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverApps
          - CloneAppView
          x-order: 1
        recoverAppParams:
          description: Specifies the parameters to recover Oracle databases.
          allOf:
          - $ref: '#/components/schemas/RecoverOracleAppParams'
          - {}
          x-order: 2
    OriginalGenericNasTargetParams:
      description: Specifies the params of the original Generic NAS recovery target.
      type: object
      title: Recover To Original Generic NAS Volume Target Params.
      properties:
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 0
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 4
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverKvmVmOriginalSourceConfig:
      description: Specifies the Source configuration if VM's are being recovered to Original Source.
      type: object
      title: Recover KVM VMs Original Source Config.
      properties:
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverKvmVmOriginalSourceNetworkConfig'
          - {}
          x-order: 0
    OriginalGpfsTargetParams:
      description: Specifies the params of the original GPFS recovery target.
      type: object
      title: Recover To Original GPFS NAS Volume Target Params.
      properties:
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 0
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 5
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverCouchbaseNoSqlObjectParams:
      description: Specifies the fully qualified object name and other attributes of each object to be recovered.
      title: Recover Couchbase Object Params.
      required:
      - objectName
      properties:
        objectName:
          description: Specifies the fully qualified name of the object to be restored.
          type:
          - string
          - 'null'
          x-order: 0
        renameTo:
          description: Specifies the new name to which the object should be renamed, at the time of recovery.
          type:
          - string
          - 'null'
          x-order: 1
    RecoverHiveParams:
      description: Specifies the type of recover action to be performed.
      title: Recover Hive params.
      allOf:
      - $ref: '#/components/schemas/CommonNoSqlRecoveryOptions'
      - type: object
        required:
        - snapshots
        properties:
          snapshots:
            description: Specifies the local snapshot ids of the Objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverHiveSnapshotParams'
            x-order: 0
          suffix:
            description: A suffix that is to be applied to all recovered objects.
            type:
            - string
            - 'null'
            x-order: 1
    TargetMailboxParam:
      description: Specifies the target Mailbox to recover to.
      allOf:
      - $ref: '#/components/schemas/RecoveryObjectIdentifier'
      - type: object
        required:
        - targetFolderPath
        properties:
          targetFolderPath:
            description: Specifies the path to the target folder.
            type:
            - string
            - 'null'
            x-order: 0
    RecoverVmwareVmParams:
      description: Specifies the parameters to recover VMware VM.
      type: object
      title: Recover VMware VM params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kVMware
          x-order: 1
        vmwareTargetParams:
          description: Specifies the params for recovering to a VMware target.
          allOf:
          - $ref: '#/components/schemas/VmwareTargetParamsForRecoverVM'
          - {}
          x-order: 2
    RecoverPureSanVolumeNewSourceConfig:
      description: Specifies the new destination Source configuration where the Pure volume will be recovered.
      type: object
      title: Recover Pure Volume New Source Config.
      required:
      - source
      properties:
        source:
          description: Specifies the id of the new target parent source to recover the Pure SAN Volume to. This field must be specified if recoverToNewSource is true.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        renameRecoveredVolumeParams:
          description: Specifies params to rename the recovered SAN volumes. If not specified, the original names of the volumes are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 1
    RecoverAzureVmNewSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover Azure VMs New Source Config.
      required:
      - source
      - computeOption
      - resourceGroup
      - storageAccount
      - storageContainer
      - networkConfig
      - storageResourceGroup
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        resourceGroup:
          description: Specifies the Azure resource group.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        storageAccount:
          description: Specifies the storage account that will contain the storage container
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        storageContainer:
          description: Specifies the storage container within the above storage account.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 3
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverAzureVmNewSourceNetworkConfig'
          - {}
          x-order: 4
        storageResourceGroup:
          description: Specifies id of the resource group for the selected storage account.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 5
        computeOption:
          description: Specifies the type of VM (e.g. small, medium, large) when cloning/restoring the VM in Azure.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 6
        availabilitySet:
          description: Specifies the availability set.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 7
    OneDriveItem:
      description: Specifies a OneDrive item to recover.
      type: object
      properties:
        id:
          description: Specifies the item id.
          type:
          - string
          - 'null'
          x-order: 0
        itemPath:
          description: Specifies the path to the OneDrive item.
          type:
          - string
          - 'null'
          x-order: 1
        isFile:
          description: Specifies if the item is a file.
          type:
          - boolean
          - 'null'
          x-order: 2
    RecoverVMwareFileAndFolderParams:
      description: Specifies the parameters to recover files and folders.
      type: object
      title: Recover VMware File And Folder Params
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kVMware
          x-order: 1
        vmwareTargetParams:
          description: Specifies the parameters to recover to a VMware target.
          allOf:
          - $ref: '#/components/schemas/VmwareTargetParamsForRecoverFileAndFolder'
          - {}
          x-order: 2
    RecoverGpfsNasVolumeParams:
      description: Specifies the parameters to recover GPFS NAS volumes.
      type: object
      title: Recover GPFS NAS Volume Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          - kView
          x-order: 0
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverGpfsToGpfsVolumeTargetParams'
          - {}
          x-order: 1
        elastifileTargetParams:
          description: Specifies the params for a Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileVolumeTargetParams'
          - {}
          x-order: 2
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeVolumeTargetParams'
          - {}
          x-order: 3
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasVolumeTargetParams'
          - {}
          x-order: 4
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonVolumeTargetParams'
          - {}
          x-order: 5
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappVolumeTargetParams'
          - {}
          x-order: 6
        viewTargetParams:
          description: Specifies the params for a Cohesity view recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNasVolumeToViewParams'
          - {}
          x-order: 7
    KubernetesTargetParamsForRecoverKubernetesNamespace:
      description: Specifies the parameters for recovering a Kubernetes namespace to a Kubernetes source.
      type: object
      title: Kubernetes Target Params For Recover Namespace
      required:
      - recoveryTargetConfig
      properties:
        objects:
          description: Specifies the objects to be recovered.
          type:
          - array
          - 'null'
          minItems: 1
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 1
        renameRecoveredNamespacesParams:
          description: Specifies params to rename the Namespaces that are recovered. If not specified, the original names of the Namespaces are preserved. If a name collision occurs then the Namespace being recovered will overwrite the Namespace already present on the source.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 2
        recoveryTargetConfig:
          description: Specifies the recovery target configuration of the Namespace recovery.
          allOf:
          - $ref: '#/components/schemas/KubernetesNamespaceRecoveryTargetConfig'
          - {}
          x-order: 3
    RecoverMongodbNoSqlObjectParams:
      description: Specifies the fully qualified object name and other attributes of each object to be recovered.
      title: Recover MongoDB Object Params.
      required:
      - objectName
      properties:
        objectName:
          description: Specifies the fully qualified name of the object to be restored.
          type:
          - string
          - 'null'
          x-order: 0
        renameTo:
          description: Specifies the new name to which the object should be renamed. at the time of recovery.
          type:
          - string
          - 'null'
          x-order: 1
        objectProperties:
          description: Specifies the properties to be applied to the object at the time of recovery.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NoSqlObjectProperty'
          x-order: 2
    RecoverHyperVVmOriginalSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for HyperV VMs if recovering to original Source.
      type: object
      title: Recover HyperV VMs Original Source Network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
    DownloadFilesAndFoldersRequestParams:
      description: Specifies the parameters to create a download files and folders Recovery.
      type: object
      title: Download Files And Folders Recovery Params.
      required:
      - name
      - object
      - filesAndFolders
      properties:
        name:
          description: Specifies the name of the recovery task. This field must be set and must be a unique name.
          type:
          - string
          - 'null'
          x-order: 0
        object:
          description: Specifies the snapshot object from which to download files and folders.
          type:
          - object
          - 'null'
          x-order: 1
          $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
        filesAndFolders:
          description: Specifies the list of files and folders to download.
          type:
          - array
          - 'null'
          minItems: 1
          items:
            $ref: '#/components/schemas/FilesAndFoldersObject'
          x-order: 2
    AwsRecoverFilesOriginalTargetConfig:
      description: Specifies the configuration for recovering files and folders to the original target.
      type: object
      title: AWS Recover Files Original Target Config.
      required:
      - targetVmCredentials
      - recoverToOriginalPath
      properties:
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 0
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 1
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverOtherNasToIsilonVolumeTargetParams:
      description: Specifies the params of the Isilon recovery target.
      type: object
      title: Recover To Isilon Volume Target Params.
      required:
      - volume
      properties:
        volume:
          description: Specifies the id and name of the volume to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    VcdStorageProfileParams:
      description: Specifies the parameters of a VCD storage profile.
      type: object
      title: VCD Storage Profile Params
      required:
      - vcdUuid
      properties:
        vcdUuid:
          description: Specifies the UUID assigned by the VCD to the storage profile.
          type:
          - string
          - 'null'
          x-order: 0
        name:
          description: Specifies the name of the storage profile.
          type:
          - string
          - 'null'
          x-order: 1
          readOnly: true
    RecoverCassandraParams:
      description: Specifies the parameters to recover Cassandra objects.
      title: Recover Cassandra params.
      allOf:
      - $ref: '#/components/schemas/CommonNoSqlRecoveryOptions'
      - type: object
        required:
        - snapshots
        properties:
          snapshots:
            description: Specifies the local snapshot ids and other details of the Objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverCassandraSnapshotParams'
            x-order: 0
          suffix:
            description: A suffix that is to be applied to all recovered objects.
            type:
            - string
            - 'null'
            x-order: 1
          selectedDataCenters:
            description: Selected Data centers for this cluster.
            type: array
            items:
              type: string
            x-order: 2
          stagingDirectoryList:
            description: Specifies the directory on the primary to copy the files which are to be uploaded using destination sstableloader.
            type: array
            items:
              type: string
            x-order: 3
    Recoveries:
      description: Specifies list of Recoveries.
      type: object
      title: List of Recoveries.
      properties:
        recoveries:
          description: Specifies list of Recoveries.
          type:
          - array
          - 'null'
          items:
            x-cohesity-discriminator-ref: CommonRecoveryResponseParams
            $ref: '#/components/schemas/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
          x-order: 0
    CommonCloudTierSettings:
      description: Specifies the common settings required for configuring cloud tiering.
      type: object
      properties:
        moveAfterUnit:
          description: Specifies the unit for moving the data from current tier to next tier. This unit will be a base unit for the 'moveAfter' field specified below.
          type:
          - string
          - 'null'
          enum:
          - Days
          - Weeks
          - Months
          - Years
          x-order: 0
        moveAfter:
          description: Specifies the time period after which the backup will be moved from current tier to next tier.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 1
    RecoverVmwareSnapshotParams:
      description: Specifies the snapshot parameters for VMware recovery.
      title: Recover VMware Parent Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/RecoverVmwareChildSnapshotParams'
      - type: object
        properties:
          childSnapshots:
            description: Specifies optional information about any child snapshots of this object. For example a VCD snapshot may have child VM information populated here.
            type: array
            items:
              $ref: '#/components/schemas/RecoverVmwareChildSnapshotParams'
            x-order: 0
    RecoverGcpVmNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for GCP VMs if recovering to new Source.
      type: object
      title: Recover GCP VMs New Source Network configuration.
      required:
      - subnet
      properties:
        subnet:
          description: Specifies the subnet.
          allOf:
          - $ref: '#/components/schemas/GcpVpcSubnetConfig'
          - {}
          x-order: 0
    HostInformation:
      description: Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server.
      type: object
      properties:
        id:
          description: Specifies the id of the host object.
          type:
          - string
          - 'null'
          x-order: 0
        name:
          description: Specifies the name of the host object.
          type:
          - string
          - 'null'
          x-order: 1
        environment:
          description: Specifies the environment of the object.
          type:
          - string
          - 'null'
          enum:
          - kVMware
          - kHyperV
          - kAzure
          - kKVM
          - kAWS
          - kAcropolis
          - kGCP
          - kPhysical
          - kPhysicalFiles
          - kIsilon
          - kNetapp
          - kGenericNas
          - kFlashBlade
          - kElastifile
          - kGPFS
          - kPure
          - kNimble
          - kSQL
          - kOracle
          - kExchange
          - kAD
          - kView
          - kO365
          - kHyperFlex
          - kKubernetes
          - kCassandra
          - kMongoDB
          - kCouchbase
          - kHdfs
          - kHive
          - kHBase
          - kUDA
          x-order: 2
    RecoverGcpVmNewSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover GCP VMs New Source Config.
      required:
      - source
      - project
      - region
      - availabilityZone
      - networkConfig
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        project:
          description: Specifies the GCP project in which to deploy the VM.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        region:
          description: Specifies the GCP region in which to deploy the VM.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        availabilityZone:
          description: Specifies the GCP zone in which to deploy the VM.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 3
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverGcpVmNewSourceNetworkConfig'
          - {}
          x-order: 4
    RecoverKvmVmParams:
      description: Specifies the parameters to recover VMs.
      type: object
      title: Recover VMs params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kKVM
          x-order: 1
        kvmTargetParams:
          description: Specifies the params for recovering to a KVM target.
          allOf:
          - $ref: '#/components/schemas/KvmTargetParamsForRecoverVm'
          - {}
          x-order: 2
    RecoverExchangeAppSnapshotParams:
      description: Specifies the snapshot parameters to recover Exchange databases.
      title: Recover Exchange App Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          appObjects:
            description: Specifies the list of params for all the databases which have to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ExchangeRecoverDatabaseParams'
            x-order: 0
    RecoverVmwareVAppVCDSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered for vCloudDirector sources.
      type: object
      title: Recover VMware VMs vCloudDirector Source Config.
      required:
      - source
      - vdc
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        vdc:
          description: Specifies the VDC object where the recovered objects will be attached.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        datastores:
          description: Specifies the datastore objects where the object's files should be recovered to.
          type:
          - array
          - 'null'
          maxItems: 1
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 2
        storageProfile:
          description: Specifies the storage profile to which the objects should be recovered. This should only be specified if datastores are not specified.
          allOf:
          - $ref: '#/components/schemas/VcdStorageProfileParams'
          - {}
          x-order: 3
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmNewSourceNetworkConfig'
          - {}
          x-order: 4
        orgVdcNetwork:
          description: Specifies the VDC organization network which will be attached with recoverd VM under current VApp.
          type: object
          x-order: 5
          $ref: '#/components/schemas/OrgVDCNetwork'
    FleetTags:
      description: Specifies the fleet tag parameters.
      type: object
      title: Fleet tags.
      required:
      - key
      - value
      properties:
        key:
          description: Specifies key for the fleet tag.
          type:
          - string
          - 'null'
          x-order: 0
        value:
          description: Specifies value for the fleet tag.
          type:
          - string
          - 'null'
          x-order: 1
    RecoverAzureParams:
      description: Specifies the recovery options specific to Azure environment.
      type: object
      title: Recover Azure environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters. This property is mandatory for all recovery action types except recover vms. While recovering VMs, a user can specify snapshots of VM's or a Protection Group Run details to recover all the VM's that are backed up by that Run. For recovering files, specifies the object contains the file to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverVMs
          - RecoverFiles
          x-order: 1
        recoverVmParams:
          description: Specifies the parameters to recover Azure VM.
          allOf:
          - $ref: '#/components/schemas/RecoverAzureVmParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover Azure files and folders.
          allOf:
          - $ref: '#/components/schemas/RecoverAzureFileAndFolderParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    CommonRecoveryResponseParams:
      description: Specifies the common response parameters to create a Recovery
      type: object
      title: Common Recovery Response Params.
      properties:
        id:
          description: Specifies the id of the Recovery.
          type:
          - string
          - 'null'
          pattern: ^\d+:\d+:\d+$
          x-order: 0
        name:
          description: Specifies the name of the Recovery.
          type:
          - string
          - 'null'
          x-order: 1
        startTimeUsecs:
          description: Specifies the start time of the Recovery in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 2
        endTimeUsecs:
          description: Specifies the end time of the Recovery in Unix timestamp epoch in microseconds. This field will be populated only after Recovery is finished.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 3
        status:
          description: Status of the Recovery. 'Running' indicates that the Recovery is still running. 'Canceled' indicates that the Recovery has been cancelled. 'Canceling' indicates that the Recovery is in the process of being cancelled. 'Failed' indicates that the Recovery has failed. 'Succeeded' indicates that the Recovery has finished successfully. 'SucceededWithWarning' indicates that the Recovery finished successfully, but there were some warning messages.
          type:
          - string
          - 'null'
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-order: 4
        progressTaskId:
          description: Progress monitor task id for Recovery.
          type:
          - string
          - 'null'
          x-order: 5
        snapshotEnvironment:
          description: Specifies the type of snapshot environment for which the Recovery was performed.
          type: string
          enum:
          - kVMware
          - kHyperV
          - kAzure
          - kGCP
          - kKVM
          - kAcropolis
          - kAWS
          - kPhysical
          - kGPFS
          - kElastifile
          - kNetapp
          - kGenericNas
          - kIsilon
          - kFlashBlade
          - kPure
          - kSQL
          - kExchange
          - kAD
          - kOracle
          - kView
          - kRemoteAdapter
          - kO365
          - kKubernetes
          - kCassandra
          - kMongoDB
          - kCouchbase
          - kHdfs
          - kHive
          - kHBase
          - kUDA
          x-order: 6
        recoveryAction:
          description: Specifies the type of recover action.
          type: string
          enum:
          - RecoverVMs
          - RecoverFiles
          - InstantVolumeMount
          - RecoverVmDisks
          - RecoverVApps
          - RecoverVAppTemplates
          - RecoverRDS
          - RecoverAurora
          - RecoverApps
          - RecoverNasVolume
          - RecoverPhysicalVolumes
          - RecoverSystem
          - CloneAppView
          - RecoverSanVolumes
          - RecoverMailbox
          - RecoverOneDrive
          - RecoverSharePoint
          - RecoverPublicFolders
          - RecoverMsGroup
          - RecoverMsTeam
          - RecoverNamespaces
          - RecoverObjects
          - DownloadFilesAndFolders
          x-order: 7
        permissions:
          description: Specifies the list of tenants that have permissions for this recovery.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Tenant'
          x-order: 8
        creationInfo:
          description: Specifies the information about the creation of the recovery.
          type:
          - object
          - 'null'
          x-order: 9
          $ref: '#/components/schemas/CreationInfo'
        canTearDown:
          description: Specifies whether it's possible to tear down the objects created by the recovery.
          type:
          - boolean
          - 'null'
          x-order: 10
        tearDownStatus:
          description: Specifies the status of the tear down operation. This is only set when the canTearDown is set to true. 'DestroyScheduled' indicates that the tear down is ready to schedule. 'Destroying' indicates that the tear down is still running. 'Destroyed' indicates that the tear down succeeded. 'DestroyError' indicates that the tear down failed.
          type:
          - string
          - 'null'
          enum:
          - DestroyScheduled
          - Destroying
          - Destroyed
          - DestroyError
          x-order: 11
        tearDownMessage:
          description: Specifies the error message about the tear down operation if it fails.
          type:
          - string
          - 'null'
          x-order: 12
        messages:
          description: Specifies messages about the recovery.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 13
        isParentRecovery:
          description: Specifies whether the current recovery operation has created child recoveries. This is currently used in SQL recovery where multiple child recoveries can be tracked under a common/parent recovery.
          type:
          - boolean
          - 'null'
          x-order: 14
        parentRecoveryId:
          description: If current recovery is child recovery triggered by another parent recovery operation, then this field willt specify the id of the parent recovery.
          type:
          - string
          - 'null'
          pattern: ^\d+:\d+:\d+$
          x-order: 15
      x-cohesity-discriminator-details:
        propertyName: snapshotEnvironment
    RecoverFlashbladeToFlashbladeFilesTargetParams:
      description: Specifies the params of the Flashblade recovery target.
      type: object
      title: Recover Flashblade To Flashblade Files Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Flashblade target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the files will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeFilesTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if files are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalFlashbladeFilesTargetParams'
          - {}
          x-order: 2
    VmwareTargetParamsForRecoverDisk:
      description: Specifies the parameters for a VMware recovery target.
      type: object
      title: VMware Target Params.
      properties:
        originalSourceConfig:
          description: Specifies the configuration for restoring a disk to the original VM from which the snapshot was taken.
          type: object
          x-order: 0
          $ref: '#/components/schemas/VmwareRecoverDisksOriginalSourceConfig'
        targetSourceConfig:
          description: Specifies the configuration for restoring disks to a different VM than the one from which the snapshot was taken.
          type: object
          x-order: 1
          $ref: '#/components/schemas/VmwareRecoverDisksTargetSourceConfig'
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 2
        powerOffVms:
          description: Specifies whether or not to power off VMs before performing the recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        powerOnVms:
          description: Specifies whether or not to power on VMs after performing the recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether or not to continue performing the recovery in the event that an error is encountered.
          type:
          - boolean
          - 'null'
          x-order: 5
    RecoverHyperVVmStandaloneHostSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover HyperV VMs New Standalone Host Source Config.
      required:
      - source
      - volume
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        volume:
          description: Specifies the datastore object where the VMs' files should be recovered to.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVVmNewSourceNetworkConfig'
          - {}
          x-order: 2
    FolderItem:
      description: Specifies an email folder to recover.
      type: object
      required:
      - key
      properties:
        key:
          description: Specifies the email folder key.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        recoverEntireFolder:
          description: Specifies whether to recover the whole email folder.
          type:
          - boolean
          - 'null'
          x-order: 1
        itemIds:
          description: Specifies a list of item ids to recover. This field is applicable only if 'recoverEntireFolder' is false.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 2
    Recovery:
      description: Specifies a Recovery.
      title: Recovery.
      allOf:
      - $ref: '#/components/schemas/CommonRecoveryResponseParams'
      - type: object
        properties:
          vmwareParams:
            description: Specifies the parameters which are specific to VMware related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverVmwareParams'
            - {}
            x-cohesity-discriminator-value: kVMware
            x-order: 0
            $ref: '#/components/schemas/RecoverVmwareParams'
          awsParams:
            description: Specifies the parameters which are specific to AWS related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverAwsParams'
            - {}
            x-cohesity-discriminator-value: kAWS
            x-order: 1
            $ref: '#/components/schemas/RecoverAwsParams'
          gcpParams:
            description: Specifies the parameters which are specific to GCP related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverGcpParams'
            - {}
            x-cohesity-discriminator-value: kGCP
            x-order: 2
            $ref: '#/components/schemas/RecoverGcpParams'
          azureParams:
            description: Specifies the parameters which are specific to Azure related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverAzureParams'
            - {}
            x-cohesity-discriminator-value: kAzure
            x-order: 3
            $ref: '#/components/schemas/RecoverAzureParams'
          kvmParams:
            description: Specifies the parameters which are specific to KVM related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverKvmParams'
            - {}
            x-cohesity-discriminator-value: kKVM
            x-order: 4
            $ref: '#/components/schemas/RecoverKvmParams'
          acropolisParams:
            description: Specifies the parameters which are specific to Acropolis related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverAcropolisParams'
            - {}
            x-cohesity-discriminator-value: kAcropolis
            x-order: 5
            $ref: '#/components/schemas/RecoverAcropolisParams'
          mssqlParams:
            description: Specifies the parameters which are specific to MsSQL related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverSqlParams'
            - {}
            x-cohesity-discriminator-value: kSQL
            x-order: 6
            $ref: '#/components/schemas/RecoverSqlParams'
          netappParams:
            description: Specifies the parameters which are specific to Netapp related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverNetappParams'
            - {}
            x-cohesity-discriminator-value: kNetapp
            x-order: 7
            $ref: '#/components/schemas/RecoverNetappParams'
          genericNasParams:
            description: Specifies the parameters which are specific to Generic NAS related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverGenericNasParams'
            - {}
            x-cohesity-discriminator-value: kGenericNas
            x-order: 8
            $ref: '#/components/schemas/RecoverGenericNasParams'
          isilonParams:
            description: Specifies the parameters which are specific to Isilon related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverIsilonParams'
            - {}
            x-cohesity-discriminator-value: kIsilon
            x-order: 9
            $ref: '#/components/schemas/RecoverIsilonParams'
          flashbladeParams:
            description: Specifies the parameters which are specific to FlashBlade related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverFlashbladeParams'
            - {}
            x-cohesity-discriminator-value: kFlashBlade
            x-order: 10
            $ref: '#/components/schemas/RecoverFlashbladeParams'
          elastifileParams:
            description: Specifies the parameters which are specific to Elastifile related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverElastifileParams'
            - {}
            x-cohesity-discriminator-value: kElastifile
            x-order: 11
            $ref: '#/components/schemas/RecoverElastifileParams'
          gpfsParams:
            description: Specifies the parameters which are specific to GPFS related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverGpfsParams'
            - {}
            x-cohesity-discriminator-value: kGPFS
            x-order: 12
            $ref: '#/components/schemas/RecoverGpfsParams'
          physicalParams:
            description: Specifies the parameters which are specific to Physical related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverPhysicalParams'
            - {}
            x-cohesity-discriminator-value: kPhysical
            x-order: 13
            $ref: '#/components/schemas/RecoverPhysicalParams'
          hypervParams:
            description: Specifies the parameters which are specific to HyperV related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverHyperVParams'
            - {}
            x-cohesity-discriminator-value: kHyperV
            x-order: 14
            $ref: '#/components/schemas/RecoverHyperVParams'
          exchangeParams:
            description: Specifies the parameters which are specific to Exchange related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverExchangeParams'
            - {}
            x-cohesity-discriminator-value: kExchange
            x-order: 15
            $ref: '#/components/schemas/RecoverExchangeParams'
          cassandraParams:
            description: Specifies the parameters which are specific to Cassandra Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/CassandraParams'
            - {}
            x-cohesity-discriminator-value: kCassandra
            x-order: 16
            $ref: '#/components/schemas/CassandraParams'
          udaParams:
            description: Specifies the parameters which are specific to Universal Data Adapter Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/UdaParams'
            - {}
            x-cohesity-discriminator-value: kUDA
            x-order: 17
            $ref: '#/components/schemas/UdaParams'
          couchbaseParams:
            description: Specifies the parameters which are specific to Couchbase Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/CouchbaseParams'
            - {}
            x-cohesity-discriminator-value: kCouchbase
            x-order: 18
            $ref: '#/components/schemas/CouchbaseParams'
          hbaseParams:
            description: Specifies the parameters which are specific to Hbase Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/HbaseParams'
            - {}
            x-cohesity-discriminator-value: kHbase
            x-order: 19
            $ref: '#/components/schemas/HbaseParams'
          hdfsParams:
            description: Specifies the parameters which are specific to HDFS Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/HdfsParams'
            - {}
            x-cohesity-discriminator-value: kHdfs
            x-order: 20
            $ref: '#/components/schemas/HdfsParams'
          hiveParams:
            description: Specifies the parameters which are specific to Hive Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/HiveParams'
            - {}
            x-cohesity-discriminator-value: kHive
            x-order: 21
            $ref: '#/components/schemas/HiveParams'
          mongodbParams:
            description: Specifies the parameters which are specific to MongoDB Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/MongodbParams'
            - {}
            x-cohesity-discriminator-value: kMongoDB
            x-order: 22
            $ref: '#/components/schemas/MongodbParams'
          pureParams:
            description: Specifies the parameters which are specific to Pure related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverPureParams'
            - {}
            x-cohesity-discriminator-value: kPure
            x-order: 23
            $ref: '#/components/schemas/RecoverPureParams'
          office365Params:
            description: Specifies the parameters which are specific to Office 365 related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverO365Params'
            - {}
            x-cohesity-discriminator-value: kO365
            x-order: 24
            $ref: '#/components/schemas/RecoverO365Params'
          kubernetesParams:
            description: Specifies the parameters which are specific to Kubernetes related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverKubernetesParams'
            - {}
            x-cohesity-discriminator-value: kKubernetes
            x-order: 25
            $ref: '#/components/schemas/RecoverKubernetesParams'
          oracleParams:
            description: Specifies the parameters which are specific to Oracle related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverOracleParams'
            - {}
            x-cohesity-discriminator-value: kOracle
            x-order: 26
            $ref: '#/components/schemas/RecoverOracleParams'
          viewParams:
            description: Specifies the parameters which are specific to View related Recovery.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/RecoverViewParams'
            - {}
            x-cohesity-discriminator-value: kView
            x-order: 27
            $ref: '#/components/schemas/RecoverViewParams'
    AwsRdsRecoveryTargetConfig:
      description: Specifies the target object parameters to recover AWS RDS.
      type: object
      title: AWS RDS Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the RDS instances will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsRdsNewSourceConfig'
          - {}
          x-order: 1
    RecoverGcpParams:
      description: Specifies the recovery options specific to GCP environment.
      type: object
      title: Recover GCP environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters. This property is mandatory for all recovery action types except recover vms. While recovering VMs, a user can specify snapshots of VM's or a Protection Group Run details to recover all the VM's that are backed up by that Run.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverVMs
          x-order: 1
        recoverVmParams:
          description: Specifies the parameters to recover GCP VM.
          allOf:
          - $ref: '#/components/schemas/RecoverGcpVmParams'
          - {}
          x-order: 2
    FilterIpConfig:
      description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
      type: object
      title: Filter IP Configuration
      properties:
        deniedIpAddresses:
          description: Specifies the IP addresses that should not be used during recovery recovery. Cannot be set if allowedIpAddresses is set.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 0
        allowedIpAddresses:
          description: Specifies the IP addresses that should be used exclusively during recovery. Cannot be set if deniedIpAddresses is set.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 1
    RecoverAcropolisVmOriginalSourceConfig:
      description: Specifies the Source configuration if VM's are being recovered to Original Source.
      type: object
      title: Recover Acropolis VMs Original Source Config.
      properties:
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverAcropolisVmOriginalSourceNetworkConfig'
          - {}
          x-order: 0
    HyperVTargetParamsForRecoverVm:
      description: Specifies the parameters for a HyperV recovery target.
      type: object
      title: HyperV Target Params.
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/HyperVVmRecoveryTargetConfig'
          - {}
          x-order: 1
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 2
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 3
        instantRecovery:
          description: Specifies whether to perform an instant recovery. By instant recovery, the recovered VM is available before files are completely copied to the recovered VM. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 4
        preserveUuids:
          description: Specifies whether to preserve uuids of recovered VMs. Default is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    RecoverCassandraNoSqlObjectParams:
      description: Specifies the fully qualified object name and other attributes of each object to be recovered.
      title: Recover Cassandra Object Params.
      required:
      - objectName
      properties:
        objectName:
          description: Specifies the fully qualified name of the object to be restored.
          type:
          - string
          - 'null'
          x-order: 0
        renameTo:
          description: Specifies the new name to which the object should be renamed to after the recovery.
          type:
          - string
          - 'null'
          x-order: 1
        objectProperties:
          description: Specifies the properties to be applied to the object at the time of recovery.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NoSqlObjectProperty'
          x-order: 2
    RecoverElastifileNasVolumeParams:
      description: Specifies the parameters to recover Elastifile NAS volumes.
      type: object
      title: Recover Elastifile NAS Volume Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          - kView
          x-order: 0
        elastifileTargetParams:
          description: Specifies the params for a Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverElastifileToElastifileVolumeTargetParams'
          - {}
          x-order: 1
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeVolumeTargetParams'
          - {}
          x-order: 2
        genericNasTargetParams:
          description: Specifies the params for a Generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasVolumeTargetParams'
          - {}
          x-order: 3
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsVolumeTargetParams'
          - {}
          x-order: 4
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonVolumeTargetParams'
          - {}
          x-order: 5
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappVolumeTargetParams'
          - {}
          x-order: 6
        viewTargetParams:
          description: Specifies the params for a Cohesity view recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNasVolumeToViewParams'
          - {}
          x-order: 7
    RecoverOtherNasToGenericNasVolumeTargetParams:
      description: Specifies the params of the Generic NAS recovery target.
      type: object
      title: Recover To Generic NAS Volume Target Params.
      required:
      - volume
      properties:
        volume:
          description: Specifies the id and name of the parent volume to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 6
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverUdaSnapshotParams:
      description: Specifies the snapshot parameters for a protected Universal Data Adapter object.
      title: Recover Universal Data Adapter Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          objects:
            description: Specifies the local snapshot ids and other details of the objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverUdaObjectParams'
            x-order: 0
    RecoverVmwareVmNewNetworkConfig:
      description: Specifies the new network config parameters to be applied to VMware VMs.
      type: object
      title: Recover VMware VMs New Network configuration.
      properties:
        networkPortGroup:
          description: Specifies the network port group (i.e, either a standard switch port group or a distributed port group) that will attached to the recovered Object. This parameter is mandatory if detach network is specified as false.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        disableNetwork:
          description: Specifies whether the attached network should be left in disabled state. Default is false
          type:
          - boolean
          - 'null'
          x-order: 1
        preserveMacAddress:
          description: If this is true and we are attaching to a new network entity, then the VM's MAC address will be preserved on the new network. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
    RecoverKvmVmOriginalSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for KVM VMs if recovering to original Source.
      type: object
      title: Recover KVM VMs Original Source Network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. All the other networking parameters set will be ignored if set to true. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
    PhysicalMountVolumesNewTargetConfig:
      description: Specifies the configuration for mounting volumes to a new target.
      type: object
      title: HyperV Mount Volumes New Target Config.
      required:
      - mountTarget
      properties:
        mountTarget:
          description: Specifies the target entity where the volumes are being mounted.
          type:
          - object
          - 'null'
          x-order: 0
          $ref: '#/components/schemas/RecoverTarget'
        serverCredentials:
          description: Specifies credentials to access the target server. This is required if the server is of Linux OS.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 1
    MigrateCloneParams:
      description: Specifies the DB migration parameters.
      type: object
      title: Oracle DB migration parameters.
      properties:
        delaySecs:
          description: Specifies when the migration of the oracle instance should be started after successful recovery.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        targetPathVec:
          description: Specifies the target paths to be used for DB migration.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 1
    CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093:
      description: Specifies the common response parameters to create a Recovery
      type: object
      title: Common Recovery Response Params.
      properties:
        id:
          description: Specifies the id of the Recovery.
          type:
          - string
          - 'null'
          pattern: ^\d+:\d+:\d+$
          x-order: 0
        name:
          description: Specifies the name of the Recovery.
          type:
          - string
          - 'null'
          x-order: 1
        startTimeUsecs:
          description: Specifies the start time of the Recovery in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 2
        endTimeUsecs:
          description: Specifies the end time of the Recovery in Unix timestamp epoch in microseconds. This field will be populated only after Recovery is finished.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 3
        status:
          description: Status of the Recovery. 'Running' indicates that the Recovery is still running. 'Canceled' indicates that the Recovery has been cancelled. 'Canceling' indicates that the Recovery is in the process of being cancelled. 'Failed' indicates that the Recovery has failed. 'Succeeded' indicates that the Recovery has finished successfully. 'SucceededWithWarning' indicates that the Recovery finished successfully, but there were some warning messages.
          type:
          - string
          - 'null'
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-order: 4
        progressTaskId:
          description: Progress monitor task id for Recovery.
          type:
          - string
          - 'null'
          x-order: 5
        snapshotEnvironment:
          description: Specifies the type of snapshot environment for which the Recovery was performed.
          type: string
          enum:
          - kVMware
          - kHyperV
          - kAzure
          - kGCP
          - kKVM
          - kAcropolis
          - kAWS
          - kPhysical
          - kGPFS
          - kElastifile
          - kNetapp
          - kGenericNas
          - kIsilon
          - kFlashBlade
          - kPure
          - kSQL
          - kExchange
          - kAD
          - kOracle
          - kView
          - kRemoteAdapter
          - kO365
          - kKubernetes
          - kCassandra
          - kMongoDB
          - kCouchbase
          - kHdfs
          - kHive
          - kHBase
          - kUDA
          x-order: 6
        recoveryAction:
          description: Specifies the type of recover action.
          type: string
          enum:
          - RecoverVMs
          - RecoverFiles
          - InstantVolumeMount
          - RecoverVmDisks
          - RecoverVApps
          - RecoverVAppTemplates
          - RecoverRDS
          - RecoverAurora
          - RecoverApps
          - RecoverNasVolume
          - RecoverPhysicalVolumes
          - RecoverSystem
          - CloneAppView
          - RecoverSanVolumes
          - RecoverMailbox
          - RecoverOneDrive
          - RecoverSharePoint
          - RecoverPublicFolders
          - RecoverMsGroup
          - RecoverMsTeam
          - RecoverNamespaces
          - RecoverObjects
          - DownloadFilesAndFolders
          x-order: 7
        permissions:
          description: Specifies the list of tenants that have permissions for this recovery.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Tenant'
          x-order: 8
        creationInfo:
          description: Specifies the information about the creation of the recovery.
          type:
          - object
          - 'null'
          x-order: 9
          $ref: '#/components/schemas/CreationInfo'
        canTearDown:
          description: Specifies whether it's possible to tear down the objects created by the recovery.
          type:
          - boolean
          - 'null'
          x-order: 10
        tearDownStatus:
          description: Specifies the status of the tear down operation. This is only set when the canTearDown is set to true. 'DestroyScheduled' indicates that the tear down is ready to schedule. 'Destroying' indicates that the tear down is still running. 'Destroyed' indicates that the tear down succeeded. 'DestroyError' indicates that the tear down failed.
          type:
          - string
          - 'null'
          enum:
          - DestroyScheduled
          - Destroying
          - Destroyed
          - DestroyError
          x-order: 11
        tearDownMessage:
          description: Specifies the error message about the tear down operation if it fails.
          type:
          - string
          - 'null'
          x-order: 12
        messages:
          description: Specifies messages about the recovery.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 13
        isParentRecovery:
          description: Specifies whether the current recovery operation has created child recoveries. This is currently used in SQL recovery where multiple child recoveries can be tracked under a common/parent recovery.
          type:
          - boolean
          - 'null'
          x-order: 14
        parentRecoveryId:
          description: If current recovery is child recovery triggered by another parent recovery operation, then this field willt specify the id of the parent recovery.
          type:
          - string
          - 'null'
          pattern: ^\d+:\d+:\d+$
          x-order: 15
      x-cohesity-discriminator-details:
        propertyName: snapshotEnvironment
      x-discriminator:
        mapping:
          kVMware: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverVmwareParamsWrapper'
          kAWS: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverAwsParamsWrapper'
          kGCP: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverGcpParamsWrapper'
          kAzure: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverAzureParamsWrapper'
          kKVM: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverKvmParamsWrapper'
          kAcropolis: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverAcropolisParamsWrapper'
          kSQL: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverSqlParamsWrapper'
          kNetapp: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverNetappParamsWrapper'
          kGenericNas: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverGenericNasParamsWrapper'
          kIsilon: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverIsilonParamsWrapper'
          kFlashBlade: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverFlashbladeParamsWrapper'
          kElastifile: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverElastifileParamsWrapper'
          kGPFS: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverGpfsParamsWrapper'
          kPhysical: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverPhysicalParamsWrapper'
          kHyperV: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverHyperVParamsWrapper'
          kExchange: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverExchangeParamsWrapper'
          kCassandra: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093CassandraParamsWrapper'
          kUDA: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093UdaParamsWrapper'
          kCouchbase: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093CouchbaseParamsWrapper'
          kHbase: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093HbaseParamsWrapper'
          kHdfs: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093HdfsParamsWrapper'
          kHive: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093HiveParamsWrapper'
          kMongoDB: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093MongodbParamsWrapper'
          kPure: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverPureParamsWrapper'
          kO365: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverO365ParamsWrapper'
          kKubernetes: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverKubernetesParamsWrapper'
          kOracle: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverOracleParamsWrapper'
          kView: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverViewParamsWrapper'
        propertyName: snapshotEnvironment
    HyperVRecoverFilesNewTargetConfig:
      description: Specifies the configuration for recovering files and folders to a new target.
      type: object
      title: HyperV Recover Files New Target Config.
      required:
      - targetVm
      - targetVmCredentials
      - absolutePath
      properties:
        targetVm:
          description: Specifies the target VM to recover files and folders to.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 1
        absolutePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverOracleAppNewSourceConfig:
      description: Specifies the new destination Source configuration where the databases will be recovered.
      type: object
      title: Recover Oracle App New Source Config.
      required:
      - host
      properties:
        host:
          description: Specifies the source id of target host where databases will be recovered. This source id can be a physical host or virtual machine.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        recoveryTarget:
          description: Specifies if recovery target is a database or a view.
          type:
          - string
          - 'null'
          enum:
          - RecoverDatabase
          - RecoverView
          x-order: 1
        recoverDatabaseParams:
          description: Specifies recovery parameters when recovering to a database
          allOf:
          - $ref: '#/components/schemas/RecoverOracleNewTargetDatabaseConfig'
          - {}
          x-order: 2
        recoverViewParams:
          description: Specifies recovery parameters when recovering to a view.
          allOf:
          - $ref: '#/components/schemas/RecoverOracleNewTargetViewConfig'
          - {}
          x-order: 3
    RecoverPublicFoldersParams:
      description: Specifies the parameters to recover Office 365 Public Folders.
      type: object
      required:
      - rootPublicFolders
      properties:
        rootPublicFolders:
          description: Specifies a list of RootPublicFolder params associated with the objects to recover.
          type:
          - array
          - 'null'
          minItems: 1
          items:
            $ref: '#/components/schemas/RootPublicFolderParam'
          x-order: 0
        targetRootPublicFolder:
          description: Specifies the target RootPublicFolder to recover to. If not specified, the objects will be recovered to original location.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        targetFolderPath:
          description: Specifies the path to the target folder.
          type:
          - string
          - 'null'
          x-order: 2
        continueOnError:
          description: Specifies whether to continue recovering other Public Folders if one of Public Folder failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 3
    VmwareRecoverDisksTargetSourceConfig:
      description: Specifies the configuration for restoring disks to a different VM than the one from which the snapshot was taken.
      type: object
      required:
      - disks
      - sourceId
      properties:
        sourceId:
          description: Specifies the source ID of the VM to which the disks will be restored.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        disks:
          description: Specifies the disks to be recovered and the location to which they will be recovered.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/VmwareRecoverTargetSourceDiskParams'
          x-order: 1
    RecoverHiveNoSqlObjectParams:
      description: Specifies the fully qualified object name and other attributes of each object to be recovered.
      title: Recover Hive Object Params.
      required:
      - objectName
      properties:
        objectName:
          description: Specifies the fully qualified name of the object to be restored.
          type:
          - string
          - 'null'
          x-order: 0
    RecoverOtherNasToElastifileFilesTargetParams:
      description: Specifies the params of the Elastifile recovery target.
      type: object
      title: Recover To Elastifile Files Target Params.
      required:
      - volume
      - alternatePath
      properties:
        volume:
          description: Specifies the id and name of the parent NAS to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        alternatePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 6
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 7
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 8
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverMongodbParams:
      description: Specifies the parameters to recover MongoDB objects.
      title: Recover MongoDB params.
      allOf:
      - $ref: '#/components/schemas/CommonNoSqlRecoveryOptions'
      - type: object
        required:
        - snapshots
        properties:
          snapshots:
            description: Specifies the local snapshot ids of the Objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverMongodbSnapshotParams'
            x-order: 0
          suffix:
            description: A suffix that is to be applied to all recovered objects.
            type:
            - string
            - 'null'
            x-order: 1
    NoSqlObjectProperty:
      description: Specifies an Object property as a set of key-value pair for NoSQL objects.
      required:
      - key
      - value
      properties:
        key:
          description: Specifies the key of the property.
          type:
          - string
          - 'null'
          x-order: 0
        value:
          description: specifies the value of the property.
          type:
          - string
          - 'null'
          x-order: 1
    RecoverPureVolumeTargetParams:
      description: Specifies the target object parameters to recover the Pure San Volume.
      type: object
      title: Pure SAN Volume Recovery Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies whether to recover to a new source.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the Pure volume will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverPureSanVolumeNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if Pure volume is being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverPureSanVolumeOriginalSourceConfig'
          - {}
          x-order: 2
    RecoverGenericNasNasVolumeParams:
      description: Specifies the parameters to recover Generic NAS volumes.
      type: object
      title: Recover Generic NAS Volume Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          - kView
          x-order: 0
        genericNasTargetParams:
          description: Specifies the params for a Generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverGenericNasToGenericNasVolumeTargetParams'
          - {}
          x-order: 1
        elastifileTargetParams:
          description: Specifies the params for a Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileVolumeTargetParams'
          - {}
          x-order: 2
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeVolumeTargetParams'
          - {}
          x-order: 3
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsVolumeTargetParams'
          - {}
          x-order: 4
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonVolumeTargetParams'
          - {}
          x-order: 5
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappVolumeTargetParams'
          - {}
          x-order: 6
        viewTargetParams:
          description: Specifies the params for a Cohesity view recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNasVolumeToViewParams'
          - {}
          x-order: 7
    OriginalNetappTargetParams:
      description: Specifies the params of the original Netapp recovery target.
      type: object
      title: Recover To Original Netapp Volume Target Params.
      properties:
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 0
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 5
          $ref: '#/components/schemas/RecoveryVlanConfig'
    AwsTargetParamsForRecoverFileAndFolder:
      description: Specifies the parameters for an AWS recovery target.
      type: object
      title: AWS Target Params for Recover File And Folder
      required:
      - recoverToOriginalTarget
      properties:
        recoverToOriginalTarget:
          description: Specifies whether to recover to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for recovering to the original target.
          allOf:
          - $ref: '#/components/schemas/AwsRecoverFilesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for recovering to a new target.
          allOf:
          - $ref: '#/components/schemas/AwsRecoverFilesNewTargetConfig'
          - {}
          x-order: 2
        overwriteExisting:
          description: Specifies whether to override the existing files. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveAttributes:
          description: Specifies whether to preserve original attributes. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of files or folders failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered files and folders. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    RecoverPhysicalVolumeParams:
      description: Specifies the parameters to recover Physical Volumes.
      type: object
      title: Recover Physical Volumes params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kPhysical
          x-order: 0
        physicalTargetParams:
          description: Specifies the params for recovering to a physical target.
          allOf:
          - $ref: '#/components/schemas/PhysicalTargetParamsForRecoverVolume'
          - {}
          x-order: 1
    HyperVTargetParamsForRecoverFileAndFolder:
      description: Specifies the parameters for a HyperV recovery target.
      type: object
      title: HyperV Target Params for Recover File And Folder
      required:
      - recoverToOriginalTarget
      properties:
        recoverToOriginalTarget:
          description: Specifies whether to recover to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for recovering to the original target.
          allOf:
          - $ref: '#/components/schemas/HyperVRecoverFilesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for recovering to a new target.
          allOf:
          - $ref: '#/components/schemas/HyperVRecoverFilesNewTargetConfig'
          - {}
          x-order: 2
        overwriteExisting:
          description: Specifies whether to override the existing files. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveAttributes:
          description: Specifies whether to preserve original attributes. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of files or folders failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered files and folders. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    RecoverHyperVParams:
      description: Specifies the recovery options specific to HyperV environment.
      type: object
      title: Recover HyperV environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters. This property is mandatory for all recovery action types except recover vms. While recovering VMs, a user can specify snapshots of VM's or a Protection Group Run details to recover all the VM's that are backed up by that Run. For recovering files, specifies the object contains the file to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recovery action to be performed.
          type: string
          enum:
          - RecoverVMs
          - InstantVolumeMount
          - RecoverFiles
          x-order: 1
        recoverVmParams:
          description: Specifies the parameters to recover HyperV VM.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVVmParams'
          - {}
          x-order: 2
        mountVolumeParams:
          description: Specifies the parameters to mount HyperV Volumes.
          allOf:
          - $ref: '#/components/schemas/MountHyperVVolumeParams'
          - {}
          x-order: 3
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files and folders.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVFileAndFolderParams'
          - {}
          x-order: 4
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 5
    OracleSbtHostParams:
      description: Specifies details about capturing Oracle SBT host info.
      type: object
      title: Oracle Protection Group SBT Host
      properties:
        sbtLibraryPath:
          description: Specifies the path of sbt library.
          type:
          - string
          - 'null'
          x-order: 0
        viewFsPath:
          description: Specifies the Cohesity view path.
          type:
          - string
          - 'null'
          x-order: 1
        vipList:
          description: Specifies the list of Cohesity primary VIPs.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 2
        vlanInfoList:
          description: Specifies the Vlan information for Cohesity cluster.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OracleVlanInfo'
          x-order: 3
    RecoverProtectionGroupRunParams:
      description: Specifies the Protection Group Run params to recover. All the VM's that are successfully backed up by specified Runs will be recovered.
      type: object
      title: Recover Protection Group Run Params.
      required:
      - protectionGroupRunId
      - protectionGroupInstanceId
      properties:
        protectionGroupRunId:
          description: Specifies the Protection Group Run id from which to recover VMs. All the VM's that are successfully protected by this Run will be recovered.
          type:
          - string
          - 'null'
          pattern: ^\d+:\d+$
          x-order: 0
        protectionGroupInstanceId:
          description: Specifies the Protection Group Instance id.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 1
        archivalTargetId:
          description: Specifies the archival target id. If specified and Protection Group run has an archival snapshot then VMs are recovered from the specified archival snapshot. If not specified (default), VMs are recovered from local snapshot.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 2
        protectionGroupId:
          description: Specifies the local Protection Group id. In case of recovering a replication Run, this field should be provided with local Protection Group id.
          type:
          - string
          - 'null'
          x-order: 3
    RecoverIsilonFilesParams:
      description: Specifies the parameters to recover Isilon files.
      type: object
      title: Recover Isilon files Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          x-order: 1
        isilonTargetParams:
          description: Specifies the params for a Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverIsilonToIsilonFilesTargetParams'
          - {}
          x-order: 2
        elastifileTargetParams:
          description: Specifies the params for an Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileFilesTargetParams'
          - {}
          x-order: 3
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeFilesTargetParams'
          - {}
          x-order: 4
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasFilesTargetParams'
          - {}
          x-order: 5
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsFilesTargetParams'
          - {}
          x-order: 6
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappFilesTargetParams'
          - {}
          x-order: 7
    CommonSqlAppSourceConfig:
      description: Specifies a common parameters used when restroring back to original or new source.
      type: object
      title: Common Sql App Source Config.
      properties:
        restoreTimeUsecs:
          description: Specifies the time in the past to which the Sql database needs to be restored. This allows for granular recovery of Sql databases. If this is not set, the Sql database will be restored from the full/incremental snapshot.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        secondaryDataFilesDirList:
          description: Specifies the secondary data filename pattern and corresponding direcories of the DB. Secondary data files are optional and are user defined. The recommended file extention for secondary files is ".ndf". If this option is specified and the destination folders do not exist they will be automatically created.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FilenamePatternToDirectory'
          x-order: 1
        withNoRecovery:
          description: Specifies the flag to bring DBs online or not after successful recovery. If this is passed as true, then it means DBs won't be brought online.
          type:
          - boolean
          - 'null'
          x-order: 2
        keepCdc:
          description: Specifies whether to keep CDC (Change Data Capture) on recovered databases or not. If not passed, this is assumed to be true. If withNoRecovery is passed as true, then this field must not be set to true. Passing this field as true in this scenario will be a invalid request.
          type:
          - boolean
          - 'null'
          x-order: 3
        overwritingPolicy:
          description: Specifies a policy to be used while recovering existing databases.
          type:
          - string
          - 'null'
          enum:
          - FailIfExists
          - Overwrite
          x-order: 4
        multiStageRestoreOptions:
          description: Specifies the parameters related to multi stage Sql restore.
          type:
          - object
          - 'null'
          x-order: 5
          $ref: '#/components/schemas/MultiStageRestoreOptions'
        nativeRecoveryWithClause:
          description: '''with_clause'' contains ''with clause'' to be used in native sql restore command. This is only applicable for database restore of native sql backup. Here user can specify multiple restore options. Example: ''WITH BUFFERCOUNT = 575, MAXTRANSFERSIZE = 2097152''.'
          type:
          - string
          - 'null'
          x-order: 6
    UdaParams:
      description: Specifies the recovery options specific to Universal Data Adapter environment.
      type: object
      title: Recover Universal Data Adapter environment params.
      required:
      - recoveryAction
      - recoverUdaParams
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverObjects
          x-order: 0
        recoverUdaParams:
          description: Specifies the parameters to recover Universal Data Adapter objects.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/RecoverUdaParams'
          - {}
          x-order: 1
          $ref: '#/components/schemas/RecoverUdaParams'
    OriginalIsilonTargetParams:
      description: Specifies the params of the original Isilon recovery target.
      type: object
      title: Recover To Original Isilon Volume Target Params.
      properties:
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 0
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 5
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverExchangeParams:
      description: Specifies the recovery options specific to Exchange environment.
      type: object
      title: Recover Exchange environment params.
      required:
      - recoveryAction
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverApps
          x-order: 0
        recoverAppParams:
          description: Specifies the parameters to recover Exchange databases.
          allOf:
          - $ref: '#/components/schemas/RecoverExchangeAppParams'
          - {}
          x-order: 1
    RecoverKubernetesParams:
      description: Specifies the recovery options specific to Kubernetes environment.
      type: object
      title: Recover Kubernetes environment params.
      required:
      - recoveryAction
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverNamespaces
          x-order: 0
        recoverNamespaceParams:
          description: Specifies the parameters to recover Kubernetes Namespaces.
          allOf:
          - $ref: '#/components/schemas/RecoverKubernetesNamespaceParams'
          - {}
          x-order: 1
    HyperVMountVolumesNewTargetConfig:
      description: Specifies the configuration for mounting volumes to a new target.
      type: object
      title: HyperV Mount Volumes New Target Config.
      required:
      - mountTarget
      - bringDisksOnline
      properties:
        mountTarget:
          description: Specifies the target entity where the volumes are being mounted.
          type:
          - object
          - 'null'
          x-order: 0
          $ref: '#/components/schemas/RecoverTarget'
        bringDisksOnline:
          description: Specifies whether the volumes need to be online within the target environment after attaching the disks. For linux VMs, this should always be set to false because bring disks online is only supported for Windows VM. If this is set to true, HyperV Integration Services must be installed on the VM.
          type:
          - boolean
          - 'null'
          x-order: 1
        targetVmCredentials:
          description: Specifies credentials to access the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 2
    RecoverHbaseNoSqlObjectParams:
      description: Specifies the fully qualified object name and other attributes of each object to be recovered.
      title: Recover Hbase Object Params.
      required:
      - objectName
      properties:
        objectName:
          description: Specifies the fully qualified name of the object to be restored.
          type:
          - string
          - 'null'
          x-order: 0
        renameTo:
          description: Specifies the new name to which the object should be renamed. at the time of recovery.
          type:
          - string
          - 'null'
          x-order: 1
    GoogleTiers:
      description: Specifies Google tiers.
      type: object
      required:
      - tiers
      properties:
        tiers:
          description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
          type:
          - array
          - 'null'
          minLength: 1
          items:
            $ref: '#/components/schemas/GoogleTier'
          x-order: 0
    TargetMsTeamParam:
      description: Specifies the target Microsoft 365 Team to recover to.
      allOf:
      - $ref: '#/components/schemas/RecoveryObjectIdentifier'
      - type: object
    RecoverHyperVVmNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for HyperV VMs if recovering to new Source.
      type: object
      title: Recover HyperV VMs New Source Network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. All the other networking parameters set will be ignored if set to true. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
        virtualSwitch:
          description: Specifies the virtual switch that will attached to all the network interfaces of the VMs being recovered. This parameter is mandatory if detach network is specified as false.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
    GoogleTier:
      description: Specifies the settings for a Google tier.
      type: object
      allOf:
      - $ref: '#/components/schemas/CommonCloudTierSettings'
      - type: object
        required:
        - tierType
        properties:
          tierType:
            description: Specifies the Google tier types.
            type:
            - string
            - 'null'
            enum:
            - kGoogleStandard
            - kGoogleRegional
            - kGoogleMultiRegional
            - kGoogleNearline
            - kGoogleColdline
            x-order: 0
    AwsTargetParamsForRecoverRds:
      description: Specifies the parameters for an AWS recovery target.
      type: object
      title: AWS RDS Recovery Target Params
      properties:
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/AwsRdsRecoveryTargetConfig'
          - {}
          x-order: 0
        rdsConfig:
          description: Specifies the RDS params.
          allOf:
          - $ref: '#/components/schemas/RdsConfig'
          - {}
          x-order: 1
    RecoverIsilonToIsilonVolumeTargetParams:
      description: Specifies the params of the Isilon recovery target.
      type: object
      title: Recover Isilon To Isilon Volume Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Isilon target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the volumes will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonVolumeTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if volumes are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalIsilonTargetParams'
          - {}
          x-order: 2
    OriginalElastifileFilesTargetParams:
      description: Specifies the params of the original Elastifile recovery target.
      type: object
      title: Recover To Original Elastifile Files Target Params.
      required:
      - recoverToOriginalPath
      properties:
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverHyperVVmStandaloneClusterSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover HyperV VMs New Standalone Cluster Source Config.
      required:
      - source
      - host
      - volume
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        host:
          description: Specifies the HyperV host where the recovered VMs will be attached. For standalone host targets, the host must be the same as the source.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        volume:
          description: Specifies the datastore object where the VMs' files should be recovered to.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVVmNewSourceNetworkConfig'
          - {}
          x-order: 3
    AzureTargetParamsForRecoverVm:
      description: Specifies the parameters for an Azure recovery target.
      type: object
      title: Azure Recovery Target Params
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/AzureVmRecoveryTargetConfig'
          - {}
          x-order: 1
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 2
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 3
    OracleVlanInfo:
      description: Specifies details about capturing Cohesity cluster VLAN info for Oracle workflow.
      type: object
      title: Oracle Protection Group vlan info
      properties:
        ipList:
          description: Specifies the list of Ips in this VLAN.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 0
        gateway:
          description: Specifies the gateway of this VLAN.
          type:
          - string
          - 'null'
          x-order: 1
        id:
          description: Specifies the Id of this VLAN.
          type: integer
          format: int32
          x-go-nullable: true
          x-order: 2
        subnetIp:
          description: Specifies the subnet Ip for this VLAN.
          type:
          - string
          - 'null'
          x-order: 3
    AwsAuroraRecoveryTargetConfig:
      description: Specifies the target object parameters to recover AWS Aurora.
      type: object
      title: AWS Aurora Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the Aurora instances will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsAuroraNewSourceConfig'
          - {}
          x-order: 1
    OneDriveParam:
      description: Specifies parameters to recover a OneDrive.
      type: object
      properties:
        id:
          description: Specifies the OneDrive id.
          type:
          - string
          - 'null'
          x-order: 0
        recoverEntireDrive:
          description: Specifies whether to recover the whole OneDrive. This is set to false when excluding recovering specific drive items.
          type:
          - boolean
          - 'null'
          x-order: 1
        recoverItems:
          description: Specifies a list of OneDrive items to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OneDriveItem'
          x-order: 2
    RecoverVmwareVmEsxiSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered for ESXi sources.
      type: object
      title: Recover VMware VMs ESXi Source Config.
      required:
      - source
      - resourcePool
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        resourcePool:
          description: Specifies the resource pool object where the recovered objects will be attached.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        datastores:
          description: Specifies the datastore objects where the object's files should be recovered to.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 2
        vmFolder:
          description: Folder where the VMs should be created.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 3
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmNewSourceNetworkConfig'
          - {}
          x-order: 4
    RecoverGenericNasToGenericNasFilesTargetParams:
      description: Specifies the params of the Generic Nas recovery target.
      type: object
      title: Recover Generic Nas To Generic Nas Files Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Generic Nas target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the files will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasFilesTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if files are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalGenericNasFilesTargetParams'
          - {}
          x-order: 2
    RecoverAzureVmNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for Azure VMs if recovering to new Source.
      type: object
      title: Recover Azure VMs New Source Network configuration.
      required:
      - virtualNetwork
      - subnet
      properties:
        virtualNetwork:
          description: Specifies the Virtual Network.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        subnet:
          description: Specifies the subnet within the above virtual network.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        networkResourceGroup:
          description: Specifies id of the resource group for the selected virtual network.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
    PhysicalTargetParamsForRecoverFileAndFolder:
      description: Specifies the parameters for a Physical recovery target.
      type: object
      title: Physical Target Params for Recover File And Folder
      required:
      - recoverTarget
      properties:
        recoverTarget:
          description: Specifies the target entity where the volumes are being mounted.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        restoreToOriginalPaths:
          description: If this is true, then files will be restored to original paths.
          type:
          - boolean
          - 'null'
          x-order: 1
        overwriteExisting:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        alternateRestoreDirectory:
          description: Specifies the directory path where restore should happen if restore_to_original_paths is set to false.
          type:
          - string
          - 'null'
          x-order: 3
        preserveAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        preserveTimestamps:
          description: Whether to preserve the original time stamps.
          type:
          - boolean
          - 'null'
          x-order: 5
        preserveAcls:
          description: Whether to preserve the ACLs of the original file.
          type:
          - boolean
          - 'null'
          x-order: 6
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 7
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 8
    Credentials:
      description: Specifies the object to hold username and password.
      type: object
      title: Credentials
      required:
      - username
      - password
      properties:
        username:
          description: Specifies the username to access target entity.
          type: string
          x-order: 0
        password:
          description: Specifies the password to access target entity.
          type: string
          x-order: 1
    VMwareMountVolumesOriginalTargetConfig:
      description: Specifies the configuration for mounting volumes to the original target.
      type: object
      title: VMware Mount Volumes Original Target Config.
      required:
      - bringDisksOnline
      properties:
        bringDisksOnline:
          description: Specifies whether the volumes need to be online within the target environment after attaching the disks. For linux VMs, this should always be set to true. For Windows, this is optional. If this is set to true, VMware tools must be installed on the VM. If this is set to false, useExistingAgent and targetCredentials are not needed.
          type:
          - boolean
          - 'null'
          x-order: 0
        useExistingAgent:
          description: Specifies whether this will use an existing agent on the target vm or will deploy a new agent. This is required if bringDisksOnline is set to true.
          type:
          - boolean
          - 'null'
          x-order: 1
        targetVmCredentials:
          description: Specifies credentials to access the target VM. This is required if bringDisksOnline is set to true and useExistingAgent set to false.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 2
    ObjectOneDriveParam:
      description: Specifies OneDrive recovery parameters associated with a user.
      type: object
      properties:
        ownerInfo:
          description: Specifies the OneDrive owner info.
          allOf:
          - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          - {}
          x-order: 0
        oneDriveParams:
          description: Specifies parameters to recover a OneDrive.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OneDriveParam'
          x-order: 1
    GcpVmRecoveryTargetConfig:
      description: Specifies the target object parameters to recover GCP vms.
      type: object
      title: GCP VMs Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverGcpVmNewSourceConfig'
          - {}
          x-order: 1
    HyperVTargetParamsForMountVolume:
      description: Specifies the parameters for a HyperV recovery target.
      type: object
      title: HyperV Target Params.
      required:
      - mountToOriginalTarget
      properties:
        mountToOriginalTarget:
          description: Specifies whether to mount to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for mounting to the original target.
          allOf:
          - $ref: '#/components/schemas/HyperVMountVolumesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for mounting to a new target.
          allOf:
          - $ref: '#/components/schemas/HyperVMountVolumesNewTargetConfig'
          - {}
          x-order: 2
        readOnlyMount:
          description: Specifies whether to perform a read-only mount. Default is false.
          type:
          - boolean
          - 'null'
          x-order: 3
        volumeNames:
          description: Specifies the names of volumes that need to be mounted. If this is not specified then all volumes that are part of the source VM will be mounted on the target VM.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 4
        mountedVolumeMapping:
          description: Specifies the mapping of original volumes and mounted volumes
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MountedVolumeMapping'
          x-order: 5
          readOnly: true
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    RecoverVmwareVAppNewSourceConfig:
      description: Specifies the new destination Source configuration where the vApps will be recovered.
      type: object
      title: Recover VMware vApps New Source Config.
      required:
      - sourceType
      properties:
        sourceType:
          description: Specifies the type of VMware source to which the VMs are being restored.
          type:
          - string
          - 'null'
          enum:
          - kvCloudDirector
          x-order: 0
        vCloudDirectorParams:
          x-order: 1
          $ref: '#/components/schemas/RecoverVmwareVAppVCDSourceConfig'
    RecoverVmwareVmVCenterSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered for vCenter sources.
      type: object
      title: Recover VMware VMs vCenter Source Config.
      required:
      - source
      - resourcePool
      - datastores
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        resourcePool:
          description: Specifies the resource pool object where the recovered objects will be attached.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        datastores:
          description: Specifies the datastore objects where the object's files should be recovered to.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 2
        vmFolder:
          description: Folder where the VMs should be created.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 3
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmNewSourceNetworkConfig'
          - {}
          x-order: 4
    RecoverElastifileToElastifileFilesTargetParams:
      description: Specifies the params of the Elastifile recovery target.
      type: object
      title: Recover Elastifile To Elastifile Files Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Elastifile target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the files will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileFilesTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if files are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalElastifileFilesTargetParams'
          - {}
          x-order: 2
    RecoverAwsFileAndFolderParams:
      description: Specifies the parameters to recover files and folders.
      type: object
      title: Recover AWS File And Folder Params
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAWS
          x-order: 1
        awsTargetParams:
          description: Specifies the parameters to recover to an AWS target.
          allOf:
          - $ref: '#/components/schemas/AwsTargetParamsForRecoverFileAndFolder'
          - {}
          x-order: 2
    RecoverHyperVVmOriginalSourceConfig:
      description: Specifies the Source configuration if VM's are being recovered to Original Source.
      type: object
      title: Recover HyperV VMs Original Source Config.
      properties:
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVVmOriginalSourceNetworkConfig'
          - {}
          x-order: 0
    OracleTiers:
      description: Specifies Oracle tiers.
      type: object
      required:
      - tiers
      properties:
        tiers:
          description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
          type:
          - array
          - 'null'
          minLength: 1
          items:
            $ref: '#/components/schemas/OracleTier'
          x-order: 0
    AwsRecoverFilesNewTargetConfig:
      description: Specifies the configuration for recovering files and folders to a new target.
      type: object
      title: AWS Recover Files New Target Config.
      required:
      - targetVm
      - targetVmCredentials
      - absolutePath
      properties:
        targetVm:
          description: Specifies the target VM to recover files and folders to.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 1
        absolutePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverMailboxParams:
      description: Specifies the parameters to recover an Office 365 Mailbox.
      type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies a list of Mailbox params associated with the objects to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ObjectMailboxParam'
          x-order: 0
        targetMailbox:
          description: Specifies the target Mailbox to recover to. If not specified, the objects will be recovered to original location.
          allOf:
          - $ref: '#/components/schemas/TargetMailboxParam'
          - {}
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other Mailboxes if one of Mailbox failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
    RecoverVmwareVAppTemplateParams:
      description: Specifies the parameters to recover VMware vApp template.
      type: object
      title: Recover VMware vApp template params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kVMware
          x-order: 0
        vmwareTargetParams:
          description: Specifies the params for recovering to a VMware target.
          allOf:
          - $ref: '#/components/schemas/VmwareTargetParamsForRecoverVAppTemplate'
          - {}
          x-order: 1
    MsGroupParam:
      description: Specifies parameters to recover MS group.
      type: object
      required:
      - recoverObject
      properties:
        recoverObject:
          description: Specifies the MS group recover Object info.
          allOf:
          - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          - {}
          x-order: 0
        recoverEntireGroup:
          description: Specifies if the entire Group (mailbox + site) is to be restored.
          type:
          - boolean
          - 'null'
          x-order: 1
        mailboxRestoreType:
          description: Specifies whether mailbox restore is full or granular.
          type:
          - string
          - 'null'
          enum:
          - kFull
          - kPartial
          x-order: 2
        siteRestoreType:
          description: Specifies whether site restore is full or granular.
          type:
          - string
          - 'null'
          enum:
          - kFull
          - kPartial
          x-order: 3
    TierLevelSettings:
      description: 'Specifies the settings tier levels configured with each archival target. The tier settings need to be applied in specific order and default tier should always be passed as first entry in tiers array. The following example illustrates how to configure tiering input for AWS tiering. Same type of input structure applied to other cloud platforms also. <br>If user wants to achieve following tiering for backup, <br>User Desired Tiering- <br><t>1.Archive Full back up for 12 Months <br><t>2.Tier Levels <br><t><t>[1,12] [ <br><t><t><t>s3 (1 to 2 months), (default tier) <br><t><t><t>s3 Intelligent tiering (3 to 6 months), <br><t><t><t>s3 One Zone (7 to 9 months) <br><t><t><t>Glacier (10 to 12 months)] <br><t>API Input <br><t><t>1.tiers-[ <br><t><t><t>{''tierType'': ''S3'',''moveAfterUnit'':''months'', <br><t><t><t>''moveAfter'':2 - move from s3 to s3Inte after 2 months}, <br><t><t><t>{''tierType'': ''S3Inte'',''moveAfterUnit'':''months'', <br><t><t><t>''moveAfter'':4 - move from S3Inte to Glacier after 4 months}, <br><t><t><t>{''tierType'': ''Glacier'', ''moveAfterUnit'':''months'', <br><t><t><t>''moveAfter'': 3 - move from Glacier to S3 One Zone after 3 months }, <br><t><t><t>{''tierType'': ''S3 One Zone'', ''moveAfterUnit'': nil, <br><t><t><t>''moveAfter'': nil - For the last record, ''moveAfter'' and ''moveAfterUnit'' <br><t><t><t>will be ignored since there are no further tier for data movement } <br><t><t><t>}]'
      type: object
      required:
      - cloudPlatform
      properties:
        cloudPlatform:
          description: Specifies the cloud platform to enable tiering.
          type:
          - string
          - 'null'
          enum:
          - AWS
          - Azure
          - Oracle
          - Google
          x-order: 0
        awsTiering:
          description: Specifies the settings for AWS Tiers.
          type:
          - object
          - 'null'
          x-order: 1
          $ref: '#/components/schemas/AWSTiers'
        azureTiering:
          description: Specifies the settings for Azure Tiers.
          type:
          - object
          - 'null'
          x-order: 2
          $ref: '#/components/schemas/AzureTiers'
        googleTiering:
          description: Specifies the settings for Google Tiers.
          type:
          - object
          - 'null'
          x-order: 3
          $ref: '#/components/schemas/GoogleTiers'
        oracleTiering:
          description: Specifies the settings for Oracle Tiers.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/OracleTiers'
    RecoverCassandraSnapshotParams:
      description: Specifies the snapshot parameters for a protected Cassandra object.
      title: Recover Cassandra Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          objects:
            description: Specifies details of objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverCassandraNoSqlObjectParams'
            x-order: 0
    VmwareTargetParamsForRecoverVApp:
      description: Specifies the parameters for a VMware recovery target.
      type: object
      title: VMware Target Params.
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        renameRecoveredVAppsParams:
          description: Specifies params to rename the vApps that are recovered. If not specified, the original names of the vApps are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 1
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/VmwareVAppRecoveryTargetConfig'
          - {}
          x-order: 2
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 3
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        recoveryProcessType:
          description: Specifies type of Recovery Process to be used. InstantRecovery/CopyRecovery etc... Default value is InstantRecovery.
          type: string
          enum:
          - InstantRecovery
          - CopyRecovery
          x-order: 6
        attemptDifferentialRestore:
          description: Specifies whether to attempt differential restore.
          type:
          - boolean
          - 'null'
          x-order: 7
    OraclePdbObjectInfo:
      description: Specifies information PDB object to restore.
      type: object
      required:
      - dbName
      - dbId
      properties:
        dbId:
          description: Specifies pluggable database id.
          type:
          - string
          - 'null'
          x-order: 0
        dbName:
          description: Specifies name of the DB.
          type:
          - string
          - 'null'
          x-order: 1
    RecoverAzureFileAndFolderParams:
      description: Specifies the parameters to recover Azure files and folders.
      type: object
      title: Recover Azure Files and Folders Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAzure
          x-order: 1
        azureTargetParams:
          description: Specifies the params for recovering to an Azure target.
          allOf:
          - $ref: '#/components/schemas/AzureTargetParamsForRecoverFileAndFolder'
          - {}
          x-order: 2
    RecoverGpfsParams:
      description: Specifies the recovery options specific to GPFS environment.
      type: object
      title: Recover GPFS Params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverNasVolume
          - RecoverFiles
          x-order: 1
        recoverNasVolumeParams:
          description: Specifies the parameters to recover Nas Volumes.
          allOf:
          - $ref: '#/components/schemas/RecoverGpfsNasVolumeParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files.
          allOf:
          - $ref: '#/components/schemas/RecoverGpfsFilesParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    AcropolisTargetParamsForRecoverVm:
      description: Specifies the parameters for an Acropolis recovery target.
      type: object
      title: Acropolis Target Params.
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/RecoverAcropolisVmTargetConfig'
          - {}
          x-order: 1
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 2
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
    MsTeamParam:
      description: Specifies the parameters to recover a Microsoft 365 Team.
      type: object
      required:
      - recoverEntireMsTeam
      properties:
        recoverEntireMsTeam:
          description: Specifies whether to recover the whole Microsoft 365 Team.
          type:
          - boolean
          - 'null'
          x-order: 0
    MultiStageRestoreOptions:
      description: Specifies the parameters related to multi stage Sql restore.
      type: object
      title: Multi Stage Restore Options
      properties:
        enableMultiStageRestore:
          description: Set this to true if you are creating a multi-stage Sql restore task needed for features such as Hot-Standby.
          type:
          - boolean
          - 'null'
          x-order: 0
        enableAutoSync:
          description: Set this to true if you want to enable auto sync for multi stage restore.
          type:
          - boolean
          - 'null'
          x-order: 1
    RecoverVmwareVmOriginalSourceConfig:
      description: Specifies the Source configuration if VM's are being recovered to Original Source.
      type: object
      title: Recover VMware VMs Original Source Config.
      properties:
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmOriginalSourceNetworkConfig'
          - {}
          x-order: 0
    KvmVmRecoveryTargetConfig:
      description: Specifies the target object parameters to recover KVM vms.
      type: object
      title: KVM VMs Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverKvmVmNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if VM's are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverKvmVmOriginalSourceConfig'
          - {}
          x-order: 2
    RecoverGpfsToGpfsFilesTargetParams:
      description: Specifies the params of the GPFS recovery target.
      type: object
      title: Recover GPFS To GPFS Files Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original GPFS target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the files will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsFilesTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if files are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalGpfsFilesTargetParams'
          - {}
          x-order: 2
    RecoverNetappToNetappVolumeTargetParams:
      description: Specifies the params of the Netapp recovery target.
      type: object
      title: Recover Netapp To Netapp Volume Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Netapp target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the volumes will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappVolumeTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if volumes are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalNetappTargetParams'
          - {}
          x-order: 2
    CommonDownloadFileAndFolderParams:
      description: Specifies the parameters to download files and folders.
      type: object
      title: Download File And Folder Params
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        downloadFilePath:
          description: Specifies the path location to download the files and folders.
          type:
          - string
          - 'null'
          x-order: 1
    RecoverPhysicalParams:
      description: Specifies the recovery options specific to Physical environment.
      type: object
      title: Recover Physical environment params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of Recover Object parameters. For recovering files, specifies the object contains the file to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverPhysicalVolumes
          - InstantVolumeMount
          - RecoverFiles
          - RecoverSystem
          x-order: 1
        recoverVolumeParams:
          description: Specifies the parameters to recover Physical Volumes.
          allOf:
          - $ref: '#/components/schemas/RecoverPhysicalVolumeParams'
          - {}
          x-order: 2
        mountVolumeParams:
          description: Specifies the parameters to mount Physical Volumes.
          allOf:
          - $ref: '#/components/schemas/MountPhysicalVolumeParams'
          - {}
          x-order: 3
        recoverFileAndFolderParams:
          description: Specifies the parameters to perform a file and folder recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverPhysicalFileAndFolderParams'
          - {}
          x-order: 4
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 5
    AwsVmRecoveryTargetConfig:
      description: Specifies the target object parameters to recover AWS vms.
      type: object
      title: AWS VMs Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsVmNewSourceConfig'
          - {}
          x-order: 1
    ArchivalTargetSummaryInfo:
      description: Specifies archival target summary information.
      type: object
      title: Archival target.
      properties:
        targetId:
          description: Specifies the archival target ID.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        archivalTaskId:
          description: Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.
          type:
          - string
          - 'null'
          x-order: 1
        targetName:
          description: Specifies the archival target name.
          type:
          - string
          - 'null'
          x-order: 2
        targetType:
          description: Specifies the archival target type.
          type:
          - string
          - 'null'
          enum:
          - Tape
          - Cloud
          - Nas
          x-order: 3
        tierSettings:
          description: Specifies the tier level settings configured with archival target. This will be specified if the run is a CAD run.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/ArchivalTargetTierInfo'
    RecoverNasVolumeToViewParams:
      description: Specifies the recovery target configuration if NAS volumes are being recovered as a Cohesity view.
      type: object
      title: Recover NAS Volume as View Params.
      properties:
        viewName:
          description: Specifies the name of the view.
          type:
          - string
          - 'null'
          x-order: 0
        qosPolicy:
          description: Specifies the QoS policy, which defines the principal and priority of the NAS recovery.
          x-order: 1
          $ref: '#/components/schemas/NasQosPolicy'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 2
          $ref: '#/components/schemas/RecoveryVlanConfig'
    ObjectMsTeamParam:
      description: Specifies recovery parameters associated with a Microsoft 365 Team.
      type: object
      required:
      - recoverObject
      - msTeamParam
      properties:
        recoverObject:
          description: Specifies the Microsoft 365 Team recover object info.
          allOf:
          - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          - {}
          x-order: 0
        msTeamParam:
          description: Specifies parameters to recover a Microsoft 365 Team.
          allOf:
          - $ref: '#/components/schemas/MsTeamParam'
          - {}
          x-order: 1
    RecoverAcropolisParams:
      description: Specifies Acropolis related recovery options.
      type: object
      title: Recover VM params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters. This property is mandatory for all recovery action types except recover vms. While recovering VMs, a user can specify snapshots of VM's or a Protection Group Run details to recover all the VM's that are backed up by that Run. For recovering files, specifies the object contains the file to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recovery action to be performed.
          type: string
          enum:
          - RecoverVMs
          - RecoverFiles
          x-order: 1
        recoverVmParams:
          description: Specifies the parameters to recover Acropolis VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverAcropolisVmParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover Acropolis files and folders.
          allOf:
          - $ref: '#/components/schemas/RecoverAcropolisFileAndFolderParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    RecoverVmwareDiskParams:
      description: Specifies the parameters to recover VMware VM.
      type: object
      title: Recover VMware VM params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kVMware
          x-order: 0
        vmwareTargetParams:
          description: Specifies the params for recovering to a VMware target.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/VmwareTargetParamsForRecoverDisk'
          - {}
          x-order: 1
    RecoverCouchbaseParams:
      description: Specifies the parameters to recover Couchbase objects.
      title: Recover Couchbase params.
      allOf:
      - $ref: '#/components/schemas/CommonNoSqlRecoveryOptions'
      - type: object
        required:
        - snapshots
        - filterDocumentsParams
        properties:
          snapshots:
            description: Specifies the local snapshot ids of the Objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverCouchbaseSnapshotParams'
            x-order: 0
          suffix:
            description: A suffix that is to be applied to all recovered objects.
            type:
            - string
            - 'null'
            x-order: 1
          filterDocumentsParams:
            description: Specifies the parameters to filter documents to be restored.
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/FilterDocumentsParams'
            - {}
            x-order: 2
            $ref: '#/components/schemas/FilterDocumentsParams'
          appendDocuments:
            description: If set to true, docuements from the bucket being recovered will be appended into the bucket at the destination.
            type:
            - boolean
            - 'null'
            x-order: 3
          ddlOnlyRecovery:
            description: Set to true to recover only the bucket configurations. No documents will be recovered.
            type:
            - boolean
            - 'null'
            x-order: 4
          overwriteUsers:
            description: If set to true existing users will be replaced with users from the bucket being recovered.
            type:
            - boolean
            - 'null'
            x-order: 5
    VmwareRecoverTargetSourceDiskParams:
      description: Specifies disk specific parameters for performing a disk recovery.
      type: object
      required:
      - diskUuid
      - datastoreId
      properties:
        diskUuid:
          description: Specifies the UUID of the source disk being recovered.
          type:
          - string
          - 'null'
          x-order: 0
        datastoreId:
          description: Specifies the ID of the datastore on which the specified disk will be spun up.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 1
    AuroraConfig:
      description: Specifies the parameters to recover AWS Aurora.
      type: object
      title: Recover AWS Aurora params.
      required:
      - dbPort
      - dbInstanceId
      - isMultiAzDeployment
      - enableIamDbAuthentication
      - enableCopyTagsToSnapshots
      - enableAutoMinorVersionUpgrade
      properties:
        dbPort:
          description: Specifies the port to use for the DB in the restored Aurora instance.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 0
        dbInstanceId:
          description: Specifies the DB instance identifier to use for the restored DB.
          type:
          - string
          - 'null'
          x-order: 1
        isMultiAzDeployment:
          description: Specifies whether this is a multi-az deployment or not.
          type:
          - boolean
          - 'null'
          x-order: 2
        enablePublicAccessibility:
          description: Specifies whether this DB will be publicly accessible or not.
          type:
          - boolean
          - 'null'
          x-order: 3
        enableIamDbAuthentication:
          description: Specifies whether to enable IAM authentication for the DB.
          type:
          - boolean
          - 'null'
          x-order: 4
        enableCopyTagsToSnapshots:
          description: Specifies whether to enable copying of tags to snapshots of the DB.
          type:
          - boolean
          - 'null'
          x-order: 5
        enableAutoMinorVersionUpgrade:
          description: Specifies whether to enable auto minor version upgrade in the restored DB.
          type:
          - boolean
          - 'null'
          x-order: 6
        dbOptionGroup:
          description: Specifies entity representing the Aurora option group to use while restoring the DB.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 7
        dbParameterGroup:
          description: Specifies the entity representing the Aurora parameter group to use while restoring the DB.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 8
    OriginalFlashbladeTargetParams:
      description: Specifies the params of the original Flashblade recovery target.
      type: object
      title: Recover To Original Flashblade Volume Target Params.
      properties:
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 0
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 5
          $ref: '#/components/schemas/RecoveryVlanConfig'
    OriginalElastifileTargetParams:
      description: Specifies the params of the original Elastifile recovery target.
      type: object
      title: Recover To Original Elastifile Volume Target Params.
      properties:
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 0
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 1
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 2
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 5
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverFlashbladeToFlashbladeVolumeTargetParams:
      description: Specifies the params of the Flashblade recovery target.
      type: object
      title: Recover Flashblade To Flashblade Volume Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Flashblade target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the volumes will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeVolumeTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if volumes are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalFlashbladeTargetParams'
          - {}
          x-order: 2
    CreationInfo:
      description: Specifies the information about the creation of the protection group or recovery.
      type: object
      title: Creation Info
      properties:
        userName:
          description: Specifies the name of the user who created the protection group or recovery.
          type:
          - string
          - 'null'
          x-order: 0
    RecoverHdfsNoSqlObjectParams:
      description: Specifies the fully qualified object name and other attributes of each object to be recovered.
      title: Recover Hdfs Object Params.
      required:
      - objectName
      properties:
        objectName:
          description: Specifies the fully qualified name of the object to be restored.
          type:
          - string
          - 'null'
          x-order: 0
    RecoverOracleAppParams:
      description: Specifies the parameters to recover Oracle databases.
      type: object
      title: Recover Oracle DB params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kOracle
          x-order: 0
        oracleTargetParams:
          description: 'Specifies the params for recovering to a oracle host. Provided oracle backup should be recovered to same type of target host. For Example: If you have oracle backup taken from a physical host then that should be recovered to physical host only.'
          allOf:
          - $ref: '#/components/schemas/OracleTargetParamsForRecoverOracleApp'
          - {}
          x-order: 1
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 2
    RecoverAwsParams:
      description: Specifies the recovery options specific to AWS environment.
      type: object
      title: Recover AWS environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters. This property is mandatory for all recovery action types except recover vms. While recovering VMs, a user can specify snapshots of VM's or a Protection Group Run details to recover all the VM's that are backed up by that Run. For recovering files, specifies the object contains the file to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverVMs
          - RecoverRDS
          - RecoverAurora
          - RecoverFiles
          x-order: 1
        recoverVmParams:
          description: Specifies the parameters to recover AWS VM.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsVmParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files and folders.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsFileAndFolderParams'
          - {}
          x-order: 3
        recoverRdsParams:
          description: Specifies the parameters to recover AWS RDS.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsRdsParams'
          - {}
          x-order: 4
        recoverAuroraParams:
          description: Specifies the parameters to recover AWS Aurora.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsAuroraParams'
          - {}
          x-order: 5
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 6
    RecoverHyperVVmSCVMMSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover HyperV VMs New SCVMM Source Config.
      required:
      - source
      - host
      - volume
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        host:
          description: Specifies the HyperV host where the recovered VMs will be attached. For standalone host targets, the host must be the same as the source.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        volume:
          description: Specifies the datastore object where the VMs' files should be recovered to.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverHyperVVmNewSourceNetworkConfig'
          - {}
          x-order: 3
    RecoverFlashbladeParams:
      description: Specifies the recovery options specific to Flashblade environment.
      type: object
      title: Recover Flashblade Params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverNasVolume
          - RecoverFiles
          x-order: 1
        recoverNasVolumeParams:
          description: Specifies the parameters to recover Nas Volumes.
          allOf:
          - $ref: '#/components/schemas/RecoverFlashbladeNasVolumeParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files.
          allOf:
          - $ref: '#/components/schemas/RecoverFlashbladeFilesParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    RecoverMsGroupParams:
      description: Specifies the parameters to recover Microsoft 365 Group.
      type: object
      required:
      - msGroups
      properties:
        msGroups:
          description: Specifies a list of groups getting restored.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MsGroupParam'
          x-order: 0
        restoreToOriginal:
          description: Specifies whether or not all groups are restored to original location.
          type:
          - boolean
          - 'null'
          x-order: 1
        targetGroup:
          description: Specifies target group nickname in case restoreToOriginal is false. This needs to be specifid when restoreToOriginal is false.
          type:
          - string
          - 'null'
          x-order: 2
        targetGroupName:
          description: Specifies target group name in case restore_to_original is false. This needs to be specifid when restoreToOriginal is false. However, this will be ignored if restoring to alternate existing group (i.e. to a group the nickname of which is same as the one supplied by the end user).
          type:
          - string
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other MS groups if one of MS groups failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
    HbaseParams:
      description: Specifies the recovery options specific to Hbase environment.
      type: object
      title: Recover Hbase environment params.
      required:
      - recoveryAction
      - recoverHbaseParams
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverObjects
          x-order: 0
        recoverHbaseParams:
          description: Specifies the parameters to recover Hbase objects.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/RecoverHbaseParams'
          - {}
          x-order: 1
          $ref: '#/components/schemas/RecoverHbaseParams'
    KubernetesNamespaceRecoveryNewSourceConfig:
      description: Specifies the new source configuration if a Kubernetes Namespace is being restored to a different source than the one from which it was protected.
      type: object
      title: Kubernetes Namespace Recovery New Source Config
      required:
      - source
      properties:
        source:
          description: Specifies the id of the parent source to recover the Namespaces.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
    RecoverHyperVVmParams:
      description: Specifies the parameters to recover VMs.
      type: object
      title: Recover VMs params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kHyperV
          x-order: 1
        hypervTargetParams:
          description: Specifies the params for recovering to a HyperV target.
          allOf:
          - $ref: '#/components/schemas/HyperVTargetParamsForRecoverVm'
          - {}
          x-order: 2
    VMwareMountVolumesNewTargetConfig:
      description: Specifies the configuration for mounting volumes to a new target.
      type: object
      title: VMware Mount Volumes New Target Config.
      required:
      - mountTarget
      - bringDisksOnline
      properties:
        mountTarget:
          description: Specifies the target entity where the volumes are being mounted.
          type:
          - object
          - 'null'
          x-order: 0
          $ref: '#/components/schemas/RecoverTarget'
        bringDisksOnline:
          description: Specifies whether the volumes need to be online within the target environment after attaching the disks. For linux VMs, this should always be set to true. For Windows, this is optional. If this is set to true, VMware tools must be installed on the VM. If this is set to false, useExistingAgent and targetCredentials are not needed.
          type:
          - boolean
          - 'null'
          x-order: 1
        useExistingAgent:
          description: Specifies whether this will use an existing agent on the target vm or will deploy a new agent. This is required if bringDisksOnline is set to true.
          type:
          - boolean
          - 'null'
          x-order: 2
        targetVmCredentials:
          description: Specifies credentials to access the target VM. This is required if bringDisksOnline is set to true and useExistingAgent set to false.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 3
    CommonRecoverFileAndFolderInfo:
      description: Specifies the information about the specific file or folder to recover.
      type: object
      title: Common File And Folder Info
      required:
      - absolutePath
      properties:
        absolutePath:
          description: Specifies the absolute path to the file or folder.
          type:
          - string
          - 'null'
          x-order: 0
        destinationDir:
          description: Specifies the destination directory where the file/directory was copied.
          type:
          - string
          - 'null'
          x-order: 1
          readOnly: true
        isDirectory:
          description: Specifies whether this is a directory or not.
          type:
          - boolean
          - 'null'
          x-order: 2
        status:
          description: Specifies the recovery status for this file or folder.
          type:
          - string
          - 'null'
          enum:
          - NotStarted
          - EstimationInProgress
          - EstimationDone
          - CopyInProgress
          - Finished
          x-order: 3
          readOnly: true
        messages:
          description: Specify error messages about the file during recovery.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 4
          readOnly: true
    RecoverGpfsFilesParams:
      description: Specifies the parameters to recover Gpfs files.
      type: object
      title: Recover Gpfs files Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          x-order: 1
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverGpfsToGpfsFilesTargetParams'
          - {}
          x-order: 2
        elastifileTargetParams:
          description: Specifies the params for an Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileFilesTargetParams'
          - {}
          x-order: 3
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeFilesTargetParams'
          - {}
          x-order: 4
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasFilesTargetParams'
          - {}
          x-order: 5
        isilonTargetParams:
          description: Specifies the params for a Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonFilesTargetParams'
          - {}
          x-order: 6
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappFilesTargetParams'
          - {}
          x-order: 7
    VmwareVAppTemplateRecoveryTargetConfig:
      description: Specifies the target object parameters to recover VMware vApp templates.
      type: object
      title: Vmware vApp Template Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the vApp templates will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVAppTemplateNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if vApp templates are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVAppOriginalSourceConfig'
          - {}
          x-order: 2
    TargetOneDriveParam:
      description: Specifies the target OneDrive to recover to.
      allOf:
      - $ref: '#/components/schemas/RecoveryObjectIdentifier'
      - type: object
        required:
        - targetFolderPath
        properties:
          targetFolderPath:
            description: Specifies the path to the target folder.
            type:
            - string
            - 'null'
            x-order: 0
    HyperVRecoverFilesOriginalTargetConfig:
      description: Specifies the configuration for recovering files and folders to the original target.
      type: object
      title: HyperV Recover Files Original Target Config.
      required:
      - targetVmCredentials
      - recoverToOriginalPath
      properties:
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 0
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 1
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverElastifileToElastifileVolumeTargetParams:
      description: Specifies the params of the Elastifile recovery target.
      type: object
      title: Recover Elastifile To Elastifile Volume Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Elastifile target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the volumes will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileVolumeTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if volumes are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalElastifileTargetParams'
          - {}
          x-order: 2
    MssqlObjectEntityParams:
      description: Object details for Mssql.
      type: object
      properties:
        hostInfo:
          description: Specifies the host information for the SQL object. Includes details of Host object such as VM or Physical server.
          type:
          - object
          - 'null'
          x-order: 0
          $ref: '#/components/schemas/HostInformation'
        aagInfo:
          description: Specifies the Always on Avalibility (AAG) information if associated with the SQL Object.
          type:
          - object
          - 'null'
          x-order: 1
          $ref: '#/components/schemas/AAGInfo'
    OracleTier:
      description: Specifies the settings for a Oracle tier.
      type: object
      allOf:
      - $ref: '#/components/schemas/CommonCloudTierSettings'
      - type: object
        required:
        - tierType
        properties:
          tierType:
            description: Specifies the Oracle tier types.
            type:
            - string
            - 'null'
            enum:
            - kOracleTierStandard
            - kOracleTierArchive
            x-order: 0
    AcropolisRecoverFilesOriginalTargetConfig:
      description: Specifies the configuration for recovering files and folders to the original target.
      type: object
      title: Acropolis Recover Files Original Target Config.
      required:
      - targetVmCredentials
      - recoverToOriginalPath
      properties:
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 0
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 1
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverOtherNasToNetappFilesTargetParams:
      description: Specifies the params of the Netapp recovery target.
      type: object
      title: Recover To Netapp Files Target Params.
      required:
      - volume
      - alternatePath
      properties:
        volume:
          description: Specifies the id and name of the parent NAS to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        alternatePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 6
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 7
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 8
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RedoLogGroupConfig:
      description: Specifies Redo log group configuration
      type: object
      properties:
        numGroups:
          description: Specifies no. of redo log groups.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 0
        memberPrefix:
          description: Specifies Log member name prefix.
          type:
          - string
          - 'null'
          x-order: 1
        sizeMBytes:
          description: Specifies Size of the member in MB.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 2
        groupMembers:
          description: Specifies list of members of this redo log group.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 3
    RecoverKubernetesNamespaceParams:
      description: Specifies the parameters to recover Kubernetes Namespaces.
      type: object
      title: Recover Kubernetes Namespace params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kKubernetes
          x-order: 0
        kubernetesTargetParams:
          description: Specifies the params for recovering to a Kubernetes host.
          allOf:
          - $ref: '#/components/schemas/KubernetesTargetParamsForRecoverKubernetesNamespace'
          - {}
          x-order: 1
    PhysicalMountVolumesOriginalTargetConfig:
      description: Specifies the configuration for mounting volumes to the original target.
      type: object
      title: Physical Mount Volumes Original Target Config.
      properties:
        serverCredentials:
          description: Specifies credentials to access the target server. This is required if the server is of Linux OS.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 0
    OracleDatabaseHost:
      description: Specifies details about an Oracle database host.
      type: object
      title: Oracle Protection Group Database Host
      properties:
        hostId:
          description: Specifies the id of the database host from which backup is allowed.
          type:
          - string
          - 'null'
          x-order: 0
        channelCount:
          description: Specifies the number of channels to be created for this host. Default value for the number of channels will be calculated as the minimum of number of nodes in Cohesity cluster and 2 * number of CPU on the host.
          type: integer
          format: int32
          x-go-nullable: true
          x-order: 1
        port:
          description: Specifies the port where the Database is listening.
          type: integer
          format: int64
          x-go-nullable: true
          x-order: 2
        sbtHostParams:
          description: Specifies the necessary parameters for SBT. This is set only when backup type is kSbt.
          type:
          - object
          - 'null'
          x-order: 3
          $ref: '#/components/schemas/OracleSbtHostParams'
    CommonRecoverObjectSnapshotParams:
      description: Specifies the common snapshot parameters for a protected object.
      type: object
      title: Common Recover Object Snapshot Params.
      required:
      - snapshotId
      properties:
        snapshotId:
          description: Specifies the snapshot id.
          type: string
          x-order: 0
        pointInTimeUsecs:
          description: Specifies the timestamp (in microseconds. from epoch) for recovering to a point-in-time in the past.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 1
        protectionGroupId:
          description: Specifies the protection group id of the object snapshot.
          type:
          - string
          - 'null'
          x-order: 2
        protectionGroupName:
          description: Specifies the protection group name of the object snapshot.
          type:
          - string
          - 'null'
          x-order: 3
        snapshotCreationTimeUsecs:
          description: Specifies the time when the snapshot is created in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 4
          readOnly: true
        objectInfo:
          description: Specifies the information about the object for which the snapshot is taken.
          allOf:
          - $ref: '#/components/schemas/ObjectSummary'
          - {}
          x-order: 5
          readOnly: true
        snapshotTargetType:
          description: Specifies the snapshot target type.
          type:
          - string
          - 'null'
          enum:
          - Local
          - Archival
          x-order: 6
          readOnly: true
        storageDomainId:
          description: Specifies the ID of the Storage Domain where this snapshot is stored.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 7
          readOnly: true
        archivalTargetInfo:
          description: Specifies the archival target information if the snapshot is an archival snapshot.
          allOf:
          - $ref: '#/components/schemas/ArchivalTargetSummaryInfo'
          - {}
          x-order: 8
          readOnly: true
        progressTaskId:
          description: Progress monitor task id for Recovery of VM.
          type:
          - string
          - 'null'
          x-order: 9
          readOnly: true
        recoverFromStandby:
          description: Specifies that user wants to perform standby restore if it is enabled for this object.
          type:
          - boolean
          - 'null'
          x-order: 10
        status:
          description: Status of the Recovery. 'Running' indicates that the Recovery is still running. 'Canceled' indicates that the Recovery has been cancelled. 'Canceling' indicates that the Recovery is in the process of being cancelled. 'Failed' indicates that the Recovery has failed. 'Succeeded' indicates that the Recovery has finished successfully. 'SucceededWithWarning' indicates that the Recovery finished successfully, but there were some warning messages.
          type:
          - string
          - 'null'
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-order: 11
          readOnly: true
        startTimeUsecs:
          description: Specifies the start time of the Recovery in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 12
          readOnly: true
        endTimeUsecs:
          description: Specifies the end time of the Recovery in Unix timestamp epoch in microseconds. This field will be populated only after Recovery is finished.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 13
          readOnly: true
        messages:
          description: Specify error messages about the object.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 14
          readOnly: true
    RecoverFlashbladeNasVolumeParams:
      description: Specifies the parameters to recover Flashblade NAS volumes.
      type: object
      title: Recover Flashblade NAS Volume Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          - kView
          x-order: 0
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverFlashbladeToFlashbladeVolumeTargetParams'
          - {}
          x-order: 1
        elastifileTargetParams:
          description: Specifies the params for a Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileVolumeTargetParams'
          - {}
          x-order: 2
        genericNasTargetParams:
          description: Specifies the params for a Generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasVolumeTargetParams'
          - {}
          x-order: 3
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsVolumeTargetParams'
          - {}
          x-order: 4
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonVolumeTargetParams'
          - {}
          x-order: 5
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappVolumeTargetParams'
          - {}
          x-order: 6
        viewTargetParams:
          description: Specifies the params for a Cohesity view recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNasVolumeToViewParams'
          - {}
          x-order: 7
    RecoverOtherNasToGpfsFilesTargetParams:
      description: Specifies the params of the GPFS recovery target.
      type: object
      title: Recover To GPFS Files Target Params.
      required:
      - volume
      - alternatePath
      properties:
        volume:
          description: Specifies the id and name of the parent NAS to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        alternatePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 6
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 7
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 8
          $ref: '#/components/schemas/RecoveryVlanConfig'
    GcpVpcSubnetConfig:
      description: Specifies the group of a GCP VPC and the subnet in it.
      type: object
      title: GCP VPC Subnet Config
      required:
      - subnetId
      properties:
        subnetId:
          description: Specifies the id of the subnet.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        subnetName:
          description: Specifies the name of the subnet.
          type:
          - string
          - 'null'
          x-order: 1
          readOnly: true
        vpcName:
          description: Specifies the name of the vpc network.
          type:
          - string
          - 'null'
          x-order: 2
          readOnly: true
    RecoverAcropolisVmNewSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover Acropolis VMs New Source Config.
      required:
      - source
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        storageContainer:
          description: A storage container where the VM's files should be restored to.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverAcropolisVmNewSourceNetworkConfig'
          - {}
          x-order: 2
    RecoverHyperVFileAndFolderParams:
      description: Specifies the parameters to recover files and folders.
      type: object
      title: Recover HyperV File And Folder Params
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kHyperV
          x-order: 1
        hypervTargetParams:
          description: Specifies the parameters to recover to a HyperV target.
          allOf:
          - $ref: '#/components/schemas/HyperVTargetParamsForRecoverFileAndFolder'
          - {}
          x-order: 2
    RecoverIsilonNasVolumeParams:
      description: Specifies the parameters to recover Isilon NAS volumes.
      type: object
      title: Recover Isilon NAS Volume Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          - kView
          x-order: 0
        isilonTargetParams:
          description: Specifies the params for a Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverIsilonToIsilonVolumeTargetParams'
          - {}
          x-order: 1
        elastifileTargetParams:
          description: Specifies the params for an Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileVolumeTargetParams'
          - {}
          x-order: 2
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeVolumeTargetParams'
          - {}
          x-order: 3
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasVolumeTargetParams'
          - {}
          x-order: 4
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsVolumeTargetParams'
          - {}
          x-order: 5
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappVolumeTargetParams'
          - {}
          x-order: 6
        viewTargetParams:
          description: Specifies the params for a Cohesity view recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverNasVolumeToViewParams'
          - {}
          x-order: 7
    VmwareTargetParamsForRecoverFileAndFolder:
      description: Specifies the parameters for a VMware recovery target.
      type: object
      title: VMware Target Params for Recover File And Folder
      required:
      - recoverToOriginalTarget
      properties:
        recoverToOriginalTarget:
          description: Specifies whether to recover to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for recovering to the original target.
          allOf:
          - $ref: '#/components/schemas/VmwareRecoverFilesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for recovering to a new target.
          allOf:
          - $ref: '#/components/schemas/VmwareRecoverFilesNewTargetConfig'
          - {}
          x-order: 2
        overwriteExisting:
          description: Specifies whether to overwrite the existing files. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveAttributes:
          description: Specifies whether to preserve original attributes. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of files or folders failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered files and folders. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    RecoverAwsAuroraNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for AWS Aurora if recovering to new Source.
      type: object
      title: Recover AWS Aurora New Source Network configuration.
      required:
      - vpc
      - subnet
      properties:
        vpc:
          description: Specifies the Virtual Private Cloud to choose for the instance type.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        subnet:
          description: Specifies the subnet within above VPC.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        availabilityZone:
          description: Specifies the entity representing the availability zone to use while restoring the DB.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        securityGroups:
          description: Specifies the network security groups within above VPC.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 3
    FleetConfig:
      description: Specifies various resources while deploying fleet params.
      type: object
      title: Recover as fleet config.
      properties:
        fleetSubnetType:
          description: Specifies the subnet type of the fleet.
          type:
          - string
          - 'null'
          enum:
          - kCluster
          - kSourceVM
          - kCustom
          x-order: 0
        fleetNetworkParams:
          description: Specifies the network security groups within above VPC.
          allOf:
          - $ref: '#/components/schemas/FleetNetworkParams'
          - {}
          x-order: 1
        fleetTags:
          description: Specifies the network security groups within above VPC.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FleetTags'
          x-order: 2
    RecoverVmwareChildSnapshotParams:
      description: Specifies the snapshot parameters for VMware recovery.
      title: Recover VMware Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          instantRecoveryInfo:
            description: Specifies the info about instant recovery. This is only applicable for RecoverVm.
            allOf:
            - $ref: '#/components/schemas/RecoveryTaskInfo'
            - {}
            x-order: 0
            readOnly: true
          datastoreMigrationInfo:
            description: Specifies the info about datastore migration. This is only applicable for RecoverVm.
            allOf:
            - $ref: '#/components/schemas/RecoveryTaskInfo'
            - {}
            x-order: 1
            readOnly: true
    RecoverO365Params:
      description: Specifies the recovery options specific to Office 365 environment.
      type: object
      title: Recover Office 365 environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recovery action to be performed.
          type: string
          enum:
          - RecoverMailbox
          - RecoverOneDrive
          - RecoverSharePoint
          - RecoverPublicFolders
          - RecoverMsGroup
          - RecoverMsTeam
          x-order: 1
        recoverOneDriveParams:
          description: Specifies the parameters to recover Office 365 One Drive.
          allOf:
          - $ref: '#/components/schemas/RecoverOneDriveParams'
          - {}
          x-order: 2
        recoverMailboxParams:
          description: Specifies the parameters to recover Office 365 Mailbox.
          allOf:
          - $ref: '#/components/schemas/RecoverMailboxParams'
          - {}
          x-order: 3
        recoverPublicFoldersParams:
          description: Specifies the parameters to recover Office 365 Public Folders.
          allOf:
          - $ref: '#/components/schemas/RecoverPublicFoldersParams'
          - {}
          x-order: 4
        recoverMsGroupParams:
          description: Specifies the parameters to recover Microsoft 365 Group.
          allOf:
          - $ref: '#/components/schemas/RecoverMsGroupParams'
          - {}
          x-order: 5
        recoverMsTeamParams:
          description: Specifies the parameters to recover Microsoft 365 Teams.
          allOf:
          - $ref: '#/components/schemas/RecoverMsTeamParams'
          - {}
          x-order: 6
    RecoverOtherNasToFlashbladeVolumeTargetParams:
      description: Specifies the params of the Flashblade recovery target.
      type: object
      title: Recover To Flashblade Volume Target Params.
      required:
      - volume
      properties:
        volume:
          description: Specifies the id and name of the parent volume to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other volumes if one of the volumes fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverGenericNasFilesParams:
      description: Specifies the parameters to recover Generic Nas files.
      type: object
      title: Recover Generic Nas files Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          x-order: 1
        genericNasTargetParams:
          description: Specifies the params for a Generic Nas recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverGenericNasToGenericNasFilesTargetParams'
          - {}
          x-order: 2
        elastifileTargetParams:
          description: Specifies the params for an Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileFilesTargetParams'
          - {}
          x-order: 3
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeFilesTargetParams'
          - {}
          x-order: 4
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsFilesTargetParams'
          - {}
          x-order: 5
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonFilesTargetParams'
          - {}
          x-order: 6
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappFilesTargetParams'
          - {}
          x-order: 7
    OrgVDCNetwork:
      description: Specifies a VDC Organization Network.
      type: object
      required:
      - vcdUuid
      - name
      properties:
        vcdUuid:
          description: Specifies the UUID of network associated with the Virtual Cloud director.
          type:
          - string
          - 'null'
          x-order: 0
        name:
          description: Specifies the name of the catalog.
          type:
          - string
          - 'null'
          x-order: 1
        vCenterUuid:
          description: Specifies the UUID of network associated with the Vcenter.
          type:
          - string
          - 'null'
          x-order: 2
          readOnly: true
    RecoverElastifileFilesParams:
      description: Specifies the parameters to recover Elastifile files.
      type: object
      title: Recover Elastifile files Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          x-order: 1
        elastifileTargetParams:
          description: Specifies the params for a Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverElastifileToElastifileFilesTargetParams'
          - {}
          x-order: 2
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToFlashbladeFilesTargetParams'
          - {}
          x-order: 3
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasFilesTargetParams'
          - {}
          x-order: 4
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsFilesTargetParams'
          - {}
          x-order: 5
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonFilesTargetParams'
          - {}
          x-order: 6
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappFilesTargetParams'
          - {}
          x-order: 7
    FilenamePatternToDirectory:
      description: Specifies a filename pattern and the directory path where to keep files matching that pattern.
      type: object
      title: Filename Pattern to Directory.
      properties:
        directory:
          description: Specifies the directory where to keep the files matching the pattern.
          type:
          - string
          - 'null'
          x-order: 0
        filenamePattern:
          description: 'Specifies a pattern to be matched with filenames. This can be a

            regex expression.'
          type:
          - string
          - 'null'
          x-order: 1
    RecoverAzureVmParams:
      description: Specifies the parameters to recover Azure VM.
      type: object
      title: Recover Azure VM params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the VM's that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of VMs. User has to make sure that specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAzure
          x-order: 1
        azureTargetParams:
          description: Specifies the params for recovering to an Azure target.
          allOf:
          - $ref: '#/components/schemas/AzureTargetParamsForRecoverVm'
          - {}
          x-order: 2
    ObjectSummary:
      description: Specifies the Object Summary.
      title: Object Summary
      allOf:
      - $ref: '#/components/schemas/ObjectIdentifier'
      - type: object
        properties:
          objectHash:
            description: Specifies the hash identifier of the object.
            type:
            - string
            - 'null'
            x-order: 0
          objectType:
            description: Specifies the type of the object.
            type:
            - string
            - 'null'
            enum:
            - kCluster
            - kVserver
            - kVolume
            - kVCenter
            - kStandaloneHost
            - kvCloudDirector
            - kFolder
            - kDatacenter
            - kComputeResource
            - kClusterComputeResource
            - kResourcePool
            - kDatastore
            - kHostSystem
            - kVirtualMachine
            - kVirtualApp
            - kStoragePod
            - kNetwork
            - kDistributedVirtualPortgroup
            - kTagCategory
            - kTag
            - kOpaqueNetwork
            - kOrganization
            - kVirtualDatacenter
            - kCatalog
            - kOrgMetadata
            - kStoragePolicy
            - kVirtualAppTemplate
            - kDomain
            - kOutlook
            - kMailbox
            - kUsers
            - kGroups
            - kSites
            - kUser
            - kGroup
            - kSite
            - kApplication
            - kGraphUser
            - kPublicFolders
            - kPublicFolder
            - kTeams
            - kTeam
            - kKeyspace
            - kTable
            - kDatabase
            - kCollection
            - kBucket
            - kNamespace
            - kSCVMMServer
            - kStandaloneCluster
            - kHostGroup
            - kHypervHost
            - kHostCluster
            - kCustomProperty
            - kSubscription
            - kResourceGroup
            - kStorageAccount
            - kStorageKey
            - kStorageContainer
            - kStorageBlob
            - kNetworkSecurityGroup
            - kVirtualNetwork
            - kSubnet
            - kComputeOptions
            - kSnapshotManagerPermit
            - kAvailabilitySet
            - kOVirtManager
            - kHost
            - kStorageDomain
            - kVNicProfile
            - kIAMUser
            - kRegion
            - kAvailabilityZone
            - kEC2Instance
            - kVPC
            - kInstanceType
            - kKeyPair
            - kRDSOptionGroup
            - kRDSParameterGroup
            - kRDSInstance
            - kRDSSubnet
            - kRDSTag
            - kAuroraCluster
            - kAccount
            - kSubTaskPermit
            - kProject
            - kLabel
            - kMetadata
            - kVPCConnector
            - kPrismCentral
            - kOtherHypervisorCluster
            - kDfsGroup
            - kDfsTopDir
            - kZone
            - kMountPoint
            - kStorageArray
            - kFileSystem
            - kContainer
            - kFilesystem
            - kFileset
            - kViewBox
            - kView
            - kWindowsCluster
            - kOracleRACCluster
            - kOracleAPCluster
            - kService
            - kPVC
            - kRootContainer
            - kDAGRootContainer
            - kExchangeNode
            - kExchangeDAGDatabaseCopy
            - kExchangeStandaloneDatabase
            - kExchangeDAG
            - kExchangeDAGDatabase
            - kDomainController
            - kInstance
            - kAAG
            - kAAGRootContainer
            - kRACRootContainer
            - kTableSpace
            - kPDB
            - kObject
            x-order: 1
          logicalSizeBytes:
            description: Specifies the logical size of object in bytes.
            type:
            - integer
            - 'null'
            format: int64
            x-order: 2
          uuid:
            description: Specifies the uuid which is a unique identifier of the object.
            type:
            - string
            - 'null'
            x-order: 3
          protectionType:
            description: Specifies the protection type of the object if any.
            type:
            - string
            - 'null'
            enum:
            - kAgent
            - kNative
            - kSnapshotManager
            - kRDSSnapshotManager
            - kAuroraSnapshotManager
            - kFile
            - kVolume
            x-order: 4
          osType:
            description: Specifies the operating system type of the object.
            type:
            - string
            - 'null'
            enum:
            - kLinux
            - kWindows
            - kAix
            - kSolaris
            - kSapHana
            - kOther
            x-order: 5
          vCenterSummary:
            description: Specifies the vCenter object details.
            type:
            - object
            - 'null'
            x-order: 6
            $ref: '#/components/schemas/ObjectTypeVCenterParams'
    ShellKeyValuePair:
      description: Specifies key value pairs of shell variables which defines the restore shell environment.
      type: object
      properties:
        key:
          description: Specifies the name of the shell environment variable.
          type:
          - string
          - 'null'
          x-order: 0
        value:
          description: Specifies the value of the shell environment variable.
          type:
          - string
          - 'null'
          x-order: 1
    RecoverNetappParams:
      description: Specifies the recovery options specific to Netapp environment.
      type: object
      title: Recover Netapp Params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverNasVolume
          - RecoverFiles
          x-order: 1
        recoverNasVolumeParams:
          description: Specifies the parameters to recover Nas Volumes.
          allOf:
          - $ref: '#/components/schemas/RecoverNetappNasVolumeParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files.
          allOf:
          - $ref: '#/components/schemas/RecoverNetappFilesParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    ExchangeRecoverDatabaseParams:
      description: Specifies the parameters to recover an Exchange database. database.
      type: object
      title: Exchange database Recovery params.
      required:
      - restoreType
      - recoverToNewSource
      - databaseSource
      properties:
        databaseSource:
          description: Specifies the source id of Exchange database which has to be recovered.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 1
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source.
          allOf:
          - $ref: '#/components/schemas/ExchangeDatabaseRecoveryTargetConfig'
          - {}
          x-order: 2
        restoreType:
          description: Specifies the type of exchange restore.
          type:
          - string
          - 'null'
          enum:
          - RestoreView
          x-order: 3
        viewOptions:
          description: Specifies the parameters related to the Exchange restore of type view. This is mandatory if restore type is RestoreView.
          type:
          - object
          - 'null'
          x-order: 4
          $ref: '#/components/schemas/ViewOptions'
    AwsTargetParamsForRecoverVm:
      description: Specifies the parameters for an AWS recovery target.
      type: object
      title: AWS Recovery Target Params
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/AwsVmRecoveryTargetConfig'
          - {}
          x-order: 1
        fleetConfig:
          description: Specifies the fleet params.
          allOf:
          - $ref: '#/components/schemas/FleetConfig'
          - {}
          x-order: 2
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
    RecoverVmwareVAppTemplateNewSourceConfig:
      description: Specifies the new destination Source configuration where the vApps templates will be recovered.
      type: object
      title: Recover VMware vApp Templates New Source Config.
      required:
      - sourceType
      properties:
        sourceType:
          description: Specifies the type of VMware source to which the vApp templatess are being restored.
          type:
          - string
          - 'null'
          enum:
          - kvCloudDirector
          x-order: 0
        vCloudDirectorParams:
          x-order: 1
          $ref: '#/components/schemas/RecoverVmwareVAppTemplateVCDSourceConfig'
    FilterDocumentsParams:
      description: Specifies the parameters to filter documents to be restored.
      title: Recover Couchbase Object Params.
      required:
      - documentFilterType
      properties:
        documentFilterType:
          description: Specifies the filter type for Documents to be restored.
          type:
          - string
          - 'null'
          enum:
          - NONE
          - ID
          - CONTENT
          x-order: 0
        idRegex:
          description: A regular expression to match Documents ID's to be restored.
          type:
          - string
          - 'null'
          x-order: 1
        filterExpression:
          description: A filter expression to match Documents content to be restored.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverAwsAuroraNewSourceConfig:
      description: Specifies the new destination Source configuration where the Aurora instances will be recovered.
      type: object
      title: Recover AWS Aurora New Source Config.
      required:
      - source
      - region
      - networkConfig
      properties:
        source:
          description: Specifies the id of the parent source to recover the Aurora.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        region:
          description: Specifies the AWS region in which to deploy the Aurora instance.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsAuroraNewSourceNetworkConfig'
          - {}
          x-order: 2
    ExchangeTargetParamsForRecoverExchangeApp:
      description: Specifies the parameters to recover Exchange applications to an Exchange target.
      type: object
      title: Recover Exchange App params.
      required:
      - object
      properties:
        object:
          description: Specifies the Recovered Object parameters.
          type:
          - object
          - 'null'
          x-order: 0
          $ref: '#/components/schemas/RecoverExchangeAppSnapshotParams'
    FilesAndFoldersObject:
      description: Specifies a file or folder to download.
      required:
      - absolutePath
      properties:
        absolutePath:
          description: Specifies the absolute path of the file or folder.
          type:
          - string
          - 'null'
          x-order: 0
        isDirectory:
          description: Specifies whether the file or folder object is a directory.
          type:
          - boolean
          - 'null'
          x-order: 1
    VmwareTargetParamsForMountVolume:
      description: Specifies the parameters for a VMware mount volume target.
      type: object
      title: VMware Target Params.
      required:
      - mountToOriginalTarget
      properties:
        mountToOriginalTarget:
          description: Specifies whether to mount to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for mounting to the original target.
          allOf:
          - $ref: '#/components/schemas/VMwareMountVolumesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for mounting to a new target.
          allOf:
          - $ref: '#/components/schemas/VMwareMountVolumesNewTargetConfig'
          - {}
          x-order: 2
        readOnlyMount:
          description: Specifies whether to perform a read-only mount. Default is false.
          type:
          - boolean
          - 'null'
          x-order: 3
        volumeNames:
          description: Specifies the names of volumes that need to be mounted. If this is not specified then all volumes that are part of the source VM will be mounted on the target VM.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 4
        mountedVolumeMapping:
          description: Specifies the mapping of original volumes and mounted volumes
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MountedVolumeMapping'
          x-order: 5
          readOnly: true
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    RecoverHbaseSnapshotParams:
      description: Specifies the snapshot parameters for a protected Hbase object.
      title: Recover Hbase Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          objects:
            description: Specifies details of objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverHbaseNoSqlObjectParams'
            x-order: 0
    RecoverUdaParams:
      description: Specifies the parameters to recover Universal Data Adapter objects.
      type: object
      title: Recover Universal Data Adapter params.
      required:
      - snapshots
      properties:
        recoverTo:
          description: Specifies the 'Source Registration ID' of the source where the objects are to be recovered. If this is not specified, the recovery job will recover to the original location.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        concurrency:
          description: Specifies the maximum number of concurrent IO Streams that will be created to exchange data with the cluster. If not specified, the default value is taken as 1.
          type:
          - integer
          - 'null'
          format: int32
          default: 1
          x-order: 1
        mounts:
          description: Specifies the maximum number of view mounts per host. If not specified, the default value is taken as 1.
          type:
          - integer
          - 'null'
          format: int32
          default: 1
          x-order: 2
        recoveryArgs:
          description: Specifies the arguments for recovery of Universal Data Adapter objects.
          type:
          - string
          - 'null'
          x-order: 3
        snapshots:
          description: Specifies the local snapshot ids and other details of the objects to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverUdaSnapshotParams'
          x-order: 4
        warnings:
          description: This field will hold the warnings in cases where the job status is SucceededWithWarnings.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 5
          readOnly: true
    KeyValuePair:
      description: Specifies a map structure to store Key and Values.
      type: object
      title: KeyValuePair
      required:
      - key
      - value
      properties:
        key:
          description: key
          type:
          - string
          - 'null'
          x-order: 0
        value:
          description: value
          type:
          - string
          - 'null'
          x-order: 1
    RecoverFlashbladeFilesParams:
      description: Specifies the parameters to recover Flashblade files.
      type: object
      title: Recover Flashblade files Params.
      required:
      - filesAndFolders
      - targetEnvironment
      properties:
        filesAndFolders:
          description: Specifies the info about the files and folders to be recovered.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverFileAndFolderInfo'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kElastifile
          - kFlashBlade
          - kGenericNas
          - kGPFS
          - kIsilon
          - kNetapp
          x-order: 1
        flashbladeTargetParams:
          description: Specifies the params for a Flashblade recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverFlashbladeToFlashbladeFilesTargetParams'
          - {}
          x-order: 2
        elastifileTargetParams:
          description: Specifies the params for an Elastifile recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToElastifileFilesTargetParams'
          - {}
          x-order: 3
        genericNasTargetParams:
          description: Specifies the params for a generic NAS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasFilesTargetParams'
          - {}
          x-order: 4
        gpfsTargetParams:
          description: Specifies the params for a GPFS recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsFilesTargetParams'
          - {}
          x-order: 5
        isilonTargetParams:
          description: Specifies the params for an Isilon recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToIsilonFilesTargetParams'
          - {}
          x-order: 6
        netappTargetParams:
          description: Specifies the params for an Netapp recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappFilesTargetParams'
          - {}
          x-order: 7
    RecoverHiveSnapshotParams:
      description: Specifies the snapshot parameters for a protected Hive object.
      title: Recover Hive Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          objects:
            description: Specifies details of objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverHiveNoSqlObjectParams'
            x-order: 0
    RecoverAcropolisVmNewSourceNetworkConfig:
      description: Specifies the network config parameters to applied for Acropolis VMs.
      type: object
      title: Recover Acropolis VMs network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. All the other networking parameters set will be ignored if set to true. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
        networkPortGroup:
          description: Specifies the network port group (i.e, either a standard switch port group or a distributed port group) that will attached to the recovered Object. This parameter is mandatory if detach network is specified as false.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
    FleetNetworkParams:
      description: Specifies various network params for the fleet.
      type: object
      title: Fleet Network Params.
      required:
      - vpc
      - subnet
      properties:
        vpc:
          description: Specifies vpc for the fleet.
          type:
          - string
          - 'null'
          x-order: 0
        subnet:
          description: Specifies subnet for the fleet.
          type:
          - string
          - 'null'
          x-order: 1
    CommonRecoverOracleAppTargetParams:
      description: Specifies the snapshot parameters to recover Oracle databases.
      type: object
      title: Recover Oracle App Snapshot Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new source or an original Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the destination Source configuration parameters where the databases will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOracleAppNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if databases are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverOracleAppOriginalSourceConfig'
          - {}
          x-order: 2
    OracleDbChannel:
      description: Specifies the DB channel info for all the databases of app entity. Length of this array will be 1 for RAC and Standalone setups.
      type: object
      title: Oracle Protection Group Database Node Channel
      properties:
        archiveLogRetentionDays:
          description: Specifies the number of days archive log should be stored. For keeping the archived log forever, set this to -1. For deleting the archived log immediately, set this to 0. For deleting the archived log after n days, set this to n.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 0
        credentials:
          description: Specifies the Database credentials.
          type:
          - object
          - 'null'
          x-order: 1
          $ref: '#/components/schemas/Credentials'
        databaseUniqueName:
          description: Specifies the unique Name of the database.
          type:
          - string
          - 'null'
          x-order: 2
        databaseUuid:
          description: Specifies the database unique id. This is an internal field and is filled by magneto master based on corresponding app entity id.
          type:
          - string
          - 'null'
          x-order: 3
        defaultChannelCount:
          description: Specifies the default number of channels to use per node per database. This value is used on all Oracle Database Nodes unless databaseNodeList item's channelCount is specified for the node. Default value for the number of channels will be calculated as the minimum of number of nodes in Cohesity cluster and 2 * number of CPU on the host. If the number of channels is unspecified here and unspecified within databaseNodeList, the above formula will be used to determine the same.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 4
        databaseNodeList:
          description: Specifies the Node info from where we are allowed to take the backup/restore.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OracleDatabaseHost'
          x-go-name: DatabaseHosts
          x-order: 5
        maxHostCount:
          description: Specifies the maximum number of hosts from which backup/restore is allowed in parallel. This will be less than or equal to the number of databaseNode specified within databaseNodeList.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 6
        enableDgPrimaryBackup:
          description: Specifies whether the database having the Primary role within Data Guard configuration is to be backed up.
          type:
          - boolean
          - 'null'
          x-order: 7
        rmanBackupType:
          description: Specifies the type of Oracle RMAN backup requested
          type: string
          enum:
          - kImageCopy
          - kBackupSets
          - kSbt
          x-order: 8
    AwsTargetParamsForRecoverAurora:
      description: Specifies the parameters for an AWS recovery target.
      type: object
      title: AWS Aurora Recovery Target Params
      properties:
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/AwsAuroraRecoveryTargetConfig'
          - {}
          x-order: 0
        auroraConfig:
          description: Specifies the Aurora params.
          allOf:
          - $ref: '#/components/schemas/AuroraConfig'
          - {}
          x-order: 1
    RecoverSqlAppNewSourceConfig:
      description: Specifies the new destination Source configuration where the databases will be recovered.
      type: object
      title: Recover Sql App New Source Config.
      required:
      - host
      - instanceName
      - dataFileDirectoryLocation
      - logFileDirectoryLocation
      allOf:
      - $ref: '#/components/schemas/CommonSqlAppSourceConfig'
      properties:
        host:
          description: Specifies the source id of target host where databases will be recovered. This source id can be a physical host or virtual machine.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        instanceName:
          description: Specifies an instance name of the Sql Server that should be used for restoring databases to.
          type:
          - string
          - 'null'
          x-order: 1
        dataFileDirectoryLocation:
          description: Specifies the directory where to put the database data files. Missing directory will be automatically created.
          type:
          - string
          - 'null'
          x-order: 2
        logFileDirectoryLocation:
          description: Specifies the directory where to put the database log files. Missing directory will be automatically created.
          type:
          - string
          - 'null'
          x-order: 3
        databaseName:
          description: Specifies a new name for the restored database. If this field is not specified, then the original database will be overwritten after recovery.
          type:
          - string
          - 'null'
          x-order: 4
    RecoverTarget:
      description: Specifies the target entity to recover to.
      title: Recover Target.
      allOf:
      - $ref: '#/components/schemas/RecoveryObjectIdentifier'
      - type: object
        properties:
          parentSourceId:
            description: Specifies the id of the parent source of the target.
            type:
            - integer
            - 'null'
            format: int64
            x-order: 0
            readOnly: true
          parentSourceName:
            description: Specifies the name of the parent source of the target.
            type:
            - string
            - 'null'
            x-order: 1
            readOnly: true
      - {}
    RecoverPureSanVolumeParams:
      description: Specifies the parameters to recover Pure SAN Volume.
      type: object
      title: Recover Pure SAN Volume Params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding target params must be filled out.
          type: string
          enum:
          - kPure
          x-order: 0
        pureTargetParams:
          description: Specifies the parameters of the Pure SAN volume to recover to.
          allOf:
          - $ref: '#/components/schemas/RecoverPureVolumeTargetParams'
          - {}
          x-order: 1
    RecoverHdfsParams:
      description: Specifies the parameters to recover HDFS objects.
      title: Recover HDFS params.
      allOf:
      - $ref: '#/components/schemas/CommonNoSqlRecoveryOptions'
      - type: object
        required:
        - snapshots
        properties:
          snapshots:
            description: Specifies the local snapshot ids of the Objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverHdfsSnapshotParams'
            x-order: 0
          targetDirectory:
            description: Specifies the target directory where files and folders are to be recovered. If not set, this will be taken as '/'
            type:
            - string
            - 'null'
            x-order: 1
    CommonOracleAppSourceConfig:
      description: Specifies a common parameters used when restoring back to original or new source.
      type: object
      title: Common Oracle App Source Config.
      properties:
        restoreTimeUsecs:
          description: Specifies the time in the past to which the Oracle db needs to be restored. This allows for granular recovery of Oracle databases. If this is not set, the Oracle db will be restored from the full/incremental snapshot.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        dbChannels:
          description: Specifies the Oracle database node channels info. If not specified, the default values assigned by the server are applied to all the databases.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OracleDbChannel'
          x-order: 1
        recoveryMode:
          description: Specifies if database should be left in recovery mode.
          type:
          - boolean
          - 'null'
          x-order: 2
        shellEvironmentVars:
          description: Specifies key value pairs of shell variables which defines the restore shell environment.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ShellKeyValuePair'
          x-order: 3
        granularRestoreInfo:
          description: Specifies information about list of objects (PDBs) to restore.
          type: object
          allOf:
          - $ref: '#/components/schemas/RecoverOracleGranularRestoreInfo'
          - {}
          x-order: 4
    RecoverVmwareParams:
      description: Specifies the recovery options specific to VMware environment.
      type: object
      title: Recover VMware environment params.
      required:
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters. This property is mandatory for all recovery action types except recover vms. While recovering VMs, a user can specify snapshots of VM's or a Protection Group Run details to recover all the VM's that are backed up by that Run. For recovering files, specifies the object contains the file to recover.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverVmwareSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recovery action to be performed.
          type: string
          enum:
          - RecoverVMs
          - RecoverFiles
          - InstantVolumeMount
          - RecoverVmDisks
          - RecoverVApps
          - RecoverVAppTemplates
          x-order: 1
        recoverVmParams:
          description: Specifies the parameters to recover VMware VM.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmParams'
          - {}
          x-order: 2
        recoverVmDiskParams:
          description: Specifies the parameters to recover VMware Disks.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareDiskParams'
          - {}
          x-order: 3
        mountVolumeParams:
          description: Specifies the parameters to mount VMware Volumes.
          allOf:
          - $ref: '#/components/schemas/MountVmwareVolumeParams'
          - {}
          x-order: 4
        recoverVAppParams:
          description: Specifies the parameters to recover a VMware vApp.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVAppParams'
          - {}
          x-order: 5
        recoverVAppTemplateParams:
          description: Specifies the parameters to recover a VMware vApp template.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVAppTemplateParams'
          - {}
          x-order: 6
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files and folders.
          allOf:
          - $ref: '#/components/schemas/RecoverVMwareFileAndFolderParams'
          - {}
          x-order: 7
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 8
    RecoveryTaskInfo:
      description: Specifies the info about a recovery task.
      type: object
      title: Recovery Task Info
      properties:
        progressTaskId:
          description: Specifies the progress monitor path.
          type:
          - string
          - 'null'
          x-order: 0
          readOnly: true
        status:
          description: Specifies the status of the recovery.
          type:
          - string
          - 'null'
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-order: 1
          readOnly: true
        startTimeUsecs:
          description: Specifies the start time in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 2
          readOnly: true
        endTimeUsecs:
          description: Specifies the end time in Unix timestamp epoch in microseconds.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 3
          readOnly: true
    ObjectIdentifier:
      description: Specifies the basic info to identify an object.
      title: Object Identifier.
      properties:
        id:
          description: Specifies object id.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        name:
          description: Specifies the name of the object.
          type:
          - string
          - 'null'
          x-order: 1
        sourceId:
          description: Specifies registered source id to which object belongs.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 2
        sourceName:
          description: Specifies registered source name to which object belongs.
          type:
          - string
          - 'null'
          x-order: 3
        environment:
          description: Specifies the environment of the object.
          type:
          - string
          - 'null'
          enum:
          - kVMware
          - kHyperV
          - kAzure
          - kKVM
          - kAWS
          - kAcropolis
          - kGCP
          - kPhysical
          - kPhysicalFiles
          - kIsilon
          - kNetapp
          - kGenericNas
          - kFlashBlade
          - kElastifile
          - kGPFS
          - kPure
          - kNimble
          - kSQL
          - kOracle
          - kExchange
          - kAD
          - kView
          - kO365
          - kHyperFlex
          - kKubernetes
          - kCassandra
          - kMongoDB
          - kCouchbase
          - kHdfs
          - kHive
          - kHBase
          - kUDA
          x-order: 4
    PublicFolder:
      description: Specifies an PublicFolder item to recover.
      type: object
      required:
      - folderId
      properties:
        folderId:
          description: Specifies the Unique ID of the folder.
          type:
          - string
          - 'null'
          x-order: 0
        recoverEntireFolder:
          description: Specifies whether to recover the whole PublicFolder.
          type:
          - boolean
          - 'null'
          x-order: 1
        itemIds:
          description: Specifies a list of item ids to recover. This field is applicable only if 'recoverEntireFolder' is false.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 2
    VmwareTargetParamsForRecoverVAppTemplate:
      description: Specifies the parameters for a VMware recovery target when recovering a vApp Template.
      type: object
      title: VMware Target Params.
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        renameRecoveredVAppTemplateParams:
          description: Specifies params to rename the vApps templates that are recovered. If not specified, the original names of the vApp templates are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 1
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vApp templates will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/VmwareVAppTemplateRecoveryTargetConfig'
          - {}
          x-order: 2
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        recoveryProcessType:
          description: Specifies type of Recovery Process to be used. InstantRecovery/CopyRecovery etc... Default value is InstantRecovery.
          type: string
          enum:
          - InstantRecovery
          - CopyRecovery
          x-order: 5
        attemptDifferentialRestore:
          description: Specifies whether to attempt differential restore.
          type:
          - boolean
          - 'null'
          x-order: 6
    VmwareRecoverFilesOriginalTargetConfig:
      description: Specifies the configuration for recovering files and folders to the original target.
      type: object
      title: Vmware Recover Files Original Target Config.
      required:
      - recoverMethod
      - recoverToOriginalPath
      properties:
        recoverMethod:
          description: Specifies the method to recover files and folders.
          type: string
          enum:
          - AutoDeploy
          - UseExistingAgent
          - UseHypervisorApis
          x-order: 0
        targetVmCredentials:
          description: Specifies the credentials for the target VM. This is mandatory if the recoverMethod is AutoDeploy or UseHypervisorApis.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 1
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 2
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 3
    RecoverOracleAppOriginalSourceConfig:
      description: Specifies the additional Source configuration parameters when databases will be recovered to original location.
      type: object
      title: Recover Oracle App Original Source Config.
      allOf:
      - $ref: '#/components/schemas/CommonOracleAppSourceConfig'
    RecoverAwsVmNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for AWS VMs if recovering to new Source.
      type: object
      title: Recover AWS VMs New Source Network configuration.
      required:
      - vpc
      - subnet
      - securityGroups
      properties:
        vpc:
          description: Specifies the Virtual Private Cloud to choose for the instance type.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        subnet:
          description: Specifies the subnet within above VPC.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        securityGroups:
          description: Specifies the network security groups within above VPC.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 2
    OriginalGpfsFilesTargetParams:
      description: Specifies the params of the original GPFS recovery target.
      type: object
      title: Recover To Original GPFS Files Target Params.
      required:
      - recoverToOriginalPath
      properties:
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverOtherNasToIsilonFilesTargetParams:
      description: Specifies the params of the Isilon recovery target.
      type: object
      title: Recover To Isilon Files Target Params.
      required:
      - volume
      - alternatePath
      properties:
        volume:
          description: Specifies the id and name of the parent NAS to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        alternatePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 6
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 7
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 8
          $ref: '#/components/schemas/RecoveryVlanConfig'
    AcropolisRecoverFilesNewTargetConfig:
      description: Specifies the configuration for recovering files and folders to the new target.
      type: object
      title: Acropolis Recover Files New Target Config.
      required:
      - targetVm
      - targetVmCredentials
      - absolutePath
      properties:
        targetVm:
          description: Specifies the target VM to recover files and folders to.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        targetVmCredentials:
          description: Specifies the credentials for the target VM.
          allOf:
          - $ref: '#/components/schemas/Credentials'
          - {}
          x-order: 1
        absolutePath:
          description: Specifies the absolute path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverGpfsToGpfsVolumeTargetParams:
      description: Specifies the params of the GPFS recovery target.
      type: object
      title: Recover GPFS To GPFS NAS Volume Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original GPFS target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the volumes will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGpfsVolumeTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if volumes are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalGpfsTargetParams'
          - {}
          x-order: 2
    OriginalIsilonFilesTargetParams:
      description: Specifies the params of the original Isilon recovery target.
      type: object
      title: Recover To Original Isilon Files Target Params.
      required:
      - recoverToOriginalPath
      properties:
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverSqlAppParams:
      description: Specifies the parameters to recover Sql databases.
      type: object
      title: Recover Sql DB params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - $ref: '#/components/schemas/MssqlObjectEntityParams'
      - type: object
        required:
        - targetEnvironment
        properties:
          targetEnvironment:
            description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
            type: string
            enum:
            - kSQL
            x-order: 0
          sqlTargetParams:
            description: 'Specifies the params for recovering to a sql host. Provided sql backup should be recovered to same type of target host. For Example: If you have sql backup taken from a physical host then that should be recovered to physical host only.'
            type:
            - object
            - 'null'
            x-order: 1
            $ref: '#/components/schemas/SqlTargetParamsForRecoverSqlApp'
    RecoverAwsVmNewSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered.
      type: object
      title: Recover AWS VMs New Source Config.
      required:
      - source
      - region
      - networkConfig
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        region:
          description: Specifies the AWS region in which to deploy the VM.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        keyPair:
          description: Specifies the pair of public and private key used to login into the VM
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverAwsVmNewSourceNetworkConfig'
          - {}
          x-order: 3
    MountVmwareVolumeParams:
      description: Specifies the parameters to mount VMware Volumes.
      type: object
      title: Mount VMware Volumes params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kVMware
          x-order: 0
        vmwareTargetParams:
          description: Specifies the params for recovering to a VMware target..
          allOf:
          - $ref: '#/components/schemas/VmwareTargetParamsForMountVolume'
          - {}
          x-order: 1
    RecoverAwsAuroraParams:
      description: Specifies the parameters to recover AWS Aurora.
      type: object
      title: Recover AWS Aurora params.
      required:
      - targetEnvironment
      properties:
        recoverProtectionGroupRunsParams:
          description: Specifies the Protection Group Runs params to recover. All the Aurora instances that are successfully backed up by specified Runs will be recovered. This can be specified along with individual snapshots of Aurora instances. User has to make sure specified Object snapshots and Protection Group Runs should not have any intersection. For example, user cannot specify multiple Runs which has same Object or an Object snapshot and a Run which has same Object's snapshot.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverProtectionGroupRunParams'
          x-order: 0
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kAWS
          x-order: 1
        awsTargetParams:
          description: Specifies the params for recovering to an AWS target.
          allOf:
          - $ref: '#/components/schemas/AwsTargetParamsForRecoverAurora'
          - {}
          x-order: 2
    CouchbaseParams:
      description: Specifies the recovery options specific to Couchbase environment.
      type: object
      title: Recover Couchbase environment params.
      required:
      - recoveryAction
      - recoverCouchbaseParams
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverObjects
          x-order: 0
        recoverCouchbaseParams:
          description: Specifies the parameters to recover Couchbase objects.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/RecoverCouchbaseParams'
          - {}
          x-order: 1
          $ref: '#/components/schemas/RecoverCouchbaseParams'
    AAGInfo:
      description: Object details for Mssql.
      type: object
      properties:
        objectId:
          description: Specifies the AAG object Id.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        name:
          description: Specifies the AAG name.
          type:
          - string
          - 'null'
          x-order: 1
    AzureTargetParamsForRecoverFileAndFolder:
      description: Specifies the parameters for an Azure files and folders recovery target.
      type: object
      title: Azure Target Params for Recover Files
      required:
      - recoverToOriginalTarget
      properties:
        recoverToOriginalTarget:
          description: Specifies whether to recover to the original target. If true, originalTargetConfig must be specified. If false, newTargetConfig must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        originalTargetConfig:
          description: Specifies the configuration for recovering to the original target.
          allOf:
          - $ref: '#/components/schemas/AzureRecoverFilesOriginalTargetConfig'
          - {}
          x-order: 1
        newTargetConfig:
          description: Specifies the configuration for recovering to a new target.
          allOf:
          - $ref: '#/components/schemas/AzureRecoverFilesNewTargetConfig'
          - {}
          x-order: 2
        overwriteExisting:
          description: Specifies whether to overwrite the existing files. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveAttributes:
          description: Specifies whether to preserve original file/folder attributes. Default is true.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the objects encounters an error. Default is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered files and folders. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 6
    Tenant:
      description: Specifies a tenant object.
      type: object
      title: Tenant
      properties:
        id:
          description: Specifies the id of the tenant.
          type:
          - string
          - 'null'
          x-order: 0
        name:
          description: Specifies the name of the tenant.
          type:
          - string
          - 'null'
          x-order: 1
    RecoverVmwareVAppParams:
      description: Specifies the parameters to recover VMware vApp.
      type: object
      title: Recover VMware vApp params.
      required:
      - targetEnvironment
      properties:
        targetEnvironment:
          description: Specifies the environment of the recovery target. The corresponding params below must be filled out.
          type: string
          enum:
          - kVMware
          x-order: 0
        vmwareTargetParams:
          description: Specifies the params for recovering to a VMware target.
          allOf:
          - $ref: '#/components/schemas/VmwareTargetParamsForRecoverVApp'
          - {}
          x-order: 1
    ViewOptions:
      description: Specifies the parameters related to the Exchange restore of type view. All the files related to one database are cloned to a view and the view can be used by third party tools like Kroll, etc. to restore exchange databases.
      type: object
      title: View Options
      properties:
        whitelistRestoreViewForAll:
          description: Whether to white-list the Exchange restore view for all the IP addresses
          type:
          - boolean
          - 'null'
          x-order: 0
        viewName:
          description: The name of the view.
          type:
          - string
          - 'null'
          x-order: 1
        mountPoint:
          description: The path of the SMB share.
          type:
          - string
          - 'null'
          x-order: 2
    CommonNoSqlRecoveryOptions:
      description: Specifies the common properties required by all Nosl adapters at the time of recovery.
      properties:
        recoverTo:
          description: Specifies the 'Source Registration ID' of the source where the objects are to be recovered. If this is not specified, the recovery job will recover to the original location.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 0
        overwrite:
          description: Set to true to overwrite an existing object at the destination. If set to false, and the same object exists at the destination, then recovery will fail for that object.
          type:
          - boolean
          - 'null'
          x-order: 1
        concurrency:
          description: Specifies the maximum number of concurrent IO Streams that will be created to exchange data with the cluster.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 2
        bandwidthMBPS:
          description: Specifies the maximum network bandwidth that each concurrent IO Stream can use for exchanging data with the cluster.
          type:
          - integer
          - 'null'
          format: int64
          x-order: 3
        warnings:
          description: This field will hold the warnings in cases where the job status is SucceededWithWarnings.
          type:
          - array
          - 'null'
          items:
            type: string
          x-order: 4
          readOnly: true
    RecoverNetappToNetappFilesTargetParams:
      description: Specifies the params of the Netapp recovery target.
      type: object
      title: Recover Netapp To Netapp Files Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Netapp target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the files will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToNetappFilesTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if files are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalNetappFilesTargetParams'
          - {}
          x-order: 2
    RecoverVmwareVmOriginalSourceNetworkConfig:
      description: Specifies the network config parameters to be applied for VMware VMs if recovering to original Source.
      type: object
      title: Recover VMware VMs Original Source Network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. All the other networking parameters set will be ignored if set to true. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
        disableNetwork:
          description: Specifies whether the attached network should be left in disabled state. Default is false.
          type:
          - boolean
          - 'null'
          x-order: 1
    VmwareTargetParamsForRecoverVM:
      description: Specifies the parameters for a VMware recovery target.
      type: object
      title: VMware Target Params.
      properties:
        renameRecoveredVmsParams:
          description: Specifies params to rename the VMs that are recovered. If not specified, the original names of the VMs are preserved.
          allOf:
          - $ref: '#/components/schemas/RecoveredOrClonedVmsRenameConfig'
          - {}
          x-order: 0
        recoveryTargetConfig:
          description: Specifies the recovery target configuration if recovery has to be done to a different location which is different from original source or to original Source with different configuration. If not specified, then the recovery of the vms will be performed to original location with all configuration parameters retained.
          allOf:
          - $ref: '#/components/schemas/VmwareVmRecoveryTargetConfig'
          - {}
          x-order: 1
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 2
        powerOnVms:
          description: Specifies whether to power on vms after recovery. If not specified, or false, recovered vms will be in powered off state.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other vms if one of vms failed to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        recoveryProcessType:
          description: Specifies type of Recovery Process to be used. InstantRecovery/CopyRecovery etc... Default value is InstantRecovery.
          type: string
          enum:
          - InstantRecovery
          - CopyRecovery
          x-order: 5
        attemptDifferentialRestore:
          description: Specifies whether to attempt differential restore.
          type:
          - boolean
          - 'null'
          x-order: 6
        overwriteExistingVm:
          description: Specifies whether to overwrite the VM at the target location. This is a data destructive operation and if this is selected, the original VM may no longer be accessible. This option is only applicable if renameRecoveredVmParams is null and powerOffAndRenameExistingVm is false. This option is not supported for vApp or vApp template recoveries. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 7
        powerOffAndRenameExistingVm:
          description: Specifies whether to power off and mark the VM at the target location as deprecated. As an example, <vm_name> will be renamed to deprecated::<vm_name>, and a new VM with the name <vm_name> in place of the now deprecated VM. Both deprecated::<vm_name> and <vm_name> will exist on the primary, but the corresponding protection job will only backup <vm_name> on its next run. Only applicable if renameRecoveredVmParams is null and overwriteExistingVm is false. This option is not supported for vApp or vApp template recoveries. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 8
    RecoverIsilonParams:
      description: Specifies the recovery options specific to Isilon environment.
      type: object
      title: Recover Isilon Params.
      required:
      - objects
      - recoveryAction
      properties:
        objects:
          description: Specifies the list of recover Object parameters.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
          x-order: 0
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverNasVolume
          - RecoverFiles
          x-order: 1
        recoverNasVolumeParams:
          description: Specifies the parameters to recover NAS Volumes.
          allOf:
          - $ref: '#/components/schemas/RecoverIsilonNasVolumeParams'
          - {}
          x-order: 2
        recoverFileAndFolderParams:
          description: Specifies the parameters to recover files.
          allOf:
          - $ref: '#/components/schemas/RecoverIsilonFilesParams'
          - {}
          x-order: 3
        downloadFileAndFolderParams:
          description: Specifies the parameters to download files and folders.
          allOf:
          - $ref: '#/components/schemas/CommonDownloadFileAndFolderParams'
          - {}
          x-order: 4
    RecoverOtherNasToGenericNasFilesTargetParams:
      description: Specifies the params of the Generic Nas recovery target.
      type: object
      title: Recover To Generic Nas Files Target Params.
      required:
      - volume
      - alternatePath
      properties:
        volume:
          description: Specifies the id and name of the parent NAS to recover to. This volume will be the target of the recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverTarget'
          - {}
          x-order: 0
        parentSource:
          description: Specifies the id of the parent source of the recovery target.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          - readOnly: true
          x-order: 1
        alternatePath:
          description: Specifies the path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 2
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 4
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 5
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 6
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    RecoverSqlAppOriginalSourceConfig:
      description: Specifies the additional Source configuration parameters when databases will be recovered to original location.
      type: object
      title: Recover Sql App New Source Config.
      allOf:
      - $ref: '#/components/schemas/CommonSqlAppSourceConfig'
      properties:
        dataFileDirectoryLocation:
          description: Specifies the directory where to put the database data files. Missing directory will be automatically created. If you are overwriting the existing database then this field will be ignored.
          type:
          - string
          - 'null'
          x-order: 0
        logFileDirectoryLocation:
          description: Specifies the directory where to put the database log files. Missing directory will be automatically created. If you are overwriting the existing database then this field will be ignored.
          type:
          - string
          - 'null'
          x-order: 1
        captureTailLogs:
          description: Set this to true if tail logs are to be captured before the recovery operation. This is only applicable if database is not being renamed.
          type:
          - boolean
          - 'null'
          x-order: 2
        newDatabaseName:
          description: Specifies a new name for the restored database. If this field is not specified, then the original database will be overwritten after recovery.
          type:
          - string
          - 'null'
          x-order: 3
    RecoverUdaObjectParams:
      description: Specifies details of objects to be recovered.
      type: object
      properties:
        objectName:
          description: Specifies the fully qualified name of the object to be restored.
          type:
          - string
          - 'null'
          x-order: 0
        overwrite:
          description: Set to true to overwrite an existing object at the destination. If set to false, and the same object exists at the destination, then recovery will fail for that object.
          type:
          - boolean
          - 'null'
          x-order: 1
        renameTo:
          description: Specifies the new name to which the object should be renamed to after the recovery.
          type:
          - string
          - 'null'
          x-order: 2
    ExchangeDatabaseRecoveryTargetConfig:
      description: Specifies the target object parameters to recover Exchange database.
      type: object
      title: Exchange database Recovery Target Config.
      required:
      - source
      properties:
        source:
          description: Specifies the id of the physical source to which the exchange database will be recovered.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
    CassandraParams:
      description: Specifies the recovery options specific to Cassandra environment.
      type: object
      title: Recover Cassandra environment params.
      required:
      - recoveryAction
      - recoverCassandraParams
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverObjects
          x-order: 0
        recoverCassandraParams:
          description: Specifies the parameters to recover Cassandra objects.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/RecoverCassandraParams'
          - {}
          x-order: 1
          $ref: '#/components/schemas/RecoverCassandraParams'
    OriginalNetappFilesTargetParams:
      description: Specifies the params of the original Netapp recovery target.
      type: object
      title: Recover To Original Netapp Files Target Params.
      required:
      - recoverToOriginalPath
      properties:
        recoverToOriginalPath:
          description: Specifies whether to recover files and folders to the original path location. If false, alternatePath must be specified.
          type:
          - boolean
          - 'null'
          x-order: 0
        alternatePath:
          description: Specifies the alternate path location to recover files to.
          type:
          - string
          - 'null'
          x-order: 1
        overwriteExistingFile:
          description: Specifies whether to overwrite existing file/folder during recovery.
          type:
          - boolean
          - 'null'
          x-order: 2
        preserveFileAttributes:
          description: Specifies whether to preserve file/folder attributes during recovery.
          type:
          - boolean
          - 'null'
          x-order: 3
        continueOnError:
          description: Specifies whether to continue recovering other files if one of the files fails to recover. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 4
        encryptionEnabled:
          description: Specifies whether encryption should be enabled during recovery.
          type:
          - boolean
          - 'null'
          x-order: 5
        filterIpConfig:
          description: Specifies the list of IP addresses that are allowed or denied during recovery. Allowed IPs and Denied IPs cannot be used together.
          type:
          - object
          - 'null'
          x-order: 6
          $ref: '#/components/schemas/FilterIpConfig'
        vlanConfig:
          description: 'Specifies VLAN settings associated with the restore. If this is not specified, then the VLAN params will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for restores.'
          x-order: 7
          $ref: '#/components/schemas/RecoveryVlanConfig'
    MountedVolumeMapping:
      description: Specifies the mapping of original volume and mounted volume after Instant Volume Mount.
      properties:
        originalVolume:
          description: Specifies the name of the original volume.
          type:
          - string
          - 'null'
          x-order: 0
        mountedVolume:
          description: Specifies the name of the point where the volume is mounted.
          type:
          - string
          - 'null'
          x-order: 1
        fileSystemType:
          description: Specifies the type of the file system of the volume.
          type:
          - string
          - 'null'
          x-order: 2
    RecoverHdfsSnapshotParams:
      description: Specifies the snapshot parameters for a protected Hdfs object.
      title: Recover Hdfs Snapshot Params.
      allOf:
      - $ref: '#/components/schemas/CommonRecoverObjectSnapshotParams'
      - type: object
        properties:
          objects:
            description: Specifies details of objects to be recovered.
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/RecoverHdfsNoSqlObjectParams'
            x-order: 0
    RecoverVmwareVmNewSourceNetworkConfig:
      description: Specifies the network config parameters to be applied to VMware VMs if recovering to new Source.
      type: object
      title: Recover VMware VMs New Source Network configuration.
      properties:
        detachNetwork:
          description: If this is set to true, then the network will be detached from the recovered VMs. All the other networking parameters set will be ignored if set to true. Default value is false.
          type:
          - boolean
          - 'null'
          x-order: 0
        newNetworkConfig:
          description: Specifies a new network configuration for the VM recovery.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmNewNetworkConfig'
          - {}
          x-order: 1
    AzureTiers:
      description: Specifies Azure tiers.
      type: object
      required:
      - tiers
      properties:
        tiers:
          description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
          type:
          - array
          - 'null'
          minLength: 1
          items:
            $ref: '#/components/schemas/AzureTier'
          x-order: 0
    RecoveryVlanConfig:
      description: Specifies the VLAN configuration for Recovery.
      type: object
      title: Recovery VLAN config.
      properties:
        id:
          description: If this is set, then the Cohesity host name or the IP address associated with this vlan is used for mounting Cohesity's view on the remote host.
          type:
          - integer
          - 'null'
          format: int32
          x-order: 0
        disableVlan:
          description: If this is set to true, then even if VLANs are configured on the system, the partition VIPs will be used for the Recovery.
          type:
          - boolean
          - 'null'
          x-order: 1
        interfaceName:
          description: Interface group to use for Recovery.
          type:
          - string
          - 'null'
          x-order: 2
          readOnly: true
    AWSTier:
      description: Specifies the settings for a aws tier.
      type: object
      allOf:
      - $ref: '#/components/schemas/CommonCloudTierSettings'
      - type: object
        required:
        - tierType
        properties:
          tierType:
            description: Specifies the AWS tier types.
            type:
            - string
            - 'null'
            enum:
            - kAmazonS3Standard
            - kAmazonS3StandardIA
            - kAmazonS3OneZoneIA
            - kAmazonS3IntelligentTiering
            - kAmazonS3Glacier
            - kAmazonS3GlacierDeepArchive
            x-order: 0
    RecoverGenericNasToGenericNasVolumeTargetParams:
      description: Specifies the params of the Generic NAS recovery target.
      type: object
      title: Recover Generic NAS To Generic NAS Volume Target Params.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or the original Generic NAS target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the volumes will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverOtherNasToGenericNasVolumeTargetParams'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if volumes are being recovered to original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/OriginalGenericNasTargetParams'
          - {}
          x-order: 2
    RecoverVmwareVmVCDSourceConfig:
      description: Specifies the new destination Source configuration where the VMs will be recovered for vCloudDirector sources.
      type: object
      title: Recover VMware VMs vCloudDirector Source Config.
      required:
      - source
      - vdc
      properties:
        source:
          description: Specifies the id of the parent source to recover the VMs.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        vdc:
          description: Specifies the VDC object where the recovered objects will be attached.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 1
        vApp:
          description: Specifies the vApp object where the recovered objects will be attached.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 2
        datastores:
          description: Specifies the datastore objects where the object's files should be recovered to. This should only be specified if storageProfile is not specified.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoveryObjectIdentifier'
          x-order: 3
        storageProfile:
          description: Specifies the storage profile to which the objects should be recovered. This should only be specified if datastores are not specified.
          allOf:
          - $ref: '#/components/schemas/VcdStorageProfileParams'
          - {}
          x-order: 4
        networkConfig:
          description: Specifies the networking configuration to be applied to the recovered VMs.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmNewSourceNetworkConfig'
          - {}
          x-order: 5
        orgVdcNetwork:
          description: Specifies the VDC organization network which will be attached with recoverd VM.
          type: object
          x-order: 6
          $ref: '#/components/schemas/OrgVDCNetwork'
    HdfsParams:
      description: Specifies the recovery options specific to HDFS environment.
      type: object
      title: Recover HDFS environment params.
      required:
      - recoveryAction
      - recoverHdfsParams
      properties:
        recoveryAction:
          description: Specifies the type of recover action to be performed.
          type: string
          enum:
          - RecoverObjects
          x-order: 0
        recoverHdfsParams:
          description: Specifies the parameters to recover HDFS objects.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/RecoverHdfsParams'
          - {}
          x-order: 1
          $ref: '#/components/schemas/RecoverHdfsParams'
    VmwareVmRecoveryTargetConfig:
      description: Specifies the target object parameters to recover VMware vms.
      type: object
      title: Vmware VMs Recovery Target Config.
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies the parameter whether the recovery should be performed to a new or an existing Source Target.
          type: boolean
          x-order: 0
        newSourceConfig:
          description: Specifies the new destination Source configuration parameters where the VMs will be recovered. This is mandatory if recoverToNewSource is set to true.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmNewSourceConfig'
          - {}
          x-order: 1
        originalSourceConfig:
          description: Specifies the Source configuration if VM's are being recovered to Original Source. If not specified, all the configuration parameters will be retained.
          allOf:
          - $ref: '#/components/schemas/RecoverVmwareVmOriginalSourceConfig'
          - {}
          x-order: 2
    PhysicalTargetParamsForRecoverVolume:
      description: Specifies the parameters for a physical recovery target.
      type: object
      title: Physical Recovery Target Params
      required:
      - mountTarget
      - volumeMapping
      properties:
        mountTarget:
          description: Specifies the target entity where the volumes are being mounted.
          allOf:
          - $ref: '#/components/schemas/RecoveryObjectIdentifier'
          - {}
          x-order: 0
        volumeMapping:
          description: Specifies the mapping from source volumes to destination volumes.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecoverVolumeMapping'
          x-order: 1
        forceUnmountVolume:
          description: Specifies whether volume would be dismounted first during LockVolume failure. If not specified, default is false.
          type:
          - boolean
          - 'null'
          x-order: 2
        vlanConfig:
          description: 'Specifies VLAN Params associated with the recovered. If this is not specified, then the VLAN settings will be automatically selected from one of the below options: a. If VLANs are configured on Cohesity, then the VLAN host/VIP will be automatically based on the client''s (e.g. ESXI host) IP address. b. If VLANs are not configured on Cohesity, then the partition hostname or VIPs will be used for Recovery.'
          allOf:
          - $ref: '#/components/schemas/RecoveryVlanConfig'
          - {}
          x-order: 3
    KubernetesNamespaceRecoveryTargetConfig:
      description: Specifies the recovery target configuration of the Namespace recovery.
      type: object
      title: Kubernetes Namespace Recovery Target Config
      required:
      - recoverToNewSource
      properties:
        recoverToNewSource:
          description: Specifies whether or not to recover the Namespaces to a different source than they were backed up from.
          type:
          - boolean
          - 'null'
          x-order: 0
        newSourceConfig:
          description: Specifies the new source configuration if a Kubernetes Namespace is being restored to a different source than the one from which it was protected.
          allOf:
          - $ref: '#/components/schemas/KubernetesNamespaceRecoveryNewSourceConfig'
          - {}
          x-order: 1
    RecoverVolumeMapping:
      description: Specifies the mapping from a source volume to a destination volume.
      type: object
      title: Recover Volume Mapping
      required:
      - sourceVolumeGuid
      - destinationVolumeGuid
      properties:
        sourceVolumeGuid:
          description: Specifies the guid of the source volume.
          type:
          - string
          - 'null'
          x-order: 0
        destinationVolumeGuid:
          description: Specifies the guid of the destination volume.
          type:
          - string
          - 'null'
          x-order: 1
  responses:
    ErrorResponse:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CreateDownloadFilesAndFoldersRecoveryResponse:
      description: Success
      content:
        application/json:
          schema:
            x-cohesity-discriminator-ref: DownloadFilesAndFoldersResponseParams
            $ref: '#/components/schemas/Recovery'
    NoContentResponse:
      description: No Content
    CreateRecoveryResponse:
      description: Success
      content:
        application/json:
          schema:
            x-cohesity-discriminator-ref: CommonRecoveryResponseParams
            $ref: '#/components/schemas/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    GetRecovery:
      description: Success
      content:
        application/json:
          schema:
            x-cohesity-discriminator-ref: CommonRecoveryResponseParams
            $ref: '#/components/schemas/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    GetRecoveries:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Recoveries'
  securitySchemes:
    APIKeyHeader:
      in: header
      name: apiKey
      type: apiKey