consumes:
- application/json
produces:
- application/json
schemes:
- https
swagger: '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 API
  version: '2.0'
basePath: /v2
paths:
  /active-directories:
    get:
      description: Get the list of Active Directories.
      tags:
      - ActiveDirectory
      summary: Get the list of Active Directories.
      operationId: GetActiveDirectory
      parameters:
      - type: array
        items:
          pattern: ^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$
          type: string
        description: Filter by a list of Active Directory domain names.
        name: domainNames
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Filter by a list of Active Directory Ids.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Groups which were
          created by all tenants which the current user has permission to see. If
          false, then only Protection Groups created by the current user will be returned.
        name: includeTenants
        in: query
      responses:
        '200':
          $ref: '#/responses/GetActiveDirectoriesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: &id001
      - APIKeyHeader: []
    post:
      description: Create an Active Directory.
      tags:
      - ActiveDirectory
      summary: Create an Active Directory.
      operationId: CreateActiveDirectory
      parameters:
      - description: Specifies the parameters to create an Active Directory.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateActiveDirectoryRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateActiveDirectoryResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /active-directories/{id}:
    get:
      description: Get an Active Directory by id.
      tags:
      - ActiveDirectory
      summary: Get an Active Directory by id.
      operationId: GetActiveDirectoryById
      parameters:
      - type: integer
        format: int64
        description: Specifies id of an Active Directory.
        name: id
        in: path
        required: true
      - type: boolean
        description: Specifies whether to include Centrify Zones of the Active Directory
          in response.
        name: includeCentrifyZones
        in: query
      - type: boolean
        description: Specifies whether to include Domain Controllers of the Active
          Directory in response.
        name: includeDomainControllers
        in: query
      - type: boolean
        description: Specifies whether to include Security Principals of the Active
          Directory in response.
        name: includeSecurityPrincipals
        in: query
      - type: string
        description: Specifies a prefix, only security principals with name or sAMAccountName
          having this prefix (ignoring cases) will be returned. This field is appliciable
          and mandatory if 'includeSecurityPrincipals' is set to true.
        name: prefix
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - User
          - Group
          - Computer
          - WellKnownPrincipal
          type: string
        description: Specifies a list of object classes, only security principals
          with object class in this list will be returned. This field is appliciable
          if 'includeSecurityPrincipals' is set to true.
        name: objectClass
        in: query
      responses:
        '200':
          $ref: '#/responses/GetActiveDirectoryByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update an Active Directory.
      tags:
      - ActiveDirectory
      summary: Update an Active Directory.
      operationId: UpdateActiveDirectory
      parameters:
      - type: integer
        format: int64
        description: Specifies id of an Active Directory.
        name: id
        in: path
        required: true
      - description: Request to update an Active Directory.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateActiveDirectoryRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateActiveDirectoryResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete an Active Directory.
      tags:
      - ActiveDirectory
      summary: Delete an Active Directory.
      operationId: DeleteActiveDirectory
      parameters:
      - type: integer
        format: int64
        description: Specifies id of an Active Directory.
        name: id
        in: path
        required: true
      - type: string
        description: Specifies the username of the Active Direcotry Admin.
        name: activeDirectoryAdminUsername
        in: header
        required: true
      - type: string
        description: Specifies the password of the Active Direcotry Admin.
        name: activeDirectoryAdminPassword
        in: header
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /alertsSummary:
    get:
      description: Get alerts summary grouped by category.
      tags:
      - Platform
      summary: Get alerts summary.
      operationId: GetAlertSummary
      parameters:
      - type: integer
        format: int64
        description: Filter by start time. Specify the start time as a Unix epoch
          Timestamp (in microseconds). By default it is current time minus a day.
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Filter by end time. Specify the end time as a Unix epoch Timestamp
          (in microseconds). By default it is current time.
        name: endTimeUsecs
        in: query
      - type: boolean
        x-nullable: true
        description: 'IncludeTenants specifies if alerts of all the tenants under
          the

          hierarchy of the logged in user''s organization should be used to

          compute summary.'
        name: includeTenants
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: 'TenantIds contains ids of the tenants for which alerts are to
          be

          used to compute summary.'
        name: tenantIds
        in: query
      - type: array
        items:
          enum:
          - kResolved
          - kOpen
          - kNote
          - kSuppressed
          type: string
        x-nullable: true
        description: 'Specifies list of alert states to filter alerts by. If not specified,

          only open alerts will be used to get summary.'
        name: statesList
        in: query
      responses:
        '200':
          $ref: '#/responses/GetAlertsSummary'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs:
    get:
      description: Get a cluster audit logs.
      tags:
      - AuditLog
      summary: Get cluster audit logs.
      operationId: GetAuditLogs
      parameters:
      - type: string
        x-nullable: true
        description: Search audit logs by 'entityName' or 'details'.
        name: searchString
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies a list of usernames, only audit logs made by these
          users will be returned.
        name: usernames
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies a list of domains, only audit logs made by user in
          these domains will be returned.
        name: domains
        in: query
      - type: array
        items:
          enum:
          - ClusterPartition
          - StorageDomain
          - View
          - Share
          - Node
          - Disk
          - Cluster
          - Vlan
          - User
          - ApiKey
          - Chassis
          - SslCertificate
          - ProtectionGroup
          - Source
          - RecoveryTask
          - SmtpServer
          - EncryptionKey
          - ProtectionPolicy
          - Alert
          - Resolution
          - AlertNotificationRule
          - Vault
          - RemoteCluster
          - ActiveDirectory
          - KerberosProvider
          - Ldap
          - AntivirusServiceGroup
          - InfectedFile
          - PreferredDomainController
          - Group
          - Role
          - ProtectionRun
          - SearchJob
          - PhysicalAgent
          - CloneTask
          - CloneRefreshTask
          - Network
          - Interface
          - NetworkInerfaceGroup
          - Scheduler
          - ProxyServer
          - StaticRoute
          - Ip
          - Qos
          - KmsConfiguration
          - CloudSpin
          - Tenant
          - IdpConfiguration
          - App
          - HeliosEvent
          - Object
          - ClusterServices
          - AccessToken
          - SnmpConfig
          - IoTier
          - ServiceFlag
          - SupportServer
          - Csr
          - Keystone
          - SwiftRoles
          - Tags
          - Nis
          - Snapshot
          - HybridExtender
          - DataTieringAnalysisGroup
          - DataTieringDowntierTask
          - DataTieringUptierTask
          - TrustedCA
          - AMQPTargetConfiguration
          - Patch
          - Hotfix
          type: string
        x-nullable: true
        description: Specifies a list of entity types, only audit logs containing
          these entity types will be returned.
        name: entityTypes
        in: query
      - type: array
        items:
          enum:
          - Login
          - Logout
          - Create
          - Modify
          - Delete
          - Activate
          - Deactivate
          - Pause
          - Resume
          - RunNow
          - Clone
          - Recover
          - Cancel
          - Register
          - Unregister
          - Update
          - Refresh
          - Upgrade
          - Upload
          - Download
          - Rename
          - Accept
          - Mark
          - Close
          - Join
          - DisJoin
          - Overwrite
          - MarkRemoval
          - CloudSpin
          - Assign
          - Unassign
          - NotificationRule
          - ScheduleReport
          - Install
          - Uninstall
          - Stop
          - Start
          - Restart
          - RunDiagnostics
          - Apply
          - Revert
          - Import
          - Validate
          type: string
        x-nullable: true
        description: Specifies a list of actions, only audit logs containing these
          actions will be returned.
        name: actions
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies a unix timestamp in microseconds, only audit logs made
          after this time will be returned.
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies a unix timestamp in microseconds, only audit logs made
          before this time will be returned.
        name: endTimeUsecs
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies a list of tenant ids, only audit logs made by these
          tenants will be returned.
        name: tenantIds
        in: query
      - type: boolean
        x-nullable: true
        description: If true, the response will include Protection Groups which were
          created by all tenants which the current user has permission to see. If
          false, then only Protection Groups created by the current user will be returned.
        name: includeTenants
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies a start index. The oldest logs before this index will
          skipped, only audit logs from this index will be fetched.
        name: startIndex
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the number of indexed obejcts to be fetched from the
          specified start index.
        name: count
        in: query
      responses:
        '200':
          $ref: '#/responses/GetAuditLogsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs/actions:
    get:
      description: Get all actions of cluster audit logs.
      tags:
      - AuditLog
      summary: Get cluster audit logs actions.
      operationId: GetAuditLogsActions
      responses:
        '200':
          $ref: '#/responses/GetAuditLogsActionsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs/entity-types:
    get:
      description: Get all entity types of cluster audit logs.
      tags:
      - AuditLog
      summary: Get cluster audit logs entity types.
      operationId: GetAuditLogsEntityTypes
      responses:
        '200':
          $ref: '#/responses/GetAuditLogsEntityTypesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs/filer-configs:
    get:
      description: Get filer audit log configs.
      tags:
      - AuditLog
      summary: Get filer audit log configs.
      operationId: GetFilerAuditLogConfigs
      responses:
        '200':
          $ref: '#/responses/GetFilerAuditLogConfigsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update filer audit log configs.
      tags:
      - AuditLog
      summary: Update filer audit log configs.
      operationId: UpdateFilerAuditLogConfigs
      parameters:
      - description: Specifies the filer audit log config to update.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/FilerAuditLogConfigs'
      responses:
        '200':
          $ref: '#/responses/GetFilerAuditLogConfigsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /chassis:
    get:
      description: Get list of all chassis info that are part of cluster.
      tags:
      - Platform
      summary: Get list of chassis
      operationId: GetChassis
      parameters:
      - type: boolean
        description: Filters chassis that have no rack assigned.
        name: noRackAssigned
        in: query
      responses:
        '200':
          $ref: '#/responses/ChassisListResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /chassis/{id}:
    get:
      description: Get a chassis info by id.
      tags:
      - Platform
      summary: Get a chassis by chassis id.
      operationId: GetChassisById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of chassis.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/ChassisResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    patch:
      description: Update selected properties of chassis info by id.
      tags:
      - Platform
      summary: Update a chassis by chassis id.
      operationId: UpdateChassisById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of chassis.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update chassis.
        name: body
        in: body
        schema:
          $ref: '#/definitions/Chassis'
      responses:
        '200':
          $ref: '#/responses/ChassisResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clientcsr:
    post:
      description: Create two Certificate Signing Request on the cluster with the
        given details one each for client and server. Each service can have at most
        one outstanding pair of CSR.
      tags:
      - Security
      summary: Create Certificate Signing Requests on the cluster.
      operationId: CreateClientcsr
      parameters:
      - description: Specifies the parameters to create the Certificate Signing Requests.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateCsrRequest'
      responses:
        '201':
          $ref: '#/responses/CreateClientcsrResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clientcsr/certificate:
    post:
      description: Import the signed certificates on the cluster after the Certificate
        Signing Requests are created.
      tags:
      - Security
      summary: Import the signed certificates on the cluster after the Certificate
        Signing Requests are created.
      operationId: ImportCertificateByClientcsr
      parameters:
      - description: Specifies the parameters to import the certificate.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImportCertificateByClientcsrRequest'
      responses:
        '200':
          $ref: '#/responses/ImportCertificateByClientcsrResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clusters:
    get:
      description: Retrieve some summary information about the Cluster Configuration.
      tags:
      - Platform
      summary: Retrieve Cluster Configuration
      operationId: GetCluster
      responses:
        '200':
          $ref: '#/responses/ClusterResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update the Cluster with the given configuration.
      tags:
      - Platform
      summary: Update a cluster.
      operationId: UpdateCluster
      parameters:
      - description: Specifies the parameters to update cluster.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Cluster'
      responses:
        '200':
          $ref: '#/responses/ClusterResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a cluster with given network and cluster configuration.
      tags:
      - Platform
      summary: Create a cluster.
      operationId: CreateCluster
      parameters:
      - description: Specifies the parameters to create cluster.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateClusterParams'
      responses:
        '201':
          $ref: '#/responses/ClusterResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clusters/amqp-target-config:
    get:
      description: Fetch AMQP target config on the cluster.
      tags:
      - Platform
      summary: Get AMQP Target Config
      operationId: GetAMQPTargetConfig
      responses:
        '200':
          $ref: '#/responses/ClusterAMQPTargetConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Updates AMQP target config on the cluster.
      tags:
      - Platform
      summary: Update AMQP Target Config
      operationId: UpdateAMQPTargetConfig
      parameters:
      - description: Specifies the parameters to update cluster AMQP target config.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ClusterAMQPTargetConfig'
      responses:
        '200':
          $ref: '#/responses/ClusterAMQPTargetConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete AMQP target config on the cluster.
      tags:
      - Platform
      summary: Delete AMQP Target Config
      operationId: DeleteAMQPTargetConfig
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-bifrost:
    get:
      description: Get connections of Bifrost on the cluster.
      tags:
      - ExternalConnection
      summary: Get connections of Bifrost on the cluster.
      operationId: GetBifrostConnection
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connections.
        name: ids
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connection belongs to.
        name: tenantId
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connections.
        name: names
        in: query
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a connection of Bifrost on the cluster.
      tags:
      - ExternalConnection
      summary: Create a connection of Bifrost on the cluster.
      operationId: CreateBifrostConnection
      parameters:
      - description: Specifies the parameters to create a connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectionRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateBifrostConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-bifrost/{id}:
    get:
      description: Get a connection of Bifrost by the id.
      tags:
      - ExternalConnection
      summary: Get a connection of Bifrost by the id.
      operationId: GetBifrostConnectionById
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Bifrost connection.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectionByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a connection of Bifrost.
      tags:
      - ExternalConnection
      summary: Update a connection of Bifrost.
      operationId: UpdateBifrostConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of a Bifrost connection.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectionRequest'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateBifrostConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a connection of Bifrost.
      tags:
      - ExternalConnection
      summary: Delete a connection of Bifrost.
      operationId: DeleteBifrostConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of a Bifrost connection.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-rigel:
    get:
      description: Get connections of Rigel on the cluster.
      tags:
      - ExternalConnection
      summary: Get connections of Rigel on the cluster.
      operationId: GetRigelConnection
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connections.
        name: ids
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connection belongs to.
        name: tenantId
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connection.
        name: names
        in: query
      responses:
        '200':
          $ref: '#/responses/GetRigelConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a connection of Rigel on the cluster.
      tags:
      - ExternalConnection
      summary: Create a connection of Rigel on the cluster.
      operationId: CreateRigelConnection
      parameters:
      - description: Specifies the parameters to create a connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateRigelConnectionRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateRigelConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-rigel/{id}:
    get:
      description: Get a connection of Rigel by the id.
      tags:
      - ExternalConnection
      summary: Get a connection of Rigel by the id.
      operationId: GetRigelConnectionById
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Rigel connection.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetRigelConnectionByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a connection of Rigel.
      tags:
      - ExternalConnection
      summary: Update a connection of Rigel.
      operationId: UpdateRigelConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Rigel connection.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update the connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateRigelConnectionRequest'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateRigelConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a connection of Rigel.
      tags:
      - ExternalConnection
      summary: Delete a connection of Rigel.
      operationId: DeleteRigelConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Rigel connection.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connector-hybrid-extender:
    get:
      description: Get Bifrost connectors on the cluster.
      tags:
      - Connectors
      summary: Get Bifrost connectors on the cluster.
      operationId: GetBifrostConnector
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connectors.
        name: ids
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connectors.
        name: names
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connector belongs to.
        name: tenantId
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the Id of the connection which the connector belongs
          to.
        name: connectionId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a Bifrost connector on the cluster.
      tags:
      - Connectors
      summary: Create a Bifrost connector on the cluster.
      operationId: CreateBifrostConnector
      parameters:
      - description: Specifies the parameters to create a connector.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectorRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateBifrostConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connector-hybrid-extender/{id}:
    get:
      description: Get a Bifrost connector by the id.
      tags:
      - Connectors
      summary: Get a Bifrost connector by the id.
      operationId: GetBifrostConnectorById
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connector belongs to.
        name: tenantId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectorByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a Bifrost connector.
      tags:
      - Connectors
      summary: Update a Bifrost connector.
      operationId: UpdateBifrostConnector
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a connector.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectorRequest'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateBifrostConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a Bifrost connector.
      tags:
      - Connectors
      summary: Delete a Bifrost connector.
      operationId: DeleteBifrostConnector
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connector-rigel:
    get:
      description: Get Rigel connectors on the cluster.
      tags:
      - Connectors
      summary: Get Rigel connectors on the cluster.
      operationId: GetRigelConnector
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connector.
        name: ids
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connectors.
        name: names
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connector belongs to.
        name: tenantId
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the Id of the connection which the connector belongs
          to.
        name: connectionId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetRigelConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a Rigel connector on the cluster.
      tags:
      - Connectors
      summary: Create a Rigel connector on the cluster.
      operationId: CreateRigelConnector
      parameters:
      - description: Specifies the parameters to create a connector.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateRigelConnectorRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateRigelConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connector-rigel/{id}:
    get:
      description: Get a Rigel connector by the id.
      tags:
      - Connectors
      summary: Get a Rigel connector by the id.
      operationId: GetRigelConnectorById
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connector belongs to.
        name: tenantId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetRigelConnectorByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a Rigel connector.
      tags:
      - Connectors
      summary: Update a Rigel connector.
      operationId: UpdateRigelConnector
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a connector.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateRigelConnectorRequest'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateRigelConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a Rigel connector.
      tags:
      - Connectors
      summary: Delete a Rigel connector.
      operationId: DeleteRigelConnector
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to delete a connector.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DeleteRigelConnectorRequest'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /csr:
    get:
      description: List Certificate Signing Requests on the cluster with service name
        filtering.
      tags:
      - Security
      summary: List Certificate Signing Requests on the cluster.
      operationId: GetCsrList
      parameters:
      - enum:
        - iris
        type: string
        description: Specifies the Cohesity service name for which the CSR is generated.
          If this is not specified, all the csrs on the cluster will be returned.
        name: serviceName
        in: query
      - type: array
        items:
          type: string
        description: Specifies the ids of the csrs. If this is not specified, all
          the csrs on the cluster will be returned.
        name: ids
        in: query
      responses:
        '200':
          $ref: '#/responses/GetCsrListResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a Certificate Signing Request on the cluster with the given
        details. Each service has at most one outstanding CSR.
      tags:
      - Security
      summary: Create a Certificate Signing Request on the cluster.
      operationId: CreateCsr
      parameters:
      - description: Specifies the parameters to create a Certificate Signing Request.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateCsrRequest'
      responses:
        '201':
          $ref: '#/responses/CreateCsrResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /csr/certificate:
    post:
      description: Update the signed certificate on the cluster after a Certificate
        Signing Request is created.
      tags:
      - Security
      summary: Update the signed certificate on the cluster after a Certificate Signing
        Request is created.
      operationId: UpdateCertificateByCsr
      parameters:
      - description: Specifies the parameters to update the certificate.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateCertificateByCsrRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateCertificateByCsrResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /csr/{id}:
    get:
      description: List the specified Certificate Signing Request.
      tags:
      - Security
      summary: List the specified Certificate Signing Request.
      operationId: GetCsrById
      parameters:
      - type: string
        description: Specifies the id of the csr.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetCsrResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a Certificate Signing Request on the cluster.
      tags:
      - Security
      summary: Delete a Certificate Signing Request on the cluster.
      operationId: DeleteCsr
      parameters:
      - type: string
        description: Specifies the id of the csr to be deleted.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/pollPlannedRuns:
    get:
      description: Poll to see whether planned run has been scheduled or not.
      tags:
      - Failover
      summary: Get the list of failover planned runs.
      operationId: PollPlannedRuns
      parameters:
      - type: array
        items:
          type: string
        description: Get runs for specific failover workflows.
        name: failoverIds
        in: query
        required: true
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Groups which were
          created by all tenants which the current user has permission to see. If
          false, then only Protection Groups created by the current user will be returned.
        name: includeTenants
        in: query
      responses:
        '200':
          $ref: '#/responses/FailoverRunsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/views/{id}:
    get:
      description: Get failover tasks of a View.
      tags:
      - Failover
      summary: Get View Failover.
      operationId: GetViewFailover
      parameters:
      - type: integer
        format: int64
        description: Specifies a view id to create an failover task.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetViewFailoverResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a view failover task.
      tags:
      - Failover
      summary: Create View Failover Task.
      operationId: CreateViewFailover
      parameters:
      - type: integer
        format: int64
        description: Specifies a view id to create an failover task.
        name: id
        in: path
        required: true
      - description: Specifies the request body to create failover task.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateViewFailoverRequest'
      responses:
        '201':
          $ref: '#/responses/CreateViewFailoverResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/views/{id}/cancel:
    post:
      description: Cancel an in progress view failover task.
      tags:
      - Failover
      summary: Cancel View Failover Task.
      operationId: CancelViewFailover
      parameters:
      - type: integer
        format: int64
        description: Specifies a view id to cancel it's failover.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/{id}:
    post:
      description: Initiate a failover request.
      tags:
      - Failover
      summary: Initiate a failover request.
      operationId: InitFailover
      parameters:
      - type: string
        description: Specifies the id of the failover workflow.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to initiate a failover. This failover
          request should be intiaited from replication cluster.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/InitFailoverRequest'
      responses:
        '201':
          $ref: '#/responses/InitFailoverResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/{id}/backupActivation:
    post:
      description: Specifies the configuration required for activating backup for
        failover objects on replication cluster. Here orchastrator can call this API
        multiple times as long as full set of object are non-overlapping. They can
        also use the existing job if its compatible to backup failover objects.
      tags:
      - Failover
      summary: Activate failover entity backup on replication clsuter.
      operationId: ReplicationBackupActivation
      parameters:
      - type: string
        description: Specifies the id of the failover workflow.
        name: id
        in: path
        required: true
      - description: Specifies the paramteres to activate the backup of failover entities.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ReplicationBackupActivation'
      responses:
        '201':
          $ref: '#/responses/ReplicationBackupActivationResult'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/{id}/backupDeactivation:
    post:
      description: Specifies the configuration required for deactivating backup for
        failover entities on source cluster.
      tags:
      - Failover
      summary: Deactivate failover entity backup on source clsuter.
      operationId: SourceBackupDeactivation
      parameters:
      - type: string
        description: Specifies the id of the failover workflow.
        name: id
        in: path
        required: true
      - description: Specifies the paramteres to deactivate the backup of failover
          entities.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/SourceBackupDeactivation'
      responses:
        '201':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/{id}/cancel:
    post:
      description: Specifies the request to cancel failover workflow. The cancellation
        request should not be made if '/backupActivation' or '/backupDeactivaetion'
        are already called on replication or source cluster respectively.
      tags:
      - Failover
      summary: Cancel failover workflow.
      operationId: CancelFailover
      parameters:
      - type: string
        description: Specifies the id of the failover workflow.
        name: id
        in: path
        required: true
      responses:
        '201':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/{id}/objectLinkage:
    post:
      description: Specifies the request to link failover objects on replication cluster
        to the replicated entity from source cluster. This linking need to be done
        after perforing recoveries for failed entities on replication cluster. This
        linkage will be useful when merging snapshots of object across replications
        and failovers.
      tags:
      - Failover
      summary: Linking between replicated objects and failover objects
      operationId: ObjectLinkage
      parameters:
      - type: string
        description: Specifies the id of the failover workflow.
        name: id
        in: path
        required: true
      - description: Specifies the paramteres to create links between replicated objects
          and failover objects.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ObjectLinkingRequest'
      responses:
        '201':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/failover/{id}/plannedRun:
    post:
      description: Specifies the configuration required for executing a special run
        as a part of failover workflow. This special run is triggered during palnned
        failover to sync the source cluster to replication cluster with minimum possible
        delta.
      tags:
      - Failover
      summary: Create a planned run for backup and replication.
      operationId: CreatePlannedRun
      parameters:
      - type: string
        description: Specifies the id of the failover workflow.
        name: id
        in: path
        required: true
      - description: Specifies the paramteres to create a planned run while failover
          workflow.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/FailoverRunConfiguration'
      responses:
        '201':
          $ref: '#/responses/FailoverCreateRunResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/filter/objects:
    post:
      description: List all the filtered objects using given regular expressions and
        wildcard supported search strings. We are currenly supporting this for only
        SQL adapter.
      tags:
      - Miscellaneous
      summary: List all the filtered objects.
      operationId: FilterObjects
      parameters:
      - description: Specifies the parameters to filter objects.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/FilterObjectsRequest'
      responses:
        '200':
          $ref: '#/responses/FilterObjectsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects:
    get:
      description: Get Objects Configurations.
      tags:
      - Objects
      summary: Get Objects.
      operationId: GetProtectedObjectsOfAnyType
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        description: Filter by a list of Object ids.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: Filter by Policy ids that are associated with Protected Objects.
        name: policyIds
        in: query
      - type: integer
        format: int64
        description: Filter by Parent Id. Parent id is a unique object Id which may
          contain protected objects underneath in the source tree.
        name: parentId
        in: query
      - type: boolean
        description: If true, the response will include only objects which have been
          protected.
        name: onlyProtectedObjects
        in: query
      - type: integer
        format: int64
        description: Filter by Storage Domain id. Only Objects protected to this Storage
          Domain will be returned.
        name: storageDomainId
        in: query
      - 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
        description: Filter by environment types such as 'kVMware', 'kView', etc.
          Only Protected objects protecting the specified environment types are returned.
        name: environments
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Objects which were protected
          by all tenants which the current user has permission to see. If false, then
          only objects protected by the current user will be returned.
        name: includeTenants
        in: query
      - type: boolean
        description: If true, the response will include information about the last
          protection run on this object.
        name: includeLastRunInfo
        in: query
      - type: boolean
        description: If true, the response will include only the auto protected objects.
        name: onlyAutoProtectedObjects
        in: query
      - type: boolean
        description: If true, the response will include only the leaf level objects.
        name: onlyLeafObjects
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectedObjectsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/actions:
    post:
      description: Specifies the request to perform various actions on multiple objects.
      tags:
      - Objects
      summary: Actions on Objects
      operationId: ObjectsActions
      parameters:
      - description: Specifies the paramteres to execute actions on given list of
          objects.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ObjectsActionRequest'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/last-run:
    get:
      description: Get last protection run of objects.
      tags:
      - Objects
      summary: Get last protection run of objects.
      operationId: GetObjectsLastRun
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of object ids, only last runs for these objects
          will be returned.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Objects which belongs to all
          tenants which the current user has permission to see.
        name: includeTenants
        in: query
      - type: string
        description: Specifies the pagination cookie with which subsequent parts of
          the response can be fetched.
        name: paginationCookie
        in: query
      - type: integer
        format: int32
        description: Specifies the number of objects to be fetched for the specified
          pagination cookie.
        name: count
        in: query
      responses:
        '200':
          $ref: '#/responses/GetObjectsLastRunResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/runs/cancel:
    post:
      description: Cancel object runs for object based protection. This does not apply
        to Group based protection.
      tags:
      - Objects
      summary: Cancel object runs.
      operationId: CancelObjectRuns
      parameters:
      - description: Specifies the parameters to cancel object runs.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CancelObjectRunsRequest'
      responses:
        '207':
          $ref: '#/responses/CancelObjectRunsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}:
    get:
      description: Get Object configrations for given object id.
      tags:
      - Objects
      summary: Get an Object.
      operationId: GetProtectedObjectOfAnyTypeById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Object.
        name: id
        in: path
        required: true
      - type: boolean
        description: If true, the response will include only objects which have been
          protected.
        name: onlyProtectedObjects
        in: query
      - type: integer
        format: int64
        description: Filter by Storage Domain id. Only Objects protected to this Storage
          Domain will be returned.
        name: storageDomainId
        in: query
      - 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
        description: Filter by environment types such as 'kVMware', 'kView', etc.
          Only Protected objects protecting the specified environment types are returned.
        name: environments
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Objects which were protected
          by all tenants which the current user has permission to see. If false, then
          only objects protected by the current user will be returned.
        name: includeTenants
        in: query
      - type: boolean
        description: If true, the response will include information about the last
          protection run on this object.
        name: includeLastRunInfo
        in: query
      - type: boolean
        description: If true, the response will include only the auto protected objects.
        name: onlyAutoProtectedObjects
        in: query
      - type: boolean
        description: If true, the response will include only the leaf level objects.
        name: onlyLeafObjects
        in: query
      responses:
        '200':
          $ref: '#/responses/ProtectedObjectResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/actions:
    post:
      description: Perform an action on an object. Depending on the object environment
        type, different actions are available.
      tags:
      - Objects
      summary: Perform an action on an object.
      operationId: PerformActionOnObject
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Object.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to perform an action on an object.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonObjectActionRequest
          $ref: '#/definitions/CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/pit-ranges:
    get:
      description: Returns the time ranges within which the specified protected object
        can be restored to any Point in time.
      tags:
      - Objects
      summary: Get PIT ranges for an object
      operationId: GetPITRangesForProtectedObject
      parameters:
      - type: integer
        format: int64
        description: Specifies the ID of the protected object.
        name: id
        in: path
        required: true
      - type: integer
        format: int64
        description: If specified, return the time ranges that lie after this timestamp.
          This parameter is specified as the timestamp in Unix time epoch in microseconds.
        name: fromTimeUsecs
        in: query
      - type: integer
        format: int64
        description: If specified, return the time ranges that lie before this timestamp.
          This parameter is specified as the timestamp in Unix time epoch in microseconds.
        name: toTimeUsecs
        in: query
      - type: array
        items:
          type: string
        description: If specified, return only the points in time corresponding to
          these protection group IDs.
        name: protectionGroupIds
        in: query
      responses:
        '200':
          $ref: '#/responses/GetPITRangesProtectedObjectResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/runs:
    get:
      description: Get the runs for a particular object.
      tags:
      - Objects
      summary: Get the list of runs for an object.
      operationId: GetObjectRuns
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the object.
        name: id
        in: path
        required: true
      - type: string
        description: Specifies a unique id of the run.
        name: runId
        in: query
      - type: integer
        format: int64
        description: Filter by a start time when the run starts. Specify the start
          time as a Unix epoch Timestamp (in microseconds).
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Filter by a end time when the run starts. Specify the start time
          as a Unix epoch Timestamp (in microseconds).
        name: endTimeUsecs
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Group Runs which
          were created by all tenants which the current user has permission to see.
          If false, then only Protection Group Runs created by the current user will
          be returned.
        name: includeTenants
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - kAll
          - kLog
          - kSystem
          - kIncremental
          - kFull
          type: string
        description: Filter by run type. Only protection run matching the specified
          types will be returned.
        name: runTypes
        in: query
      - type: array
        items:
          enum:
          - kInProgress
          - kSuccessful
          - kFailed
          - kWaitingForNextAttempt
          - kWarning
          type: string
        description: Specifies a list of status for the object in the backup run.
        name: localBackupObjectStatus
        in: query
      - type: array
        items:
          enum:
          - kInProgress
          - kSuccessful
          - kFailed
          - kWaitingForNextAttempt
          - kWarning
          type: string
        description: Specifies a list of status for the object in the replication
          run.
        name: replicationObjectStatus
        in: query
      - type: array
        items:
          enum:
          - kInProgress
          - kSuccessful
          - kFailed
          - kWaitingForNextAttempt
          - kWarning
          type: string
        description: Specifies a list of status for the object in the archival run.
        name: archivalObjectStatus
        in: query
      - type: array
        items:
          enum:
          - kInProgress
          - kSuccessful
          - kFailed
          - kWaitingForNextAttempt
          - kWarning
          type: string
        description: Specifies a list of status for the object in the cloud spin run.
        name: cloudSpinRunStatus
        in: query
      - type: integer
        format: int64
        description: Specifies the max number of runs. If not specified, at most 100
          runs will be returned.
        name: numRuns
        in: query
      - type: string
        description: Specifies the pagination cookie with which subsequent parts of
          the response can be fetched. Users can use this to get next runs
        name: paginationCookie
        in: query
      - type: boolean
        default: false
        description: Specifies whether to exclude non restorable runs. Run is treated
          restorable only if there is atleast one object snapshot (which may be either
          a local or an archival snapshot) which is not deleted or expired. Default
          value is false.
        name: excludeNonRestorableRuns
        in: query
      responses:
        '200':
          $ref: '#/responses/GetObjectRunsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/runs/{runId}:
    get:
      description: Get a run for an object.
      tags:
      - Objects
      summary: Get a run for an object.
      operationId: GetObjectRunByRunId
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the object.
        name: id
        in: path
        required: true
      - type: string
        description: Specifies the id of the run.
        name: runId
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetObjectRunResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/snapshots:
    get:
      description: List the snapshots for a given object.
      tags:
      - Objects
      summary: List the snapshots for a given object.
      operationId: GetObjectSnapshots
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Object.
        name: id
        in: path
        required: true
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter Object's snapshots which were taken after this value.
        name: fromTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter Object's snapshots which were taken before this value.
        name: toTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter Object's snapshots which were run after this value.
        name: runStartFromTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter Object's snapshots which were run before this value.
        name: runStartToTimeUsecs
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - kRegular
          - kFull
          - kLog
          - kSystem
          - kHydrateCDP
          type: string
        description: Filter by run type. Only protection run matching the specified
          types will be returned. By default, CDP hydration snapshots are not included,
          unless explicitly queried using this field.
        name: runTypes
        in: query
      - type: array
        items:
          type: string
        description: If specified, this returns only the snapshots of the specified
          object ID, which belong to the provided protection group IDs.
        name: protectionGroupIds
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Filter by a list run instance ids. If specified, only snapshots
          created by these protection runs will be returned.
        name: runInstanceIds
        in: query
      responses:
        '200':
          $ref: '#/responses/GetObjectSnapshotsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/snapshots/{snapshotId}:
    put:
      description: Update an object snapshot.
      tags:
      - Objects
      summary: Update an object snapshot.
      operationId: UpdateObjectSnapshot
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Object.
        name: id
        in: path
        required: true
      - type: string
        description: 'Specifies the id of the snapshot.<br> Note: 1. If the snapshotid
          of one of the apps is specified, it applies for all the databases in the
          Protection Run.<br> 2. In case of volume based jobs, please specify the
          snapshotid of the source not the database. if source snapshot is specified,
          applied to source snapshot. if database snapshotid is specified in case
          of volume based jobs, then it is applicable for host''s snapshot.'
        name: snapshotId
        in: path
        required: true
      - description: Specifies the parameters update an object snapshot.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateObjectSnapshotRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateObjectSnapshotResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/stats:
    get:
      description: Get stats for a given object.
      tags:
      - Objects
      summary: Get stats for a given object.
      operationId: GetObjectStats
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Object.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetObjectStatsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{id}/tree:
    get:
      description: Get the objects tree hierarchy for for an Object. If the object
        does not have a hierarchy then a single object will be returned.
      tags:
      - Objects
      summary: Get the objects tree hierarchy for for an Object.
      operationId: GetObjectTree
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Object.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/ObjectTreeResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{objectId}/indexed-objects/snapshots:
    get:
      description: Get snapshots of indexed object.
      tags:
      - Objects
      summary: Get snapshots of indexed object.
      operationId: GetAllIndexedObjectSnapshots
      parameters:
      - type: integer
        format: int64
        description: Specifies the object id.
        name: objectId
        in: path
        required: true
      - type: string
        description: Specifies the indexed object name.
        name: indexedObjectName
        in: query
        required: true
      - type: string
        description: Specifies the protection group id.
        name: protectionGroupId
        in: query
      - type: boolean
        default: false
        description: Specifies whether to only return snapshots which are indexed.
          In an indexed snapshot files are guaranteed to exist, while in a non-indexed
          snapshot files may not exist.
        name: includeIndexedSnapshotsOnly
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter indexed object's snapshots which are taken after this value.
        name: fromTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter indexed object's snapshots which are taken before this value.
        name: toTimeUsecs
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - kRegular
          - kFull
          - kLog
          - kSystem
          - kHydrateCDP
          type: string
        description: Filter by run type. Only protection run matching the specified
          types will be returned. By default, CDP hydration snapshots are not included,
          unless explicitly queried using this field.
        name: runTypes
        in: query
      responses:
        '200':
          $ref: '#/responses/GetIndexedObjectSnapshotsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/objects/{objectId}/protection-groups/{protectionGroupId}/indexed-objects/snapshots:
    get:
      description: Get snapshots of indexed object.
      tags:
      - Objects
      summary: Get snapshots of indexed object.
      operationId: GetIndexedObjectSnapshots
      parameters:
      - type: string
        description: Specifies the protection group id.
        name: protectionGroupId
        in: path
        required: true
      - type: integer
        format: int64
        description: Specifies the object id.
        name: objectId
        in: path
        required: true
      - type: string
        description: Specifies the indexed object name.
        name: indexedObjectName
        in: query
        required: true
      - type: boolean
        default: false
        description: Specifies whether to only return snapshots which are indexed.
          In an indexed snapshots file are guaranteened to exist, while in a non-indexed
          snapshots file may not exist.
        name: includeIndexedSnapshotsOnly
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter indexed object's snapshots which are taken after this value.
        name: fromTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter indexed object's snapshots which are taken before this value.
        name: toTimeUsecs
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - kRegular
          - kFull
          - kLog
          - kSystem
          - kHydrateCDP
          type: string
        description: Filter by run type. Only protection run matching the specified
          types will be returned. By default, CDP hydration snapshots are not included,
          unless explicitly queried using this field.
        name: runTypes
        in: query
      responses:
        '200':
          $ref: '#/responses/GetIndexedObjectSnapshotsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/policies:
    get:
      description: Lists protection policies based on filtering query parameters.
      tags:
      - ProtectionPolicies
      summary: List Protection Policies based on provided filtering parameters.
      operationId: GetProtectionPolicies
      parameters:
      - type: array
        items:
          type: string
        description: Filter policies by a list of policy ids.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: Filter policies by a list of policy names.
        name: policyNames
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the organizations for which objects
          are to be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: IncludeTenantPolicies specifies if objects of all the organizations
          under the hierarchy of the logged in user's organization should be returned.
        name: includeTenants
        in: query
      - type: array
        items:
          enum:
          - Regular
          - Internal
          type: string
        default:
        - Regular
        description: Types specifies the policy type of policies to be returned
        name: types
        in: query
      - type: boolean
        description: If excludeLinkedPolicies is set to true then only local policies
          created on cluster will be returned. The result will exclude all linked
          policies created from policy templates.
        name: excludeLinkedPolicies
        in: query
      - type: boolean
        description: If includeReplicatedPolicies is set to true, then response will
          also contain replicated policies. By default, replication policies are not
          included in the response.
        name: includeReplicatedPolicies
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionPoliciesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create the Protection Policy and returns the newly created policy
        object.
      tags:
      - ProtectionPolicies
      summary: Create a Protection Policy.
      operationId: CreateProtectionPolicy
      parameters:
      - description: Request to create a Protection Policy.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ProtectionPolicyRequest'
      responses:
        '201':
          $ref: '#/responses/CreateProtectionPolicyResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/policies/{id}:
    get:
      description: Returns the Protection Policy details based on provided Policy
        Id.
      tags:
      - ProtectionPolicies
      summary: List details about a single Protection Policy.
      operationId: GetProtectionPolicyById
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Policy to return.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetProtectionPolicyByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Specifies the request to update the existing Protection Policy.
        On successful update, returns the updated policy object.
      tags:
      - ProtectionPolicies
      summary: Update a Protection Policy.
      operationId: UpdateProtectionPolicy
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Policy to update.
        name: id
        in: path
        required: true
      - description: Request to update a Protection Policy.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ProtectionPolicyRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateProtectionPolicyResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Deletes a Protection Policy based on given policy id.
      tags:
      - ProtectionPolicies
      summary: Delete a Protection Policy.
      operationId: DeleteProtectionPolicy
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Policy to delete.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/policy-templates:
    get:
      description: Returns the policy templates based on the filtering parameters.
        If no parameters are specified, then all the policy templates are returned.
      tags:
      - ProtectionPolicies
      summary: List Policy Templates filtered by query parameters.
      operationId: GetPolicyTemplates
      parameters:
      - type: array
        items:
          type: string
        description: Filter policies by a list of policy template ids.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: Filter policies by a list of policy names.
        name: policyNames
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the organizations for which objects
          are to be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: IncludeTenantPolicies specifies if objects of all the organizations
          under the hierarchy of the logged in user's organization should be returned.
        name: includeTenants
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionPolicyTemplatesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/policy-templates/{id}:
    get:
      description: Returns the Policy Template corresponding to the specified Policy
        Id.
      tags:
      - ProtectionPolicies
      summary: List details about a single Policy Template.
      operationId: GetPolicyTemplateById
      parameters:
      - type: string
        description: Specifies a unique id of the Policy Template to return.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetProtectionPolicyTemplateByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protected-objects:
    post:
      description: Create Protect Objects Backup.
      tags:
      - Protected Objects
      summary: Create Object Backup.
      operationId: ProtectObjectsOfAnyType
      parameters:
      - description: Specifies the parameters to protect objects.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateProtectedObjectsRequest'
      responses:
        '207':
          $ref: '#/responses/CreateProtectedObjectsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protected-objects/actions:
    post:
      description: Perform actions on Protected Objects.
      tags:
      - Protected Objects
      summary: Perform Actions on Protect Objects.
      operationId: PerformActionOnProtectObjects
      parameters:
      - description: Specifies the parameters to perform an action on an already protected
          object.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ProtectdObjectsActionRequest'
      responses:
        '202':
          $ref: '#/responses/ProtectedObjectActionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protected-objects/{id}:
    put:
      description: Update Protected object backup configuration given a object id.
      tags:
      - Protected Objects
      summary: Update Object Backup.
      operationId: UpdateProtectedObjectsOfAnyType
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Protected Object.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to perform an update on protected objects.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateProtectedObjectsRequest'
      responses:
        '200':
          $ref: '#/responses/GetProtectedObjectResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups:
    get:
      description: Get the list of Protection Groups.
      tags:
      - ProtectionGroups
      summary: Get the list of Protection Groups.
      operationId: GetProtectionGroups
      parameters:
      - type: array
        items:
          type: string
        description: Filter by a list of Protection Group ids.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: Filter by a list of Protection Group names.
        name: names
        in: query
      - type: array
        items:
          type: string
        description: Filter by Policy ids that are associated with Protection Groups.
          Only Protection Groups associated with the specified Policy ids, are returned.
        name: policyIds
        in: query
      - type: integer
        format: int64
        description: Filter by Storage Domain id. Only Protection Groups writing data
          to this Storage Domain will be returned.
        name: storageDomainId
        in: query
      - type: boolean
        description: Whether to only return Protection Groups with a datalock.
        name: includeGroupsWithDatalockOnly
        in: query
      - 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
        description: Filter by environment types such as 'kVMware', 'kView', etc.
          Only Protection Groups protecting the specified environment types are returned.
        name: environments
        in: query
      - type: array
        items:
          enum:
          - kMailbox
          - kOneDrive
          - kSharePoint
          - kPublicFolders
          - kGroups
          - kTeams
          type: string
        name: office365Workloads
        in: query
      - type: boolean
        description: Filter by Inactive or Active Protection Groups. If not set, all
          Inactive and Active Protection Groups are returned. If true, only Active
          Protection Groups are returned. If false, only Inactive Protection Groups
          are returned. When you create a Protection Group on a Primary Cluster with
          a replication schedule, the Cluster creates an Inactive copy of the Protection
          Group on the Remote Cluster. In addition, when an Active and running Protection
          Group is deactivated, the Protection Group becomes Inactive.
        name: isActive
        in: query
      - type: boolean
        description: If true, return only Protection Groups that have been deleted
          but still have Snapshots associated with them. If false, return all Protection
          Groups except those Protection Groups that have been deleted and still have
          Snapshots associated with them. A Protection Group that is deleted with
          all its Snapshots is not returned for either of these cases.
        name: isDeleted
        in: query
      - type: boolean
        description: Filter by paused or non paused Protection Groups, If not set,
          all paused and non paused Protection Groups are returned. If true, only
          paused Protection Groups are returned. If false, only non paused Protection
          Groups are returned.
        name: isPaused
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Filter by last local backup run status.<br> 'Running' indicates
          that the run is still running.<br> 'Canceled' indicates that the run has
          been canceled.<br> 'Canceling' indicates that the run is in the process
          of being canceled.<br> 'Failed' indicates that the run has failed.<br> 'Missed'
          indicates that the run was unable to take place at the scheduled time because
          the previous run was still happening.<br> 'Succeeded' indicates that the
          run has finished successfully.<br> 'SucceededWithWarning' indicates that
          the run finished successfully, but there were some warning messages.
        name: lastRunLocalBackupStatus
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Filter by last remote replication run status.<br> 'Running' indicates
          that the run is still running.<br> 'Canceled' indicates that the run has
          been canceled.<br> 'Canceling' indicates that the run is in the process
          of being canceled.<br> 'Failed' indicates that the run has failed.<br> 'Missed'
          indicates that the run was unable to take place at the scheduled time because
          the previous run was still happening.<br> 'Succeeded' indicates that the
          run has finished successfully.<br> 'SucceededWithWarning' indicates that
          the run finished successfully, but there were some warning messages.
        name: lastRunReplicationStatus
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Filter by last cloud archival run status.<br> 'Running' indicates
          that the run is still running.<br> 'Canceled' indicates that the run has
          been canceled.<br> 'Canceling' indicates that the run is in the process
          of being canceled.<br> 'Failed' indicates that the run has failed.<br> 'Missed'
          indicates that the run was unable to take place at the scheduled time because
          the previous run was still happening.<br> 'Succeeded' indicates that the
          run has finished successfully.<br> 'SucceededWithWarning' indicates that
          the run finished successfully, but there were some warning messages.
        name: lastRunArchivalStatus
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Filter by last cloud spin run status.<br> 'Running' indicates
          that the run is still running.<br> 'Canceled' indicates that the run has
          been canceled.<br> 'Canceling' indicates that the run is in the process
          of being canceled.<br> 'Failed' indicates that the run has failed.<br> 'Missed'
          indicates that the run was unable to take place at the scheduled time because
          the previous run was still happening.<br> 'Succeeded' indicates that the
          run has finished successfully.<br> 'SucceededWithWarning' indicates that
          the run finished successfully, but there were some warning messages.
        name: lastRunCloudSpinStatus
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Filter by last any run status.<br> 'Running' indicates that the
          run is still running.<br> 'Canceled' indicates that the run has been canceled.<br>
          'Canceling' indicates that the run is in the process of being canceled.<br>
          'Failed' indicates that the run has failed.<br> 'Missed' indicates that
          the run was unable to take place at the scheduled time because the previous
          run was still happening.<br> 'Succeeded' indicates that the run has finished
          successfully.<br> 'SucceededWithWarning' indicates that the run finished
          successfully, but there were some warning messages.
        name: lastRunAnyStatus
        in: query
      - type: boolean
        description: If true, return Protection Groups for which last run SLA was
          violated.
        name: isLastRunSlaViolated
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Groups which were
          created by all tenants which the current user has permission to see. If
          false, then only Protection Groups created by the current user will be returned.
        name: includeTenants
        in: query
      - type: boolean
        description: If true, the response will include last run info. If it is false
          or not specified, the last run info won't be returned.
        name: includeLastRunInfo
        in: query
      - type: boolean
        description: If true, the response will not include the list of excluded source
          IDs in groups that contain this field. This can be set to true in order
          to improve performance if excluded source IDs are not needed by the user.
        name: pruneExcludedSourceIds
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionGroupsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a Protection Group.
      tags:
      - ProtectionGroups
      summary: Create a Protection Group.
      operationId: CreateProtectionGroup
      parameters:
      - description: Specifies the parameters to create a Protection Group.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonProtectionGroupRequestParams
          $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateProtectionGroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/states:
    post:
      description: Perform an action like pause, resume, active, deactivate on all
        specified Protection Groups. Note that the pause or resume actions will take
        effect from next Protection Run. Also, user can specify only one type of action
        on all the Protection Groups. Deactivate and activate actions are independent
        of pause and resume state. Deactivate and activate actions are useful in case
        of failover situations. Returns success if the state of all the Protection
        Groups state is changed successfully.
      tags:
      - ProtectionGroups
      summary: Perform an action like pause, resume, active, deactivate on all specified
        Protection Groups.
      operationId: UpdateProtectionGroupsState
      parameters:
      - description: Specifies the parameters to perform an action of list of Protection
          Groups.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateProtectionGroupsStateRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateProtectionGroupsStateResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/{id}:
    get:
      description: Returns the Protection Group corresponding to the specified Group
        id.
      tags:
      - ProtectionGroups
      summary: List details about single Protection Group.
      operationId: GetProtectionGroupById
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - type: boolean
        description: If true, the response will include last run info. If it is false
          or not specified, the last run info won't be returned.
        name: includeLastRunInfo
        in: query
      - type: boolean
        description: If true, the response will not include the list of excluded source
          IDs in groups that contain this field. This can be set to true in order
          to improve performance if excluded source IDs are not needed by the user.
        name: pruneExcludedSourceIds
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionGroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update the specified Protection Group.
      tags:
      - ProtectionGroups
      summary: Update a Protection Group.
      operationId: UpdateProtectionGroup
      parameters:
      - type: string
        description: Specifies the id of the Protection Group.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a Protection Group.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonProtectionGroupRequestParams
          $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateProtectionGroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Returns Success if the Protection Group is deleted.
      tags:
      - ProtectionGroups
      summary: Delete a Protection Group.
      operationId: DeleteProtectionGroup
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - type: boolean
        description: Specifies if Snapshots generated by the Protection Group should
          also be deleted when the Protection Group is deleted.
        name: deleteSnapshots
        in: query
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/{id}/runs:
    get:
      description: Get the runs for a particular Protection Group.
      tags:
      - ProtectionGroups
      summary: Get the list of runs for a Protection Group.
      operationId: GetProtectionGroupRuns
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies the protection run id.
        name: runId
        in: query
      - type: integer
        format: int64
        description: Filter by a start time. Specify the start time as a Unix epoch
          Timestamp (in microseconds).
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Filter by a end time. Specify the start time as a Unix epoch
          Timestamp (in microseconds).
        name: endTimeUsecs
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Group Runs which
          were created by all tenants which the current user has permission to see.
          If false, then only Protection Group Runs created by the current user will
          be returned.
        name: includeTenants
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - kAll
          - kLog
          - kSystem
          - kIncremental
          - kFull
          type: string
        description: Filter by run type. Only protection run matching the specified
          types will be returned.
        name: runTypes
        in: query
      - type: boolean
        description: Specifies if the result includes the object details for each
          protection run. If set to true, details of the protected object will be
          returned. If set to false or not specified, details will not be returned.
        name: includeObjectDetails
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Specifies a list of local backup status, runs matching the status
          will be returned.<br> 'Running' indicates that the run is still running.<br>
          'Canceled' indicates that the run has been canceled.<br> 'Canceling' indicates
          that the run is in the process of being canceled.<br> 'Failed' indicates
          that the run has failed.<br> 'Missed' indicates that the run was unable
          to take place at the scheduled time because the previous run was still happening.<br>
          'Succeeded' indicates that the run has finished successfully.<br> 'SucceededWithWarning'
          indicates that the run finished successfully, but there were some warning
          messages.
        name: localBackupRunStatus
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Specifies a list of replication status, runs matching the status
          will be returned.<br> 'Running' indicates that the run is still running.<br>
          'Canceled' indicates that the run has been canceled.<br> 'Canceling' indicates
          that the run is in the process of being canceled.<br> 'Failed' indicates
          that the run has failed.<br> 'Missed' indicates that the run was unable
          to take place at the scheduled time because the previous run was still happening.<br>
          'Succeeded' indicates that the run has finished successfully.<br> 'SucceededWithWarning'
          indicates that the run finished successfully, but there were some warning
          messages.
        name: replicationRunStatus
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Specifies a list of archival status, runs matching the status
          will be returned.<br> 'Running' indicates that the run is still running.<br>
          'Canceled' indicates that the run has been canceled.<br> 'Canceling' indicates
          that the run is in the process of being canceled.<br> 'Failed' indicates
          that the run has failed.<br> 'Missed' indicates that the run was unable
          to take place at the scheduled time because the previous run was still happening.<br>
          'Succeeded' indicates that the run has finished successfully.<br> 'SucceededWithWarning'
          indicates that the run finished successfully, but there were some warning
          messages.
        name: archivalRunStatus
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Specifies a list of cloud spin status, runs matching the status
          will be returned.<br> 'Running' indicates that the run is still running.<br>
          'Canceled' indicates that the run has been canceled.<br> 'Canceling' indicates
          that the run is in the process of being canceled.<br> 'Failed' indicates
          that the run has failed.<br> 'Missed' indicates that the run was unable
          to take place at the scheduled time because the previous run was still happening.<br>
          'Succeeded' indicates that the run has finished successfully.<br> 'SucceededWithWarning'
          indicates that the run finished successfully, but there were some warning
          messages.
        name: cloudSpinRunStatus
        in: query
      - type: integer
        format: int64
        description: Specifies the max number of runs. If not specified, at most 100
          runs will be returned.
        name: numRuns
        in: query
      - type: boolean
        default: false
        description: Specifies whether to exclude non restorable runs. Run is treated
          restorable only if there is atleast one object snapshot (which may be either
          a local or an archival snapshot) which is not deleted or expired. Default
          value is false.
        name: excludeNonRestorableRuns
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionGroupRunsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: 'Update runs for a particular Protection Group. A user can perform
        the following actions: 1. Extend or reduce retention of a local, replication
        and archival snapshots. 2. Can perform resync operation on failed copy snapshots
        attempts in this Run. 3. Add new replication and archival snapshot targets
        to the Run. 4. Add or remove legal hold on the snapshots. Only a user with
        DSO role can perform this operation. 5. Delete the snapshots that were created
        as a part of this Run. 6. Apply datalock on existing snapshots where a user
        cannot manually delete snapshots before the expiry time. '
      tags:
      - ProtectionGroups
      summary: Update runs for a particular Protection Group.
      operationId: UpdateProtectionGroupRun
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a Protection Group Run.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateProtectionGroupRunRequestBody'
      responses:
        '207':
          $ref: '#/responses/UpdateProtectionGroupRunResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a new protection run. This can be used to start a run for
        a Protection Group on demand, ignoring the schedule and retention specified
        in the protection policy.
      tags:
      - ProtectionGroups
      summary: Create a new protection run.
      operationId: CreateProtectionGroupRun
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to start a protection run.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateProtectionGroupRunRequest'
      responses:
        '202':
          $ref: '#/responses/CreateProtectionGroupRunResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/{id}/runs/{runId}:
    get:
      description: Get a run for a particular Protection Group.
      tags:
      - ProtectionGroups
      summary: Get a run for a Protection Group.
      operationId: GetProtectionGroupRun
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies a unique run id of the Protection Group run.
        name: runId
        in: path
        required: true
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which the run is to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Group Runs which
          were created by all tenants which the current user has permission to see.
          If false, then only Protection Groups created by the current user will be
          returned. If it's not specified, it is true by default.
        name: includeTenants
        in: query
      - type: boolean
        description: Specifies if the result includes the object details for a protection
          run. If set to true, details of the protected object will be returned. If
          set to false or not specified, details will not be returned.
        name: includeObjectDetails
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionGroupRunResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/{id}/runs/{runId}/cancel:
    post:
      description: Cancel protection run for a given protection group ID and run ID.
      tags:
      - ProtectionGroups
      summary: Cancel protection group run.
      operationId: CancelProtectionGroupRun
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies a unique run id of the Protection Group run.
        name: runId
        in: path
        required: true
      - description: Specifies the parameters to cancel a protection run.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CancelProtectionGroupRunRequest'
      responses:
        '200':
          description: OK
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/{id}/runs/{runId}/debug-logs:
    get:
      description: Get the debug logs for all objects of a run for a particular Protection
        Group.
      tags:
      - ProtectionGroups
      summary: Get the debug logs for a run from a Protection Group.
      operationId: GetRunDebugLogs
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies a unique run id of the Protection Group run.
        name: runId
        in: path
        required: true
      - type: string
        description: 'Specifies the id of the object for which debug logs are to be
          returned. '
        name: objectId
        in: query
      responses:
        '200':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/{id}/runs/{runId}/objects/{objectId}/debug-logs:
    get:
      description: Get the debug logs for a particular object of a run for a particular
        Protection Group.
      tags:
      - ProtectionGroups
      summary: Get the debug logs for a particular object in a run from a Protection
        Group.
      operationId: GetRunDebugLogsForObject
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies a unique run id of the Protection Group run.
        name: runId
        in: path
        required: true
      - type: string
        description: 'Specifies the id of the object for which debug logs are to be
          returned. '
        name: objectId
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/protection-groups/{id}/runs/{runId}/objects/{objectId}/downloadMessages:
    get:
      description: Get an CSV error report for given objectId and run id. Each row
        in CSV report contains the File Path, error/warning code and error/warning
        message.
      tags:
      - ProtectionGroups
      summary: Get the CSV of errors/warnings for a given run and an object.
      operationId: GetRunErrorsReport
      parameters:
      - type: string
        description: Specifies a unique id of the Protection Group.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies a unique run id of the Protection Group run.
        name: runId
        in: path
        required: true
      - type: string
        description: 'Specifies the id of the object for which errors/warnings are
          to be returned. '
        name: objectId
        in: path
        required: true
      responses:
        '200':
          description: OK
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/recoveries:
    get:
      description: Lists the Recoveries.
      tags:
      - Recoveries
      summary: Lists the Recoveries.
      operationId: GetRecoveries
      parameters:
      - type: array
        items:
          pattern: ^\d+:\d+:\d+$
          type: string
        description: Filter Recoveries for given ids.
        name: ids
        in: query
      - type: boolean
        description: 'Returns only child recoveries if passed as true. This filter
          should always be used along with ''ids'' filter. '
        name: returnOnlyChildRecoveries
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the organizations for which recoveries
          are to be returned.
        name: tenantIds
        in: query
      - type: boolean
        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
      - type: integer
        format: int64
        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
      - 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
      - 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
      - uniqueItems: true
        type: array
        items:
          enum:
          - Local
          - Archival
          type: string
        description: Specifies the snapshot's target type from which recovery has
          been performed.
        name: snapshotTargetType
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - Tape
          - Cloud
          - Nas
          type: string
        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
      - uniqueItems: true
        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
        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
      - uniqueItems: true
        type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Specifies the list of run status to filter Recoveries. If empty,
          Recoveries with all run status will be returned.
        name: status
        in: query
      - 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
        description: Specifies the list of recovery actions to filter Recoveries.
          If empty, Recoveries related to all actions will be returned.
        name: recoveryActions
        in: query
      responses:
        '200':
          $ref: '#/responses/GetRecoveries'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Performs a Recovery.
      tags:
      - Recoveries
      summary: Performs a Recovery.
      operationId: CreateRecovery
      parameters:
      - description: Specifies the parameters to create a Recovery.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonRecoveryRequestParams
          $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
      responses:
        '201':
          $ref: '#/responses/CreateRecoveryResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /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
      parameters:
      - description: Specifies the parameters to create a download files and folder
          recovery.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DownloadFilesAndFoldersRequestParams'
      responses:
        '201':
          $ref: '#/responses/CreateDownloadFilesAndFoldersRecoveryResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/recoveries/{id}:
    get:
      description: Get Recovery for a given id.
      tags:
      - Recoveries
      summary: Get Recovery for a given id.
      operationId: GetRecoveryById
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
      - type: boolean
        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
      responses:
        '200':
          $ref: '#/responses/GetRecovery'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /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:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /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:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id of a Recovery job.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /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:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
      - type: integer
        format: int64
        description: Specifies the start offset of file chunk to be downloaded.
        name: startOffset
        in: query
      - 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
      responses:
        '200':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /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:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id of a Recovery.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/runs/summary:
    get:
      description: Get a list of protection runs.
      tags:
      - ProtectionGroups
      summary: Get the list of runs.
      operationId: GetProtectionRuns
      parameters:
      - type: integer
        format: int64
        description: Filter by a start time. Specify the start time as a Unix epoch
          Timestamp (in microseconds), only runs executing after this time will be
          returned. By default it is endTimeUsecs minus an hour.
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Filter by a end time. Specify the start time as a Unix epoch
          Timestamp (in microseconds), only runs executing before this time will be
          returned. By default it is current time.
        name: endTimeUsecs
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Specifies a list of status, runs matching the status will be
          returned.<br> 'Running' indicates that the run is still running.<br> 'Canceled'
          indicates that the run has been canceled.<br> 'Canceling' indicates that
          the run is in the process of being canceled.<br> 'Failed' indicates that
          the run has failed.<br> 'Missed' indicates that the run was unable to take
          place at the scheduled time because the previous run was still happening.<br>
          'Succeeded' indicates that the run has finished successfully.<br> 'SucceededWithWarning'
          indicates that the run finished successfully, but there were some warning
          messages.
        name: runStatus
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionRunsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/runs/{runId}/progress:
    get:
      description: Get the progress of a run.
      tags:
      - ProtectionGroups
      summary: Get the progress of a run.
      operationId: GetProtectionRunProgress
      parameters:
      - type: string
        description: Specifies a unique run id of the Protection Run.
        name: runId
        in: path
        required: true
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies the objects whose progress will be returned. This only
          applies to protection group runs and will be ignored for object runs. If
          the objects are specified, the run progress will not be returned and only
          the progress of the specified objects will be returned.
        name: objects
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which the run is to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Group Runs which
          were created by all tenants which the current user has permission to see.
          If false, then only Protection Groups created by the current user will be
          returned. If it's not specified, it is true by default.
        name: includeTenants
        in: query
      - type: boolean
        description: Specifies whether to return finished tasks. By default only active
          tasks are returned.
        name: includeFinishedTasks
        in: query
      - type: integer
        format: int64
        description: Specifies the time after which the progress task starts in Unix
          epoch Timestamp(in microseconds).
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Specifies the time before which the progress task ends in Unix
          epoch Timestamp(in microseconds).
        name: endTimeUsecs
        in: query
      - type: integer
        format: int32
        description: Specifies the maximum number of tasks to return.
        name: maxTasksNum
        in: query
      - type: boolean
        description: Specifies whether to return objects. By default all the task
          tree are returned.
        name: excludeObjectDetails
        in: query
      - type: boolean
        description: Specifies whether to include event logs
        name: includeEventLogs
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionRunProgress'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/search/indexed-objects:
    post:
      description: List all the indexed objects like files and folders, emails, mailboxes
        etc., that match the specified search and filter criteria from protected objects.
      tags:
      - Search
      summary: List indexed objects.
      operationId: SearchIndexedObjects
      parameters:
      - description: Specifies the parameters to search for indexed objects.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonSearchIndexedObjectsRequestParams
          $ref: '#/definitions/SearchIndexedObjectsRequest'
      responses:
        '200':
          $ref: '#/responses/SearchIndexedObjectsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/search/objects:
    get:
      description: List objects.
      tags:
      - Search
      summary: List Objects.
      operationId: SearchObjects
      parameters:
      - type: string
        description: Specifies the search string to filter the objects. This search
          string will be applicable for objectnames. User can specify a wildcard character
          '*' as a suffix to a string where all object names are matched with the
          prefix string. For example, if vm1 and vm2 are the names of objects, user
          can specify vm* to list the objects. If not specified, then all the objects
          will be returned which will match other filtering criteria.
        name: searchString
        in: query
      - uniqueItems: true
        type: array
        items:
          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
          type: string
        description: Specifies the environment type to filter objects.
        name: environments
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - kAgent
          - kNative
          - kSnapshotManager
          - kRDSSnapshotManager
          - kAuroraSnapshotManager
          - kFile
          - kVolume
          type: string
        description: Specifies the protection type to filter objects.
        name: protectionTypes
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Objects which belongs to all
          tenants which the current user has permission to see.
        name: includeTenants
        in: query
      - type: array
        items:
          type: string
        description: Specifies a list of Protection Group ids to filter the objects.
          If specified, the objects protected by specified Protection Group ids will
          be returned.
        name: protectionGroupIds
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of Object ids to filter.
        name: objectIds
        in: query
      - type: array
        items:
          enum:
          - kLinux
          - kWindows
          - kAix
          - kSolaris
          - kSapHana
          - kOther
          type: string
        description: Specifies the operating system types to filter objects on.
        name: osTypes
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of Protection Source object ids to filter the
          objects. If specified, the object which are present in those Sources will
          be returned.
        name: sourceIds
        in: query
      - type: array
        items:
          type: string
        description: Specifies a list of Protection Source object uuids to filter
          the objects. If specified, the object which are present in those Sources
          will be returned.
        name: sourceUuids
        in: query
      - type: boolean
        description: Specifies the protection status of objects. If set to true, only
          protected objects will be returned. If set to false, only unprotected objects
          will be returned. If not specified, all objects will be returned.
        name: isProtected
        in: query
      - type: array
        items:
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          type: string
        description: Specifies a list of status of the object's last protection run.
          Only objects with last run status of these will be returned.
        name: lastRunStatusList
        in: query
      - type: array
        items:
          type: string
        description: Specifies a list of region ids. Only records from clusters having
          these region ids will be returned.
        name: regionIds
        in: query
      - type: array
        items:
          type: string
        description: Specifies the list of cluster identifiers. Format is clusterId:clusterIncarnationId.
          Only records from clusters having these identifiers will be returned.
        name: clusterIdentifiers
        in: query
      - type: string
        description: Specifies the pagination cookie with which subsequent parts of
          the response can be fetched.
        name: paginationCookie
        in: query
      - type: integer
        format: int32
        description: Specifies the number of objects to be fetched for the specified
          pagination cookie.
        name: count
        in: query
      - uniqueItems: true
        type: array
        items:
          pattern: ^\d+:\d+:[A-Z0-9-]+$
          type: string
        description: Specifies tags which must be all present in the document.
        name: mustHaveTagIds
        in: query
      - uniqueItems: true
        type: array
        items:
          pattern: ^\d+:\d+:[A-Z0-9-]+$
          type: string
        description: 'Specifies list of tags, one or more of which might be present
          in

          the document. These are OR''ed together and the resulting criteria

          AND''ed with the rest of the query.'
        name: mightHaveTagIds
        in: query
      - uniqueItems: true
        type: array
        items:
          pattern: ^\d+:\d+:[A-Z0-9-]+$
          type: string
        description: Specifies snapshot tags which must be all present in the document.
        name: mustHaveSnapshotTagIds
        in: query
      - uniqueItems: true
        type: array
        items:
          pattern: ^\d+:\d+:[A-Z0-9-]+$
          type: string
        description: 'Specifies list of snapshot tags, one or more of which might
          be

          present in the document. These are OR''ed together and the resulting

          criteria AND''ed with the rest of the query.'
        name: mightHaveSnapshotTagIds
        in: query
      responses:
        '200':
          $ref: '#/responses/ObjectsSearchResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/search/protected-objects:
    get:
      description: List protected objects and corresponding detail information from
        registered sources filtered by specified query parameters. If no search pattern
        or filter parameters are specified, all protected objects currently found
        are returned.
      tags:
      - Search
      summary: List Protected Objects.
      operationId: SearchProtectedObjects
      parameters:
      - type: string
        description: Specifies the search string to filter the objects. This search
          string will be applicable for objectnames and Protection Group names. User
          can specify a wildcard character '*' as a suffix to a string where all object
          and their Protection Group names are matched with the prefix string. For
          example, if vm1 and vm2 are the names of objects, user can specify vm* to
          list the objects. If not specified, then all the objects with Protection
          Groups will be returned which will match other filtering criteria.
        name: searchString
        in: query
      - uniqueItems: true
        type: array
        items:
          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
          type: string
        description: Specifies the environment type to filter objects.
        name: environments
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - RecoverVMs
          - RecoverFiles
          - InstantVolumeMount
          - RecoverVmDisks
          - MountVolumes
          - RecoverVApps
          - RecoverRDS
          - RecoverAurora
          - RecoverApps
          - RecoverNasVolume
          - RecoverPhysicalVolumes
          - RecoverSystem
          - RecoverSanVolumes
          - RecoverNamespaces
          - RecoverObjects
          - DownloadFilesAndFolders
          - RecoverPublicFolders
          - RecoverVAppTemplates
          - RecoverMailbox
          - RecoverOneDrive
          - RecoverMsTeam
          - RecoverMsGroup
          type: string
        description: Specifies a list of recovery actions. Only snapshots that applies
          to these actions will be returned.
        name: snapshotActions
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Objects which belongs to all
          tenants which the current user has permission to see.
        name: includeTenants
        in: query
      - type: array
        items:
          type: string
        description: Specifies a list of Protection Group ids to filter the objects.
          If specified, the objects protected by specified Protection Group ids will
          be returned.
        name: protectionGroupIds
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of Object ids to filter.
        name: objectIds
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies the Storage Domain ids to filter objects for which
          Protection Groups are writing data to Cohesity Views on the specified Storage
          Domains.
        name: storageDomainIds
        in: query
      - type: integer
        format: int32
        description: Specifies the size of objects to be fetched for a single subresult.
        name: subResultSize
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter the objects if the Object has a successful snapshot after this value.
        name: filterSnapshotFromUsecs
        in: query
      - type: integer
        format: int64
        description: Specifies the timestamp in Unix time epoch in microseconds to
          filter the objects if the Object has a successful snapshot before this value.
        name: filterSnapshotToUsecs
        in: query
      - type: array
        items:
          enum:
          - kLinux
          - kWindows
          - kAix
          - kSolaris
          - kSapHana
          - kOther
          type: string
        description: Specifies the operating system types to filter objects on.
        name: osTypes
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of Protection Source object ids to filter the
          objects. If specified, the object which are present in those Sources will
          be returned.
        name: sourceIds
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of run instance ids. If specified only objects
          belonging to the provided run id will be retunrned.
        name: runInstanceIds
        in: query
      - type: boolean
        description: Specifies whether to only return the CDP protected objects.
        name: cdpProtectedOnly
        in: query
      responses:
        '200':
          $ref: '#/responses/ProtectedObjectsSearchResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/snapshots/{snapshotId}:
    get:
      description: Get details of object snapshot.
      tags:
      - Objects
      summary: Get details of object snapshot.
      operationId: GetObjectSnapshotInfo
      parameters:
      - type: string
        description: Specifies the snapshot id.
        name: snapshotId
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetObjectSnapshotInfoResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/snapshots/{snapshotId}/metaInfo:
    post:
      description: Construct meta info from object snapshot and some additional params.
      tags:
      - Objects
      summary: Construct meta info for any workflow from object snapshot and some
        other information.
      operationId: ConstructMetaInfo
      parameters:
      - type: string
        description: Specifies the snapshot id.
        name: snapshotId
        in: path
        required: true
      - description: Specifies the parameters to construct meta info for desired workflow.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ConstructMetaInfoParams'
      responses:
        '200':
          $ref: '#/responses/ConstructMetaInfoResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/snapshots/{snapshotId}/volume:
    get:
      description: Get volume info of object snapshot.
      tags:
      - Objects
      summary: Get volume info of object snapshot.
      operationId: GetObjectSnapshotVolumeInfo
      parameters:
      - type: string
        description: Specifies the snapshot id.
        name: snapshotId
        in: path
        required: true
      - type: boolean
        description: Specifies whether to only return supported volumes.
        name: includeSupportedOnly
        in: query
      - type: number
        format: int64
        description: Specifies the point-in-time timestamp (in usecs from epoch) between
          snapshots for which the volume info is to be returned.
        name: pointInTimeUsecs
        in: query
      responses:
        '200':
          $ref: '#/responses/GetObjectSnapshotVolumeInfoResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/snapshots/{snapshotsId}/downloadFile:
    get:
      description: Download an indexed file from a snapshot.
      tags:
      - Recoveries
      summary: Download an indexed file.
      operationId: DownloadIndexedFile
      parameters:
      - type: string
        description: Specifies the snapshot id to download from.
        name: snapshotsId
        in: path
        required: true
      - 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
      - type: integer
        format: int64
        description: Specifies the number of attempts the protection run took to create
          this file.
        name: retryAttempt
        in: query
      - type: integer
        format: int64
        description: Specifies the start offset of file chunk to be downloaded.
        name: startOffset
        in: query
      - 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
      responses:
        '200':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources:
    get:
      description: Get a List of Protection Sources.
      tags:
      - ProtectionSources
      summary: Get a List of Protection Sources.
      operationId: GetProtectionSources
      parameters:
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which Sources are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Sources which belong belong
          to all tenants which the current user has permission to see. If false, then
          only Sources for the current user will be returned.
        name: includeTenants
        in: query
      - type: boolean
        description: If true, the encrypted crednetial for the registered sources
          will be included. Credential is first encrypted with internal key and then
          reencrypted with user supplied encryption key.
        name: includeSourceCredentials
        in: query
      - type: string
        description: Specifies the key to be used to encrypt the source credential.
          If includeSourceCredentials is set to true this key must be specified.
        name: encryptionKey
        in: query
      responses:
        '200':
          $ref: '#/responses/SourcesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources/filters:
    get:
      description: Get a List of attribute filters for leaf entities within a a source
      tags:
      - ProtectionSources
      summary: List attribute filters for a source.
      operationId: GetSourceAttributeFilters
      parameters:
      - type: string
        description: Specifies the source UUID of the parent entity.
        name: sourceUuid
        in: query
        required: true
      - enum:
        - kVMware
        - kHyperV
        - kAcropolis
        - kKVM
        - kAWS
        - kGCP
        - kAzure
        - kPhysical
        - kPure
        - kNimble
        - kNetapp
        - kGenericNas
        - kIsilon
        - kFlashBlade
        - kGPFS
        - kElastifile
        - kO365
        - kHyperFlex
        - kKubernetes
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        type: string
        x-nullable: true
        description: Specifies the environment type of the Protection Source.
        name: environment
        in: query
      responses:
        '200':
          $ref: '#/responses/SourceAttributeFiltersResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources/registrations:
    get:
      description: Get the list of Protection Source registrations.
      tags:
      - ProtectionSources
      summary: Get the list of Protection Source registrations.
      operationId: GetSourceRegistrations
      parameters:
      - type: array
        items:
          type: integer
        description: Ids specifies the list of source registration ids to return.
          If left empty, every source registration will be returned by default.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Registrations which were created
          by all tenants which the current user has permission to see. If false, then
          only Registrations created by the current user will be returned.
        name: includeTenants
        in: query
      - type: boolean
        description: If true, the encrypted crednetial for the registered sources
          will be included. Credential is first encrypted with internal key and then
          reencrypted with user supplied encryption key.
        name: includeSourceCredentials
        in: query
      - type: string
        description: Specifies the key to be used to encrypt the source credential.
          If includeSourceCredentials is set to true this key must be specified.
        name: encryptionKey
        in: query
      responses:
        '200':
          $ref: '#/responses/SourceRegistrationsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Register a Protection Source.
      tags:
      - ProtectionSources
      summary: Register a Protection Source.
      operationId: RegisterProtectionSource
      parameters:
      - description: Specifies the parameters to register a Protection Source.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonSourceRegistrationRequestParams
          $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
      responses:
        '201':
          $ref: '#/responses/SourceRegistrationResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources/registrations/{id}:
    get:
      description: Get a Protection Source registration.
      tags:
      - ProtectionSources
      summary: Get a Protection Source registration.
      operationId: GetProtectionSourceRegistration
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Protection Source registration.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/SourceRegistrationResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update Protection Source registration.
      tags:
      - ProtectionSources
      summary: Update Protection Source registration.
      operationId: UpdateProtectionSourceRegistration
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Protection Source registration.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update the registration.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonSourceRegistrationRequestParams
          $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
      responses:
        '200':
          $ref: '#/responses/SourceRegistrationResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete Protection Source Registration.
      tags:
      - ProtectionSources
      summary: Delete Protection Source Registration.
      operationId: DeleteProtectionSourceRegistration
      parameters:
      - type: integer
        format: int64
        description: Specifies the ID of the Protection Source Registration.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources/test-connection:
    post:
      description: Test connection to a source.
      tags:
      - ProtectionSources
      summary: Test connection to a source.
      operationId: TestConnectionProtectionSource
      parameters:
      - description: Specifies the parameters to test connectivity with a source.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/SourceConnectionRequestParams'
      responses:
        '200':
          $ref: '#/responses/SourceConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources/virtual-datacenter/{id}:
    get:
      description: Get the details such as catelogs, Org networks associated with
        a VMware virtual datacenter (VDC).
      tags:
      - ProtectionSources
      summary: Get VDC Details.
      operationId: GetVdcDetails
      parameters:
      - type: integer
        format: int64
        description: Specifies the ID of the VMware virtual datacenter.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetVdcByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources/{id}:
    get:
      description: Get a Protection Source.
      tags:
      - ProtectionSources
      summary: Get a Protection Sources.
      operationId: ProtectionSourceById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the Protection Source.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/SourceResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-protect/sources/{sourceId}/objects:
    get:
      description: List objects which can be used for data protection.
      tags:
      - Objects
      summary: List objects on a source which can be used for data protection.
      operationId: GetSourceHierarchyObjects
      parameters:
      - type: integer
        format: int64
        description: Specifies the source ID for which objects should be returned.
        name: sourceId
        in: path
        required: true
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the parent ID under which objects should be returned.
        name: parentId
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Objects which belongs to all
          tenants which the current user has permission to see.
        name: includeTenants
        in: query
      - type: array
        items:
          enum:
          - kVCenter
          - kStandaloneHost
          - kvCloudDirector
          - kFolder
          - kDatacenter
          - kComputeResource
          - kClusterComputeResource
          - kResourcePool
          - kDatastore
          - kHostSystem
          - kVirtualMachine
          - kVirtualApp
          - kStoragePod
          - kNetwork
          - kDistributedVirtualPortgroup
          - kTagCategory
          - kTag
          - kOpaqueNetwork
          - kOrganization
          - kVirtualDatacenter
          - kCatalog
          - kOrgMetadata
          - kStoragePolicy
          - kVirtualAppTemplate
          type: string
        description: Specifies the VMware object types to filter objects.
        name: vmwareObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kVserver
          - kVolume
          type: string
        description: Specifies the Netapp object types to filter objects.
        name: netappObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kDomain
          - kOutlook
          - kMailbox
          - kUsers
          - kGroups
          - kSites
          - kUser
          - kGroup
          - kSite
          - kApplication
          - kGraphUser
          - kPublicFolders
          - kPublicFolder
          - kTeams
          - kTeam
          type: string
        description: Specifies the Office 365 object types to filter objects.
        name: o365ObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kKeyspace
          - kTable
          type: string
        description: Specifies the Cassandra object types to filter objects.
        name: cassandraObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kDatabase
          - kCollection
          type: string
        description: Specifies the Mongo DB object types to filter objects.
        name: mongodbObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kBucket
          type: string
        description: Specifies the Couchbase object types to filter objects.
        name: couchbaseObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          type: string
        description: Specifies the HDFS object types to filter objects.
        name: hdfsObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kNamespace
          - kTable
          type: string
        description: Specifies the Hbase object types to filter objects.
        name: hbaseObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kDatabase
          - kTable
          type: string
        description: Specifies the Hive object types to filter objects.
        name: hiveObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kSCVMMServer
          - kStandaloneHost
          - kStandaloneCluster
          - kHostGroup
          - kHypervHost
          - kHostCluster
          - kVirtualMachine
          - kNetwork
          - kDatastore
          - kTag
          - kCustomProperty
          type: string
        description: Specifies the HyperV object types to filter objects.
        name: hypervObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kSubscription
          - kResourceGroup
          - kVirtualMachine
          - kStorageAccount
          - kStorageKey
          - kStorageContainer
          - kStorageBlob
          - kNetworkSecurityGroup
          - kVirtualNetwork
          - kSubnet
          - kComputeOptions
          - kSnapshotManagerPermit
          - kTag
          - kAvailabilitySet
          type: string
        description: Specifies the Azure object types to filter objects.
        name: azureObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kOVirtManager
          - kStandaloneHost
          - kDatacenter
          - kCluster
          - kHost
          - kVirtualMachine
          - kNetwork
          - kStorageDomain
          - kVNicProfile
          type: string
        description: Specifies the KVM object types to filter objects.
        name: kvmObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kIAMUser
          - kRegion
          - kAvailabilityZone
          - kEC2Instance
          - kVPC
          - kSubnet
          - kNetworkSecurityGroup
          - kInstanceType
          - kKeyPair
          - kTag
          - kRDSOptionGroup
          - kRDSParameterGroup
          - kRDSInstance
          - kRDSSubnet
          - kRDSTag
          - kAuroraCluster
          - kAccount
          - kSubTaskPermit
          type: string
        description: Specifies the AWS object types to filter objects.
        name: awsObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kIAMUser
          - kProject
          - kRegion
          - kAvailabilityZone
          - kVirtualMachine
          - kVPC
          - kSubnet
          - kNetworkSecurityGroup
          - kInstanceType
          - kLabel
          - kMetadata
          - kTag
          - kVPCConnector
          type: string
        description: Specifies the GCP object types to filter objects.
        name: gcpObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kPrismCentral
          - kStandaloneCluster
          - kOtherHypervisorCluster
          - kCluster
          - kHost
          - kVirtualMachine
          - kNetwork
          - kStorageContainer
          type: string
        description: Specifies the Acropolis object types to filter objects.
        name: acropolisObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kGroup
          - kHost
          - kDfsGroup
          - kDfsTopDir
          type: string
        description: Specifies the generic NAS object types to filter objects.
        name: genericNasObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kZone
          - kMountPoint
          type: string
        description: Specifies the Isilon object types to filter objects.
        name: isilonObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kStorageArray
          - kFileSystem
          type: string
        description: Specifies the Flashblade object types to filter objects.
        name: flashbladeObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kContainer
          type: string
        description: Specifies the Elastifile object types to filter objects.
        name: elastifileObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kFilesystem
          - kFileset
          type: string
        description: Specifies the GPFS object types to filter objects.
        name: gpfsObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kStorageArray
          - kVolume
          type: string
        description: Specifies the Pure object types to filter objects.
        name: pureObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kStorageArray
          - kVolume
          type: string
        description: Specifies the Nimble object types to filter objects.
        name: nimbleObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kGroup
          - kHost
          - kWindowsCluster
          - kOracleRACCluster
          - kOracleAPCluster
          type: string
        description: Specifies the Physical object types to filter objects.
        name: physicalObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kCluster
          - kNamespace
          - kService
          - kPVC
          - kLabel
          type: string
        description: Specifies the Kubernetes object types to filter objects.
        name: kubernetesObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kRootContainer
          - kDAGRootContainer
          - kExchangeNode
          - kExchangeDAGDatabaseCopy
          - kExchangeStandaloneDatabase
          - kExchangeDAG
          - kExchangeDAGDatabase
          type: string
        description: Specifies the Exchange object types to filter objects.
        name: exchangeObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kRootContainer
          - kDomainController
          type: string
        description: Specifies the AD object types to filter objects.
        name: adObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kInstance
          - kDatabase
          - kAAG
          - kAAGRootContainer
          - kRootContainer
          type: string
        description: Specifies the MSSQL object types to filter objects.
        name: mssqlObjectTypes
        in: query
      - type: array
        items:
          enum:
          - kRACRootContainer
          - kRootContainer
          - kHost
          - kDatabase
          - kTableSpace
          - kTable
          - kPDB
          type: string
        description: Specifies the Oracle object types to filter objects.
        name: oracleObjectTypes
        in: query
      responses:
        '200':
          $ref: '#/responses/SourceHierarchyObjectSummariesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/analysis-groups:
    get:
      description: Get list of all data tiering analysis groups.
      tags:
      - Data Tiering
      summary: Get the list of data tiering analysis groups.
      operationId: GetDataTieringAnalysisGroups
      parameters:
      - type: array
        items:
          type: string
        description: Filter by a list of Analysis Group IDs.
        name: ids
        in: query
      responses:
        '200':
          $ref: '#/responses/GetDataTieringAnalysisGroupsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a data tiering analysis group.
      tags:
      - Data Tiering
      summary: Create a data tiering analysis group.
      operationId: CreateDataTieringAnalysisGroup
      parameters:
      - description: Specifies the data tiering analysis group.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CommonDataTieringAnalysisGroupParams'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateDataTieringAnalysisGroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/analysis-groups/states:
    post:
      description: 'Perform actions like pause or resume on the data tiering analysis

        groups for the specified sources.'
      tags:
      - Data Tiering
      summary: Update data tiering analysis groups state.
      operationId: UpdateDataTieringAnalysisGroupsState
      parameters:
      - description: 'Specifies the parameters to perform an action of list of data
          tiering

          analysis groups.'
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateDataTieringStateRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateDataTieringStateResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/analysis-groups/{id}:
    get:
      description: Get data tiering analysis group by id.
      tags:
      - Data Tiering
      summary: Get data tiering analysis group by id.
      operationId: GetDataTieringAnalysisGroupById
      parameters:
      - type: string
        description: Specifies a unique id of the data tiering analysis group.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetDataTieringAnalysisGroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: 'Returns NoContentResponse if the data tiering analysis group is

        deleted.'
      tags:
      - Data Tiering
      summary: Delete data tiering analysis group.
      operationId: DeleteDataTieringAnalysisGroup
      parameters:
      - type: string
        description: Specifies a unique id of the data tiering analysis group.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/analysis-groups/{id}/config:
    put:
      description: Update data tiering analysis group config.
      tags:
      - Data Tiering
      summary: Update data tiering analysis group config.
      operationId: UpdateDataTieringAnalysisGroupTagsConfig
      parameters:
      - type: string
        description: Specifies a unique id of the data tiering analysis group.
        name: id
        in: path
        required: true
      - description: Specifies the data tiering analysis Tags Config.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DataTieringTagConfig'
      responses:
        '200':
          $ref: '#/responses/UpdateDataTieringTagConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/analysis-groups/{id}/runs:
    post:
      description: Create a data tiering analysis group run.
      tags:
      - Data Tiering
      summary: Create a data tiering analysis group run.
      operationId: CreateDataTieringAnalysisGroupRun
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id of the data tiering analysis group.
        name: id
        in: path
        required: true
      responses:
        '202':
          $ref: '#/responses/AcceptedResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/analysis-groups/{id}/runs/{runId}/cancel:
    post:
      description: 'Cancel data tiering analysis run for given analysis group ID

        and run ID'
      tags:
      - Data Tiering
      summary: Cancel data tiering analysis run.
      operationId: CancelDataTieringAnalysisGroupRun
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies a unique id of data tiering group.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies a unique run id of data tiering group run.
        name: runId
        in: path
        required: true
      responses:
        '202':
          $ref: '#/responses/AcceptedResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/tasks:
    get:
      description: Get the list of data tiering tasks.
      tags:
      - Data Tiering
      summary: Get the list of data tiering tasks.
      operationId: GetDataTieringTasks
      parameters:
      - type: array
        items:
          type: string
        description: Filter by a list of data tiering task ids.
        name: ids
        in: query
      responses:
        '200':
          $ref: '#/responses/DataTieringTasksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a data tiering task.
      tags:
      - Data Tiering
      summary: Create a data tiering task.
      operationId: CreateDataTieringTask
      parameters:
      - description: Specifies the parameters to create a data tiering task.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonDataTieringTaskParams
          $ref: '#/definitions/CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396e'
      responses:
        '201':
          $ref: '#/responses/DataTieringTaskResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/tasks/states:
    post:
      description: Perform actions like pause or resume on the data tiering tasks.
      tags:
      - Data Tiering
      summary: Update data tiering source analysis tasks state.
      operationId: UpdateDataTieringTasksState
      parameters:
      - description: 'Specifies the parameters to perform an action of list of data
          tiering

          tasks.'
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateDataTieringStateRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateDataTieringStateResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/tasks/{id}:
    get:
      description: Get data tiering task by id.
      tags:
      - Data Tiering
      summary: Get data tiering task by id.
      operationId: GetDataTieringTaskById
      parameters:
      - type: string
        description: Specifies the id of the data tiering task.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/DataTieringTaskResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a data tiering task.
      tags:
      - Data Tiering
      summary: Update a data tiering task.
      operationId: UpdateDataTieringTask
      parameters:
      - type: string
        description: Specifies the id of the data tiering task.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a data tiering task.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonDataTieringTaskParams
          $ref: '#/definitions/CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396e'
      responses:
        '200':
          $ref: '#/responses/DataTieringTaskResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Returns Success if the data tiering task is deleted.
      tags:
      - Data Tiering
      summary: delete the data tiering task.
      operationId: DeleteDataTieringTask
      parameters:
      - type: string
        description: Specifies the id of the data tiering task.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/tasks/{id}/runs:
    post:
      description: Create a data tiering tasks run.
      tags:
      - Data Tiering
      summary: Create a data tiering tasks run.
      operationId: CreateDataTieringTaskRun
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id of the data tiering tasks.
        name: id
        in: path
        required: true
      - description: Specifies the request to run tiering task once.
        name: body
        in: body
        schema:
          $ref: '#/definitions/DataTieringTaskRunRequest'
      responses:
        '202':
          $ref: '#/responses/AcceptedResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /data-tiering/tasks/{id}/runs/{runId}/cancel:
    post:
      description: Cancel data tiering task run for given data tiering task id and
        run id.
      tags:
      - Data Tiering
      summary: Cancel data tiering task.
      operationId: CancelDataTieringTaskRun
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies a unique id of data tiering task.
        name: id
        in: path
        required: true
      - pattern: ^\d+:\d+$
        type: string
        description: Specifies a unique run id of data tiering task.
        name: runId
        in: path
        required: true
      responses:
        '202':
          $ref: '#/responses/AcceptedResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /disks/assimilate:
    post:
      description: Assimilate list of disks from one or more nodes of cluster.
      tags:
      - Platform
      summary: Assimilate disks.
      operationId: DisksAssimilate
      parameters:
      - description: Specifies the parameter to assimilate disks.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ClusterFreeDisks'
      responses:
        '200':
          $ref: '#/responses/DiskAssimilationResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /disks/discover:
    get:
      description: Discover disks that are ready for activation
      tags:
      - Platform
      summary: Discover new disks
      operationId: DiscoverDisks
      responses:
        '200':
          $ref: '#/responses/DiscoverDisksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /disks/identify:
    post:
      description: Turn on/off led light of a disk.
      tags:
      - Platform
      summary: Identify a disk
      operationId: DiskIdentify
      parameters:
      - description: Specifies the parameter to identify disk.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DiskIdentify'
      responses:
        '200':
          $ref: '#/responses/DiskIdentifyResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /disks/local:
    get:
      description: Get list of local disks.
      tags:
      - Platform
      summary: Get list of disks
      operationId: ListDisks
      parameters:
      - type: integer
        format: int64
        description: Specifies node id of the node to get list of disks
        name: nodeId
        in: query
      responses:
        '200':
          $ref: '#/responses/DisksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /disks/remote:
    get:
      description: Get remote disks.
      tags:
      - Platform
      summary: Get remote disks
      operationId: GetRemoteDisks
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of disk ids, only disks having these ids will
          be returned.
        name: diskIds
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Specifies a list of node ids, only disks in these nodes will
          be returned.
        name: nodeIds
        in: query
      - type: array
        items:
          enum:
          - PCIeSSD
          - SATA-SSD
          - SATA-HDD
          - CLOUD
          type: string
        description: Specifies a list of disk tiers, only disks with given tiers will
          be returned.
        name: tiers
        in: query
      - type: string
        description: This field is deprecated. Providing this queryparam will not
          have any impact. Please use fileSystem query param to filter instead.
        name: mountPath
        in: query
      - type: string
        description: Specified file system name to search. only disks with file system
          name that partially matches the specified name will be returned.
        name: fileSystem
        in: query
      responses:
        '200':
          $ref: '#/responses/GetRemoteDisksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Add a remote disk.
      tags:
      - Platform
      summary: Add remote disk
      operationId: AddRemoteDisk
      parameters:
      - description: Specifies the remote disk configuration.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RemoteDisks'
      responses:
        '201':
          $ref: '#/responses/AddRemoteDiskResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /disks/remote/{id}:
    delete:
      description: Remove a remote disk.
      tags:
      - Platform
      summary: Remove remote disk
      operationId: RemoveRemoteDisk
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the remote disk to remove.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /disks/{id}/remove:
    post:
      description: Mark disk for removal or cancel removal if a disk is already marked
        for removal.
      tags:
      - Platform
      summary: Mark Disk for removal
      operationId: MarkDiskRemoval
      parameters:
      - type: integer
        format: int64
        description: Specifies unique id of the disk to mark for removal.
        name: id
        in: path
        required: true
      - description: Specifies parameters to mark/cancel disk removal.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DiskRemovalParams'
      responses:
        '200':
          $ref: '#/responses/DiskRemovalResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /dmaas-tenant-certificate:
    get:
      description: Get DMaaS tenant certificates on the cluster.
      tags:
      - DMaaSTenantCertificate
      summary: Get DMaaS tenant certificates on the cluster.
      operationId: GetDmaasTenantCerts
      parameters:
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which tenants are returned.
          If no tenant id is specified, all tenant certificates are returned.
        name: tenantIds
        in: query
      responses:
        '200':
          $ref: '#/responses/GetDmaasTenantCertsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Add a DMaaS tenant certificate to the cluster.
      tags:
      - DMaaSTenantCertificate
      summary: Add a DMaaS tenant certificate to the cluster.
      operationId: AddDmaasTenantCert
      parameters:
      - description: Specifies the parameters to add the tenant certificate.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/AddDmaasTenantCertRequest'
      responses:
        '201':
          $ref: '#/responses/AddDmaasTenantCertResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /dmaas-tenant-certificate/{tenantId}:
    delete:
      description: Delete a tenant certificate.
      tags:
      - DMaaSTenantCertificate
      summary: Delete a tenant certificate.
      operationId: DeleteDmaasTenantCert
      parameters:
      - type: string
        x-nullable: true
        description: Specifies the id of tenant.
        name: tenantId
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /domain-controllers:
    get:
      description: Get Domain Controllers of specified domains.
      tags:
      - ActiveDirectory
      summary: Get Domain Controllers of specified domains.
      operationId: GetDomainControllers
      parameters:
      - minItems: 1
        uniqueItems: true
        type: array
        items:
          pattern: ^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$
          type: string
        description: Specifies a list of domain names.
        name: domainNames
        in: query
        required: true
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the Id of the connection which the connector belongs
          to.
        name: connectionId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetDomainControllersResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /file-services/view-template:
    get:
      description: 'All view templates on the Cohesity Cluster are returned.

        Specifying parameters filters the results that are returned.'
      tags:
      - Views
      summary: List View Templates
      operationId: ReadViewTemplates
      responses:
        '200':
          $ref: '#/responses/ReadViewTemplatesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Creates a View Template.
      tags:
      - Views
      summary: Create a View Template
      operationId: CreateViewTemplate
      parameters:
      - description: Request to create a view template.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Template'
      responses:
        '201':
          $ref: '#/responses/CreateViewTemplateResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /file-services/view-template/{id}:
    get:
      description: Reads a view template based on given template id.
      tags:
      - Views
      summary: Read a View Template by Id
      operationId: ReadViewTemplateById
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the view template.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/ReadViewTemplateByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Updates a View Template.
      tags:
      - Views
      summary: Update a View Template
      operationId: UpdateViewTemplate
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the view template.
        name: id
        in: path
        required: true
      - description: Request to update a view template.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Template'
      responses:
        '200':
          $ref: '#/responses/UpdateViewTemplateResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Deletes a view template based on given template id.
      tags:
      - Views
      summary: Delete a View Template
      operationId: DeleteViewTemplate
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the view template to delete.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /file-services/views:
    get:
      description: 'If no parameters are specified, all Views on the Cohesity Cluster
        are returned.

        Specifying parameters filters the results that are returned.

        NOTE: If maxCount is set and the number of Views returned exceeds the maxCount,

        there are more Views to return.

        To get the next set of Views, send another request and specify the id of the

        last View returned in viewList from the previous response.'
      tags:
      - Views
      summary: List Views
      operationId: GetViews
      parameters:
      - type: array
        items:
          type: string
        description: Filter by a list of View names.
        name: viewNames
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Filter by a list of View ids.
        name: viewIds
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Filter by a list of Storage Domains (View Boxes) specified by
          id.
        name: storageDomainIds
        in: query
      - type: array
        items:
          type: string
        description: Filter by a list of View Box names.
        name: storageDomainNames
        in: query
      - type: array
        items:
          enum:
          - NFS
          - NFS4
          - SMB
          - S3
          - Swift
          type: string
        description: 'Filter by a list of protocol accesses. Only views with

          protocol accesses in these specified accesses list will be returned.'
        name: protocolAccesses
        in: query
      - type: boolean
        description: 'If true, the names in viewNames are matched by any partial rather
          than

          exactly matched.'
        name: matchPartialNames
        in: query
      - type: integer
        format: int32
        description: Specifies a limit on the number of Views returned.
        name: maxCount
        in: query
      - type: boolean
        description: 'Specifies if internal Views created by the Cohesity Cluster
          are

          also returned. In addition, regular Views are returned.'
        name: includeInternalViews
        in: query
      - type: boolean
        description: 'Specifies if Protection Groups information needs to be returned
          along with

          view metadata. By default, if not set or set to true, Group information
          is

          returned.'
        name: includeProtectionGroups
        in: query
      - type: integer
        format: int64
        description: 'If the number of Views to return exceeds the maxCount specified
          in the

          original request, specify the id of the last View

          from the viewList in the previous response

          to get the next set of Views.'
        name: maxViewId
        in: query
      - type: boolean
        description: 'Specifies if inactive Views on this Remote Cluster (which have

          Snapshots copied by replication) should also be returned.

          Inactive Views are not counted towards the maxCount.

          By default, this field is set to false.'
        name: includeInactive
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: 'Filter by Protection Group ids. Return Views that are being
          protected by

          listed Groups, which are specified by ids.'
        name: protectionGroupIds
        in: query
      - type: boolean
        description: 'Whether to get just the total number of views with the given
          input

          filters. If the flag is true, we ignore the parameter ''maxViews'' for the

          count. Also, if flag is true, list of views will not be returned.'
        name: viewCountOnly
        in: query
      - type: boolean
        description: If set to true, the list is sorted descending by logical usage.
        name: sortByLogicalUsage
        in: query
      - type: array
        items:
          type: string
        description: 'Sids of restricted principals who can access the view. This
          is an

          internal field and therefore does not have json tag.'
        name: internalAccessSids
        in: query
      - type: boolean
        description: If true, view aliases are also matched with the names in viewNames.
        name: matchAliasNames
        in: query
      - type: array
        items:
          type: string
        description: 'TenantIds contains ids of the tenants for which objects are
          to be

          returned.'
        name: tenantIds
        in: query
      - type: boolean
        description: 'IncludeTenants specifies if objects of all the tenants under
          the

          hierarchy of the logged in user''s organization should be returned.'
        name: includeTenants
        in: query
      - type: boolean
        description: 'If set to true, stats of views will be returned. By default
          this parameter

          is set to false.'
        name: includeStats
        in: query
      - type: boolean
        description: 'If set to true, the list will contain only the views for which
          antivirus

          scan is enabled.'
        name: includeViewsWithAntivirusEnabledOnly
        in: query
      - type: boolean
        description: 'If set to true, the list will contain only the views for which
          either

          file level data lock is enabled or view level data lock is enabled.'
        name: includeViewsWithDataLockEnabledOnly
        in: query
      - type: boolean
        description: 'If set to true, only views with filer audit log enabled will
          be returned.

          If set to false, only views with filer audit log disabled will be returned.'
        name: filerAuditLogEnabled
        in: query
      responses:
        '200':
          $ref: '#/responses/GetViewsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Creates a View.
      tags:
      - Views
      summary: Create a View
      operationId: CreateView
      parameters:
      - description: Request to create a View.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateViewRequest'
      responses:
        '201':
          $ref: '#/responses/CreateViewResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /file-services/views/{id}:
    get:
      description: Get a View based on given Id.
      tags:
      - Views
      summary: Get a View by Id
      operationId: GetViewById
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the View to delete.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetViewByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Updates a View based on given id.
      tags:
      - Views
      summary: Update a View
      operationId: UpdateView
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the View to update.
        name: id
        in: path
        required: true
      - description: Request to update a view.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/View'
      responses:
        '200':
          $ref: '#/responses/UpdateViewResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Deletes a View based on given id.
      tags:
      - Views
      summary: Delete a View
      operationId: DeleteView
      parameters:
      - type: integer
        format: int64
        description: Specifies a unique id of the View to delete.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /fleet-env-info:
    post:
      description: Add fleet environment info to cluster.
      tags:
      - FleetInstance
      summary: Update Fleet Env Info.
      operationId: UpdateFleetEnvInfo
      parameters:
      - description: Specifies the parameters to add fleet env info.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateFleetEnvInfoRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateFleetEnvInfoResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /helios-registration:
    post:
      description: Claim to Helios.
      tags:
      - HeliosRegistration
      summary: Register to Helios.
      operationId: HeliosClaim
      parameters:
      - description: Specifies the parameters to claim to Helios.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/HeliosClaimRequest'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /helios-registration-config:
    get:
      description: Lists the Helios Registration Config.
      tags:
      - HeliosRegistration
      summary: Lists the Helios Registration Config.
      operationId: GetHeliosRegConfig
      responses:
        '200':
          $ref: '#/responses/HeliosRegConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /kerberos-providers:
    get:
      description: Get the list of Kerberos Authentication Providers.
      tags:
      - Kerberos Providers
      summary: Get the list of Kerberos Providers.
      operationId: GetKerberosProviders
      parameters:
      - type: array
        items:
          type: string
        x-omitempty: true
        description: Filter by a list of realm names.
        name: realmNames
        in: query
      - type: array
        items:
          type: integer
          format: int64
        x-omitempty: true
        description: Filter by a list of Kerberos Provider Ids.
        name: ids
        in: query
      - type: array
        items:
          type: string
        x-omitempty: true
        description: Filter by a list of KDC servers.
        name: kdcServers
        in: query
      responses:
        '200':
          $ref: '#/responses/GetKerberosProvidersResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /kerberos-providers/register:
    post:
      description: Register a Kerberos Authentication Provider.
      tags:
      - Kerberos Providers
      summary: Register a Kerberos Authentication Provider.
      operationId: RegisterKerberosProvider
      parameters:
      - description: Specifies the parameters to Register a Kerberos Provider.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegisterOrUpdateKerberosProviderRequest'
      responses:
        '201':
          $ref: '#/responses/RegisterOrUpdateKerberosProviderResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /kerberos-providers/unregister/{id}:
    post:
      description: Unregister a Kerberos Provider.
      tags:
      - Kerberos Providers
      summary: Unregister a Kerberos Provider.
      operationId: UnregisterKerberosProvider
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: Specifies the id.
        name: id
        in: path
        required: true
      - description: Request to unregister a Kerberos Provider.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UnregisterKerberosRequest'
      responses:
        '200':
          $ref: '#/responses/UnregisterKerberosProviderResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /kerberos-providers/{id}:
    get:
      description: Get the Registered Kerberos Provider by id.
      tags:
      - Kerberos Providers
      summary: Get the Registered Kerberos Provider by id.
      operationId: GetKerberosProviderById
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: 'Specifies the id which will be of the pattern

          cluster_id:clusterincarnation_id:resource_id.'
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetKerberosProviderByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update the Kerberos Provider Registration.
      tags:
      - Kerberos Providers
      summary: Update the Kerberos Provider Registration.
      operationId: UpdateKerberosProvider
      parameters:
      - pattern: ^\d+:\d+:\d+$
        type: string
        description: 'Specifies the id which will be of the pattern

          cluster_id:clusterincarnation_id:resource_id.'
        name: id
        in: path
        required: true
      - description: Request to update a Kerberos Provider.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegisterOrUpdateKerberosProviderRequest'
      responses:
        '200':
          $ref: '#/responses/RegisterOrUpdateKerberosProviderResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /keystones:
    get:
      description: Get Keystones.
      tags:
      - Keystone
      summary: Get Keystones.
      operationId: GetKeystones
      parameters:
      - uniqueItems: true
        type: array
        items:
          type: string
        description: Specifies a list of Keystone names.
        name: names
        in: query
      - uniqueItems: true
        type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Keystones which were created
          by all tenants which the current user has permission to see. If false, then
          only Keystones created by the current user will be returned.
        name: includeTenants
        in: query
      responses:
        '200':
          $ref: '#/responses/GetKeystonesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a Keystone configuration.
      tags:
      - Keystone
      summary: Create a Keystone configuration.
      operationId: CreateKeystone
      parameters:
      - description: Specifies the paremters to create a Keystone configuration.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateKeystoneRequest'
      responses:
        '201':
          $ref: '#/responses/GetKeystonesByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /keystones/{id}:
    get:
      description: Get a Keystone by its id.
      tags:
      - Keystone
      summary: Get a Keystone by its id.
      operationId: GetKeystonesById
      parameters:
      - type: integer
        format: int64
        description: Specifies the Keystone id.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetKeystonesByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a Keystone configuration.
      tags:
      - Keystone
      summary: Update a Keystone configuration.
      operationId: UpdateKeystone
      parameters:
      - type: integer
        format: int64
        description: Specifies the Keystone id.
        name: id
        in: path
        required: true
      - description: Specifies the paremters to update a Keystone configuration.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateKeystoneRequest'
      responses:
        '200':
          $ref: '#/responses/GetKeystonesByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a Keystone configuration.
      tags:
      - Keystone
      summary: Delete a Keystone configuration.
      operationId: DeleteKeystone
      parameters:
      - type: integer
        format: int64
        description: Specifies the Keystone id.
        name: id
        in: path
        required: true
      - type: string
        description: Specifies the password of Keystone administrator.
        name: adminPassword
        in: header
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /network-interfaces:
    get:
      description: Get a list of interfaces present on the node or cluster.
      tags:
      - Platform
      summary: Get list of interfaces
      operationId: GetNetworkInterfaces
      responses:
        '200':
          $ref: '#/responses/GetNetworkInterfacesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /networkReset:
    post:
      description: This is destructive operation. Reset nodes' networking in cluster
        to factory state or cancel the reset operation.
      tags:
      - network-reset
      summary: Set or cancel cluster reset state. This is destructive operation.
      operationId: ResetNodesNetwork
      parameters:
      - description: Request to reset or restore cluster networking.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ResetOrRestoreNetworking'
      responses:
        '202':
          $ref: '#/responses/AcceptedResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /networkReset/status:
    get:
      description: Get networking reset state status.
      tags:
      - network-reset
      summary: List of nodes reset states.
      operationId: GetNetworkResetStates
      responses:
        '202':
          $ref: '#/responses/GetNodesResetStateResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nis-netgroups:
    get:
      description: Get a list of NIS netgroups.
      tags:
      - Network Information Service (NIS)
      summary: Get a list of NIS netgroups.
      operationId: GetNisNetgroups
      parameters:
      - type: array
        items:
          type: string
        description: Filter by a list of NIS netgroup names.
        name: netgroupNames
        in: query
      responses:
        '200':
          $ref: '#/responses/GetNisNetgroupsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create an NIS netgroup.
      tags:
      - Network Information Service (NIS)
      summary: Create an NIS netgroup.
      operationId: CreateNisNetgroup
      parameters:
      - description: Specifies the parameters to create an NIS netgroup.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NisNetgroup'
      responses:
        '201':
          $ref: '#/responses/NisNetgroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nis-netgroups/{name}:
    get:
      description: Get an NIS netgroup by name.
      tags:
      - Network Information Service (NIS)
      summary: Get an NIS netgroup by name.
      operationId: GetNisNetgroupByName
      parameters:
      - type: string
        description: Specifies name of the NIS netgroup.
        name: name
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetNisNetgroupByNameResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update an NIS netgroup by name.
      tags:
      - Network Information Service (NIS)
      summary: Update an NIS netgroup by name.
      operationId: UpdateNisNetgroupByName
      parameters:
      - type: string
        description: Specifies name of the NIS netgroup.
        name: name
        in: path
        required: true
      - description: Request to update the NIS netgroup.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NisNetgroup'
      responses:
        '200':
          $ref: '#/responses/NisNetgroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete an NIS netgroup by name.
      tags:
      - Network Information Service (NIS)
      summary: Delete an NIS netgroup by name.
      operationId: DeleteNisNetgroupByName
      parameters:
      - type: string
        description: Specifies name of the NIS netgroup.
        name: name
        in: path
        required: true
      - description: Request to delete the NIS netgroup.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NisNetgroup'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nis-providers:
    get:
      description: Get a list of NIS Providers.
      tags:
      - Network Information Service (NIS)
      summary: Get a list of NIS Providers.
      operationId: GetNisProviders
      parameters:
      - type: array
        items:
          type: string
        description: Filter by a list of NIS domain names.
        name: domainNames
        in: query
      responses:
        '200':
          $ref: '#/responses/GetNisProvidersResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create an NIS Provider.
      tags:
      - Network Information Service (NIS)
      summary: Create an NIS Provider.
      operationId: CreateNisProvider
      parameters:
      - description: Specifies the parameters to create an NIS provider entry.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NisProvider'
      responses:
        '201':
          $ref: '#/responses/NisProviderResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nis-providers/{domain}:
    get:
      description: Get an NIS Provider by domain name.
      tags:
      - Network Information Service (NIS)
      summary: Get an NIS Provider by domain name.
      operationId: GetNisProviderByDomainName
      parameters:
      - type: string
        description: Specifies domain of an NIS Provider.
        name: domain
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetNisProviderByDomainNameResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update an NIS Provider by domain name.
      tags:
      - Network Information Service (NIS)
      summary: Update an NIS Provider by domain name.
      operationId: UpdateNisProviderByDomainName
      parameters:
      - type: string
        description: Specifies domain name of an NIS Provider.
        name: domain
        in: path
        required: true
      - description: Request to update an NIS Provider.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NisProvider'
      responses:
        '200':
          $ref: '#/responses/NisProviderResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete an NIS Provider by domain name.
      tags:
      - Network Information Service (NIS)
      summary: Delete an NIS Provider by domain name.
      operationId: DeleteNisProviderByDomainName
      parameters:
      - type: string
        description: Specifies domain name of an NIS Provider.
        name: domain
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nodeGroups:
    get:
      description: List node groups.
      tags:
      - NodeGroups
      summary: List Node Groups based on provided filtering parameters.
      operationId: GetNodeGroups
      parameters:
      - type: array
        items:
          type: string
        description: Filter node groups by a list of node group names.
        name: groupNames
        in: query
      - type: integer
        format: int32
        description: Filter node groups by a node group type.
        name: groupType
        in: query
      responses:
        '200':
          $ref: '#/responses/GetNodeGroupsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create the Node Group and returns the newly created node group
        object.
      tags:
      - NodeGroups
      summary: Create a Node Group.
      operationId: CreateNodeGroup
      parameters:
      - description: Request to create a Node Group.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NodeGroupRequest'
      responses:
        '201':
          $ref: '#/responses/CreateNodeGroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nodeGroups/{groupName}:
    get:
      description: Returns Node Group for given Group Name.
      tags:
      - NodeGroups
      summary: List Node Groups for a given Group Name.
      operationId: GetNodeGroupByName
      parameters:
      - type: string
        description: Specifies a unique id of Node Group to return.
        name: groupName
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetNodeGroupByNameResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Specifies the request to update the existing Node Group. On successful
        update, returns the updated node group object.
      tags:
      - NodeGroups
      summary: Update a Node Group.
      operationId: UpdateNodeGroup
      parameters:
      - type: string
        description: Specifies a unique name of the Node Group to update.
        name: groupName
        in: path
        required: true
      - description: Request to update a Node Group.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NodeGroupRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateNodeGroupResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Deletes a Node Group based on given node group name.
      tags:
      - NodeGroups
      summary: Delete a Node Group.
      operationId: DeleteNodeGroup
      parameters:
      - type: string
        description: Specifies a unique name of the Node Group to delete.
        name: groupName
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nodePower:
    post:
      description: Reboot or shutdown nodes in cluster.
      tags:
      - Platform
      summary: Reboot or shutdown nodes in cluster.
      operationId: SetNodePower
      parameters:
      - description: Specifies the reboot or shutdown operation.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NodePowerOperation'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nodes/{id}/identify:
    post:
      description: Turn on/off LED light of a node to identify.
      tags:
      - Platform
      summary: Identify node
      operationId: Identify node
      parameters:
      - type: integer
        format: int64
        description: Specifies id of node to identify.
        name: id
        in: path
        required: true
      - description: Specifies the parameter to identify node.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NodeIdentifyParams'
      responses:
        '200':
          $ref: '#/responses/NodeIdentifyResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /nodes/{id}/remove:
    post:
      description: Mark node for removal or Cancel if a node is already marked for
        removal.
      tags:
      - Platform
      summary: Mark Node for removal
      operationId: MarkNodeRemoval
      parameters:
      - type: integer
        format: int64
        description: Specifies id of node to cancel removal.
        name: id
        in: path
        required: true
      - description: Specifies parameters to initiate/cancel node removal .
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NodeRemovalParams'
      responses:
        '200':
          $ref: '#/responses/NodeRemovalResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /patch-management/applied-patches:
    get:
      description: Returns a list of currently applied patches that are running on
        the cluster.
      tags:
      - Patches
      summary: Get applied patches
      operationId: GetAppliedPatches
      parameters:
      - type: string
        description: Specifies optional service name whose current patch is returned.
          If it is not specified, all the applied patches are returned.
        name: service
        in: query
      - type: boolean
        description: Specifies whether to return the details of all the fixes in the
          patch. By default, returns only the most recent fix made for the service
          in the patch.
        name: includeDetails
        in: query
      responses:
        '200':
          $ref: '#/responses/GetAppliedPatchesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Revert an applied service patch and its dependencies.
      tags:
      - Patches
      summary: Revert patches
      operationId: RevertPatches
      parameters:
      - description: Request to revert patches.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RevertPatchesRequest'
      responses:
        '201':
          $ref: '#/responses/RevertPatchesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /patch-management/available-patches:
    get:
      description: Returns a list of patches that are available and ready to apply
        on the cluster.
      tags:
      - Patches
      summary: Get available patches
      operationId: GetAvailablePatches
      parameters:
      - type: string
        description: Specifies optional service name whose available patch is returned.
          If it is not specified, available patches for all the serivces are returned.
        name: service
        in: query
      - type: boolean
        description: Specifies whether to return the description of all the fixes
          in the patch. By default, returns only the most recent fix made for the
          service in the patch.
        name: includeDetails
        in: query
      responses:
        '200':
          $ref: '#/responses/GetAvailablePatchesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Import a patch or a hotfix to the cluster.
      consumes:
      - multipart/formData
      tags:
      - Patches
      summary: Import patches
      operationId: ImportPatches
      parameters:
      - type: string
        name: fileName
        in: formData
        required: true
      - type: string
        name: checksum
        in: formData
        required: true
      - type: file
        name: patch
        in: formData
        required: true
      responses:
        '201':
          $ref: '#/responses/ImportPatchesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Apply a service patch and its dependencies.
      tags:
      - Patches
      summary: Apply patches
      operationId: ApplyPatches
      parameters:
      - description: Request to apply patches.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ApplyPatchesRequest'
      responses:
        '201':
          $ref: '#/responses/ApplyPatchesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /patch-management/operation-status:
    get:
      description: Returns the status of the current or the last patch operation.
        There can be only one active patch operation at any given time.
      tags:
      - Patches
      summary: Get patch operation status
      operationId: GetPatchOperationStatus
      parameters:
      - type: boolean
        description: Specifies whether to return details of all service patch opertions
          on all nodes. By default, returns whether there is a patch operation in
          progress or not.
        name: includeDetails
        in: query
      responses:
        '200':
          $ref: '#/responses/GetPatchOperationStatusResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /patch-management/patches-history:
    get:
      description: Get the history of all the patch management operations.
      tags:
      - Patches
      summary: Get patches history
      operationId: GetPatchesHistory
      parameters:
      - type: string
        description: Specifies optional service name whose patch operation history
          is returned. If it is not specified, patch operations of all the serivces
          are returned.
        name: service
        in: query
      responses:
        '200':
          $ref: '#/responses/GetPatchesHistoryResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /racks:
    get:
      description: Get list of all racks that are part of cluster.
      tags:
      - Platform
      summary: Get list of racks
      operationId: GetRacks
      responses:
        '200':
          $ref: '#/responses/RacksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create list of racks and optionally also assign list of chassis
        to each rack
      tags:
      - Platform
      summary: Create racks
      operationId: CreateRacks
      parameters:
      - description: Specifies the parameters to create racks.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Racks'
      responses:
        '201':
          $ref: '#/responses/RacksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete all the racks.
      tags:
      - Platform
      summary: Delete all the racks.
      operationId: DeleteRacks
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    patch:
      description: Updates list of racks with name, chassis list or/and location
      tags:
      - Platform
      summary: Update racks
      operationId: UpdateRacks
      parameters:
      - description: Specifies the parameters to update racks.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Racks'
      responses:
        '200':
          $ref: '#/responses/RacksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /racks/{id}:
    get:
      description: Get a rack info by id.
      tags:
      - Platform
      summary: Get a rack by rack id.
      operationId: GetRackById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of rack.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/RackResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a given rack by id.
      tags:
      - Platform
      summary: Delete a rack by id.
      operationId: DeleteRackById
      parameters:
      - type: string
        description: Specifies a unique id of the rack.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    patch:
      description: Update selected properties of a rack given by id.
      tags:
      - Platform
      operationId: UpdateRackById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of rack.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update rack.
        name: body
        in: body
        schema:
          $ref: '#/definitions/Rack'
      responses:
        '200':
          $ref: '#/responses/RackResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /refresh-bulletin-board:
    post:
      description: Refresh bulletin board from Helios.
      tags:
      - Internal
      summary: Refresh bulletin board from Helios.
      operationId: RefreshBulletinBoard
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /remote-storage:
    get:
      description: Get summary about list of registered remote storage servers.
      tags:
      - Platform
      summary: Get Registered Remote Storage Servers List
      operationId: GetRegisteredRemoteStorageList
      responses:
        '200':
          $ref: '#/responses/RegisteredRemoteStorageListResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Register a remote storage to be used for disaggregated storage.
      tags:
      - Platform
      summary: Register Remote Storage
      operationId: RegisterNewRemoteStorage
      parameters:
      - description: Specifies the parameters to register a remote storage management
          server.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RemoteStorageInfo'
      responses:
        '201':
          $ref: '#/responses/RemoteStorageRegistrationResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /remote-storage/{id}:
    get:
      description: Get details of remote storage given by id.
      tags:
      - Platform
      summary: Get remote storage details
      operationId: GetRemoteStorageDetails
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of the registered remote storage.
        name: id
        in: path
        required: true
      - type: boolean
        default: false
        x-go-name: IncludeAvailableSpace
        description: Specifies whether to include available capacity on remote storage.
        name: includeAvailableSpace
        in: query
      - type: boolean
        default: false
        x-go-name: IncludeAvailableDataVips
        description: Specifies whether to include available data vips on remote storage.
        name: includeAvailableDataVips
        in: query
      - type: boolean
        default: false
        x-go-name: IncludeArrayInfo
        description: Includes flashblade specific info like name, software os and
          version of pure flashblade.
        name: includeArrayInfo
        in: query
      responses:
        '200':
          $ref: '#/responses/RemoteStorageRegistrationResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete remote storage registration.
      tags:
      - Platform
      summary: Delete Remote Storage Registration
      operationId: DeleteRemoteStorageRegistration
      parameters:
      - type: integer
        format: int64
        description: Specifies the registration id of the registered remote storage.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    patch:
      description: Update Registered Remote Storage Config.
      tags:
      - Platform
      summary: Update Remote Storage Config
      operationId: UpdateRemoteStorageRegistration
      parameters:
      - type: integer
        format: int64
        description: Specifies the registration id of the registered remote storage.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update the registration.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RemoteStorageInfo'
      responses:
        '200':
          $ref: '#/responses/RemoteStorageRegistrationResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /rigel-claim-logs:
    get:
      description: Lists the logs during rigel cluster creation and claim.
      tags:
      - HeliosRegistration
      summary: Lists the claim logs for rigel.
      operationId: GetRigelClaimLogs
      responses:
        '200':
          $ref: '#/responses/GetRigelClaimLogsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /security-config:
    get:
      description: Get cluster security settings.
      tags:
      - Security
      summary: Get cluster security settings.
      operationId: GetSecurityConfig
      responses:
        '200':
          $ref: '#/responses/SecurityConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update cluster security settings.
      tags:
      - Security
      summary: Update cluster security settings.
      operationId: UpdateSecurityConfig
      parameters:
      - description: Specifies the parameters to update security config.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateSecurityConfigRequest'
      responses:
        '200':
          $ref: '#/responses/SecurityConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /security-principals:
    get:
      description: Get Security Principals
      tags:
      - Users
      summary: Get Security Principals.
      operationId: GetSecurityPrincipals
      parameters:
      - minItems: 1
        uniqueItems: true
        type: array
        items:
          pattern: ^(S\-\d\-(\d+\-){1,14}\d+)$
          type: string
        description: Specifies a list of SIDs.
        name: sids
        in: query
        required: true
      responses:
        '200':
          $ref: '#/responses/GetSecurityPrincipalsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /security/ciphers:
    get:
      description: Gets the list of ciphers enabled on the cluster.
      tags:
      - Security
      summary: Gets the list of ciphers enabled on the cluster.
      operationId: GetCiphers
      responses:
        '200':
          $ref: '#/responses/CiphersResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Enable/Disable a list of ciphers on the cluster.
      tags:
      - Security
      summary: Enable/Disable a list of ciphers on the cluster. Iris must be restarted
        for the change to take effect.
      operationId: ModifyCiphers
      parameters:
      - description: Enable/Disable ciphers.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ModifyCiphersRequestBody'
      responses:
        '200':
          $ref: '#/responses/CiphersResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /stats/protection-runs:
    get:
      description: Get statistics of protection runs.
      tags:
      - Stats
      summary: Get statistics of protection runs.
      operationId: GetProtectionRunsStats
      parameters:
      - type: integer
        format: int64
        description: Specify the start time as a Unix epoch Timestamp (in microseconds),
          only runs executing after this time will be counted. By default it is current
          time minus a day.
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Specify the end time as a Unix epoch Timestamp (in microseconds),
          only runs executing before this time will be counted. By default it is current
          time.
        name: endTimeUsecs
        in: query
      - type: array
        items:
          enum:
          - Running
          - Canceled
          - Failed
          - Succeeded
          - SucceededWithWarning
          type: string
        description: Specifies a list of status, runs matching the status will be
          returned. 'Running' indicates that the run is still running. 'Canceled'
          indicates that the run has been canceled. 'Failed' indicates that the run
          has failed. 'Succeeded' indicates that the run has finished successfully.
          'SucceededWithWarning' indicates that the run finished successfully, but
          there were some warning messages.
        name: runStatus
        in: query
      responses:
        '200':
          $ref: '#/responses/GetProtectionRunsStatusResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /storage-domains/{id}:
    delete:
      description: Delete a Storage Domain.
      tags:
      - StorageDomains
      summary: Delete a Storage Domain.
      operationId: DeleteStorageDomain
      parameters:
      - type: integer
        format: int64
        description: Specified the Storage Domain id to delete.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /support-channel-config:
    get:
      description: Get support channel configuration.
      tags:
      - Platform
      summary: Get support channel configuration.
      operationId: GetSupportChannelConfig
      responses:
        '200':
          $ref: '#/responses/GetSupportChannelConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update support channel configuration.
      tags:
      - Platform
      summary: Update support channel configuration.
      operationId: UpdateSupportChannelConfig
      parameters:
      - description: Specifies the support channel configuration.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/SupportChannelConfig'
      responses:
        '200':
          $ref: '#/responses/GetSupportChannelConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /syslogAuditTags:
    get:
      description: Get cluster audit tags.
      tags:
      - Platform
      summary: Get cluster audit tags.
      operationId: GetSyslogAuditTags
      responses:
        '200':
          $ref: '#/responses/SyslogAuditTagResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Update cluster audit tags.
      tags:
      - Platform
      summary: Update cluster audit tags.
      operationId: UpdateSyslogAuditTags
      parameters:
      - description: Specifies syslog audit tag to update.
        name: body
        in: body
        schema:
          $ref: '#/definitions/SyslogAuditTag'
      responses:
        '200':
          $ref: '#/responses/SyslogAuditTagResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /syslogProgramNames:
    get:
      description: Get supported program names to configure for a syslog server.
      tags:
      - Platform
      summary: Get supported program names.
      operationId: GetSupportedSyslogProgramNames
      responses:
        '200':
          $ref: '#/responses/SyslogProgramNamesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /syslogs:
    get:
      description: Get list of syslog servers.
      tags:
      - Platform
      summary: Get list of syslog servers.
      operationId: GetSyslogServers
      responses:
        '200':
          $ref: '#/responses/GetSyslogServersResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Add a new syslog server
      tags:
      - Platform
      summary: Add Syslog Server
      operationId: AddSyslogServer
      parameters:
      - description: Specifies parameters to add syslog server.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/SyslogServer'
      responses:
        '201':
          $ref: '#/responses/AddSyslogServerResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete all syslog servers.
      tags:
      - Platform
      summary: Remove syslog servers
      operationId: RemoveSyslogServers
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /syslogs/{id}:
    get:
      description: Get a syslog server by id.
      tags:
      - Platform
      summary: Get a syslog server by id.
      operationId: GetSyslogServerById
      parameters:
      - type: integer
        format: int32
        description: Specifies the id of syslog server.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/SyslogServerResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update syslog server by id.
      tags:
      - Platform
      summary: Update a syslog server by id.
      operationId: UpdateSyslogServerById
      parameters:
      - type: integer
        format: int32
        description: Specifies the id of syslog server.
        name: id
        in: path
        required: true
      - description: Specifies the body of syslog server body to update.
        name: body
        in: body
        schema:
          $ref: '#/definitions/SyslogServer'
      responses:
        '200':
          $ref: '#/responses/SyslogServerResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete syslog server by id.
      tags:
      - Platform
      summary: Remove syslog server by id
      operationId: RemoveSyslogServer
      parameters:
      - type: integer
        format: int32
        description: Specifies a unique id of the syslog server.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    patch:
      description: Patch syslog server by id.
      tags:
      - Platform
      summary: Patch a syslog server by id.
      operationId: PatchSyslogServerById
      parameters:
      - type: integer
        format: int32
        description: Specifies the id of syslog server.
        name: id
        in: path
        required: true
      - description: Specifies the body of syslog server fields to patch.
        name: body
        in: body
        schema:
          $ref: '#/definitions/SyslogServer'
      responses:
        '200':
          $ref: '#/responses/SyslogServerResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /syslogs/{id}/status:
    get:
      description: Check syslog server reachability by given Id.
      tags:
      - Platform
      summary: Get a syslog server reachability status.
      operationId: GetSyslogServerStatusById
      parameters:
      - type: integer
        format: int32
        description: Specifies the id of syslog server.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/SyslogServerStatusResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tags:
    get:
      description: 'If no parameters are specified, all tags are returned.

        Specifying parameters filters the results that are returned.'
      tags:
      - Tags
      summary: Get tags based on filters.
      operationId: GetTags
      parameters:
      - type: array
        items:
          pattern: ^\d+:\d+:[A-Z0-9-]+$
          type: string
        description: 'Filter by a list of Tag Ids. If Ids are mentioned all other
          fields

          will be ignored.'
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: Filter by a list of Tag names.
        name: names
        in: query
      - type: array
        items:
          type: string
        description: Filter by a list of Namespaces.
        name: namespaces
        in: query
      - type: array
        items:
          type: string
        description: 'TenantIds contains ids of the tenants for which tags are to
          be

          returned.'
        name: tenantIds
        in: query
      - type: boolean
        description: 'IncludeTenants specifies if tags of all the tenants under the

          hierarchy of the logged in user''s organization should be returned.

          False, by default.'
        name: includeTenants
        in: query
      - type: boolean
        description: 'Specifies if tags marked for deletion should be shown. These
          are

          tags which are undergoing deletion. False, by default.'
        name: includeMarkedForDeletion
        in: query
      responses:
        '200':
          $ref: '#/responses/GetTagsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Creates a Tag.
      tags:
      - Tags
      summary: Create a Tag
      operationId: CreateTag
      parameters:
      - description: Request to create a Tag.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Tag'
      responses:
        '201':
          $ref: '#/responses/TagResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tags/{id}:
    get:
      description: Get Tag by id.
      tags:
      - Tags
      summary: Get Tag by id.
      operationId: GetTagById
      parameters:
      - pattern: ^\d+:\d+:[A-Z0-9-]+$
        type: string
        description: Specifies the Id of the tag.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/TagResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Updates a Tag by id.
      tags:
      - Tags
      summary: Update a Tag
      operationId: UpdateTag
      parameters:
      - pattern: ^\d+:\d+:[A-Z0-9-]+$
        type: string
        description: Specifies the Id of the tag.
        name: id
        in: path
        required: true
      - description: Request to update a tag.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Tag'
      responses:
        '200':
          $ref: '#/responses/TagResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Deletes a Tag by id.
      tags:
      - Tags
      summary: Delete a Tag
      operationId: DeleteTag
      parameters:
      - pattern: ^\d+:\d+:[A-Z0-9-]+$
        type: string
        description: Specifies the Id of the tag.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tasks:
    get:
      description: Get details about tasks by providing task ids.
      tags:
      - Tasks
      summary: Get tasks details.
      operationId: GetProgressTasks
      parameters:
      - minItems: 1
        uniqueItems: true
        type: array
        items:
          type: string
        description: Specifies a unique task id to get the deatils of a task. To fetch
          the status of multiple tasks, pass comma seperated list of taskIds.
        name: ids
        in: query
      responses:
        '200':
          $ref: '#/responses/ProgressTasksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tdm/objects:
    get:
      description: Get all TDM objects matching specified optional filter criteria.
      tags:
      - Test Data Management
      summary: Get all TDM objects
      operationId: GetTdmObjects
      parameters:
      - type: array
        items:
          type: string
        description: Get the objects matching specifies IDs.
        name: ids
        in: query
      - type: array
        items:
          enum:
          - kSQL
          - kOracle
          type: string
        description: Get the objects matching specified environments.
        name: environments
        in: query
      - type: string
        description: Get the objects matching specified name.
        name: name
        in: query
      - type: array
        items:
          type: string
        description: Get the objects belonging to the specified TDM task IDs.
        name: taskIds
        in: query
      - type: array
        items:
          enum:
          - scheduled
          - inProgress
          - succeeded
          - failed
          - canceled
          type: string
        description: Get the objects matching specified statuses.
        name: statuses
        in: query
      - type: string
        description: Get the next set of objects by specifying the cookie string,
          as received from the server in the last call.
        name: paginationCookie
        in: query
      responses:
        '200':
          $ref: '#/responses/GetTdmObjectsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tdm/objects/{id}:
    get:
      description: Get a TDM object by specifying its ID.
      tags:
      - Test Data Management
      summary: Get TDM object by ID
      operationId: GetTdmObjectById
      parameters:
      - type: string
        description: Specifies the ID of the TDM object.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetTdmObjectResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tdm/objects/{id}/timeline-events:
    get:
      description: Get the collection of timeline events of a TDM object by specifying
        its ID.
      tags:
      - Test Data Management
      summary: Get timeline events of object
      operationId: GetTdmTimelineEventsByObjectId
      parameters:
      - type: string
        description: Specifies the ID of the TDM object.
        name: id
        in: path
        required: true
      - type: integer
        format: int64
        description: Get the events created after the specified time (in usecs from
          epoch).
        name: createdAfter
        in: query
      - type: integer
        format: int64
        description: Get the events created before the specified time (in usecs from
          epoch).
        name: createdBefore
        in: query
      responses:
        '200':
          $ref: '#/responses/GetTdmObjectTimelineEventsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tdm/snapshots/{id}:
    put:
      description: Update the details of a snapshot by specifying its ID.
      tags:
      - Test Data Management
      summary: Update a snapshot by ID
      operationId: UpdateTdmSnapshotById
      parameters:
      - type: string
        description: Specifies the ID of the snapshot.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update the snapshot.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateTdmSnapshotRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateTdmSnapshotResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a snapshot by specifying its ID.
      tags:
      - Test Data Management
      summary: Delete a snapshot by ID
      operationId: DeleteTdmSnapshotById
      parameters:
      - type: string
        description: Specifies the ID of the snapshot.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tdm/tasks:
    get:
      description: Get all the TDM tasks matching specified optional filter criteria.
      tags:
      - Test Data Management
      summary: Get all TDM tasks
      operationId: GetTdmTasks
      parameters:
      - type: array
        items:
          type: string
        description: Get the tasks matching specified IDs.
        name: ids
        in: query
      - type: array
        items:
          enum:
          - clone
          - teardown
          - refresh
          - snapshot
          - rewind
          type: string
        description: Get the tasks matching specified actions.
        name: actions
        in: query
      - type: array
        items:
          enum:
          - kSQL
          - kOracle
          type: string
        description: Get the tasks matching specified environments.
        name: environments
        in: query
      - type: integer
        format: int64
        description: Get the tasks created after the specified time (in usecs from
          epoch).
        name: createdAfterUsecs
        in: query
      - type: integer
        format: int64
        description: Get the tasks created before the specified time (in usecs from
          epoch).
        name: createdBeforeUsecs
        in: query
      - type: array
        items:
          enum:
          - scheduled
          - inProgress
          - succeeded
          - failed
          - canceled
          type: string
        description: Get the tasks matching specified statuses.
        name: statuses
        in: query
      - type: array
        items:
          type: string
        description: Get the tasks for the specified TDM object IDs.
        name: objectIds
        in: query
      - type: string
        description: Get the next set of tasks by specifying the cookie string, as
          received from the server in the last call.
        name: paginationCookie
        in: query
      responses:
        '200':
          $ref: '#/responses/GetTdmTasksResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a task for the Test Data Management (TDM) workflow.
      tags:
      - Test Data Management
      summary: Create a TDM task
      operationId: CreateTdmTask
      parameters:
      - description: Specifies the parameters to create a TDM task.
        name: body
        in: body
        required: true
        schema:
          x-cohesity-discriminator-ref: CommonTdmTaskRequestParams
          $ref: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1'
      responses:
        '201':
          $ref: '#/responses/CreateTdmTaskResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tdm/tasks/{id}:
    get:
      description: Get a TDM task by ID.
      tags:
      - Test Data Management
      summary: Get a TDM task by ID
      operationId: GetTdmTaskById
      parameters:
      - type: string
        description: Specifies the ID of the TDM task.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetTdmTaskResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tenants/swift:
    get:
      description: Get a Swift configuration.
      tags:
      - Tenants
      summary: Get a Swift configuration.
      operationId: GetTenantSwift
      parameters:
      - type: string
        description: Specifies the tenant Id.
        name: tenantId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetSwiftResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a Swift configuration.
      tags:
      - Tenants
      summary: Update a Swift configuration.
      operationId: UpdateTenantSwift
      parameters:
      - description: Specifies the parameters to update a Swift configuration.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/SwiftParams'
      responses:
        '200':
          $ref: '#/responses/UpdateSwiftResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tenants/swift/register:
    post:
      description: Register Swift service on Keystone server.
      tags:
      - Tenants
      summary: Register Swift service on a Keystone server.
      operationId: RegisterSwift
      parameters:
      - description: Specifies the parameters to register a Swift service on Keystone
          server.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegisterSwiftParams'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /tenants/swift/unregister:
    post:
      description: Unregister Swift service from Keystone server.
      tags:
      - Tenants
      summary: Unregister Swift service from a Keystone server.
      operationId: UnregisterSwift
      parameters:
      - description: Specifies the parameters to unregister a Swift service from Keystone
          server.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UnregisterSwiftParams'
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /trusted-cas:
    get:
      description: List all trusted certificates in cluster trust store.
      tags:
      - Security
      summary: List all Certificates with cluster trust store.
      operationId: ListTrustedCas
      parameters:
      - type: array
        items:
          type: string
        description: Specifies the ids of the certificates to be returned.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: Specifies the names of the certificates to be returned.
        name: names
        in: query
      responses:
        '200':
          $ref: '#/responses/ListTrustedCasResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Register CA Certificate to the cluster trust store.
      tags:
      - Security
      summary: Register CA Certificate to the cluster trust store.
      operationId: RegisterTrustedCas
      parameters:
      - description: Specifies the parameters to register a Certificate.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegisterTrustedCas'
      responses:
        '201':
          $ref: '#/responses/ListTrustedCasResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /trusted-cas/{id}:
    get:
      description: List the specified Certificate.
      tags:
      - Security
      summary: List the specified Certificate.
      operationId: ListTrustedCaById
      parameters:
      - type: string
        description: Specifies the id of the certificate.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/ListTrustedCaByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Unregister CA Certificate from the cluster trust store.
      tags:
      - Security
      summary: Unregister CA Certificate from the cluster trust store.
      operationId: UnregisterTrustedCa
      parameters:
      - type: string
        description: Specifies the id of the certificate to be unregistered.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /trusted-cas/{id}/validate:
    post:
      description: Certificate will be checked for Expiration and Revocation.
      tags:
      - Security
      summary: Validate CA Certificate.
      operationId: ValidateTrustedCaById
      parameters:
      - type: string
        description: Specifies the id of the certificate to be validated.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/ListTrustedCaByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /users/sessions:
    post:
      description: Create a user session
      tags:
      - Users
      summary: Create a user session
      operationId: CreateSession
      parameters:
      - description: Specifies the parameters to create a user session
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateUserSessionRequestParams'
      responses:
        '201':
          $ref: '#/responses/UserSessionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Deletes all sessions for given user sid or system wide sessions
      tags:
      - Users
      summary: Delete user sessions
      operationId: DeleteSession
      parameters:
      - type: string
        description: Specifies a user sid. If sid is not given system wide sessions
          are deleted.
        name: sid
        in: query
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
responses:
  AcceptedResponse:
    description: Request Accepted
  AddDmaasTenantCertResponse:
    description: Success
    schema:
      $ref: '#/definitions/AddDmaasTenantCertRequest'
  AddRemoteDiskResponse:
    description: Success
    schema:
      $ref: '#/definitions/AddRemoteDiskResponseBody'
  AddSyslogServerResponse:
    description: Success
    schema:
      $ref: '#/definitions/SyslogServer'
  ApplyPatchesResponse:
    description: Success
    schema:
      $ref: '#/definitions/ServicePatchLevels'
  CancelObjectRunsResponse:
    description: Success
    schema:
      $ref: '#/definitions/CancelObjectRunsResults'
  ChassisListResponse:
    description: Success
    schema:
      $ref: '#/definitions/ChassisList'
  ChassisResponse:
    description: Success
    schema:
      $ref: '#/definitions/Chassis'
  CiphersResponse:
    description: Success
    schema:
      $ref: '#/definitions/CiphersResp'
  ClusterAMQPTargetConfigResponse:
    description: Success
    schema:
      $ref: '#/definitions/ClusterAMQPTargetConfig'
  ClusterResponse:
    description: Success
    schema:
      $ref: '#/definitions/Cluster'
  ConstructMetaInfoResponse:
    description: Success
    schema:
      $ref: '#/definitions/ConstructMetaInfoResult'
  CreateClientcsrResponse:
    description: Success
    schema:
      $ref: '#/definitions/CreateClientcsrResponseBody'
  CreateCsrResponse:
    description: Success
    schema:
      $ref: '#/definitions/CreateCsrResponseBody'
  CreateDownloadFilesAndFoldersRecoveryResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: DownloadFilesAndFoldersResponseParams
      $ref: '#/definitions/Recovery'
  CreateMcmClaimResponse:
    description: Success
    schema:
      $ref: '#/definitions/CreateMcmClaimResponseBody'
  CreateNodeGroupResponse:
    description: Success
    schema:
      $ref: '#/definitions/NodeGroupResponse'
  CreateOrUpdateActiveDirectoryResponse:
    description: Success
    schema:
      $ref: '#/definitions/ActiveDirectory'
  CreateOrUpdateBifrostConnectionResponse:
    description: Success
    schema:
      $ref: '#/definitions/BifrostConnection'
  CreateOrUpdateBifrostConnectorResponse:
    description: Success
    schema:
      $ref: '#/definitions/BifrostConnector'
  CreateOrUpdateDataTieringAnalysisGroupResponse:
    description: Success
    schema:
      $ref: '#/definitions/DataTieringAnalysisGroup'
  CreateOrUpdateProtectionGroupResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonProtectionGroupResponseParams
      $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
  CreateOrUpdateRigelConnectionResponse:
    description: Success
    schema:
      $ref: '#/definitions/RigelConnection'
  CreateOrUpdateRigelConnectorResponse:
    description: Success
    schema:
      $ref: '#/definitions/RigelConnector'
  CreateProtectedObjectsResponse:
    description: Success
    schema:
      $ref: '#/definitions/CreateProtectedObjectsResponse'
  CreateProtectionGroupRunResponse:
    description: Accepted
    schema:
      $ref: '#/definitions/CreateProtectionGroupRunResponseBody'
  CreateProtectionPolicyResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionPolicyResponse'
  CreateRecoveryResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonRecoveryResponseParams
      $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
  CreateTdmTaskResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonTdmTaskResponseParams
      $ref: '#/definitions/CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37'
  CreateViewFailoverResponse:
    description: Success
    schema:
      $ref: '#/definitions/Failover'
  CreateViewResponse:
    description: Success
    schema:
      $ref: '#/definitions/View'
  CreateViewTemplateResponse:
    description: Success
    schema:
      $ref: '#/definitions/Template'
  DataTieringTaskResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonDataTieringTaskResponse
      $ref: '#/definitions/CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2f'
  DataTieringTasksResponse:
    description: Success
    schema:
      $ref: '#/definitions/DataTieringTasks'
  DiscoverDisksResponse:
    description: Success
    schema:
      $ref: '#/definitions/ClusterFreeDisks'
  DiskAssimilationResponse:
    description: Success
    schema:
      $ref: '#/definitions/ClusterFreeDisks'
  DiskIdentifyResponse:
    description: Success
    schema:
      $ref: '#/definitions/DiskIdentify'
  DiskRemovalResponse:
    description: Success
    schema:
      $ref: '#/definitions/RemoveDisk'
  DisksResponse:
    description: Success
    schema:
      $ref: '#/definitions/DisksList'
  ErrorResponse:
    description: Error
    schema:
      $ref: '#/definitions/Error'
  FailoverCreateRunResponse:
    description: Success
    schema:
      $ref: '#/definitions/FailoverCreateRunResponse'
  FailoverRunsResponse:
    description: Success
    schema:
      $ref: '#/definitions/FailoverRunsResponse'
  FilterObjectsResponse:
    description: Success
    schema:
      $ref: '#/definitions/FilteredObjectsResponseBody'
  GetActiveDirectoriesResponse:
    description: Success
    schema:
      $ref: '#/definitions/ActiveDirectories'
  GetActiveDirectoryByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/ActiveDirectory'
  GetAlertsSummary:
    description: Success
    schema:
      $ref: '#/definitions/AlertsSummaryResponse'
  GetAppliedPatchesResponse:
    description: Success
    schema:
      $ref: '#/definitions/AppliedPatches'
  GetAuditLogsActionsResponse:
    description: Success
    schema:
      $ref: '#/definitions/AuditLogsActions'
  GetAuditLogsEntityTypesResponse:
    description: Success
    schema:
      $ref: '#/definitions/AuditLogsEntityTypes'
  GetAuditLogsResponse:
    description: Success
    schema:
      $ref: '#/definitions/AuditLogs'
  GetAvailablePatchesResponse:
    description: Success
    schema:
      $ref: '#/definitions/AvailablePatches'
  GetBifrostConnectionByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/BifrostConnection'
  GetBifrostConnectionResponse:
    description: Success
    schema:
      $ref: '#/definitions/BifrostConnections'
  GetBifrostConnectorByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/BifrostConnector'
  GetBifrostConnectorResponse:
    description: Success
    schema:
      $ref: '#/definitions/BifrostConnectors'
  GetCsrListResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetCsrListResponseBody'
  GetCsrResponse:
    description: Success
    schema:
      $ref: '#/definitions/CommonCsrResponseParams'
  GetDataTieringAnalysisGroupResponse:
    description: Success
    schema:
      $ref: '#/definitions/DataTieringAnalysisGroup'
  GetDataTieringAnalysisGroupsResponse:
    description: Success
    schema:
      $ref: '#/definitions/DataTieringAnalysisGroups'
  GetDmaasTenantCertsResponse:
    description: Success
    schema:
      $ref: '#/definitions/TenantDmaasCerts'
  GetDomainControllersResponse:
    description: Success
    schema:
      $ref: '#/definitions/DomainControllersResponse'
  GetFilerAuditLogConfigsResponse:
    description: Success
    schema:
      $ref: '#/definitions/FilerAuditLogConfigs'
  GetIndexedObjectSnapshotsResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetIndexedObjectSnapshotsResponseBody'
  GetKerberosProviderByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/KerberosProvider'
  GetKerberosProvidersResponse:
    description: Success
    schema:
      $ref: '#/definitions/KerberosProviders'
  GetKeystonesByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/Keystone'
  GetKeystonesResponse:
    description: Success
    schema:
      $ref: '#/definitions/Keystones'
  GetNetworkInterfacesResponse:
    description: Success
    schema:
      $ref: '#/definitions/ClusterInterfaces'
  GetNisNetgroupByNameResponse:
    description: Success
    schema:
      $ref: '#/definitions/NisNetgroup'
  GetNisNetgroupsResponse:
    description: Success
    schema:
      $ref: '#/definitions/NisNetgroups'
  GetNisProviderByDomainNameResponse:
    description: Success
    schema:
      $ref: '#/definitions/NisProvider'
  GetNisProvidersResponse:
    description: Success
    schema:
      $ref: '#/definitions/NisProviders'
  GetNodeGroupByNameResponse:
    description: Success
    schema:
      $ref: '#/definitions/NodeGroupResponse'
  GetNodeGroupsResponse:
    description: Success
    schema:
      $ref: '#/definitions/NodeGroupResponse'
  GetNodesResetStateResponse:
    description: Success
    schema:
      $ref: '#/definitions/ResetStates'
  GetObjectRunResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectProtectionRunSummary'
  GetObjectRunsResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetObjectRunsResponseBody'
  GetObjectSnapshotInfoResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectSnapshot'
  GetObjectSnapshotVolumeInfoResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectSnapshotVolumeInfo'
  GetObjectSnapshotsResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetObjectSnapshotsResponseBody'
  GetObjectStatsResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectStats'
  GetObjectsLastRunResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectsLastRun'
  GetPITRangesProtectedObjectResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetPITRangesProtectedObjectResponseBody'
  GetPatchOperationStatusResponse:
    description: Success
    schema:
      $ref: '#/definitions/PatchOperationStatus'
  GetPatchesHistoryResponse:
    description: Success
    schema:
      $ref: '#/definitions/PatchesHistory'
  GetProtectedObjectResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetProtectedObjectResponse'
  GetProtectedObjectsResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetProtectedObjectsResponse'
  GetProtectionGroupResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonProtectionGroupResponseParams
      $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
  GetProtectionGroupRunResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionGroupRun'
  GetProtectionGroupRunsResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionGroupRuns'
  GetProtectionGroupsResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionGroups'
  GetProtectionPoliciesResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionPolicyResponseWithPagination'
  GetProtectionPolicyByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionPolicyResponse'
  GetProtectionPolicyTemplateByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/PolicyTemplateResponse'
  GetProtectionPolicyTemplatesResponse:
    description: Success
    schema:
      $ref: '#/definitions/PolicyTemplatesResponseWithPagination'
  GetProtectionRunProgress:
    description: Success
    schema:
      $ref: '#/definitions/GetProtectionRunProgressBody'
  GetProtectionRunsResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionRunsSummary'
  GetProtectionRunsStatusResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetProtectionRunsStatusResponseBody'
  GetRecoveries:
    description: Success
    schema:
      $ref: '#/definitions/Recoveries'
  GetRecovery:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonRecoveryResponseParams
      $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
  GetRemoteDisksResponse:
    description: Success
    schema:
      $ref: '#/definitions/RemoteDisks'
  GetRigelClaimLogsResponse:
    description: Success
    schema:
      $ref: '#/definitions/RigelClaimLogs'
  GetRigelConnectionByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/RigelConnection'
  GetRigelConnectionResponse:
    description: Success
    schema:
      $ref: '#/definitions/RigelConnections'
  GetRigelConnectorByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/RigelConnector'
  GetRigelConnectorResponse:
    description: Success
    schema:
      $ref: '#/definitions/RigelConnectors'
  GetSecurityPrincipalsResponse:
    description: Success
    schema:
      $ref: '#/definitions/SecurityPrincipals'
  GetSupportChannelConfigResponse:
    description: Success
    schema:
      $ref: '#/definitions/SupportChannelConfig'
  GetSwiftResponse:
    description: Success
    schema:
      $ref: '#/definitions/SwiftParams'
  GetSyslogServersResponse:
    description: Success
    schema:
      $ref: '#/definitions/SyslogServers'
  GetTagsResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetTagsResult'
  GetTdmObjectResponse:
    description: Success
    schema:
      $ref: '#/definitions/TdmObject'
  GetTdmObjectTimelineEventsResponse:
    description: Success
    schema:
      $ref: '#/definitions/TdmObjectTimelineEvents'
  GetTdmObjectsResponse:
    description: Success
    schema:
      $ref: '#/definitions/TdmObjects'
  GetTdmTaskResponse:
    description: Success
    schema:
      $ref: '#/definitions/TdmTask'
  GetTdmTasksResponse:
    description: Success
    schema:
      $ref: '#/definitions/TdmTasks'
  GetVdcByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/VdcObject'
  GetViewByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/View'
  GetViewFailoverResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetViewFailoverResponseBody'
  GetViewsResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetViewsResult'
  HeliosRegConfigResponse:
    description: Success
    schema:
      $ref: '#/definitions/HeliosRegConfig'
  ImportCertificateByClientcsrResponse:
    description: Success
    schema:
      $ref: '#/definitions/ImportCertificateByClientcsrResponseBody'
  ImportPatchesResponse:
    description: Success
    schema:
      $ref: '#/definitions/PatchesDetails'
  InitFailoverResponse:
    description: Success
    schema:
      $ref: '#/definitions/InitFailoverResponse'
  ListTrustedCaByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/TrustedCa'
  ListTrustedCasResponse:
    description: Success
    schema:
      $ref: '#/definitions/ListTrustedCasResult'
  NisNetgroupResponse:
    description: Success
    schema:
      $ref: '#/definitions/NisNetgroup'
  NisProviderResponse:
    description: Success
    schema:
      $ref: '#/definitions/NisProvider'
  NoContentResponse:
    description: No Content
  NodeIdentifyResponse:
    description: Success
    schema:
      $ref: '#/definitions/NodeIdentifyParams'
  NodeRemovalResponse:
    description: Success
    schema:
      $ref: '#/definitions/RemoveNode'
  ObjectResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonObjectSummary
      $ref: '#/definitions/CommonObjectSummaryf0e8a175-a9e2-409b-8c0e-4b53b0423501'
  ObjectTreeResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectWithChildren'
  ObjectsResponse:
    description: Success
    schema:
      $ref: '#/definitions/Objects'
  ObjectsSearchResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectsSearchResponseBody'
  ProgressTasksResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProgressTasks'
  ProtectedObjectActionResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectedObjectActionResponse'
  ProtectedObjectResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectedObjectInfo'
  ProtectedObjectsSearchResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectedObjectsSearchResponseBody'
  RackResponse:
    description: Success
    schema:
      $ref: '#/definitions/Rack'
  RacksResponse:
    description: Success
    schema:
      $ref: '#/definitions/Racks'
  ReadViewTemplateByIdResponse:
    description: Success
    schema:
      $ref: '#/definitions/Template'
  ReadViewTemplatesResponse:
    description: Success
    schema:
      $ref: '#/definitions/GetViewTemplatesResult'
  RegisterOrUpdateKerberosProviderResponse:
    description: Success
    schema:
      $ref: '#/definitions/KerberosProvider'
  RegisteredRemoteStorageListResponse:
    description: Success
    schema:
      $ref: '#/definitions/RegisteredRemoteStorageList'
  RemoteStorageRegistrationResponse:
    description: Success
    schema:
      $ref: '#/definitions/RemoteStorageInfo'
  ReplicationBackupActivationResult:
    description: Success
    schema:
      $ref: '#/definitions/ReplicationBackupActivationResult'
  RevertPatchesResponse:
    description: Success
    schema:
      $ref: '#/definitions/ServicePatchLevels'
  SearchIndexedObjectsResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonSearchIndexedObjectsResponseParams
      $ref: '#/definitions/SearchIndexedObjectsResponseBody'
  SecurityConfigResponse:
    description: Success
    schema:
      $ref: '#/definitions/SecurityConfigResponse'
  SourceAttributeFiltersResponse:
    description: Success
    schema:
      $ref: '#/definitions/SourceAttributeFiltersResponseParams'
  SourceConnectionResponse:
    description: Success
    schema:
      $ref: '#/definitions/SourceConnectionResponseParams'
  SourceHierarchyObjectSummariesResponse:
    description: Success
    schema:
      $ref: '#/definitions/SourceHierarchyObjectSummaries'
  SourceRegistrationResponse:
    description: Success
    schema:
      x-cohesity-discriminator-ref: CommonSourceRegistrationReponseParams
      $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
  SourceRegistrationsResponse:
    description: Success
    schema:
      $ref: '#/definitions/SourceRegistrations'
  SourceResponse:
    description: Success
    schema:
      $ref: '#/definitions/Source'
  SourcesResponse:
    description: Success
    schema:
      $ref: '#/definitions/Sources'
  SyslogAuditTagResponse:
    description: Success
    schema:
      $ref: '#/definitions/SyslogAuditTag'
  SyslogProgramNamesResponse:
    description: Success
    schema:
      type: array
      items:
        type: string
  SyslogServerResponse:
    description: Success
    schema:
      $ref: '#/definitions/SyslogServer'
  SyslogServerStatusResponse:
    description: Success
    schema:
      $ref: '#/definitions/SyslogServerStatus'
  TagResponse:
    description: Success
    schema:
      $ref: '#/definitions/Tag'
  UnregisterKerberosProviderResponse:
    description: Success
    schema:
      $ref: '#/definitions/UnregisterKerberosProvider'
  UpdateActiveDirectoryResponse:
    description: Success
    schema:
      $ref: '#/definitions/ActiveDirectory'
  UpdateCertificateByCsrResponse:
    description: Success
    schema:
      $ref: '#/definitions/UpdateCertificateByCsrResponseBody'
  UpdateDataTieringStateResponse:
    description: Success
    schema:
      $ref: '#/definitions/UpdateDataTieringState'
  UpdateDataTieringTagConfigResponse:
    description: Success
    schema:
      $ref: '#/definitions/DataTieringTagConfig'
  UpdateFleetEnvInfoResponse:
    description: Success
    schema:
      $ref: '#/definitions/UpdateFleetEnvInfoRequest'
  UpdateNodeGroupResponse:
    description: Success
    schema:
      $ref: '#/definitions/NodeGroupResponse'
  UpdateObjectSnapshotResponse:
    description: Success
    schema:
      $ref: '#/definitions/ObjectSnapshot'
  UpdateProtectionGroupRunResponse:
    description: Success
    schema:
      $ref: '#/definitions/UpdateProtectionGroupRunResponseBody'
  UpdateProtectionGroupsStateResponse:
    description: Success
    schema:
      $ref: '#/definitions/UpdateProtectionGroupsState'
  UpdateProtectionPolicyResponse:
    description: Success
    schema:
      $ref: '#/definitions/ProtectionPolicyResponse'
  UpdateSwiftResponse:
    description: Success
    schema:
      $ref: '#/definitions/SwiftParams'
  UpdateTdmSnapshotResponse:
    description: Success
    schema:
      $ref: '#/definitions/TdmSnapshot'
  UpdateViewResponse:
    description: Success
    schema:
      $ref: '#/definitions/View'
  UpdateViewTemplateResponse:
    description: Success
    schema:
      $ref: '#/definitions/Template'
  UserSessionResponse:
    description: Success
    schema:
      $ref: '#/definitions/UserSession'
definitions:
  AAGGroup:
    description: Specifies the details of a AAG Group.
    type: object
    properties:
      id:
        description: Specifies the unique identifier of the AGGGroup.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the AAG Group.
        type: string
        x-nullable: true
        x-order: 1
      resourceInfo:
        description: Specifies the resource information about the AAG Group.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/AppResource'
      servers:
        description: Specifies the list of SQL servers which belongs to the given
          AAG Group.
        type: array
        items:
          $ref: '#/definitions/SQLServer'
        x-nullable: true
        x-order: 3
      fciClusters:
        description: Specifies the list of FCI clusters which belongs to the given
          AAG Group.
        type: array
        items:
          $ref: '#/definitions/FCICluster'
        x-nullable: true
        x-order: 4
  AAGInfo:
    description: Object details for Mssql.
    type: object
    properties:
      objectId:
        description: Specifies the AAG object Id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the AAG name.
        type: string
        x-nullable: true
        x-order: 1
  ADAttributeConstants:
    description: AD Attribute Constants
    type: object
    title: AD Attribute Constants
    properties:
      adAttributeConstants:
        description: AD Attribute Constants
        type: string
        enum:
        - name
        - objectSid
        - sAMAccountName
        - objectClass
        x-order: 0
  ADClassConstants:
    description: AD Class Constants
    type: object
    title: AD Class Constants
    properties:
      adClassConstants:
        description: AD Class Constants
        type: string
        enum:
        - user
        - group
        - computer
        - wellKnownPrincipal
        x-order: 0
  ADProtectionGroupParams:
    description: Specifies the parameters which are specific to Active directory related
      Protection Groups.
    type: object
    title: Active Directory(AD) Protection Group Parameters.
    required:
    - objects
    properties:
      objects:
        description: Specifies the list of object ids to be protected.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ActiveDirectoryProtectionGroupObjectParams'
        x-order: 0
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/IndexingPolicy'
  AWSTags:
    description: Specifies the AWS tags.
    type: object
    properties:
      vmTagIds:
        description: 'Array of Arrays of VMs Tags Ids that Specify VMs to Protect.
          Optionally specify a list of VMs to protect by listing Protection Source
          ids of VM Tags in this two dimensional array. Using this two dimensional
          array of Tag ids, the Cluster generates a list of VMs to protect which are
          derived from intersections of the inner arrays and union of the outer array,
          as shown by the following example. To protect only ''Eng'' VMs in the East
          and all the VMs in the West, specify the following tag id array: [ [1101,
          2221], [3031] ], where 1101 is the ''Eng'' VM Tag id, 2221 is the ''East''
          VM Tag id and 3031 is the ''West'' VM Tag id. The inner array [1101, 2221]
          produces a list of VMs that are both tagged with ''Eng'' and ''East'' (an
          intersection). The outer array combines the list from the inner array with
          list of VMs tagged with ''West'' (a union). The list of resulting VMs are
          protected by this Protection Group.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 0
    x-nullable: true
  AWSTargetConfig:
    description: Specifies the configuration for adding AWS as repilcation target
    type: object
    title: AWS Target Configuration
    required:
    - sourceId
    - region
    properties:
      sourceId:
        description: Specifies the source id of the AWS protection source registered
          on Cohesity cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the AWS Replication target.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      region:
        description: Specifies id of the AWS region in which to replicate the Snapshot
          to. Applicable if replication target is AWS target.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      regionName:
        description: Specifies name of the AWS region in which to replicate the Snapshot
          to. Applicable if replication target is AWS target.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
  AWSTier:
    description: Specifies the settings for a aws tier.
    type: object
    allOf:
    - $ref: '#/definitions/CommonCloudTierSettings'
    - type: object
      required:
      - tierType
      properties:
        tierType:
          description: Specifies the AWS tier types.
          type: string
          enum:
          - kAmazonS3Standard
          - kAmazonS3StandardIA
          - kAmazonS3OneZoneIA
          - kAmazonS3IntelligentTiering
          - kAmazonS3Glacier
          - kAmazonS3GlacierDeepArchive
          x-nullable: true
          x-order: 0
  AWSTieringLevels:
    description: AWS Tiering Levels
    type: object
    title: AWS Tiering Levels.
    properties:
      type:
        description: AWS Tiering Levels
        type: string
        enum:
        - kAmazonS3Standard
        - kAmazonS3StandardIA
        - kAmazonS3OneZoneIA
        - kAmazonS3IntelligentTiering
        - kAmazonS3Glacier
        - kAmazonS3GlacierDeepArchive
        x-order: 0
  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
        minLength: 1
        items:
          $ref: '#/definitions/AWSTier'
        x-nullable: true
        x-order: 0
  AagBackupPreference:
    description: Specifies Aag Backup Preference Type.
    type: object
    title: Aag Backup Preference Type.
    properties:
      aagBackupPreference:
        description: Specifies Aag Backup Preference Type.
        type: string
        enum:
        - kPrimaryReplicaOnly
        - kSecondaryReplicaOnly
        - kPreferSecondaryReplica
        - kAnyReplica
        x-order: 0
  AcropolisProtectionGroupObjectParams:
    description: Specifies an object protected by a Acropolis Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  AcropolisProtectionGroupParams:
    description: Specifies the parameters which are related to Acropolis Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/AcropolisProtectionGroupObjectParams'
        x-order: 0
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
      excludeObjectIds:
        description: Specifies the object ids to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 3
      indexingPolicy:
        description: Specifies settings for indexing files found in an Object (such
          as a VM) so these files can be searched and recovered. This also specifies
          inclusion and exclusion rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/IndexingPolicy'
      appConsistentSnapshot:
        description: Specifies whether or not to quiesce apps and the file system
          in order to take app consistent snapshots. If not specified or false then
          snapshots will not be app consistent.
        type: boolean
        x-nullable: true
        x-order: 5
      continueOnQuiesceFailure:
        description: Specifies whether to continue backing up on quiesce failure
        type: boolean
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      targetVmCredentials:
        description: Specifies the credentials for the target VM.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      absolutePath:
        description: Specifies the absolute path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
  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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for recovering to the original target.
        allOf:
        - $ref: '#/definitions/AcropolisRecoverFilesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for recovering to a new target.
        allOf:
        - $ref: '#/definitions/AcropolisRecoverFilesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      overwriteExisting:
        description: Specifies whether to overwrite the existing files. Default is
          true.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveAttributes:
        description: Specifies whether to preserve original file/folder attributes.
          Default is true.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverAcropolisVmTargetConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
  ActionObjectLevelResponse:
    description: Specifies the object level response params after performing an action
      on a protected object.
    type: object
    allOf:
    - $ref: '#/definitions/ProtectionObjectInput'
    - type: object
      properties:
        resumeStatus:
          description: Specifies the infomration about status of resume action.
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/ResumeActionObjectLevelResponse'
        pauseStatus:
          description: Specifies the infomration about status of pause action.
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/PauseActionObjectLevelResponse'
        runNowStatus:
          description: Specifies the infomration about status of run now action.
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/RunNowActionObjectLevelResponse'
        unProtectStatus:
          description: Specifies the infomration about status of Unprotect action.
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/UnprotectActionObjectLevelResponse'
  ActionObjectMapping:
    description: Specifies the object paring for performing action on list of objects.
    type: object
    properties:
      sourceObjectId:
        description: Specifies the source object id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      destinationObjectId:
        description: Specifies the destination object id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  ActiveDirectories:
    description: Response of Active Directories.
    type: object
    properties:
      activeDirectories:
        description: A list of Active Directories.
        type: array
        items:
          $ref: '#/definitions/ActiveDirectory'
        x-nullable: true
        x-order: 0
  ActiveDirectory:
    description: Specifies an Active Directory.
    type: object
    allOf:
    - $ref: '#/definitions/CommonActiveDirectoryParams'
    - type: object
      properties:
        idMappingParams:
          description: Specifies the params of the user id mapping info of an Active
            Directory.
          type: object
          allOf:
          - $ref: '#/definitions/IdMappingParams'
          - x-nullable: true
          x-nullable: true
          x-order: 0
        domainName:
          description: Specifies the domain name of the Active Directory.
          type: string
          x-nullable: true
          x-order: 1
        centrifyZones:
          description: Specifies a list of centrify zones.
          type: array
          items:
            $ref: '#/definitions/CentrifyZones'
          x-nullable: true
          x-order: 2
        domainControllers:
          description: A list of domain names with a list of it's domain controllers.
          type: array
          items:
            $ref: '#/definitions/DomainControllers'
          x-nullable: true
          x-order: 3
        securityPrincipals:
          description: Specifies a list of security principals.
          type: array
          items:
            $ref: '#/definitions/SecurityPrincipal'
          x-nullable: true
          x-order: 4
        permissions:
          description: Specifies the list of tenants that have permissions for this
            Active Directory.
          type: array
          items:
            $ref: '#/definitions/Tenant'
          x-nullable: true
          x-order: 5
        transitiveAdTrustLevelLimit:
          description: Specifies level of transitive Active Directory trust domains
            to be used.
          type: integer
          format: int32
          x-nullable: true
          x-order: 6
  ActiveDirectoryAdminParams:
    description: Specifies the params of a user with administrative privilege of an
      Active Directory.
    type: object
    required:
    - username
    - password
    properties:
      username:
        description: Specifies the user name.
        type: string
        x-nullable: true
        x-order: 0
      password:
        description: Specifies the password of the user.
        type: string
        x-nullable: true
        x-order: 1
  ActiveDirectoryAppParams:
    description: Specifies the Active Directory special parameters for the Protection
      Group.
    type: object
    title: Active Directory App Parameters.
    properties:
      appId:
        description: Specifies the application id of the Active Directory instance.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      appName:
        description: Specifies the application name of the Active Directory instance.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  ActiveDirectoryProtectionGroupObjectParams:
    description: Specifies the object identifier to for the active directory protection
      group.
    type: object
    title: Active Directory Protection Group Object Params.
    required:
    - sourceId
    properties:
      sourceId:
        description: Specifies the id of the registered active directory source.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      sourceName:
        description: Specifies the name of the registered active directory source.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      appParams:
        description: Specifies the specific parameters required for active directory
          app configuration.
        type: array
        items:
          type: object
          $ref: '#/definitions/ActiveDirectoryAppParams'
        x-nullable: true
        x-order: 2
      enableSystemBackup:
        description: Specifies whether to take bmr backup. If this is not specified,
          the bmr backup won't be enabled.
        type: boolean
        x-nullable: true
        x-order: 3
  AdAuthMapping:
    description: Describes AD user mapping options for certificate based authentication.
    type: object
    title: AD User Auth Mapping
    properties:
      enum:
        description: Specifies the auth field options
        type: string
        enum:
        - SamAccountName
        - UserPrincipalName
        x-order: 0
  AdCentrifyTypeParams:
    description: Specifies the properties associated to a Centrify type user id mapping.
    type: object
    allOf:
    - $ref: '#/definitions/CentrifyZone'
    - type: object
      required:
      - fallbackOption
      properties:
        fallbackOption:
          description: Specifies a fallback user id mapping param in case the primary
            config does not work.
          type: object
          allOf:
          - $ref: '#/definitions/FallbackUserIdMappingParams'
          - x-nullable: true
          x-nullable: true
          x-order: 0
  AdCustomAttributesTypeParams:
    description: Specifies the properties accociated to a CustomAttributes type user
      id mapping.
    type: object
    required:
    - uidAttrName
    - gidAttrName
    - fallbackOption
    properties:
      uidAttrName:
        description: Specifies the custom field name in Active Directory user properties
          to get the UID.
        type: string
        x-nullable: true
        x-order: 0
      gidAttrName:
        description: Specifies the custom field name in Active Directory user properties
          to get the GID.
        type: string
        x-nullable: true
        x-order: 1
      fallbackOption:
        description: Specifies a fallback user id mapping param in case the primary
          config does not work.
        type: object
        allOf:
        - $ref: '#/definitions/FallbackUserIdMappingParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  AdFixedTypeParams:
    description: Specifies the properties accociated to a Fixed type user id mapping.
    type: object
    required:
    - uid
    - gid
    properties:
      uid:
        description: Specifies the fixed Unix UID, when mapping type is set to kFixed.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      gid:
        description: Specifies the fixed Unix GID, when mapping type is set to kFixed.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  AdLdapProviderTypeParams:
    description: Specifies the properties associated to a LdapProvider type user id
      mapping.
    type: object
    required:
    - fallbackOption
    properties:
      fallbackOption:
        description: Specifies a fallback user id mapping param in case the primary
          config does not work.
        type: object
        allOf:
        - $ref: '#/definitions/FallbackUserIdMappingParams'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  AdNisProviderTypeParams:
    description: Specifies the properties associated to a NisProvider type user id
      mapping.
    type: object
    required:
    - fallbackOption
    properties:
      fallbackOption:
        description: Specifies a fallback user id mapping param in case the primary
          config does not work.
        type: object
        allOf:
        - $ref: '#/definitions/FallbackUserIdMappingParams'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  AdRfc2307TypeParams:
    description: Specifies the properties associated to a Rfc2307 type user id mapping.
    type: object
    required:
    - fallbackOption
    properties:
      fallbackOption:
        description: Specifies a fallback user id mapping param in case the primary
          config does not work.
        type: object
        allOf:
        - $ref: '#/definitions/FallbackUserIdMappingParams'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  AdSfu30TypeParams:
    description: Specifies the properties associated to a Sfu30 type user id mapping.
    type: object
    required:
    - fallbackOption
    properties:
      fallbackOption:
        description: Specifies a fallback user id mapping param in case the primary
          config does not work.
        type: object
        allOf:
        - $ref: '#/definitions/FallbackUserIdMappingParams'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  AddDmaasTenantCertRequest:
    description: Specifies the parameters to add an Orion tenant certificate.
    type: object
    title: Add Tenant Cert Request.
    required:
    - tenantId
    - certificate
    - privateKey
    - connectorCaChain
    properties:
      tenantId:
        description: The id of the tenant.
        type: string
        x-nullable: true
        x-order: 0
      certificate:
        description: Specifies the tenant certificate.
        type: string
        x-nullable: true
        x-order: 1
      privateKey:
        description: Specifies the tenant private key.
        type: string
        x-nullable: true
        x-order: 2
      connectorCaChain:
        description: Specifies the CA chain that is used to sign the connector certificate.
        type: string
        x-nullable: true
        x-order: 3
      passphrase:
        description: Specifies the passphrase used to encode the private key.
        type: string
        x-nullable: true
        x-order: 4
  AddRemoteDiskResponseBody:
    description: Specifies the response of creating remote disk.
    type: object
    properties:
      remoteDisks:
        description: Specifies a list of remote disk creating status.
        type: array
        items:
          $ref: '#/definitions/CreateRemoteDiskStatus'
        x-nullable: true
        x-order: 0
  AgentInformation:
    description: Specifies the agent details.
    type: object
    properties:
      connectionStatus:
        description: Specifies the status of agent connection.
        type: string
        enum:
        - Unknown
        - Healthy
        - Unregistered
        - Unreachable
        - Unhealthy
        - Error
        x-nullable: true
        x-order: 0
      supportStatus:
        description: Specifies the whether agent version is compatible with cluster
          version ro use various features.
        type: string
        enum:
        - Supported
        - Upgrade
        - Unsupported
        x-nullable: true
        x-order: 1
      agentSwVersion:
        description: Specifies the software version of the agent
        type: string
        x-nullable: true
        x-order: 2
      lastFetchedTimeInUsecs:
        description: Specifies the time in usecs when the last agent info was fetched.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      hostSettingChecks:
        description: Specifies the list of host checks and its results.
        type: array
        items:
          $ref: '#/definitions/HostSettingCheck'
        x-nullable: true
        x-order: 4
  AlertGroupSummary:
    description: Specifies alerts summary grouped for an alert category.
    type: object
    properties:
      category:
        description: Category of alerts by which summary is grouped.
        type: string
        enum:
        - kDisk
        - kNode
        - kCluster
        - kChassis
        - kPowerSupply
        - kCPU
        - kMemory
        - kTemperature
        - kFan
        - kNIC
        - kFirmware
        - kNodeHealth
        - kOperatingSystem
        - kDataPath
        - kMetadata
        - kIndexing
        - kHelios
        - kAppMarketPlace
        - kLicense
        - kSecurity
        - kUpgrade
        - kClusterManagement
        - kAuditLog
        - kNetworking
        - kConfiguration
        - kStorageUsage
        - kFaultTolerance
        - kBackupRestore
        - kArchivalRestore
        - kRemoteReplication
        - kQuota
        - kCDP
        x-order: 0
      type:
        description: Type/bucket that this alert category belongs to.
        type: string
        x-order: 1
      warningCount:
        description: Specifies count of warning alerts.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      criticalCount:
        description: Specifies count of critical alerts.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      infoCount:
        description: Specifies count of info alerts.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      totalCount:
        description: Specifies count of total alerts.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
  AlertStatus:
    description: Alert Status type.
    type: object
    title: Alert Status type.
    properties:
      alertStatus:
        description: Specifies Alert Status type.
        type: string
        enum:
        - kSuccess
        - kFailure
        - kSlaViolation
        x-order: 0
  AlertTarget:
    description: Specifies an alert target to receive an alert.
    type: object
    required:
    - emailAddress
    properties:
      emailAddress:
        description: Specifies an email address to receive an alert.
        type: string
        x-nullable: true
        x-order: 0
      language:
        description: Specifies the language of the delivery target. Default value
          is 'en-us'.
        type: string
        enum:
        - en-us
        - ja-jp
        - zh-cn
        x-nullable: true
        x-order: 1
      recipientType:
        description: Specifies the recipient type of email recipient. Default value
          is 'kTo'.
        type: string
        enum:
        - kTo
        - kCc
        x-nullable: true
        x-order: 2
  AlertsSummaryResponse:
    description: Specifies the response of alerts summary.
    type: object
    properties:
      alertsSummary:
        description: Specifies a list of alerts summary grouped by category.
        type: array
        items:
          $ref: '#/definitions/AlertGroupSummary'
        x-nullable: true
        x-order: 0
  AliasSmbConfig:
    description: 'Message defining SMB config for IRIS. SMB config contains SMB encryption

      flags, SMB discoverable flag and Share level permissions.'
    type: object
    properties:
      discoveryEnabled:
        description: Whether the share is discoverable.
        type: boolean
        x-nullable: true
        x-order: 0
      encryptionEnabled:
        description: 'Whether SMB encryption is enabled for this share. Encryption
          is supported

          only by SMB 3.x dialects. Dialects that do not support would still

          access data in unencrypted format.'
        type: boolean
        x-nullable: true
        x-order: 1
      encryptionRequired:
        description: 'Whether to enforce encryption for all the sessions for this
          view. When

          enabled all unencrypted sessions are disallowed.'
        type: boolean
        x-nullable: true
        x-order: 2
      permissions:
        description: Share level permissions.
        type: array
        items:
          $ref: '#/definitions/SmbPermission'
        x-nullable: true
        x-order: 3
      superUserSids:
        description: Specifies a list of super user sids.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 4
      cachingEnabled:
        description: Indicate if offline file caching is supported
        type: boolean
        x-nullable: true
        x-order: 5
      isShareLevelPermissionEmpty:
        description: Indicate if share level permission is cleared by user.
        type: boolean
        x-nullable: true
        x-order: 6
      oplockEnabled:
        description: Indicate the operation lock is enabled by this view.
        type: boolean
        x-nullable: true
        x-order: 7
      continuousAvailability:
        description: 'Whether file open handles are persited to scribe to survive
          bridge

          process crash. When set to false, open handles will be kept in

          memory untill the current node has exclusive ticket for the entity

          handle. When the entity is opened from another node, the exclusive

          ticket would be revoked from the node. In revoke control flow, the

          current node would persist the state to scribe. On acquiring the

          exclusive ticket,another node would read the file open handles from

          scribe and resume the handling of operation.'
        type: boolean
        x-nullable: true
        x-order: 8
  AntivirusScanConfig:
    description: Specifies the antivirus scan config settings for this View.
    type: object
    title: Antivirus scan config
    properties:
      blockAccessOnScanFailure:
        description: Specifies whether block access to the file when antivirus scan
          fails.
        type: boolean
        x-nullable: true
        x-order: 0
      isEnabled:
        description: Specifies whether the antivirus service is enabled or not.
        type: boolean
        x-nullable: true
        x-order: 1
      maximumScanFileSize:
        description: 'Specifies maximum file size that will be sent to antivirus server
          for

          scanning. if greater than zero, the file size that exceeds this size

          would be skipped from virus scan.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      scanFilter:
        description: 'Files extension that meets these filter criteria will be sent
          to

          antivirus server for the scan.'
        allOf:
        - $ref: '#/definitions/FileExtensionFilter'
        - x-nullable: true
        x-order: 3
      scanOnAccess:
        description: Specifies whether to scan a file when it is opened.
        type: boolean
        x-nullable: true
        x-order: 4
      scanOnClose:
        description: Specifies whether to scan a file when it is closed after modify.
        type: boolean
        x-nullable: true
        x-order: 5
      scanTimeoutUsecs:
        description: 'Specifies the maximum amount of time that a scan can take before
          timing

          out.'
        type: integer
        format: int32
        x-nullable: true
        x-order: 6
  AppResource:
    description: Specifies the details about App Resource.
    type: object
    properties:
      id:
        description: Specifies the unique id of the app resource.
        type: string
        x-nullable: true
        x-order: 0
      type:
        description: Specifies the type of the app resource.
        type: string
        enum:
        - standaloneServer
        - windowsCluster
        - sqlCluster
        x-nullable: true
        x-order: 1
      endpoints:
        description: Specifies the information about endpoint associated with this
          resorce.
        type: array
        items:
          $ref: '#/definitions/ResourceEndpoint'
        x-nullable: true
        x-order: 2
  AppliedPatch:
    description: Specifies the description of an applied patch.
    title: Applied Patch.
    properties:
      service:
        description: Specifies the name of the service.
        type: string
        x-order: 0
      component:
        description: Specifies the description of the service.
        type: string
        x-order: 1
      version:
        description: Specifies the version of the patch.
        type: string
        x-order: 2
      versionReplaced:
        description: Specifies the version it replaced.
        type: string
        x-order: 3
      patchLevel:
        description: Specifies the number of patches applied so far for this service.
        type: integer
        format: int64
        x-order: 4
      appliedTimeMsecs:
        description: Specifies the time when the patch was applied in Unix epoch in
          milliseconds.
        type: integer
        format: int64
        x-order: 5
      count:
        description: Specifies the number of fixed issues.
        type: integer
        format: int64
        x-order: 6
      dependencies:
        description: Specifies the services for which their patches were applied together.
          They will also be reverted together.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 7
      fixedIssues:
        description: Specifies the details of the issues fixed in the patch.
        type: array
        items:
          $ref: '#/definitions/FixedIssue'
        x-order: 8
  AppliedPatches:
    description: Specifies the applied patches on the cluster.
    type: array
    title: Applied Patches.
    items:
      $ref: '#/definitions/AppliedPatch'
  ApplyPatchesRequest:
    description: Specifies the request to apply a patch.
    type: object
    title: Apply patch.
    properties:
      service:
        description: Specifies the name of the service whose patch should be applied.
        type: string
        x-nullable: true
        x-order: 0
      all:
        description: Specifies all the available patches should be applied.
        type: boolean
        x-nullable: true
        x-order: 1
  ArchivalConfig:
    description: Specifies settings for copying Snapshots External Targets (such as
      AWS or Tape). This also specifies the retention policy that should be applied
      to Snapshots after they have been copied to the specified target.
    title: Archival Target Configuration
    allOf:
    - $ref: '#/definitions/CommonTargetConfiguration'
    - type: object
      required:
      - targetId
      properties:
        targetId:
          description: Specifies the Archival target to copy the Snapshots to.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        targetName:
          description: Specifies the Archival target name where Snapshots are copied.
          type: string
          x-nullable: true
          x-order: 1
          readOnly: true
        targetType:
          description: Specifies the Archival target type where Snapshots are copied.
          type: string
          enum:
          - Tape
          - Cloud
          - Nas
          x-nullable: true
          x-order: 2
          readOnly: true
        tierSettings:
          description: Specifies the tier settings that will be applied to given target.
            If provided target is of type 'cloud', then only tiering can be applied.
            The respective cloud platform details need to be provided here.
          type: object
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/TierLevelSettings'
        extendedRetention:
          description: Specifies additional retention policies that should be applied
            to the archived backup. Archived backup snapshot will be retained up to
            a time that is the maximum of all retention policies that are applicable
            to it.
          type: array
          items:
            $ref: '#/definitions/ExtendedRetentionPolicy'
          x-nullable: true
          x-order: 4
  ArchivalDataStats:
    description: Specifies statistics about archival data.
    type: object
    title: Archival data statistics.
    properties:
      logicalSizeBytes:
        description: Specifies the logicalSizeBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      bytesRead:
        description: Specifies total logical bytes read for creating the snapshot.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      logicalBytesTransferred:
        description: Specifies the logical bytes transferred.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      physicalBytesTransferred:
        description: Specifies the physical bytes transferred.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      avgLogicalTransferRateBps:
        description: Specifies the average rate of transfer in bytes per second.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      fileWalkDone:
        description: Specifies whether the file system walk is done. Only applicable
          to file based backups.
        type: boolean
        x-nullable: true
        x-order: 5
      totalFileCount:
        description: Specifies the total number of file and directory entities visited
          in this backup. Only applicable to file based backups.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      backupFileCount:
        description: Specifies the total number of file and directory entities that
          are backed up in this run. Only applicable to file based backups.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
  ArchivalRun:
    description: Specifies information about archival run for an object.
    type: object
    title: Archival run information for an object.
    properties:
      archivalTargetResults:
        description: Archival result for an archival target.
        type: array
        items:
          $ref: '#/definitions/ArchivalTargetResult'
        x-order: 0
  ArchivalRunSummary:
    description: Specifies summary information about archival run.
    type: object
    title: Summary information for archival run.
    properties:
      archivalTargetResults:
        description: Archival results for each archival target.
        type: array
        items:
          $ref: '#/definitions/ArchivalTargetResult'
        x-order: 0
  ArchivalTargetProgressInfo:
    description: Specifies the progress of an archival run target.
    type: object
    allOf:
    - $ref: '#/definitions/ArchivalTargetSummaryInfo'
    - $ref: '#/definitions/ProgressTaskInfo'
    - type: object
      properties:
        objects:
          description: Specifies progress for objects.
          type: array
          items:
            $ref: '#/definitions/ObjectProgressInfo'
          x-nullable: true
          x-order: 0
  ArchivalTargetResult:
    description: Archival result for an archival target.
    title: Archival result for a target.
    allOf:
    - $ref: '#/definitions/ArchivalTargetSummaryInfo'
    - type: object
      properties:
        runType:
          description: Type of Protection Group run. 'kRegular' indicates an incremental
            (CBT) backup. Incremental backups utilizing CBT (if supported) are captured
            of the target protection objects. The first run of a kRegular schedule
            captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete
            backup (all blocks) of the target protection objects are always captured
            and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database
            Log backup. Capture the database transaction logs to allow rolling back
            to a specific point in time. 'kSystem' indicates system volume backup.
            It produces an image for bare metal recovery.
          type: string
          enum:
          - kRegular
          - kFull
          - kLog
          - kSystem
          - kHydrateCDP
          x-nullable: true
          x-order: 0
        isSlaViolated:
          description: Indicated if SLA has been violated for this run.
          type: boolean
          x-nullable: true
          x-order: 1
        snapshotId:
          description: Snapshot id for a successful snapshot. This field will not
            be set if the archival Run fails to take the snapshot.
          type: string
          x-nullable: true
          x-order: 2
        startTimeUsecs:
          description: Specifies the start time of replication run in Unix epoch Timestamp(in
            microseconds) for an archival target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 3
        endTimeUsecs:
          description: Specifies the end time of replication run in Unix epoch Timestamp(in
            microseconds) for an archival target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 4
        queuedTimeUsecs:
          description: Specifies the time when the archival is queued for schedule
            in Unix epoch Timestamp(in microseconds) for a target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 5
        isIncremental:
          description: Whether this is an incremental archive. If set to true, this
            is an incremental archive, otherwise this is a full archive.
          type: boolean
          x-nullable: true
          x-order: 6
        isForeverIncremental:
          description: Whether this is forever incremental or not
          type: boolean
          x-nullable: true
          x-order: 7
        status:
          description: Status of the replication run for an archival target. 'Running'
            indicates that the run is still running. 'Canceled' indicates that the
            run has been canceled. 'Canceling' indicates that the run is in the process
            of being canceled. 'Failed' indicates that the run has failed. 'Missed'
            indicates that the run was unable to take place at the scheduled time
            because the previous run was still happening. 'Succeeded' indicates that
            the run has finished successfully. 'SucceededWithWarning' indicates that
            the run finished successfully, but there were some warning messages.
          type: string
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-nullable: true
          x-order: 8
        message:
          description: Message about the archival run.
          type: string
          x-nullable: true
          x-order: 9
        progressTaskId:
          description: Progress monitor task id for archival.
          type: string
          x-nullable: true
          x-order: 10
        indexingTaskId:
          description: Progress monitor task for indexing.
          type: string
          x-nullable: true
          x-order: 11
        successfulObjectsCount:
          description: Specifies the count of objects for which backup was successful.
          type: integer
          format: int64
          x-nullable: true
          x-order: 12
        failedObjectsCount:
          description: Specifies the count of objects for which backup failed.
          type: integer
          format: int64
          x-nullable: true
          x-order: 13
        cancelledObjectsCount:
          description: Specifies the count of objects for which backup was cancelled.
          type: integer
          format: int64
          x-nullable: true
          x-order: 14
        successfulAppObjectsCount:
          description: Specifies the count of app objects for which backup was successful.
          type: integer
          format: int32
          x-nullable: true
          x-order: 15
        failedAppObjectsCount:
          description: Specifies the count of app objects for which backup failed.
          type: integer
          format: int32
          x-nullable: true
          x-order: 16
        cancelledAppObjectsCount:
          description: Specifies the count of app objects for which backup was cancelled.
          type: integer
          format: int32
          x-nullable: true
          x-order: 17
        stats:
          description: Archival data statistics for a target.
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/ArchivalDataStats'
        isManuallyDeleted:
          description: Specifies whether the snapshot is deleted manually.
          type: boolean
          x-nullable: true
          x-order: 19
        expiryTimeUsecs:
          description: Specifies the expiry time of attempt in Unix epoch Timestamp
            (in microseconds).
          type: integer
          format: int64
          x-nullable: true
          x-order: 20
  ArchivalTargetSummaryInfo:
    description: Specifies archival target summary information.
    type: object
    title: Archival target.
    properties:
      targetId:
        description: Specifies the archival target ID.
        type: integer
        format: int64
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      targetName:
        description: Specifies the archival target name.
        type: string
        x-nullable: true
        x-order: 2
      targetType:
        description: Specifies the archival target type.
        type: string
        enum:
        - Tape
        - Cloud
        - Nas
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ArchivalTargetTierInfo'
  ArchivalTargetTierInfo:
    description: Specifies the tier info for archival.
    title: Archival Target Tier Info
    allOf:
    - $ref: '#/definitions/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
          enum:
          - kAmazonS3Standard
          - kAmazonS3StandardIA
          - kAmazonS3OneZoneIA
          - kAmazonS3IntelligentTiering
          - kAmazonS3Glacier
          - kAmazonS3GlacierDeepArchive
          - kAzureTierHot
          - kAzureTierCool
          - kAzureTierArchive
          - kGoogleStandard
          - kGoogleRegional
          - kGoogleMultiRegional
          - kGoogleNearline
          - kGoogleColdline
          - kOracleTierStandard
          - kOracleTierArchive
          x-nullable: true
          x-order: 0
  ArchivalTargets:
    description: Archival Targets
    type: object
    title: ArchivalTargets
    properties:
      archivalTargets:
        description: Specifies the archival target.
        type: string
        enum:
        - Tape
        - Cloud
        - Nas
        x-order: 0
  AuditActions:
    description: Audit Actions
    type: object
    title: Audit Actions
    properties:
      actions:
        description: Audit Actions
        type: string
        enum:
        - Login
        - Logout
        - Create
        - Modify
        - Delete
        - Activate
        - Deactivate
        - Pause
        - Resume
        - RunNow
        - Clone
        - Recover
        - Cancel
        - Register
        - Unregister
        - Update
        - Refresh
        - Upgrade
        - Upload
        - Download
        - Rename
        - Accept
        - Mark
        - Close
        - Join
        - DisJoin
        - Overwrite
        - MarkRemoval
        - CloudSpin
        - Assign
        - Unassign
        - NotificationRule
        - ScheduleReport
        - Install
        - Uninstall
        - Stop
        - Start
        - Restart
        - RunDiagnostics
        - Apply
        - Revert
        - Import
        - Validate
        x-order: 0
  AuditEntityTypes:
    description: Entity Types
    type: object
    title: Entity Types
    properties:
      entityTypes:
        description: Entity Types
        type: string
        enum:
        - ClusterPartition
        - StorageDomain
        - View
        - Share
        - Node
        - Disk
        - Cluster
        - Vlan
        - User
        - ApiKey
        - Chassis
        - SslCertificate
        - ProtectionGroup
        - Source
        - RecoveryTask
        - SmtpServer
        - EncryptionKey
        - ProtectionPolicy
        - Alert
        - Resolution
        - AlertNotificationRule
        - Vault
        - RemoteCluster
        - ActiveDirectory
        - KerberosProvider
        - Ldap
        - AntivirusServiceGroup
        - InfectedFile
        - PreferredDomainController
        - Group
        - Role
        - ProtectionRun
        - SearchJob
        - PhysicalAgent
        - CloneTask
        - CloneRefreshTask
        - Network
        - Interface
        - NetworkInerfaceGroup
        - Scheduler
        - ProxyServer
        - StaticRoute
        - Ip
        - Qos
        - KmsConfiguration
        - CloudSpin
        - Tenant
        - IdpConfiguration
        - App
        - HeliosEvent
        - Object
        - ClusterServices
        - AccessToken
        - SnmpConfig
        - IoTier
        - ServiceFlag
        - SupportServer
        - Csr
        - Keystone
        - SwiftRoles
        - Tags
        - Nis
        - Snapshot
        - HybridExtender
        - DataTieringAnalysisGroup
        - DataTieringDowntierTask
        - DataTieringUptierTask
        - TrustedCA
        - AMQPTargetConfiguration
        - Patch
        - Hotfix
        x-order: 0
  AuditLog:
    description: Specifies an audit log message.
    type: object
    properties:
      details:
        description: Specifies the change details of this audit log.
        type: string
        x-nullable: true
        x-order: 0
      username:
        description: Specifies the username who made this audit log.
        type: string
        x-nullable: true
        x-order: 1
      domain:
        description: Specifies the domain of user who made this audit log.
        type: string
        x-nullable: true
        x-order: 2
      entityName:
        description: Specifies the entity name.
        type: string
        x-nullable: true
        x-order: 3
      entityType:
        description: Specifies the entity type.
        type: string
        x-nullable: true
        x-order: 4
      action:
        description: Specifies the action type of this audit log.
        type: string
        x-nullable: true
        x-order: 5
      timestampUsecs:
        description: Specifies a unix timestamp in micro seconds when the audit log
          was taken.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      ip:
        description: Specifies the ip of user who made this audit log.
        type: string
        x-nullable: true
        x-order: 7
      isImpersonation:
        description: Specifies if the action is made through impersonation.
        type: boolean
        x-nullable: true
        x-order: 8
      tenantId:
        description: Specifies the tenant id who made this audit log.
        type: string
        x-nullable: true
        x-order: 9
      tenantName:
        description: Specifies the tenant name who made this audit log.
        type: string
        x-nullable: true
        x-order: 10
      originalTenantId:
        description: Specifies the original tenant id who made this audit log.
        type: string
        x-nullable: true
        x-order: 11
      originalTenantName:
        description: Specifies the original tenant name who made this audit log.
        type: string
        x-nullable: true
        x-order: 12
      previousRecord:
        description: 'Specifies the record before the action is invoked. This will
          be returned only if verbose audit is enabled. '
        type: string
        x-nullable: true
        x-order: 13
      newRecord:
        description: 'Specifies the record after the action is invoked. This will
          be returned only if verbose audit is enabled. '
        type: string
        x-nullable: true
        x-order: 14
  AuditLogs:
    description: Sepcifies the audit logs.
    type: object
    properties:
      auditLogs:
        description: Specifies a list of audit logs.
        type: array
        items:
          $ref: '#/definitions/AuditLog'
        x-nullable: true
        x-order: 0
      count:
        description: Specifies the total number of audit logs that match the filter
          and search criteria. Use this value to determine how many additional requests
          are required to get the full result.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  AuditLogsActions:
    description: Specifies actions of audit logs.
    type: object
    properties:
      actions:
        description: Specifies a list of audit logs actions.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
  AuditLogsEntityTypes:
    description: Specifies entity types of audit logs.
    type: object
    properties:
      entityTypes:
        description: Specifies a list of audit logs entity types.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
  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
        format: int32
        x-nullable: true
        x-order: 0
      dbInstanceId:
        description: Specifies the DB instance identifier to use for the restored
          DB.
        type: string
        x-nullable: true
        x-order: 1
      isMultiAzDeployment:
        description: Specifies whether this is a multi-az deployment or not.
        type: boolean
        x-nullable: true
        x-order: 2
      enablePublicAccessibility:
        description: Specifies whether this DB will be publicly accessible or not.
        type: boolean
        x-nullable: true
        x-order: 3
      enableIamDbAuthentication:
        description: Specifies whether to enable IAM authentication for the DB.
        type: boolean
        x-nullable: true
        x-order: 4
      enableCopyTagsToSnapshots:
        description: Specifies whether to enable copying of tags to snapshots of the
          DB.
        type: boolean
        x-nullable: true
        x-order: 5
      enableAutoMinorVersionUpgrade:
        description: Specifies whether to enable auto minor version upgrade in the
          restored DB.
        type: boolean
        x-nullable: true
        x-order: 6
      dbOptionGroup:
        description: Specifies entity representing the Aurora option group to use
          while restoring the DB.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 7
      dbParameterGroup:
        description: Specifies the entity representing the Aurora parameter group
          to use while restoring the DB.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 8
  AvailablePatch:
    description: Specifies the description of an available patch.
    title: Available Patch.
    properties:
      service:
        description: Specifies the name of the service.
        type: string
        x-order: 0
      component:
        description: Specifies the description of the service.
        type: string
        x-order: 1
      version:
        description: Specifies the version of the patch.
        type: string
        x-order: 2
      count:
        description: Specifies the number of fixed issues.
        type: integer
        format: int64
        x-order: 3
      dependencies:
        description: Specifies the services for which their patches must be applied
          together.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 4
      fixedIssues:
        description: Specifies the details of the issues fixed in the patch.
        type: array
        items:
          $ref: '#/definitions/FixedIssue'
        x-order: 5
  AvailablePatches:
    description: Specifies the available patches for the cluster.
    type: array
    title: Available Patches.
    items:
      $ref: '#/definitions/AvailablePatch'
  AwsAgentProtectionGroupObjectParams:
    description: Specifies the object parameters to create agent based AWS Protection
      Group.
    type: object
    title: Agent based AWS Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  AwsAgentProtectionGroupParams:
    description: Specifies the parameters which are specific to AWS related Protection
      Groups using cohesity protection-service installed on EC2 instance.
    type: object
    title: Agent based AWS Protection Group Request Params.
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/AwsAgentProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      indexingPolicy:
        description: Specifies settings for indexing files found in an Object (such
          as a VM) so these files can be searched and recovered. This also specifies
          inclusion and exclusion rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/IndexingPolicy'
      appConsistentSnapshot:
        description: Specifies whether or not to quiesce apps and the file system
          in order to take app consistent snapshots. If not specified or false then
          snapshots will not be app consistent.
        type: boolean
        x-nullable: true
        x-order: 5
  AwsAuroraProtectionGroupObjectParams:
    description: Specifies the object parameters to create an AWS Aurora Protection
      Group.
    type: object
    title: AWS Aurora Snapshot Manager Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  AwsAuroraProtectionGroupParams:
    description: Specifies the parameters which are specific to AWS Aurora related
      Protection Groups.
    type: object
    title: AWS Aurora Snapshot Manager Protection Group Request Params.
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/AwsAuroraProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      auroraTagIds:
        description: Array of arrays of Aurora Tag Ids that specify aurora clusters
          to protect.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 2
      excludeAuroraTagIds:
        description: Array of arrays of RDS Tag Ids that specify aurora clusters to
          exclude.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 5
        readOnly: true
  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: '#/definitions/RecoverAwsAuroraNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  AwsCloudSpinParams:
    description: Specifies various resources when converting and deploying a VM to
      AWS.
    type: object
    title: AWS Parameters.
    required:
    - region
    properties:
      region:
        description: Specifies id of the AWS region in which to deploy the VM.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      vpcId:
        description: Specifies id of the Virtual Private Cloud to chose for the instance
          type.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      subnetId:
        description: Specifies id of the subnet within above VPC.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  AwsNativeProtectionGroupObjectParams:
    description: Specifies the object parameters to create AWS Native Protection Group.
    type: object
    title: AWS Native Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      volumeExclusionParams:
        description: Specifies the paramaters to exclude volumes attached to EC2 instances
          at object level.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/EbsVolumeExclusionParams'
  AwsNativeProtectionGroupParams:
    description: Specifies the parameters which are specific to AWS related Protection
      Groups using AWS native snapshot APIs. Atlease one of tags or objects must be
      specified.
    type: object
    title: AWS Native Protection Group Request Params.
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        items:
          $ref: '#/definitions/AwsNativeProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      volumeExclusionParams:
        description: Specifies the paramaters to exclude volumes attached to EC2 instances
          at global level.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/EbsVolumeExclusionParams'
      vmTagIds:
        description: 'Array of Array of VM Tag Ids that Specify VMs to Protect. Optionally
          specify a list of VMs to protect by listing Protection Source ids of VM
          Tags in this two dimensional array. Using this two dimensional array of
          Tag ids, the Cluster generates a list of VMs to protect which are derived
          from intersections of the inner arrays and union of the outer array, as
          shown by the following example. To protect only ''Eng'' VMs in the East
          and all the VMs in the West, specify the following tag id array: [ [1101,
          2221], [3031] ], where 1101 is the ''Eng'' VM Tag id, 2221 is the ''East''
          VM Tag id and 3031 is the ''West'' VM Tag id. The inner array [1101, 2221]
          produces a list of VMs that are both tagged with ''Eng'' and ''East'' (an
          intersection). The outer array combines the list from the inner array with
          list of VMs tagged with ''West'' (a union). The list of resulting VMs are
          protected by this Protection Group.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      excludeVmTagIds:
        description: 'Array of Arrays of VM Tag Ids that Specify VMs to Exclude. Optionally
          specify a list of VMs to exclude from protecting by listing Protection Source
          ids of VM Tags in this two dimensional array. Using this two dimensional
          array of Tag ids, the Cluster generates a list of VMs to exclude from protecting,
          which are derived from intersections of the inner arrays and union of the
          outer array, as shown by the following example. For example a Datacenter
          is selected to be protected but you want to exclude all the ''Former Employees''
          VMs in the East and West but keep all the VMs for ''Former Employees'' in
          the South which are also stored in this Datacenter, by specifying the following
          tag id array: [ [1000, 2221], [1000, 3031] ], where 1000 is the ''Former
          Employee'' VM Tag id, 2221 is the ''East'' VM Tag id and 3031 is the ''West''
          VM Tag id. The first inner array [1000, 2221] produces a list of VMs that
          are both tagged with ''Former Employees'' and ''East'' (an intersection).
          The second inner array [1000, 3031] produces a list of VMs that are both
          tagged with ''Former Employees'' and ''West'' (an intersection). The outer
          array combines the list of VMs from the two inner arrays. The list of resulting
          VMs are excluded from being protected this Job.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-order: 4
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 6
        readOnly: true
      indexingPolicy:
        description: Specifies settings for indexing files found in an Object (such
          as a VM) so these files can be searched and recovered. This also specifies
          inclusion and exclusion rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/IndexingPolicy'
  AwsProtectionGroupParams:
    description: Specifies the parameters which are specific to AWS related Protection
      Groups.
    type: object
    title: AWS Protection Group Request Params.
    required:
    - protectionType
    properties:
      protectionType:
        description: Specifies the AWS Protection Group type.
        type: string
        enum:
        - kAgent
        - kNative
        - kSnapshotManager
        - kRDSSnapshotManager
        - kAuroraSnapshotManager
        x-order: 0
      agentProtectionTypeParams:
        description: Specifies the parameters which are specific to AWS related Protection
          Groups using cohesity protection-service installed on EC2 instance.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/AwsAgentProtectionGroupParams'
      nativeProtectionTypeParams:
        description: Specifies the parameters which are specific to AWS related Protection
          Groups using AWS native snapshot APIs.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/AwsNativeProtectionGroupParams'
      snapshotManagerProtectionTypeParams:
        description: Specifies the parameters which are specific to AWS related Protection
          Groups using AWS native snapshot orchestration with snapshot manager.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/AwsSnapshotManagerProtectionGroupParams'
      rdsProtectionTypeParams:
        description: Specifies the parameters which are specific to AWS RDS related
          Protection Groups.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/AwsRdsProtectionGroupParams'
      auroraProtectionTypeParams:
        description: Specifies the parameters which are specific to AWS Aurora related
          Protection Groups.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/AwsAuroraProtectionGroupParams'
  AwsProtectionGroupType:
    description: AWS Protection Group type.
    type: object
    title: AWS Protection Group type.
    properties:
      environment:
        description: Specifies AWS Protection Group type.
        type: string
        enum:
        - kAgent
        - kNative
        - kSnapshotManager
        - kRDSSnapshotManager
        - kAuroraSnapshotManager
        x-order: 0
  AwsRdsProtectionGroupObjectParams:
    description: Specifies the object parameters to create an AWS RDS Protection Group.
    type: object
    title: AWS RDS Snapshot Manager Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  AwsRdsProtectionGroupParams:
    description: Specifies the parameters which are specific to AWS RDS related Protection
      Groups.
    type: object
    title: AWS RDS Snapshot Manager Protection Group Request Params.
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/AwsRdsProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      rdsTagIds:
        description: Array of arrays of RDS Tag Ids that Specify db instaces to Protect.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 2
      excludeRdsTagIds:
        description: Array of arrays of RDS Tag Ids that Specify db instaces to Exclude.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 5
        readOnly: true
  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: '#/definitions/RecoverAwsRdsNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      targetVmCredentials:
        description: Specifies the credentials for the target VM.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      absolutePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
  AwsSnapshotManagerProtectionGroupObjectParams:
    description: Specifies the object parameters to create AWS Snapshot Manager Protection
      Group.
    type: object
    title: AWS Snapshot Manager Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      volumeExclusionParams:
        description: Specifies the paramaters to exclude volumes attached to EC2 instances
          at object level.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/EbsVolumeExclusionParams'
  AwsSnapshotManagerProtectionGroupParams:
    description: Specifies the parameters which are specific to AWS related Protection
      Groups using AWS native snapshot orchestration with snapshot manager. Atlease
      one of tags or objects must be specified.
    type: object
    title: Create AWS Snapshot Manager Protection Group Request Body
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        items:
          $ref: '#/definitions/AwsSnapshotManagerProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      volumeExclusionParams:
        description: Specifies the paramaters to exclude volumes attached to EC2 instances
          at global level.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/EbsVolumeExclusionParams'
      vmTagIds:
        description: 'Array of Array of VM Tag Ids that Specify VMs to Protect. Optionally
          specify a list of VMs to protect by listing Protection Source ids of VM
          Tags in this two dimensional array. Using this two dimensional array of
          Tag ids, the Cluster generates a list of VMs to protect which are derived
          from intersections of the inner arrays and union of the outer array, as
          shown by the following example. To protect only ''Eng'' VMs in the East
          and all the VMs in the West, specify the following tag id array: [ [1101,
          2221], [3031] ], where 1101 is the ''Eng'' VM Tag id, 2221 is the ''East''
          VM Tag id and 3031 is the ''West'' VM Tag id. The inner array [1101, 2221]
          produces a list of VMs that are both tagged with ''Eng'' and ''East'' (an
          intersection). The outer array combines the list from the inner array with
          list of VMs tagged with ''West'' (a union). The list of resulting VMs are
          protected by this Protection Group.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      excludeVmTagIds:
        description: 'Array of Arrays of VM Tag Ids that Specify VMs to Exclude. Optionally
          specify a list of VMs to exclude from protecting by listing Protection Source
          ids of VM Tags in this two dimensional array. Using this two dimensional
          array of Tag ids, the Cluster generates a list of VMs to exclude from protecting,
          which are derived from intersections of the inner arrays and union of the
          outer array, as shown by the following example. For example a Datacenter
          is selected to be protected but you want to exclude all the ''Former Employees''
          VMs in the East and West but keep all the VMs for ''Former Employees'' in
          the South which are also stored in this Datacenter, by specifying the following
          tag id array: [ [1000, 2221], [1000, 3031] ], where 1000 is the ''Former
          Employee'' VM Tag id, 2221 is the ''East'' VM Tag id and 3031 is the ''West''
          VM Tag id. The first inner array [1000, 2221] produces a list of VMs that
          are both tagged with ''Former Employees'' and ''East'' (an intersection).
          The second inner array [1000, 3031] produces a list of VMs that are both
          tagged with ''Former Employees'' and ''West'' (an intersection). The outer
          array combines the list of VMs from the two inner arrays. The list of resulting
          VMs are excluded from being protected this Job.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-order: 4
      createAmi:
        description: Specifies whether AMI should be created after taking snapshots
          of the instance.
        type: boolean
        x-nullable: true
        x-order: 5
      amiCreationFrequency:
        description: The frequency of AMI creation. This should be set if the option
          to create AMI is set. A value of n creates an AMI from the snapshots after
          every n runs. eg. n = 2 implies every alternate backup run starting from
          the first will create an AMI.
        type: integer
        format: int32
        x-nullable: true
        x-order: 6
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 8
        readOnly: true
  AwsSnapshotParams:
    description: Specifies parameters of AWS type snapshots.
    type: object
    properties:
      protectionType:
        description: Specifies the protection type of AWS snapshots.
        type: string
        enum:
        - kAgent
        - kNative
        - kSnapshotManager
        - kRDSSnapshotManager
        - kAuroraSnapshotManager
        x-nullable: true
        x-order: 0
  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: '#/definitions/AwsAuroraRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      auroraConfig:
        description: Specifies the Aurora params.
        allOf:
        - $ref: '#/definitions/AuroraConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for recovering to the original target.
        allOf:
        - $ref: '#/definitions/AwsRecoverFilesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for recovering to a new target.
        allOf:
        - $ref: '#/definitions/AwsRecoverFilesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      overwriteExisting:
        description: Specifies whether to override the existing files. Default is
          true.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveAttributes:
        description: Specifies whether to preserve original attributes. Default is
          true.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/AwsRdsRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      rdsConfig:
        description: Specifies the RDS params.
        allOf:
        - $ref: '#/definitions/RdsConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/AwsVmRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      fleetConfig:
        description: Specifies the fleet params.
        allOf:
        - $ref: '#/definitions/FleetConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoverAwsVmNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  AzureAgentProtectionGroupObjectParams:
    description: Specifies the object parameters to create agent based Azure Protection
      Group.
    type: object
    title: Agent based Azure Protection Group Object Params has.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  AzureAgentProtectionGroupParams:
    description: Specifies the parameters which are specific to Azure related Protection
      Groups using cohesity protection-service installed on the instance. Objects
      must be specified.
    type: object
    title: Agent based Azure Protection Group Request Params.
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/AzureAgentProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-order: 1
      appConsistentSnapshot:
        description: Specifies whether or not to quiesce apps and the file system
          in order to take app consistent snapshots.
        type: boolean
        x-nullable: true
        x-order: 2
      indexingPolicy:
        description: Specifies the indexing policy for VMs in this Group.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/IndexingPolicy'
      cloudMigration:
        description: Specifies whether or not to move the workload to the cloud.
        type: boolean
        x-nullable: true
        x-order: 4
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 6
        readOnly: true
  AzureCloudSpinParams:
    description: Specifies various resources when converting and deploying a VM to
      Azure.
    type: object
    title: Azure Parameters.
    properties:
      networkResourceGroupId:
        description: Specifies id of the resource group for the selected virtual network.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      resourceGroupId:
        description: Specifies id of the Azure resource group. Its value is globally
          unique within Azure.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      storageAccountId:
        description: Specifies id of the storage account that will contain the storage
          container within which we will create the blob that will become the VHD
          disk for the cloned VM.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      storageContainerId:
        description: Specifies id of the storage container within the above storage
          account.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      storageResourceGroupId:
        description: Specifies id of the resource group for the selected storage account.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      availabilitySetId:
        description: Specifies the availability set.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      tempVmResourceGroupId:
        description: Specifies id of the temporary Azure resource group.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      tempVmStorageAccountId:
        description: Specifies id of the temporary VM storage account that will contain
          the storage container within which we will create the blob that will become
          the VHD disk for the cloned VM.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      tempVmStorageContainerId:
        description: Specifies id of the temporary VM storage container within the
          above storage account.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
      tempVmSubnetId:
        description: Specifies Id of the temporary VM subnet within the above virtual
          network.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
      tempVmVirtualNetworkId:
        description: Specifies Id of the temporary VM Virtual Network.
        type: integer
        format: int64
        x-nullable: true
        x-order: 10
  AzureNativeProtectionGroupObjectParams:
    description: Specifies the object parameters to create Azure Native Protection
      Group.
    type: object
    title: Azure Native Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  AzureNativeProtectionGroupParams:
    description: Specifies the parameters which are specific to Azure related Protection
      Groups using Azure native snapshot APIs. Objects must be specified.
    type: object
    title: Azure Native Protection Group Request Params.
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        items:
          $ref: '#/definitions/AzureNativeProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-order: 1
      vmTagIds:
        description: Array of arrays of VM Tag Ids that Specify VMs to Protect.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 2
      excludeVmTagIds:
        description: Array of arrays of VM Tag Ids that Specify VMs to Exclude.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      indexingPolicy:
        description: Specifies the indexing policy for VMs in this Group.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/IndexingPolicy'
      cloudMigration:
        description: Specifies whether or not to move the workload to the cloud.
        type: boolean
        x-nullable: true
        x-order: 5
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 7
        readOnly: true
  AzureProtectionGroupParams:
    description: Specifies the parameters which are specific to Azure related Protection
      Groups.
    type: object
    title: Azure Protection Group Request Params.
    required:
    - protectionType
    properties:
      protectionType:
        description: Specifies the Azure Protection Group type.
        type: string
        enum:
        - kAgent
        - kNative
        - kSnapshotManager
        x-order: 0
      agentProtectionTypeParams:
        description: Specifies the parameters which are specific to Azure related
          protection groups using cohesity protection-service installed on the instance.
          Objects must be specified.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/AzureAgentProtectionGroupParams'
      nativeProtectionTypeParams:
        description: Specifies the parameters which are specific to Azure related
          Protection Groups using Azure native snapshot APIs.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/AzureNativeProtectionGroupParams'
      snapshotManagerProtectionTypeParams:
        description: Specifies the parameters which are specific to Azure related
          Protection Groups using Azure native snapshot orchestration with snapshot
          manager.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/AzureSnapshotManagerProtectionGroupParams'
  AzureProtectionGroupType:
    description: Azure Protection Group type.
    type: object
    title: Azure Protection Group type.
    properties:
      environment:
        description: Specifies Azure Protection Group type.
        type: string
        enum:
        - kAgent
        - kNative
        - kSnapshotManager
        x-order: 0
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      targetVmCredentials:
        description: Specifies the credentials for the target VM.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      absolutePath:
        description: Specifies the absolute path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
  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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
  AzureSnapshotManagerProtectionGroupObjectParams:
    description: Specifies the object parameters to create Azure Snapshot Manager
      Protection Group.
    type: object
    title: Azure Snapshot Manager Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  AzureSnapshotManagerProtectionGroupParams:
    description: Specifies the parameters which are specific to Azure related Protection
      Groups using Azure native snapshot orchestration with snapshot manager. Objects
      must be specified.
    type: object
    title: Create Azure Snapshot Manager Protection Group Request Body
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        uniqueItems: true
        items:
          $ref: '#/definitions/AzureSnapshotManagerProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      vmTagIds:
        description: Array of arrays of VM Tag Ids that Specify VMs to Protect.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 2
      excludeVmTagIds:
        description: Array of arrays of VM Tag Ids that Specify VMs to Exclude.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 5
        readOnly: true
  AzureSnapshotParams:
    description: Specifies parameters of Azure type snapshots.
    type: object
    properties:
      protectionType:
        description: Specifies the protection type of Azure snapshots.
        type: string
        enum:
        - kAgent
        - kNative
        - kSnapshotManager
        x-nullable: true
        x-order: 0
  AzureTargetConfig:
    description: Specifies the configuration for adding Azure as replication target
    type: object
    title: Azure Target Configuration
    required:
    - sourceId
    properties:
      sourceId:
        description: Specifies the source id of the Azure protection source registered
          on Cohesity cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the Azure Replication target.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      resourceGroup:
        description: Specifies id of the Azure resource group used to filter regions
          in UI.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      resourceGroupName:
        description: Specifies name of the Azure resource group used to filter regions
          in UI.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      storageAccount:
        description: Specifies id of the storage account of Azure replication target
          which will contain storage container.
        type: integer
        x-nullable: true
        x-order: 4
        readOnly: true
      storageAccountName:
        description: Specifies name of the storage account of Azure replication target
          which will contain storage container.
        type: string
        x-nullable: true
        x-order: 5
        readOnly: true
      storageContainer:
        description: Specifies id of the storage container of Azure Replication target.
        type: integer
        x-nullable: true
        x-order: 6
        readOnly: true
      storageContainerName:
        description: Specifies name of the storage container of Azure Replication
          target.
        type: string
        x-nullable: true
        x-order: 7
        readOnly: true
      storageResourceGroup:
        description: Specifies id of the storage resource group of Azure Replication
          target.
        type: integer
        x-nullable: true
        x-order: 8
        readOnly: true
      storageResourceGroupName:
        description: Specifies name of the storage resource group of Azure Replication
          target.
        type: string
        x-nullable: true
        x-order: 9
        readOnly: true
  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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for recovering to the original target.
        allOf:
        - $ref: '#/definitions/AzureRecoverFilesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for recovering to a new target.
        allOf:
        - $ref: '#/definitions/AzureRecoverFilesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      overwriteExisting:
        description: Specifies whether to overwrite the existing files. Default is
          true.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveAttributes:
        description: Specifies whether to preserve original file/folder attributes.
          Default is true.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/AzureVmRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 3
  AzureTier:
    description: Specifies the settings for a Azure tier.
    type: object
    allOf:
    - $ref: '#/definitions/CommonCloudTierSettings'
    - type: object
      required:
      - tierType
      properties:
        tierType:
          description: Specifies the Azure tier types.
          type: string
          enum:
          - kAzureTierHot
          - kAzureTierCool
          - kAzureTierArchive
          x-nullable: true
          x-order: 0
  AzureTieringLevels:
    description: Azure Tiering Levels
    type: object
    title: Azure Tiering Levels.
    properties:
      type:
        description: Azure Tiering Levels
        type: string
        enum:
        - kAzureTierHot
        - kAzureTierCool
        - kAzureTierArchive
        x-order: 0
  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
        minLength: 1
        items:
          $ref: '#/definitions/AzureTier'
        x-nullable: true
        x-order: 0
  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: '#/definitions/RecoverAzureVmNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  BackupAttempt:
    description: Specifies a backup attempt for an object.
    type: object
    title: Attempt information for an object.
    properties:
      startTimeUsecs:
        description: Specifies the start time of attempt in Unix epoch Timestamp(in
          microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      endTimeUsecs:
        description: Specifies the end time of attempt in Unix epoch Timestamp(in
          microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      admittedTimeUsecs:
        description: Specifies the time at which the backup task was admitted to run
          in Unix epoch Timestamp(in microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      permitGrantTimeUsecs:
        description: Specifies the time when gatekeeper permit is granted to the backup
          task. If the backup task is rescheduled due to errors, the field is updated
          to the time when permit is granted again.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      queueDurationUsecs:
        description: Specifies the duration between the startTime and when gatekeeper
          permit is granted to the backup task. If the backup task is rescheduled
          due to errors, the field is updated considering the time when permit is
          granted again. Queue duration = PermitGrantTimeUsecs - StartTimeUsecs
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      snapshotCreationTimeUsecs:
        description: Specifies the time at which the source snapshot was taken in
          Unix epoch Timestamp(in microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      status:
        description: Status of the attempt for an object. 'Running' indicates that
          the run is still running. 'Canceled' indicates that the run has been canceled.
          'Canceling' indicates that the run is in the process of being canceled.
          'Failed' indicates that the run has failed. 'Missed' indicates that the
          run was unable to take place at the scheduled time because the previous
          run was still happening. 'Succeeded' indicates that the run has finished
          successfully. 'SucceededWithWarning' indicates that the run finished successfully,
          but there were some warning messages.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 6
      stats:
        description: Statistics about backup data for an object.
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/BackupDataStats'
      progressTaskId:
        description: Progress monitor task for an object..
        type: string
        x-nullable: true
        x-order: 8
      message:
        description: A message about the error if encountered while performing backup.
        type: string
        x-nullable: true
        x-order: 9
  BackupDataStats:
    description: Specifies statistics about local snapshot.
    type: object
    title: Local snapshot statistics.
    properties:
      logicalSizeBytes:
        description: Specifies total logical size of object(s) in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      bytesWritten:
        description: Specifies total size of data in bytes written after taking backup.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      bytesRead:
        description: Specifies total logical bytes read for creating the snapshot.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  BackupPolicy:
    description: Specifies the backup schedule and retentions of a Protection Policy.
    type: object
    title: Backup Schedule and Retention.
    required:
    - regular
    properties:
      regular:
        description: Specifies the Incremental and Full policy settings and also the
          common Retention policy settings.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/RegularBackupPolicy'
      log:
        description: Specifies the Log backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/LogBackupPolicy'
      bmr:
        description: Specifies the BMR backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/BmrBackupPolicy'
      cdp:
        description: Specifies the settings for CDP (Continious Data Protection) Protection
          policy.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/CdpBackupPolicy'
  BackupRun:
    description: Specifies information about backup run for an object.
    type: object
    title: Snapshot run information for an object.
    properties:
      snapshotInfo:
        description: Snapshot information for an object.
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/SnapshotInfo'
      failedAttempts:
        description: Failed backup attempts for an object.
        type: array
        items:
          $ref: '#/definitions/BackupAttempt'
        x-order: 1
  BackupRunProgressInfo:
    description: Specifies the progress of a local backup run.
    type: object
    allOf:
    - $ref: '#/definitions/ProgressTaskInfo'
    - type: object
      properties:
        objects:
          description: Specifies progress for objects.
          type: array
          items:
            $ref: '#/definitions/ObjectProgressInfo'
          x-nullable: true
          x-order: 0
  BackupRunSummary:
    description: Specifies summary information about local snapshot run across all
      objects.
    type: object
    title: Summary information for local snapshot run.
    properties:
      runType:
        description: Type of Protection Group run. 'kRegular' indicates an incremental
          (CBT) backup. Incremental backups utilizing CBT (if supported) are captured
          of the target protection objects. The first run of a kRegular schedule captures
          all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup
          (all blocks) of the target protection objects are always captured and Change
          Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup.
          Capture the database transaction logs to allow rolling back to a specific
          point in time. 'kSystem' indicates system volume backup. It produces an
          image for bare metal recovery.
        type: string
        enum:
        - kRegular
        - kFull
        - kLog
        - kSystem
        - kHydrateCDP
        x-nullable: true
        x-order: 0
      isSlaViolated:
        description: Indicated if SLA has been violated for this run.
        type: boolean
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the start time of backup run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      endTimeUsecs:
        description: Specifies the end time of backup run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      status:
        description: Status of the backup run. 'Running' indicates that the run is
          still running. 'Canceled' indicates that the run has been canceled. 'Canceling'
          indicates that the run is in the process of being canceled. 'Failed' indicates
          that the run has failed. 'Missed' indicates that the run was unable to take
          place at the scheduled time because the previous run was still happening.
          'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning'
          indicates that the run finished successfully, but there were some warning
          messages.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 4
      messages:
        description: Message about the backup run.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 5
      successfulObjectsCount:
        description: Specifies the count of objects for which backup was successful.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      failedObjectsCount:
        description: Specifies the count of objects for which backup failed.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      cancelledObjectsCount:
        description: Specifies the count of objects for which backup was cancelled.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
      successfulAppObjectsCount:
        description: Specifies the count of app objects for which backup was successful.
        type: integer
        format: int32
        x-nullable: true
        x-order: 9
      failedAppObjectsCount:
        description: Specifies the count of app objects for which backup failed.
        type: integer
        format: int32
        x-nullable: true
        x-order: 10
      cancelledAppObjectsCount:
        description: Specifies the count of app objects for which backup was cancelled.
        type: integer
        format: int32
        x-nullable: true
        x-order: 11
      localSnapshotStats:
        description: Statistics about local snapshot (across all objects).
        x-nullable: true
        x-order: 12
        $ref: '#/definitions/BackupDataStats'
      indexingTaskId:
        description: Progress monitor task for indexing.
        type: string
        x-nullable: true
        x-order: 13
      progressTaskId:
        description: Progress monitor task id for local backup run.
        type: string
        x-nullable: true
        x-order: 14
      dataLock:
        description: "Specifies WORM retention type for the local backeup. When a\
          \ WORM retention type is specified, the snapshots of the Protection Groups\
          \ using this policy will be kept until the maximum of the snapshot retention\
          \ time. During that time, the snapshots cannot be deleted. \n'Compliance'\
          \ implies WORM retention is set for compliance reason. \n'Administrative'\
          \ implies WORM retention is set for administrative purposes."
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 15
      localTaskId:
        description: Task ID for a local protection run.
        type: string
        x-nullable: true
        x-order: 16
  BgpInstance:
    description: BGP instance.
    type: object
    title: bgpInstance
    properties:
      localAS:
        description: Local AS.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 0
      peers:
        description: List of bgp peer groups.
        type: array
        items:
          $ref: '#/definitions/BgpPeer'
        x-nullable: true
        x-order: 1
      timers:
        description: BGP timers.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/BgpTimers'
  BgpPeer:
    description: BGP peer information.
    type: object
    title: BgpPeer
    properties:
      addressOrTag:
        description: IP Address.
        type: string
        x-nullable: true
        x-order: 0
      description:
        description: Peer's description.
        type: string
        x-nullable: true
        x-order: 1
      remoteAS:
        description: Remote AS.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 2
      timers:
        description: Bgp timers.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/BgpTimers'
  BgpTimers:
    description: BGP protocol timers.
    type: object
    title: BgpTimers
    properties:
      keepAlive:
        description: Keep alive interval in seconds.
        type: integer
        format: int32
        x-nullable: true
        x-order: 0
      holdTime:
        description: Hold time in seconds.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
  BifrostConnection:
    description: Specify a connection of Bifrost.
    type: object
    title: Bifrost connection.
    properties:
      id:
        description: Specifies the id of the connection.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the connection.
        type: string
        x-nullable: true
        x-order: 1
      subnet:
        description: Specifies the connection subnet.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/ConnectionSubnet'
      certificateVersion:
        description: Specifies the version of the connection's certificate. The version
          is used to revoke/renew connection's certificates.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      networkConnectionInfo:
        description: Specifies the network connection information.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/NetworkConnectionInfo'
  BifrostConnections:
    description: Specify a list of connection of Bifrost.
    type: object
    title: Bifrost connections.
    properties:
      BifrostConnections:
        description: Specifies a list of connection of Bifrost.
        type: array
        items:
          $ref: '#/definitions/BifrostConnection'
        x-nullable: true
        x-order: 0
  BifrostConnector:
    description: Specify a Bifrost connector.
    type: object
    title: Bifrost Connector.
    properties:
      id:
        description: Specifies the id of the connector.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the connector.
        type: string
        x-nullable: true
        x-order: 1
      connectionId:
        description: Specifies the Id of the connection which this connector belongs
          to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      connectionStatus:
        description: Specifies the connection status.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/ConnectorConnectionInfo'
      cohesitySideIp:
        description: Specifies the cohesity side ip of the connector
        type: string
        x-nullable: true
        x-order: 4
        readOnly: true
      tenantSourceSideIp:
        description: Specifies the tenant source side ip of the connector
        type: string
        x-nullable: true
        x-order: 5
        readOnly: true
      hyxVersion:
        description: Specifies the connector's software Version
        type: string
        x-nullable: true
        x-order: 6
        readOnly: true
  BifrostConnectors:
    description: Specify a list of Bifrost connectors.
    type: object
    title: Bifrost Connectors.
    properties:
      BifrostConnectors:
        description: Specifies a list of Bifrost Connectors.
        type: array
        items:
          $ref: '#/definitions/BifrostConnector'
        x-nullable: true
        x-order: 0
  BlackoutWindow:
    description: Specifies a time range in a single day when new Protection Group
      Runs of Protection Groups cannot be started. For example, a Protection Group
      with a daily schedule could define a blackout period for Sunday.
    type: object
    title: Blackout Window
    required:
    - day
    - startTime
    - endTime
    properties:
      day:
        description: Specifies a day in the week when no new Protection Group Runs
          should be started such as 'Sunday'. If not set, the time range applies to
          all days. Specifies a day in a week such as 'Sunday', 'Monday', etc.
        type: string
        enum:
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        x-nullable: true
        x-order: 0
      startTime:
        description: Specifies the start time of the blackout time range.
        title: Blackout Start Time.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/TimeOfDay'
      endTime:
        description: Specifies the end time of the blackout time range.
        title: Blackout End Time.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/TimeOfDay'
      configId:
        description: Specifies the unique identifier for the target getting added.
          This field need to be passed olny when policies are updated.
        type: string
        x-nullable: true
        x-order: 3
  BmrBackupPolicy:
    description: Specifies the BMR schedule in case of physical source protection.
    type: object
    title: BMR Backup (Physical) Schedule and Retention.
    required:
    - schedule
    - retention
    properties:
      schedule:
        description: Specifies the schedule settings for BMR backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/BmrSchedule'
      retention:
        description: Specifies the Retention period of a backup in days, months or
          years.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Retention'
  BmrSchedule:
    description: Specifies settings that defines how frequent bmr backup will be performed
      for a Protection Group.
    type: object
    title: Bmr Schedule
    required:
    - unit
    properties:
      unit:
        description: Specifies how often to start new runs of a Protection Group.
          <br>'Weeks' specifies that new Protection Group runs start weekly on certain
          days specified using 'dayOfWeek' field. <br>'Months' specifies that new
          Protection Group runs start monthly on certain day of specific week.
        type: string
        enum:
        - Days
        - Weeks
        - Months
        x-nullable: true
        x-order: 0
      daySchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of days.
        type: object
        x-order: 1
        $ref: '#/definitions/DaySchedule'
      weekSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on certain number of days in a week.
        type: object
        x-order: 2
        $ref: '#/definitions/WeekSchedule'
      monthSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on specific week in a month and specific days of that week.
        type: object
        x-order: 3
        $ref: '#/definitions/MonthSchedule'
  BondingModeType:
    description: Type of bonding mode.
    type: object
    title: Bonding Mode Type
    properties:
      bondingModeType:
        description: Specifies the bonding mode type.
        type: string
        enum:
        - ActiveBackup
        - 802_3ad
        - BalanceAlb
        - Invalid
        x-order: 0
  CDPFilterStatus:
    description: CDP Filter Status
    type: object
    title: CDP Filter Status
    properties:
      cdpFilterStatus:
        description: Specifies the CDP filter status.
        type: string
        enum:
        - NotInstalled
        - InstallFilterInProgress
        - FilterInstalledIOInactive
        - FilterInstalled
        - IOInactive
        - IOActivationInProgress
        - IOActive
        - IODeactivationInProgress
        - UninstallFilterInProgress
        - UpgradeFilterInProgress
        - UpgradeFilterFailed
        x-order: 0
  CancelObjectRunParams:
    description: One object run to cancel.
    type: object
    required:
    - runId
    properties:
      runId:
        description: Specifies the id of the run to cancel.
        type: string
        x-nullable: true
        x-order: 0
      cancelLocalRun:
        description: Specifies whether to cancel the local backup run. Default is
          false.
        type: boolean
        x-nullable: true
        x-order: 1
      archivalTargetIds:
        description: Specifies the archival target ids where the tasks run. If specified,
          the archival target ids must be present within the run specified by the
          runId above.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 2
      replicationTargets:
        description: Specifies the cluster identifiers where the tasks run. If specified,
          the archival target ids must be present within the run specified by the
          runId above.
        type: array
        items:
          $ref: '#/definitions/ClusterIdentifier'
        x-nullable: true
        x-order: 3
      cloudSpinTargetIds:
        description: Specifies the cloud spin target ids where the tasks run. If specified,
          the archival target ids must be present within the run specified by the
          runId above.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 4
  CancelObjectRunsParams:
    description: Request to cancel object runs.
    type: object
    required:
    - objectId
    properties:
      objectId:
        description: Specifies object id
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      runsConfig:
        description: Specifies a list of runs to cancel. If no runs are specified,
          then all the outstanding runs will be canceled.
        type: array
        items:
          $ref: '#/definitions/CancelObjectRunParams'
        x-nullable: true
        x-order: 1
  CancelObjectRunsRequest:
    description: Request to cancel object runs.
    type: object
    properties:
      objectRuns:
        description: Specifies a list of object runs to cancel.
        type: array
        items:
          $ref: '#/definitions/CancelObjectRunsParams'
        x-nullable: true
        x-order: 0
  CancelObjectRunsResult:
    description: Result after canceling object runs.
    type: object
    properties:
      objectId:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      errorMessage:
        description: Specifies the error message if any error happens.
        type: string
        x-nullable: true
        x-order: 1
  CancelObjectRunsResults:
    description: Results after canceling object runs. If no errors happen, this will
      not be returned.
    type: object
    properties:
      results:
        description: Specifies results after canceling object runs.
        type: array
        items:
          $ref: '#/definitions/CancelObjectRunsResult'
        x-nullable: true
        x-order: 0
  CancelProtectionGroupRunRequest:
    description: Specifies the request to cancel a protection run.
    type: object
    title: Cancel protection run request.
    properties:
      localTaskId:
        description: Specifies the task id of the local run.
        type: string
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 0
      replicationTaskId:
        description: Specifies the task id of the replication run.
        type: array
        items:
          type: string
          pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 1
      archivalTaskId:
        description: Specifies the task id of the archival run.
        type: array
        items:
          type: string
          pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 2
      cloudSpinTaskId:
        description: Specifies the task id of the cloudSpin run.
        type: array
        items:
          type: string
          pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 3
  CassandraAuthType:
    description: Enumeration of all the Cassandra Authentication types.
    type: object
    title: Enumeration of all the Cassandra Authentication types.
    properties:
      CassandraAuthType:
        description: Enumeration of all the Cassandra Authentication.
        type: string
        enum:
        - PASSWORD
        - KERBEROS
        - LDAP
        x-order: 0
  CassandraConnectionParams:
    description: Specifies the parameters to connect to a Cassandra seed node and
      fetch information from its cassandra config file.
    title: Parameters to connect and query cassandra config file.
    required:
    - seedNode
    - configDirectory
    - isDseTieredStorage
    - isDseAuthenticator
    properties:
      seedNode:
        description: Any one seed node of the Cassandra cluster.
        type: string
        x-order: 0
      configDirectory:
        description: Directory path containing Cassandra configuration YAML file.
        type: string
        x-order: 1
      dseConfigurationDirectory:
        description: Directory from where DSE specific configuration can be read.
          This should be set only when you are using the DSE distribution of Cassandra.
        type: string
        x-nullable: true
        x-order: 2
      isDseTieredStorage:
        description: Set to true if this cluster has DSE tiered storage.
        type: boolean
        x-order: 3
      isDseAuthenticator:
        description: Set to true if this cluster has DSE Authenticator.
        type: boolean
        x-order: 4
      sshPasswordCredentials:
        description: SSH username + password required for reading configuration file
          and for scp backup.Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials'
          are required.
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: SSH password.
            type: string
            x-order: 0
          username:
            description: SSH username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 5
      sshPrivateKeyCredentials:
        description: SSH  userID + privateKey required for reading configuration file
          and for scp backup.
        type: object
        required:
        - userId
        - privateKey
        properties:
          passphrase:
            description: Passphrase for the private key.
            type: string
            x-order: 0
          privateKey:
            description: The private key.
            type: string
            x-order: 1
          userId:
            description: userId for PrivateKey credentials.
            type: string
            x-order: 2
        x-nullable: true
        x-order: 6
  CassandraIndexedObject:
    description: Specifies a Cassandra indexed object.
    title: CassandraIndexedObject
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        type:
          description: Specifies the Cassandra Object type.
          type: string
          enum:
          - CassandraKeyspaces
          - CassandraTables
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the id of the indexed object.
          type: string
          x-nullable: true
          x-order: 1
  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
        allOf:
        - $ref: '#/definitions/RecoverCassandraParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RecoverCassandraParams'
  CassandraPortInfo:
    description: Contains info about specific cassandra ports.
    type: object
    title: Cassandra specific port info.
    properties:
      nativeTransportPort:
        description: Port for the CQL native transport.
        type: integer
        format: int32
        x-nullable: true
        x-order: 0
      rpcPort:
        description: Remote Procedure Call (RPC) port for general mechanism for client-server
          applications.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
      storagePort:
        description: TCP port for data. Internally used by Cassandra bulk loader.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
      sslStoragePort:
        description: SSL port for encrypted communication. Internally used by the
          Cassandra bulk loader.
        type: integer
        format: int32
        x-nullable: true
        x-order: 3
      jmxPort:
        description: Cassandra management port.
        type: integer
        format: int32
        x-nullable: true
        x-order: 4
  CassandraProtectionGroupParams:
    description: Specifies the parameters for Cassandra Protection Group.
    allOf:
    - $ref: '#/definitions/NoSqlProtectionGroupParams'
    - type: object
      properties:
        dataCenters:
          description: Only the specified data centers will be considered while taking
            backup. The keyspaces having replication strategy 'Simple' can be backed
            up only if all the datacenters for the cassandra cluster are specified.
            For any keyspace having replication strategy as 'Network', all the associated
            data centers should be specified.
          type: array
          items:
            type: string
          x-order: 0
      x-cohesity-discriminator-value: kCassandra
      x-nullable: true
  CassandraSecurityInfo:
    description: Cassandra security related info.
    type: object
    title: Cassandra security info.
    properties:
      cassandraAuthorizer:
        description: Cassandra Authenticator/Authorizer.
        type: string
        x-nullable: true
        x-order: 0
      cassandraAuthRequired:
        description: Is Cassandra authentication required ?
        type: boolean
        x-nullable: true
        x-order: 1
      cassandraAuthType:
        description: Cassandra Authentication type.
        type: string
        enum:
        - PASSWORD
        - KERBEROS
        - LDAP
        x-nullable: true
        x-order: 2
      dseAuthorization:
        description: Is DSE Authorization enabled for this cluster ?
        type: boolean
        x-nullable: true
        x-order: 3
      clientEncryption:
        description: Is Client Encryption enabled for this cluster ?
        type: boolean
        x-nullable: true
        x-order: 4
      serverInternodeEncryptionType:
        description: '''Server internal node Encryption'' type.'
        type: string
        x-nullable: true
        x-order: 5
      serverEncryptionReqClientAuth:
        description: Is 'Server encryption request client authentication' enabled
          for this cluster ?
        type: boolean
        x-nullable: true
        x-order: 6
  CassandraSourceConfigParams:
    description: Specifies the parameters fetched by reading cassandra configuration
      on the seed node.
    title: Parameters fetched by reading cassandra config file.
    properties:
      seeds:
        description: Seed nodes of this cluster.
        type: array
        items:
          type: string
        x-order: 0
      isJmxAuthEnable:
        description: Is JMX Authentication enabled in this cluster ?
        type: boolean
        x-nullable: true
        x-order: 1
      cassandraPortInfo:
        description: Info about specific cassandra ports.
        x-order: 2
        $ref: '#/definitions/CassandraPortInfo'
      cassandraSecurityInfo:
        description: Cassandra security related info.
        x-order: 3
        $ref: '#/definitions/CassandraSecurityInfo'
      dataCenterNames:
        description: Data centers for this cluster.
        type: array
        items:
          type: string
        x-order: 4
      endpointSnitch:
        description: Endpoint snitch used for this cluster.
        type: string
        x-nullable: true
        x-order: 5
      cassandraPartitioner:
        description: Cassandra partitioner required in compaction.
        type: string
        x-nullable: true
        x-order: 6
      kerberosSaslProtocol:
        description: Populated if cassandraAuthType is Kerberos.
        type: string
        x-nullable: true
        x-order: 7
      cassandraVersion:
        description: Cassandra Version.
        type: string
        x-nullable: true
        x-order: 8
      dseVersion:
        description: DSE Version
        type: string
        x-nullable: true
        x-order: 9
  CassandraSourceRegistrationParams:
    description: Specifies parameters to register cassandra source.
    title: Register cassandra source request parameters.
    allOf:
    - $ref: '#/definitions/CassandraConnectionParams'
    - type: object
      properties:
        jmxCredentials:
          description: JMX Credentials for this cluster. These should be the same
            for all the nodes
          type: object
          required:
          - username
          - password
          properties:
            password:
              description: JMX password.
              type: string
              x-order: 0
            username:
              description: JMX username.
              type: string
              x-order: 1
          x-nullable: true
          x-order: 0
        cassandraCredentials:
          description: Cassandra Credentials for this cluster.
          type: object
          required:
          - username
          - password
          properties:
            password:
              description: Cassandra password.
              type: string
              x-order: 0
            username:
              description: Cassandra username.
              type: string
              x-order: 1
          x-nullable: true
          x-order: 1
        dataCenterNames:
          description: Data centers for this cluster.
          type: array
          items:
            type: string
          x-order: 2
        kerberosPrincipal:
          description: Principal for the kerberos connection. (This is required only
            if your Cassandra has Kerberos authentication. Please refer to the user
            guide.)
          type: string
          x-nullable: true
          x-order: 3
        dseSolrInfo:
          description: Contains information about the DSE Solr on this cluster.
          x-order: 4
          $ref: '#/definitions/DSESolrInfo'
  CassandraSourceRegistrationUpdateParams:
    description: Specifies parameters to update cassandra source.
    type: object
    title: Update cassandra source request parameters.
    properties:
      seedNode:
        description: Any one seed node of the Cassandra cluster.
        type: string
        x-order: 0
      configDirectory:
        description: Directory path containing Cassandra configuration YAML file.
        type: string
        x-order: 1
      dseConfigurationDirectory:
        description: Directory from where DSE specific configuration can be read.
          This should be set only when you are using the DSE distribution of Cassandra.
        type: string
        x-nullable: true
        x-order: 2
      isDseTieredStorage:
        description: Set to true if this cluster has DSE tiered storage.
        type: boolean
        x-order: 3
      isDseAuthenticator:
        description: Set to true if this cluster has DSE Authenticator.
        type: boolean
        x-order: 4
      sshPasswordCredentials:
        description: SSH username + password required for reading configuration file
          and for scp backup.Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials'
          are required.
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: SSH password.
            type: string
            x-order: 0
          username:
            description: SSH username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 5
      sshPrivateKeyCredentials:
        description: SSH  userID + privateKey required for reading configuration file
          and for scp backup.
        type: object
        required:
        - userId
        - privateKey
        properties:
          passphrase:
            description: Passphrase for the private key.
            type: string
            x-order: 0
          privateKey:
            description: The private key.
            type: string
            x-order: 1
          userId:
            description: userId for PrivateKey credentials.
            type: string
            x-order: 2
        x-nullable: true
        x-order: 6
      jmxCredentials:
        description: JMX Credentials for this cluster. These should be the same for
          all the nodes
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: JMX password.
            type: string
            x-order: 0
          username:
            description: JMX username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 7
      cassandraCredentials:
        description: Cassandra Credentials for this cluster.
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: Cassandra password.
            type: string
            x-order: 0
          username:
            description: Cassandra username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 8
      dataCenterNames:
        description: Data centers for this cluster.
        type: array
        items:
          type: string
        x-order: 9
      kerberosPrincipal:
        description: Principal for the kerberos connection. (This is required only
          if your Cassandra has Kerberos authentication. Please refer to the user
          guide.)
        type: string
        x-nullable: true
        x-order: 10
      dseSolrInfo:
        description: Contains information about the DSE Solr on this cluster.
        x-order: 11
        $ref: '#/definitions/DSESolrInfo'
  CdpBackupPolicy:
    description: Specifies CDP (Continious Data Protection) backup settings for a
      Protection Group.
    type: object
    title: Continious Data Protection (CDP) Policy.
    required:
    - retention
    properties:
      retention:
        description: Specifies the Retention period of a log backup in days, months
          or years.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/CdpRetention'
  CdpLocalBackupInfo:
    description: Specifies the last local backup information for a given CDP object.
    type: object
    properties:
      startTimeInUsecs:
        description: Specifies the start time of the last local backup taken.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      endTimeInUsecs:
        description: Specifies the end time of the last local backup taken.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  CdpObjectInfo:
    description: Specifies the CDP related information for a given object. This field
      will only be populated when protection group is configured with policy having
      CDP retention settings.
    type: object
    properties:
      cdpEnabled:
        description: Specifies whether CDP is currently active or not. CDP might have
          been active on this object before, but it might not be anymore.
        type: boolean
        x-nullable: true
        x-order: 0
      lastRunInfo:
        description: Specifies the details about last continious backup taken for
          this object.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/CdpObjectLastRunInfo'
      protectionGroupId:
        description: Specifies the protection group id to which this CDP object belongs.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
  CdpObjectLastRunInfo:
    description: Specifies the last backup information for a given CDP object.
    type: object
    properties:
      localBackupInfo:
        description: Specifies the last backup information for a given CDP object.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/CdpLocalBackupInfo'
  CdpRetention:
    description: Specifies the retention of a CDP backup.
    type: object
    required:
    - unit
    - duration
    properties:
      unit:
        description: Specificies the Retention Unit of a CDP backup measured in minutes
          or hours.
        type: string
        enum:
        - Minutes
        - Hours
        x-nullable: true
        x-order: 0
      duration:
        description: Specifies the duration for a cdp backup retention.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  CentrifyZone:
    description: Specifies a centrify zone.
    type: object
    required:
    - description
    - distinguishedName
    - schema
    properties:
      description:
        description: Specifies a description of the Centrify zone.
        type: string
        x-nullable: true
        x-order: 0
      distinguishedName:
        description: Specifies the distinguished name of the Centrify zone.
        type: string
        x-nullable: true
        x-order: 1
      schema:
        description: Specifies the schema of this Centrify zone.
        type: string
        enum:
        - CentrifyDynamicSchema_1_0
        - CentrifyDynamicSchema_2_0
        - CentrifySfu_3_0
        - CentrifySfu_4_0
        - CentrifyCdcRfc2307
        - CentrifyDynamicSchema_3_0
        - CentrifyCdcRfc2307_2
        - CentrifyDynamicSchema_5_0
        - CentrifyCdcRfc2307_3
        - CentrifySfu_3_0_V5
        x-nullable: true
        x-order: 2
      zoneName:
        description: Specifies the zone name of the Centrify zone.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      zoneDomain:
        description: Specifies the zone domain of the Centrify zone.
        type: string
        x-nullable: true
        x-order: 4
        readOnly: true
  CentrifyZones:
    description: Specifies a list of centrify zones for a domain.
    type: object
    properties:
      domainName:
        description: Specifies a domain name with these centrify zones.
        type: string
        x-nullable: true
        x-order: 0
      centrifyZones:
        description: Specifies a list of centrify zones for this domain.
        type: array
        items:
          $ref: '#/definitions/CentrifyZone'
        x-nullable: true
        x-order: 1
  CertificateAuthMapping:
    description: 'Describes certificate mapping options for certificate based

      authentication.'
    type: object
    title: Certificate Auth Mapping
    properties:
      enum:
        description: Specifies the auth field options
        type: string
        enum:
        - CommonName
        - EmailAddress
        - UserPrincipalName
        x-order: 0
  CertificateValidationStatus:
    description: Describes the certificate validation status.
    type: object
    title: Certificate Validation Status.
    properties:
      type:
        description: Specifies the certificate validation status
        type: string
        enum:
        - Valid
        - Expired
        - Revoked
        - Unknown
        x-order: 0
  Chassis:
    description: Specifies information about hardware chassis.
    type: object
    title: Chassis specific response.
    properties:
      id:
        description: Specifies the id of the chassis used to uniquely identify a chassis.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      hardwareModel:
        description: Specifies the hardware model of the chassis.
        type: string
        x-nullable: true
        x-order: 1
      name:
        description: Specifies the name of the chassis.
        type: string
        x-nullable: true
        x-order: 2
      serialNumber:
        description: Specifies the serial number of the chassis.
        type: string
        x-nullable: true
        x-order: 3
      nodeIds:
        description: Specifies list of ids of all the nodes in chassis.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 4
      rackId:
        description: Rack Id that this chassis belong to
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
  ChassisList:
    description: Specifies the list of hardware chassis.
    type: object
    title: List of chassis
    properties:
      chassis:
        description: Specifies the list of chassis.
        type: array
        items:
          $ref: '#/definitions/Chassis'
        x-nullable: true
        x-order: 0
  CipherSuite:
    description: Cipher Suite
    type: object
    title: CipherSuite
    properties:
      cipher:
        description: Specifies the cipher suite used for TLS handshake.
        type: string
        enum:
        - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
        - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
        - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
        - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
        - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
        - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
        - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
        - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
        - TLS_RSA_WITH_AES_256_GCM_SHA384
        - TLS_RSA_WITH_AES_128_GCM_SHA256
        - TLS_RSA_WITH_AES_256_CBC_SHA
        - TLS_RSA_WITH_AES_128_CBC_SHA
        x-order: 0
  CiphersResp:
    description: Specifies a list of enabled/disabled ciphers on the cluster.
    type: object
    title: 'Response with two lists: a list of enabled ciphers and a list of disabled
      ciphers.'
    properties:
      enabledCiphers:
        description: Enabled ciphers.
        type: array
        items:
          type: string
          enum:
          - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
          - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
          - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
          - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
          - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
          - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
          - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
          - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
          - TLS_RSA_WITH_AES_256_GCM_SHA384
          - TLS_RSA_WITH_AES_128_GCM_SHA256
          - TLS_RSA_WITH_AES_256_CBC_SHA
          - TLS_RSA_WITH_AES_128_CBC_SHA
        x-order: 0
      disabledCiphers:
        description: Disabled ciphers.
        type: array
        items:
          type: string
          enum:
          - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
          - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
          - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
          - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
          - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
          - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
          - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
          - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
          - TLS_RSA_WITH_AES_256_GCM_SHA384
          - TLS_RSA_WITH_AES_128_GCM_SHA256
          - TLS_RSA_WITH_AES_256_CBC_SHA
          - TLS_RSA_WITH_AES_128_CBC_SHA
        x-order: 1
  CloudSpinConfig:
    description: Specifies settings for copying Snapshots to Cloud. This also specifies
      the retention policy that should be applied to Snapshots after they have been
      copied to Cloud.
    title: CloudSpin Target Configuration.
    allOf:
    - $ref: '#/definitions/CommonTargetConfiguration'
    - type: object
      required:
      - target
      properties:
        target:
          description: Specifies the details about CloudSpin target where backup snapshots
            may be converted and stored.
          type: object
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/CloudSpinTarget'
  CloudSpinDataStats:
    description: Specifies statistics about Cloud Spin data.
    type: object
    title: Cloud Spin data statistics.
    properties:
      physicalBytesTransferred:
        description: Specifies the physical bytes transferred.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
  CloudSpinRun:
    description: Specifies information about Cloud Spin run for an object.
    type: object
    title: Cloud Spin run information for an object.
    properties:
      cloudSpinTargetResults:
        description: Cloud Spin result for a target.
        type: array
        items:
          $ref: '#/definitions/CloudSpinTargetResult'
        x-order: 0
  CloudSpinRunSummary:
    description: Specifies summary information about cloud spin run.
    type: object
    title: Summary information for cloud spin run.
    properties:
      cloudSpinTargetResults:
        description: Cloud Spin results for each Cloud Spin target.
        type: array
        items:
          $ref: '#/definitions/CloudSpinTargetResult'
        x-order: 0
  CloudSpinTarget:
    description: Specifies the details about Cloud Spin target where backup snapshots
      may be converted and stored.
    type: object
    properties:
      id:
        description: Specifies the unique id of the cloud spin entity.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      awsParams:
        description: Specifies various resources when converting and deploying a VM
          to AWS.
        type: object
        title: Contains information needed to identify various resources when deploying
          VMs to Cloud.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/AwsCloudSpinParams'
      azureParams:
        description: Specifies various resources when converting and deploying a VM
          to Azure.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/AzureCloudSpinParams'
      name:
        description: Specifies the name of the already added cloud spin target.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
  CloudSpinTargetResult:
    description: Cloud Spin result for a target.
    title: Cloud Spin result for a target.
    allOf:
    - $ref: '#/definitions/CloudSpinTarget'
    - type: object
      properties:
        startTimeUsecs:
          description: Specifies the start time of Cloud Spin in Unix epoch Timestamp(in
            microseconds) for a target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        endTimeUsecs:
          description: Specifies the end time of Cloud Spin in Unix epoch Timestamp(in
            microseconds) for a target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
        status:
          description: Status of the Cloud Spin for a target. 'Running' indicates
            that the run is still running. 'Canceled' indicates that the run has been
            canceled. 'Canceling' indicates that the run is in the process of being
            canceled. 'Failed' indicates that the run has failed. 'Missed' indicates
            that the run was unable to take place at the scheduled time because the
            previous run was still happening. 'Succeeded' indicates that the run has
            finished successfully. 'SucceededWithWarning' indicates that the run finished
            successfully, but there were some warning messages.
          type: string
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-nullable: true
          x-order: 2
        message:
          description: Message about the Cloud Spin run.
          type: string
          x-nullable: true
          x-order: 3
        stats:
          description: Cloud Spin data statistics for a target.
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/CloudSpinDataStats'
        isManuallyDeleted:
          description: Specifies whether the snapshot is deleted manually.
          type: boolean
          x-nullable: true
          x-order: 5
        expiryTimeUsecs:
          description: Specifies the expiry time of attempt in Unix epoch Timestamp
            (in microseconds) for an object.
          type: integer
          format: int64
          x-nullable: true
          x-order: 6
        cloudspinTaskId:
          description: Task ID for a CloudSpin protection run.
          type: string
          x-nullable: true
          x-order: 7
        progressTaskId:
          description: Progress monitor task id for Cloud Spin run.
          type: string
          x-nullable: true
          x-order: 8
  Cluster:
    description: Specifies the cluster details.
    type: object
    title: Create Cluster Response.
    properties:
      id:
        description: Specifies the cluster id of the new cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
        readOnly: true
      incarnationId:
        description: Specifies the incarnation id of the new cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
        readOnly: true
      name:
        description: Name of the new cluster.
        type: string
        x-nullable: true
        x-order: 2
      description:
        description: Description of the cluster.
        type: string
        x-nullable: true
        x-order: 3
      type:
        description: Specifies the type of the new cluster.
        type: string
        enum:
        - Physical
        - Virtual
        - Cloud
        - Rigel
        - Unknown
        x-nullable: true
        x-order: 4
        readOnly: true
      localTenantId:
        description: Specifies the local tenant id. Only applicable on Helios.
        type: string
        x-nullable: true
        x-order: 5
        readOnly: true
      tenantId:
        description: Specifies the globally unique tenant id. Only applicable on Helios.
        type: string
        x-nullable: true
        x-order: 6
        readOnly: true
      regionId:
        description: Specifies the region id on which this cluster is present. Only
          applicable on Helios for DMaaS clusters.
        type: string
        x-nullable: true
        x-order: 7
        readOnly: true
      rigelClusterParams:
        description: Specifies the Rigel specific parameters.
        x-order: 8
        $ref: '#/definitions/RigelClusterConfigParams'
      swVersion:
        description: Software version of the new cluster.
        type: string
        x-nullable: true
        x-order: 9
        readOnly: true
      networkConfig:
        description: Network config of the new cluster.
        x-order: 10
        $ref: '#/definitions/ClusterCreateNetworkConfig'
      proxyServerConfig:
        description: Specifies the proxy to use for external HTTP traffic.
        x-order: 11
        $ref: '#/definitions/ClusterProxyServerConfig'
      enableEncryption:
        description: Specifies whether or not encryption is enabled. If encryption
          is enabled, all data on the Cluster will be encrypted.
        type: boolean
        x-nullable: true
        x-order: 12
        readOnly: true
  ClusterAMQPTargetConfig:
    description: Specifies the AMQP target config.
    type: object
    properties:
      serverIp:
        description: Specifies the server ip.
        type: string
        x-nullable: true
        x-order: 0
      username:
        description: Specifies the username.
        type: string
        x-nullable: true
        x-order: 1
      password:
        description: Specifies the password.
        type: string
        x-nullable: true
        x-order: 2
      virtualHost:
        description: Specifies the virtual host.
        type: string
        x-nullable: true
        x-order: 3
      exchange:
        description: Specifies the exchange.
        type: string
        x-nullable: true
        x-order: 4
      filerId:
        description: Specifies the filer id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      certificate:
        description: Specifies the certificate.
        type: string
        x-nullable: true
        x-order: 6
  ClusterCreateCloudParams:
    description: Params for Cloud Edition Cluster Creation
    title: Cloud Cluster Params.
    properties:
      nodeIps:
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: string
        x-order: 0
    x-nullable: true
  ClusterCreateNetworkConfig:
    description: Specifies all of the parameters needed for network configuration
      of the new Cluster.
    type: object
    title: Cluster Network Config.
    required:
    - useDhcp
    - ntpServers
    - domainNames
    properties:
      ntpServers:
        description: Specifies the list of NTP Servers new cluster should be configured
          with.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      domainNames:
        description: Specifies the list of Domain Names new cluster should be configured
          with.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 1
      vipHostName:
        description: Specifies the FQDN hostname of the cluster.
        type: string
        x-nullable: true
        x-order: 2
      ipPreference:
        description: Specifies IP preference of the cluster to be Ipv4/Ipv6. It is
          Ipv4 by default.
        type: string
        enum:
        - Ipv4
        - Ipv6
        x-nullable: true
        x-order: 3
      useDhcp:
        description: Specifies whether or not to use DHCP to configure the network
          of the Cluster.
        type: boolean
        x-nullable: true
        x-order: 4
      dhcpNetworkConfig:
        description: Specifies the parameters needed for DHCP based network configuration.
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/ClusterDhcpNetworkConfig'
      manualNetworkConfig:
        description: Specifies the parameters needed for manual network configuration.
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/ClusterManualNetworkConfig'
  ClusterCreateNodeParams:
    description: Node params required for cluster creation
    type: object
    title: Node Specific Params.
    required:
    - nodeId
    - nodeIp
    properties:
      nodeId:
        description: Specifies the node id of the node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      nodeIp:
        description: Specifies the node ip address which is either in ipv4/ipv6 format.
        type: string
        x-nullable: true
        x-order: 1
  ClusterCreateNodeStatusResponse:
    description: Specifies node specific response of cluster create.
    type: object
    title: Node specific response.
    properties:
      nodeId:
        description: Specifies the id of the node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      nodeIp:
        description: Specifies the Ip address of the node.
        type: string
        x-nullable: true
        x-order: 1
      message:
        description: Specifies optional message related to node status.
        type: string
        x-nullable: true
        x-order: 2
    x-nullable: true
  ClusterCreatePhysicalParams:
    description: Params for Physical Edition Cluster Creation
    title: Physical Cluster Params.
    properties:
      nodes:
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ClusterCreateNodeParams'
        x-order: 0
  ClusterCreateRigelParams:
    description: Params for Rigel Cluster Creation
    title: Rigel Cluster Params.
    required:
    - nodes
    - claimToken
    properties:
      nodes:
        type: array
        uniqueItems: true
        items:
          $ref: '#/definitions/RigelClusterNode'
        x-order: 0
      claimToken:
        description: Specifies the token which will be used to claim this Cluster
          to Helios.
        type: string
        x-nullable: true
        x-order: 1
    x-nullable: true
  ClusterCreateVirtualParams:
    description: Params for Virtual Edition Cluster Creation
    title: Virtual Cluster Params.
    properties:
      nodes:
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ClusterCreateNodeParams'
        x-order: 0
  ClusterDhcpNetworkConfig:
    description: Specifies all of the parameters needed for network configuration
      of the new Cluster using DHCP.
    type: object
    title: Cluster Network Config.
    required:
    - dnsServers
    properties:
      gateway:
        description: Specifies the gateway of the new cluster network.
        type: string
        x-nullable: true
        x-order: 0
        readOnly: true
      subnetIp:
        description: Specifies the ip subnet ip of the cluster network.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      subnetMask:
        description: Specifies the ip subnet mask of the cluster network.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
      dnsServers:
        description: Specifies the list of Dns Servers new cluster should be configured
          with.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 3
  ClusterFreeDisks:
    description: Sepcifies the free disks of cluster.
    type: object
    title: ClusterFreeDisks
    required:
    - nodeFreeDisks
    properties:
      nodeFreeDisks:
        description: Specifies list of free disks of cluster.
        type: array
        items:
          $ref: '#/definitions/NodeFreeDisks'
        x-nullable: true
        x-order: 0
  ClusterIdentifier:
    description: Specifies the information about a cluster.
    type: object
    title: Cluster Identifier
    properties:
      clusterId:
        description: Specifies the id of the cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      clusterIncarnationId:
        description: Specifies the incarnation id of the cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      clusterName:
        description: Specifies the name of the cluster.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
  ClusterInterfaces:
    description: Specifies the interfaces present on a Cluster grouped by the Node
      where they are present.
    type: object
    title: Cluster Interfaces
    properties:
      nodes:
        description: Specifies the list of nodes present in the cluster. If the request
          was sent to a free node, then this list will have exactly one entry.
        type: array
        items:
          $ref: '#/definitions/NodeInterfaces'
        x-order: 0
  ClusterLogType:
    description: cluster log type.
    type: object
    title: Cluster Log Type.
    properties:
      type:
        description: Cluster Log Type.
        type: string
        enum:
        - Info
        - Warning
        - Error
        x-order: 0
  ClusterManualNetworkConfig:
    description: Specifies all of the parameters needed for network configuration
      of the new Cluster using manual configuration.
    type: object
    title: Cluster Network Config.
    required:
    - gateway
    - subnetIp
    - subnetMask
    - dnsServers
    properties:
      gateway:
        description: Specifies the gateway of the new cluster network.
        type: string
        x-nullable: true
        x-order: 0
      subnetIp:
        description: Specifies the ip subnet ip of the cluster network.
        type: string
        x-nullable: true
        x-order: 1
      subnetMask:
        description: Specifies the ip subnet mask of the cluster network.
        type: string
        x-nullable: true
        x-order: 2
      dnsServers:
        description: Specifies the list of Dns Servers new cluster should be configured
          with.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 3
  ClusterProxyServerConfig:
    description: Specifies the parameters of the proxy server to be used for external
      traffic.
    type: object
    title: Cluster Proxy Server Config.
    required:
    - ip
    - port
    properties:
      name:
        description: Specifies the unique name of the proxy server.
        type: string
        x-nullable: true
        x-order: 0
        readOnly: true
      ip:
        description: Specifies the IP address of the proxy server.
        type: string
        x-nullable: true
        x-order: 1
      port:
        description: Specifies the port on which the server is listening.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
      username:
        description: Specifies the username for the proxy.
        type: string
        x-nullable: true
        x-order: 3
      password:
        description: Specifies the password for the proxy.
        type: string
        x-nullable: true
        x-order: 4
    x-nullable: true
  ClusterType:
    description: Cluster Type
    type: object
    title: Cluster Type
    properties:
      clusterType:
        description: Specifies the cluster types.
        type: string
        enum:
        - Physical
        - Virtual
        - Cloud
        - Rigel
        - Unknown
        x-order: 0
  CommonActiveDirectoryParams:
    description: Specifies the params of Active Directory which are used across creating
      and updating.
    type: object
    required:
    - machineAccounts
    properties:
      machineAccounts:
        description: Specifies a list of computer names used to identify the Cohesity
          Cluster on the Active Directory domain. The first machine account is used
          as primary machine account and it can not be modified.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: object
          $ref: '#/definitions/MachineAccount'
        x-nullable: true
        x-order: 0
      id:
        description: Specifies the id of the Active Directory.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
        readOnly: true
      organizationalUnitName:
        description: Specifies an optional organizational unit name.
        type: string
        x-nullable: true
        x-order: 2
      workGroupName:
        description: Specifies a work group name.
        type: string
        x-nullable: true
        x-order: 3
      preferredDomainControllers:
        description: Specifies a list of preferred domain controllers of this Active
          Directory.
        type: array
        items:
          type: object
          x-nullable: true
          $ref: '#/definitions/DomainController'
        x-nullable: true
        x-order: 4
      ldapProviderId:
        description: Specifies the LDAP provider id which is mapped to this Active
          Directory
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      trustedDomainParams:
        description: Specifies the params of trusted domain info of an Active Directory.
        type: object
        allOf:
        - $ref: '#/definitions/TrustedDomainParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      nisProviderDomainName:
        description: Specifies the name of the NIS Provider which is mapped to this
          Active Directory.
        type: string
        x-nullable: true
        x-order: 7
      connectionId:
        description: Specifies the id of the connection.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
  CommonBackupParams:
    description: Specifies the common parameters for backup. These parameters are
      common across protection group and object protection.
    type: object
    required:
    - policyId
    properties:
      policyId:
        description: Specifies the unique id of the Protection Policy. The Policy
          settings will be attached with every object and will be used in backup.
        type: string
        x-nullable: true
        x-order: 0
      storageDomainId:
        description: Specifies the Storage Domain (View Box) ID where the object backup
          will be taken. This is not required if Cloud archive direct is benig used.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      startTime:
        description: Specifies the start time for the backup to trigger. If no start
          time is specified, the start time will default to 2am. This field is only
          used if the policy has a daily or monthly schedule.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/TimeOfDay'
      priority:
        description: Specifies the priority for the objects backup.
        type: string
        enum:
        - kLow
        - kMedium
        - kHigh
        x-nullable: true
        x-order: 3
      sla:
        description: Specifies the SLA parameters for list of objects.
        type: array
        items:
          $ref: '#/definitions/SlaRule'
        x-nullable: true
        x-order: 4
      qosPolicy:
        description: Specifies whether object backup will be written to HDD or SSD.
        type: string
        enum:
        - kBackupHDD
        - kBackupSSD
        - kTestAndDevHigh
        - kBackupAll
        x-nullable: true
        x-order: 5
      abortInBlackouts:
        description: Specifies whether currently executing object backup should abort
          if a blackout period specified by a policy starts. Available only if the
          selected policy has at least one blackout period. Default value is false.
        type: boolean
        x-nullable: true
        x-order: 6
  CommonCdpParams:
    description: Specifies the params for Continuous Data Protection.
    type: object
    title: Continuous Data Protection Params.
    properties:
      enableCdpSyncReplication:
        description: Specifies whether synchronous replication is enabled for CDP
          Protection Group when replication target is specified in attached policy.
        type: boolean
        x-nullable: true
        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
        enum:
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 0
      moveAfter:
        description: Specifies the time period after which the backup will be moved
          from current tier to next tier.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  CommonCreateOrUpdateRigelConnectionRequest:
    description: Specify the common params to create or update a connection of Rigel.
    type: object
    title: Common Create Or Update Rigel Connection Request.
    required:
    - tenantId
    - name
    properties:
      tenantId:
        description: Specifies the id of the tenant which the connection belongs to.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the connection.
        type: string
        x-nullable: true
        x-order: 1
  CommonCreateOrUpdateRigelConnectorRequest:
    description: Specify the common params to create or update a Rigel connector.
    type: object
    title: Common Create Or Update Rigel connector Request.
    required:
    - connectionId
    - tenantId
    - name
    - certificateVersion
    properties:
      connectionId:
        description: Specifies the Id of the connection which this connector belongs
          to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      tenantId:
        description: Specifies the id of the tenant which the connector belongs to.
        type: string
        x-nullable: true
        x-order: 1
      name:
        description: Specifies the name of the connector.
        type: string
        x-nullable: true
        x-order: 2
      certificateVersion:
        description: Specifies the version of the connector's certificate. The version
          is used to revoke/renew connector's certificates.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  CommonCsrRequestParams:
    description: Specifies the parameters of a CSR.
    type: object
    required:
    - organization
    - organizationUnit
    - countryCode
    - state
    - city
    properties:
      organization:
        description: Specifies the organization attribute, which is part of the distinguished
          name definition. It is used to specify the name of the company.
        type: string
        x-nullable: true
        x-order: 0
      organizationUnit:
        description: Specifies the organization unit attribute, which is part of the
          distinguished name definition. It is used to identify the specific department
          or business unit in the company that is owning the Cluster.
        type: string
        x-nullable: true
        x-order: 1
      countryCode:
        description: Specifies the country attribute, which is part of the distinguished
          name definition. It is used to identify the country where the state is located.
          It is specified as two letter code defined by the ISO standard.
        type: string
        x-nullable: true
        x-order: 2
      state:
        description: Specifies the state attribute, which is part of the distinguished
          name definition. It is used to identify the state where the city is located.
        type: string
        x-nullable: true
        x-order: 3
      city:
        description: Specifies the locality attribute, which is part of the distinguished
          name definition. It is used to identify the city where the company is located
          or the Cluster is installed.
        type: string
        x-nullable: true
        x-order: 4
      keyType:
        description: Specifies the algorithm to be used to generate the key pair.
          RSA is the default value.
        type: string
        default: rsa
        enum:
        - rsa
        - ecdsa
        x-nullable: true
        x-order: 5
      keySizeBits:
        description: Specifies the size of the keys in bits. The default is 2048 bits
          for the RSA keys and 256 bits for ECDSA.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      commonName:
        description: Specifies the common name attribute, which is part of the distinguished
          name definition. Common name is used to specify a context for the certificate,
          for example, the name of the Cluster to which the certificate is to be assigned.
          Default value is the name of the Cluster.
        type: string
        x-nullable: true
        x-order: 7
      dnsNames:
        description: Specifies an alternative subject name component to be included
          in the certificate. It is used to identify the ways the Cluster will be
          accessed. It is given as a comma separated list of FQDNs. The default value
          is the Cluster's VIP hostname.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 8
      hostIps:
        description: Specifies an alternative subject name component to be included
          in the certificate. It is used to identify the ways the Cluster will be
          accessed. It is given as a comma separated list of IP addresses. The default
          value is the Cluster's VIP addresses.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 9
      emailAddress:
        description: Specifies an alternative subject name component to be included
          in the certificate. Format is a standard e-mail address, for example joe@company.com.
        type: string
        x-nullable: true
        x-order: 10
      serviceName:
        description: Specifies the Cohesity service name for which the CSR is generated.
          Default service name is iris.
        type: string
        default: iris
        enum:
        - iris
        x-nullable: true
        x-order: 11
  CommonCsrResponseParams:
    description: Specifies the common response params for a CSR.
    allOf:
    - $ref: '#/definitions/CommonCsrRequestParams'
    - type: object
      properties:
        id:
          description: Specifies the id of the CSR.
          type: string
          x-nullable: true
          x-order: 0
        publicKey:
          description: Specifies the public key generated for this CSR.
          type: string
          x-nullable: true
          x-order: 1
        csr:
          description: Specifies the CSR generated for the service.
          type: string
          x-nullable: true
          x-order: 2
  CommonDataTieringAnalysisGroupParams:
    description: Specifies the data tiering analysis group.
    type: object
    required:
    - name
    - source
    properties:
      name:
        description: Specifies the name of the data tiering analysis group.
        type: string
        x-nullable: true
        x-order: 0
      source:
        x-order: 1
        $ref: '#/definitions/DataTieringSource'
  CommonDataTieringTaskParams:
    description: Specifies the data tiering task details.
    type: object
    required:
    - name
    - type
    properties:
      name:
        description: Specifies the name of the data tiering task.
        type: string
        x-nullable: true
        x-order: 0
      description:
        description: Specifies a description of the data tiering task.
        type: string
        x-nullable: true
        x-order: 1
      alertPolicy:
        description: Specifies the alerting policy for the data tiering task.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      source:
        description: Specifies source for data tiering.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/DataTieringSource'
      target:
        description: Specifies target for data tiering
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/DataTieringTarget'
      schedule:
        description: Specifies schedule for data tiering
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/DataTieringSchedule'
      type:
        description: 'Type of data tiering task.

          ''Downtier'' indicates downtiering task.

          ''Uptier'' indicates uptiering task.'
        type: string
        enum:
        - Downtier
        - Uptier
        x-nullable: true
        x-order: 6
    x-cohesity-discriminator-details:
      propertyName: type
  CommonDataTieringTaskResponse:
    description: Specifies the data tiering task details.
    type: object
    required:
    - name
    - type
    properties:
      id:
        description: Specifies the id of the data tiering task.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the data tiering task.
        type: string
        x-nullable: true
        x-order: 1
      description:
        description: Specifies a description of the data tiering task.
        type: string
        x-nullable: true
        x-order: 2
      alertPolicy:
        description: Specifies the alerting policy for the data tiering task.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      source:
        description: Specifies source for data tiering.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/DataTieringSource'
      target:
        description: Specifies target for data tiering
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/DataTieringTarget'
      schedule:
        description: Specifies schedule for data tiering
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/DataTieringSchedule'
      type:
        description: 'Type of data tiering task.

          ''Downtier'' indicates downtiering task.

          ''Uptier'' indicates uptiering task.'
        type: string
        enum:
        - Downtier
        - Uptier
        x-nullable: true
        x-order: 7
      lastRun:
        description: Specifies last run details for data tiering task.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/DataTieringTaskRun'
        readOnly: true
      isActive:
        description: Whether the data tiering task is active or not.
        type: boolean
        default: true
        x-nullable: true
        x-order: 9
      isPaused:
        description: 'Whether the data tiering task is paused. New runs are not scheduled

          for the paused tasks. Active run of the task (if any) is not

          impacted.'
        type: boolean
        default: true
        x-nullable: true
        x-order: 10
      isDeleted:
        description: Tracks whether the backup job has actually been deleted.
        type: boolean
        default: true
        x-nullable: true
        x-order: 11
    x-cohesity-discriminator-details:
      propertyName: type
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        x-order: 0
      downloadFilePath:
        description: Specifies the path location to download the files and folders.
        type: string
        x-nullable: true
        x-order: 1
  CommonGenericNasProtectionParams:
    description: Specifies the parameters which are specific to Generic NAS Protection.
    type: object
    properties:
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/IndexingPolicy'
      continueOnError:
        description: Specifies whether or not the backup should continue regardless
          of whether or not an error was encountered.
        type: boolean
        x-nullable: true
        x-order: 1
      encryptionEnabled:
        description: Specifies whether the encryption should be used while backup
          or not.
        type: boolean
        x-nullable: true
        x-order: 2
      fileLockConfig:
        description: Optional config that enables file locking for this view. It cannot
          be disabled during the edit of a view, if it has been enabled during the
          creation of the view. Also, it cannot be enabled if it was disabled during
          the creation of the view.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/FileLevelDataLockConfig'
      fileFilters:
        description: Specifies file paths to include or exclude.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/FileFilteringPolicy'
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the backup.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/HostBasedBackupScriptParams'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          full or incremental backup of the NAS source.
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/NasThrottlingConfig'
  CommonIndexedObjectParams:
    description: Holds parameters common to an indexed object.
    title: CommonIndexedObjectParams
    allOf:
    - type: object
      properties:
        name:
          description: Specifies the name of the object.
          type: string
          x-nullable: true
          x-order: 0
        path:
          description: Specifies the path of the object.
          type: string
          x-nullable: true
          x-order: 1
        protectionGroupId:
          description: '"Specifies the protection group id which contains this object."'
          type: string
          x-nullable: true
          x-order: 2
        protectionGroupName:
          description: '"Specifies the protection group name which contains this object."'
          type: string
          x-nullable: true
          x-order: 3
        storageDomainId:
          description: '"Specifies the Storage Domain id where the backup data of
            Object

            is present."'
          type: integer
          format: int64
          x-nullable: true
          x-order: 4
        sourceInfo:
          description: Specifies the Source Object information.
          allOf:
          - $ref: '#/definitions/ObjectSummary'
          - x-nullable: true
          x-order: 5
    - $ref: '#/definitions/TagObject'
  CommonMSSQLProtectionGroupParams:
    description: Specifies the common params to create a MSSQL Protection Group.
    type: object
    title: Common MSSQL Protection Group Request Params.
    properties:
      userDbBackupPreferenceType:
        description: Specifies the preference type for backing up user databases on
          the host.
        type: string
        enum:
        - kBackupAllDatabases
        - kBackupAllExceptAAGDatabases
        - kBackupOnlyAAGDatabases
        x-nullable: true
        x-order: 0
      backupSystemDbs:
        description: Specifies whether to backup system databases. If not specified
          then parameter is set to true.
        type: boolean
        x-nullable: true
        x-order: 1
      useAagPreferencesFromServer:
        description: Specifies whether or not the AAG backup preferences specified
          on the SQL Server host should be used.
        type: boolean
        x-nullable: true
        x-order: 2
      aagBackupPreferenceType:
        description: Specifies the preference type for backing up databases that are
          part of an AAG. If not specified, then default preferences of the AAG server
          are applied. This field wont be applicable if user DB preference is set
          to skip AAG databases.
        type: string
        enum:
        - kPrimaryReplicaOnly
        - kSecondaryReplicaOnly
        - kPreferSecondaryReplica
        - kAnyReplica
        x-nullable: true
        x-order: 3
      fullBackupsCopyOnly:
        description: Specifies whether full backups should be copy-only.
        type: boolean
        x-nullable: true
        x-order: 4
      prePostScript:
        description: Specifies the pre and post script parameters associated with
          a protection group.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/PrePostScriptParams'
      excludeFilters:
        description: Specifies the list of exclusion filters applied during the group
          creation or edit. These exclusion filters can be wildcard supported strings
          or regular expressions. Objects satisfying the will filters will be excluded
          during backup and also auto protected objects will be ignored if filtered
          by any of the filters.
        type: array
        items:
          $ref: '#/definitions/Filter'
        x-nullable: true
        x-order: 6
  CommonMssqlFileObjectProtectionParams:
    description: Specifies the common params to create a File based MSSQL Object Protection.
    allOf:
    - $ref: '#/definitions/CommonMSSQLProtectionGroupParams'
  CommonMssqlNativeObjectProtectionParams:
    description: Specifies the common params to create a Native based MSSQL Object
      Protection.
    allOf:
    - type: object
      properties:
        numStreams:
          description: Specifies the number of streams to be used.
          type: integer
          format: int32
          x-nullable: true
          x-order: 0
        withClause:
          description: Specifies the WithClause to be used.
          type: string
          x-nullable: true
          x-order: 1
    - $ref: '#/definitions/CommonMSSQLProtectionGroupParams'
  CommonMssqlObjectProtectionParams:
    description: Specifies the common parameters for MSSQL Object Protection.
    type: object
    required:
    - objectProtectionType
    properties:
      objectProtectionType:
        description: Specifies the MSSQL Object Protection type.
        type: string
        enum:
        - kFile
        - kVolume
        - kNative
        x-order: 0
      commonFileObjectProtectionTypeParams:
        description: Specifies the common File based MSSQL Object Protection params.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/CommonMssqlFileObjectProtectionParams'
      commonNativeObjectProtectionTypeParams:
        description: Specifies the common Native based MSSQL Object Protection params.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/CommonMssqlNativeObjectProtectionParams'
  CommonNasObjectParams:
    description: Specifies the common parameters for NAS objects.
    type: object
    properties:
      supportedNasMountProtocols:
        description: Specifies a list of NAS mount protocols supported by this object.
        type: array
        items:
          type: string
          enum:
          - kNoProtocol
          - kNfs3
          - kCifs1
          - kCifs2
          - kCifs3
        x-nullable: true
        x-order: 0
  CommonNasProtectionParams:
    description: Specifies the parameters which are specific to NAS Protection.
    type: object
    properties:
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/IndexingPolicy'
      continueOnError:
        description: Specifies whether or not the backup should continue regardless
          of whether or not an error was encountered.
        type: boolean
        x-nullable: true
        x-order: 1
      encryptionEnabled:
        description: Specifies whether the encryption should be used while backup
          or not.
        type: boolean
        x-nullable: true
        x-order: 2
      fileLockConfig:
        description: Optional config that enables file locking for this view. It cannot
          be disabled during the edit of a view, if it has been enabled during the
          creation of the view. Also, it cannot be enabled if it was disabled during
          the creation of the view.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/FileLevelDataLockConfig'
      fileFilters:
        description: Specifies file paths to include or exclude.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/FileFilteringPolicy'
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the backup.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/HostBasedBackupScriptParams'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          full or incremental backup of the NAS source.
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/NasThrottlingConfig'
  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
        format: int64
        x-nullable: true
        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
        x-nullable: true
        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
        format: int32
        x-nullable: true
        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
        format: int64
        x-nullable: true
        x-order: 3
      warnings:
        description: This field will hold the warnings in cases where the job status
          is SucceededWithWarnings.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 4
        readOnly: true
  CommonObjectActionRequest:
    description: Specifies the common request parameters for performing an action
      on Object.
    type: object
    title: Common Object Action Request.
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Object.
        type: string
        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-nullable: true
        x-order: 0
    x-cohesity-discriminator-details:
      propertyName: environment
  CommonObjectProtectParams:
    description: Specifies the common parameters for object backup. These parameters
      are common across all types of adapters and objects.
    type: object
    allOf:
    - $ref: '#/definitions/CommonBackupParams'
  CommonObjectSnapshotVolumeParams:
    description: Specifies volume info of snapshot across all enviroments.
    type: object
    properties:
      volumes:
        description: Specifies a list of volume info.
        type: array
        items:
          $ref: '#/definitions/VolumeInfo'
        x-nullable: true
        x-order: 0
  CommonObjectSummary:
    description: Specifies an Common summary properties for an object.
    type: object
    title: Common Object Entity Summary.
    allOf:
    - $ref: '#/definitions/ObjectSummary'
    - type: object
      properties:
        protectionStats:
          description: Specifies the count and size of protected and unprotected objects
            for the size.
          type: array
          items:
            $ref: '#/definitions/ObjectProtectionStatsSummary'
          x-nullable: true
          x-order: 0
        permissions:
          description: Specifies the list of users, groups and tenants that have permissions
            for this object.
          type: object
          x-order: 1
          $ref: '#/definitions/PermissionInfo'
    x-cohesity-discriminator-details:
      propertyName: environment
  CommonObjectsActionParams:
    description: Specifies the comon action params needed for performing bulk actions
      on list of objects.
    type: object
    properties:
      objectMap:
        description: Specifies the objectMap that will be used to perform bulk actions
          such as linking and unlinking.
        type: array
        items:
          $ref: '#/definitions/ActionObjectMapping'
        x-nullable: true
        x-order: 0
  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
        format: int64
        x-nullable: true
        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
        items:
          $ref: '#/definitions/OracleDbChannel'
        x-nullable: true
        x-order: 1
      recoveryMode:
        description: Specifies if database should be left in recovery mode.
        type: boolean
        x-nullable: true
        x-order: 2
      shellEvironmentVars:
        description: Specifies key value pairs of shell variables which defines the
          restore shell environment.
        type: array
        items:
          $ref: '#/definitions/ShellKeyValuePair'
        x-nullable: true
        x-order: 3
      granularRestoreInfo:
        description: Specifies information about list of objects (PDBs) to restore.
        type: object
        allOf:
        - $ref: '#/definitions/RecoverOracleGranularRestoreInfo'
        - x-nullable: true
        x-order: 4
  CommonOracleCloneParams:
    description: Specifies the common properties of an Oracle clone.
    type: object
    required:
    - dbName
    - homeFolder
    - baseFolder
    properties:
      dbName:
        description: Specifies the name of the cloned database.
        type: string
        x-nullable: true
        x-order: 0
      homeFolder:
        description: Specifies the home folder for the cloned database.
        type: string
        x-nullable: true
        x-order: 1
      baseFolder:
        description: Specifies the base folder of Oracle installation on the target
          host.
        type: string
        x-nullable: true
        x-order: 2
      sga:
        description: Specifies the System Global Area (SGA) for the clone database.
        type: string
        x-nullable: true
        x-order: 3
  CommonPostBackupScriptParams:
    description: Specifies the common params for PostBackup scripts.
    title: Common PostBackup Script Params
    allOf:
    - $ref: '#/definitions/CommonPrePostScriptParams'
  CommonPreBackupScriptParams:
    description: Specifies the common params for PreBackup scripts.
    title: Common PreBackup Script Params
    allOf:
    - $ref: '#/definitions/CommonPrePostScriptParams'
    - type: object
      properties:
        continueOnError:
          description: Specifies if the script needs to continue even if there is
            an occurence of an error. If this flag is set to true, then Backup Run
            will start even if the pre backup script fails. If not specified or false,
            then backup run will not start when script fails.
          type: boolean
          x-nullable: true
          x-order: 0
  CommonPrePostScriptParams:
    description: Specifies the path to the remote script and any common parameters
      expected by the remote script.
    type: object
    title: Common PrePost Script Params
    required:
    - path
    properties:
      path:
        description: Specifies the absolute path to the script on the remote host.
        type: string
        x-order: 0
      params:
        description: 'Specifies the arguments or parameters and values to pass into
          the remote script. For example if the script expects values for the ''database''
          and ''user'' parameters, specify the parameters and values using the following
          string: "database=myDatabase user=me".'
        type: string
        x-nullable: true
        x-order: 1
      timeoutSecs:
        description: Specifies the timeout of the script in seconds. The script will
          be killed if it exceeds this value. By default, no timeout will occur if
          left empty.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 2
      isActive:
        description: Specifies whether the script should be enabled, default value
          set to true.
        type: boolean
        x-nullable: true
        x-order: 3
  CommonProtectionGroupRequestParams:
    description: Specifies the parameters which are common between all Protection
      Group requests.
    type: object
    required:
    - name
    - policyId
    - environment
    properties:
      name:
        description: Specifies the name of the Protection Group.
        type: string
        x-nullable: true
        x-order: 0
      policyId:
        description: Specifies the unique id of the Protection Policy associated with
          the Protection Group. The Policy provides retry settings Protection Schedules,
          Priority, SLA, etc.
        type: string
        x-nullable: true
        x-order: 1
      priority:
        description: Specifies the priority of the Protection Group.
        type: string
        enum:
        - kLow
        - kMedium
        - kHigh
        x-nullable: true
        x-order: 2
      storageDomainId:
        description: Specifies the Storage Domain (View Box) ID where this Protection
          Group writes data.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      description:
        description: Specifies a description of the Protection Group.
        type: string
        x-nullable: true
        x-order: 4
      startTime:
        description: Specifies the start time for this Protection Group. If no start
          time is specified, the start time will default to 2am. This field is only
          used if the policy has a daily or monthly schedule.
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/TimeOfDay'
      endTimeUsecs:
        description: Specifies the end time in micro seconds for this Protection Group.
          If this is not specified, the Protection Group won't be ended.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      alertPolicy:
        description: Specifies the alerting policy for this Protection Group.
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      sla:
        description: Specifies the SLA parameters for this Protection Group.
        type: array
        items:
          $ref: '#/definitions/SlaRule'
        x-nullable: true
        x-order: 8
      qosPolicy:
        description: Specifies whether the Protection Group will be written to HDD
          or SSD.
        type: string
        enum:
        - kBackupHDD
        - kBackupSSD
        - kTestAndDevHigh
        - kBackupAll
        x-nullable: true
        x-order: 9
      abortInBlackouts:
        description: Specifies whether currently executing jobs should abort if a
          blackout period specified by a policy starts. Available only if the selected
          policy has at least one blackout period. Default value is false.
        type: boolean
        x-nullable: true
        x-order: 10
      environment:
        description: Specifies the environment type of the Protection Group.
        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-nullable: true
        x-order: 11
      isPaused:
        description: Specifies if the the Protection Group is paused. New runs are
          not scheduled for the paused Protection Groups. Active run if any is not
          impacted.
        type: boolean
        x-nullable: true
        x-order: 12
    x-cohesity-discriminator-details:
      propertyName: environment
  CommonProtectionGroupResponseParams:
    description: Specifies the parameters which are common between all Protection
      Group responses.
    type: object
    properties:
      id:
        description: Specifies the ID of the Protection Group.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the Protection Group.
        type: string
        x-nullable: true
        x-order: 1
      policyId:
        description: Specifies the unique id of the Protection Policy associated with
          the Protection Group. The Policy provides retry settings Protection Schedules,
          Priority, SLA, etc.
        type: string
        x-nullable: true
        x-order: 2
      priority:
        description: Specifies the priority of the Protection Group.
        type: string
        enum:
        - kLow
        - kMedium
        - kHigh
        x-nullable: true
        x-order: 3
      storageDomainId:
        description: Specifies the Storage Domain (View Box) ID where this Protection
          Group writes data.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      description:
        description: Specifies a description of the Protection Group.
        type: string
        x-nullable: true
        x-order: 5
      startTime:
        description: Specifies the start time for this Protection Group. If no start
          time is specified, the start time will default to 2am. This field is only
          used if the policy has a daily or monthly schedule.
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/TimeOfDay'
      endTimeUsecs:
        description: Specifies the end time in micro seconds for this Protection Group.
          If this is not specified, the Protection Group won't be ended.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      alertPolicy:
        description: Specifies the alerting policy for this Protection Group.
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      sla:
        description: Specifies the SLA parameters for this Protection Group.
        type: array
        items:
          $ref: '#/definitions/SlaRule'
        x-nullable: true
        x-order: 9
      qosPolicy:
        description: Specifies whether the Protection Group will be written to HDD
          or SSD.
        type: string
        enum:
        - kBackupHDD
        - kBackupSSD
        - kTestAndDevHigh
        - kBackupAll
        x-nullable: true
        x-order: 10
      abortInBlackouts:
        description: Specifies whether currently executing jobs should abort if a
          blackout period specified by a policy starts. Available only if the selected
          policy has at least one blackout period. Default value is false.
        type: boolean
        x-nullable: true
        x-order: 11
      isActive:
        description: Specifies if the Protection Group is active or not.
        type: boolean
        x-nullable: true
        x-order: 12
      isDeleted:
        description: Specifies if the Protection Group has been deleted.
        type: boolean
        x-nullable: true
        x-order: 13
      isPaused:
        description: Specifies if the the Protection Group is paused. New runs are
          not scheduled for the paused Protection Groups. Active run if any is not
          impacted.
        type: boolean
        x-nullable: true
        x-order: 14
      environment:
        description: Specifies the environment of the Protection Group.
        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-nullable: true
        x-order: 15
      lastRun:
        description: Specifies information about the last run for this Protection
          Group.
        x-nullable: true
        x-order: 16
        $ref: '#/definitions/ProtectionGroupRun'
      permissions:
        description: Specifies the list of tenants that have permissions for this
          protection group.
        type: array
        items:
          $ref: '#/definitions/Tenant'
        x-nullable: true
        x-order: 17
      isProtectOnce:
        description: Specifies if the the Protection Group is using a protect once
          type of policy. This field is helpful to identify run happen for this group.
        type: boolean
        x-nullable: true
        x-order: 18
    x-cohesity-discriminator-details:
      propertyName: environment
  CommonProtectionGroupRunResponseParameters:
    description: Specifies the parameters which are common between Protection Group
      runs of all Protection Groups.
    type: object
    title: Common Protection Group run response parameters.
    properties:
      id:
        description: Specifies the ID of the Protection Group run.
        type: string
        x-nullable: true
        x-order: 0
      protectionGroupInstanceId:
        description: Protection Group instance Id. This field will be removed later.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      protectionGroupId:
        description: ProtectionGroupId to which this run belongs.
        type: string
        x-nullable: true
        x-order: 2
      isReplicationRun:
        description: Specifies if this protection run is a replication run.
        type: boolean
        x-nullable: true
        x-order: 3
      originClusterIdentifier:
        description: Specifies the information of the primary cluster if this run
          is a replication run.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ClusterIdentifier'
      originProtectionGroupId:
        description: ProtectionGroupId to which this run belongs on the primary cluster
          if this run is a replication run.
        type: string
        x-nullable: true
        x-order: 5
      protectionGroupName:
        description: Name of the Protection Group to which this run belongs.
        type: string
        x-nullable: true
        x-order: 6
      isLocalSnapshotsDeleted:
        description: Specifies if snapshots for this run has been deleted.
        type: boolean
        x-nullable: true
        x-order: 7
      objects:
        description: Snapahot, replication, archival results for each object.
        type: array
        items:
          $ref: '#/definitions/ObjectRunResult'
        x-order: 8
      localBackupInfo:
        description: Summary information about local snapshot run across all objects.
        x-nullable: true
        x-order: 9
        $ref: '#/definitions/BackupRunSummary'
      originalBackupInfo:
        description: Summary information about snapshot run on the original cluster.
          This only applies to replication run.
        x-nullable: true
        x-order: 10
        $ref: '#/definitions/BackupRunSummary'
      replicationInfo:
        description: Summary information about replication run across all objects.
        x-nullable: true
        x-order: 11
        $ref: '#/definitions/ReplicationRunSummary'
      archivalInfo:
        description: Summary information about archival run.
        x-nullable: true
        x-order: 12
        $ref: '#/definitions/ArchivalRunSummary'
      cloudSpinInfo:
        description: Summary information about cloud spin run.
        x-nullable: true
        x-order: 13
        $ref: '#/definitions/CloudSpinRunSummary'
      onLegalHold:
        description: Specifies if the Protection Run is on legal hold.
        type: boolean
        x-nullable: true
        x-order: 14
      permissions:
        description: Specifies the list of tenants that have permissions for this
          protection group run.
        type: array
        items:
          $ref: '#/definitions/Tenant'
        x-nullable: true
        x-order: 15
      isCloudArchivalDirect:
        description: Specifies whether the run is a CAD run if cloud archive direct
          feature is enabled. If this field is true, the primary backup copy will
          only be available at the given archived location.
        type: boolean
        x-nullable: true
        x-order: 16
      hasLocalSnapshot:
        description: Specifies whether the run has a local snapshot. For cloud retrieved
          runs there may not be local snapshots.
        type: boolean
        x-nullable: true
        x-order: 17
      environment:
        description: Specifies the environment of the Protection Group.
        type: string
        x-cohesity-enum: protection_group_run_type
        x-nullable: true
        x-order: 18
  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
        x-nullable: true
        x-order: 0
      destinationDir:
        description: Specifies the destination directory where the file/directory
          was copied.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      isDirectory:
        description: Specifies whether this is a directory or not.
        type: boolean
        x-nullable: true
        x-order: 2
      status:
        description: Specifies the recovery status for this file or folder.
        type: string
        enum:
        - NotStarted
        - EstimationInProgress
        - EstimationDone
        - CopyInProgress
        - Finished
        x-nullable: true
        x-order: 3
        readOnly: true
      messages:
        description: Specify error messages about the file during recovery.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 4
        readOnly: true
  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
        format: int64
        x-nullable: true
        x-order: 1
      protectionGroupId:
        description: Specifies the protection group id of the object snapshot.
        type: string
        x-nullable: true
        x-order: 2
      protectionGroupName:
        description: Specifies the protection group name of the object snapshot.
        type: string
        x-nullable: true
        x-order: 3
      snapshotCreationTimeUsecs:
        description: Specifies the time when the snapshot is created in Unix timestamp
          epoch in microseconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
        readOnly: true
      objectInfo:
        description: Specifies the information about the object for which the snapshot
          is taken.
        allOf:
        - $ref: '#/definitions/ObjectSummary'
        - x-nullable: true
        x-nullable: true
        x-order: 5
        readOnly: true
      snapshotTargetType:
        description: Specifies the snapshot target type.
        type: string
        enum:
        - Local
        - Archival
        x-nullable: true
        x-order: 6
        readOnly: true
      storageDomainId:
        description: Specifies the ID of the Storage Domain where this snapshot is
          stored.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
        readOnly: true
      archivalTargetInfo:
        description: Specifies the archival target information if the snapshot is
          an archival snapshot.
        allOf:
        - $ref: '#/definitions/ArchivalTargetSummaryInfo'
        - x-nullable: true
        x-nullable: true
        x-order: 8
        readOnly: true
      progressTaskId:
        description: Progress monitor task id for Recovery of VM.
        type: string
        x-nullable: true
        x-order: 9
        readOnly: true
      recoverFromStandby:
        description: Specifies that user wants to perform standby restore if it is
          enabled for this object.
        type: boolean
        x-nullable: true
        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
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 11
        readOnly: true
      startTimeUsecs:
        description: Specifies the start time of the Recovery in Unix timestamp epoch
          in microseconds.
        type: integer
        format: int64
        x-nullable: true
        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
        format: int64
        x-nullable: true
        x-order: 13
        readOnly: true
      messages:
        description: Specify error messages about the object.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 14
        readOnly: true
  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: '#/definitions/RecoverOracleAppNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverOracleAppOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverSqlAppNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverSqlAppOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  CommonRecoveryRequestParams:
    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
        x-nullable: true
        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
  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
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the Recovery.
        type: string
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the start time of the Recovery in Unix timestamp epoch
          in microseconds.
        type: integer
        format: int64
        x-nullable: true
        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
        format: int64
        x-nullable: true
        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
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 4
      progressTaskId:
        description: Progress monitor task id for Recovery.
        type: string
        x-nullable: true
        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
        items:
          $ref: '#/definitions/Tenant'
        x-nullable: true
        x-order: 8
      creationInfo:
        description: Specifies the information about the creation of the recovery.
        type: object
        x-nullable: true
        x-order: 9
        $ref: '#/definitions/CreationInfo'
      canTearDown:
        description: Specifies whether it's possible to tear down the objects created
          by the recovery.
        type: boolean
        x-nullable: true
        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
        enum:
        - DestroyScheduled
        - Destroying
        - Destroyed
        - DestroyError
        x-nullable: true
        x-order: 11
      tearDownMessage:
        description: Specifies the error message about the tear down operation if
          it fails.
        type: string
        x-nullable: true
        x-order: 12
      messages:
        description: Specifies messages about the recovery.
        type: array
        items:
          type: string
        x-nullable: true
        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
        x-nullable: true
        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
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 15
    x-cohesity-discriminator-details:
      propertyName: snapshotEnvironment
  CommonRemoteStorageInfo:
    description: Specifies the details of common remote storage info.
    type: object
    title: Common Remote Storage Info
    required:
    - product
    properties:
      id:
        description: Specifies unique id of the registered remote storage.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
        readOnly: true
      product:
        description: Specifies the product type of the remote storage.
        type: string
        enum:
        - FlashBlade
        x-nullable: true
        x-order: 1
    x-cohesity-discriminator-details:
      propertyName: product
  CommonSearchIndexedObjectsRequestParams:
    description: Specifies the common params to search for indexed objects.
    type: object
    title: Common Search Indexed Objects Params
    required:
    - objectType
    properties:
      protectionGroupIds:
        description: Specifies a list of Protection Group ids to filter the indexed
          objects. If specified, the objects indexed by specified Protection Group
          ids will be returned.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      storageDomainIds:
        description: Specifies the Storage Domain ids to filter indexed objects for
          which Protection Groups are writing data to Cohesity Views on the specified
          Storage Domains.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      tenantId:
        description: TenantId contains id of the tenant for which objects are to be
          returned.
        type: string
        x-nullable: true
        x-order: 2
      includeTenants:
        description: If true, the response will include objects which belongs to all
          tenants which the current user has permission to see. Default value is false.
        type: boolean
        default: false
        x-nullable: true
        x-order: 3
      tags:
        description: '"This field is deprecated. Please use mightHaveTagIds."'
        type: array
        uniqueItems: true
        items:
          type: string
        x-nullable: true
        x-order: 4
      snapshotTags:
        description: '"This field is deprecated. Please use mightHaveSnapshotTagIds."'
        type: array
        items:
          type: string
        x-order: 5
      mustHaveTagIds:
        description: Specifies tags which must be all present in the document.
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 6
      mightHaveTagIds:
        description: 'Specifies list of tags, one or more of which might be present
          in the

          document. These are OR''ed together and the resulting criteria AND''ed

          with the rest of the query.'
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 7
      mustHaveSnapshotTagIds:
        description: Specifies snapshot tags which must be all present in the document.
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 8
      mightHaveSnapshotTagIds:
        description: 'Specifies list of snapshot tags, one or more of which might
          be

          present in the document. These are OR''ed together and the resulting

          criteria AND''ed with the rest of the query.'
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 9
      paginationCookie:
        description: Specifies the pagination cookie with which subsequent parts of
          the response can be fetched.
        type: string
        x-nullable: true
        x-order: 10
      count:
        description: Specifies the number of indexed objects to be fetched for the
          specified pagination cookie.
        type: integer
        format: int32
        x-nullable: true
        x-order: 11
      objectType:
        description: Specifies the object type to be searched for.
        type: string
        enum:
        - Emails
        - Files
        - CassandraObjects
        - CouchbaseObjects
        - HbaseObjects
        - HiveObjects
        - MongoObjects
        - HDFSObjects
        - ExchangeObjects
        - PublicFolders
        x-order: 12
  CommonSearchIndexedObjectsResponseParams:
    description: Specifies the common search indexed objects response params.
    type: object
    title: Common Search Indexed Objects Response Params.
    properties:
      objectType:
        description: Specifies the object type.
        type: string
        enum:
        - Emails
        - Files
        - CassandraObjects
        - CouchbaseObjects
        - HbaseObjects
        - HiveObjects
        - MongoObjects
        - HDFSObjects
        - ExchangeObjects
        - PublicFolders
        x-order: 0
      count:
        description: Specifies the total number of indexed objects that match the
          filter and search criteria. Use this value to determine how many additional
          requests are required to get the full result.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
      paginationCookie:
        description: Specifies cookie for resuming search if pagination is being used.
        type: string
        x-nullable: true
        x-order: 2
  CommonSourceRegistrationParams:
    description: Specifies common parameters to register a source.
    title: Register source common request parameters.
    allOf:
    - $ref: '#/definitions/Credentials'
    - type: object
      required:
      - endpoint
      properties:
        endpoint:
          description: Specifies the endpoint IPaddress, URL or hostname of the host.
          type: string
          x-order: 0
        description:
          description: Specifies the description of the source being registered.
          type: string
          x-nullable: true
          x-order: 1
  CommonSourceRegistrationReponseParams:
    description: Specifies the parameters which are common between all Protection
      Source registrations.
    type: object
    properties:
      id:
        description: Source Registration ID. This can be used to retrieve, edit or
          delete the source registration.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
        readOnly: true
      sourceId:
        description: ID of top level source object discovered after the registration.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
        readOnly: true
      sourceInfo:
        description: Specifies detailed info about the source.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/Object'
      environment:
        description: Specifies the environment type of the Protection Source.
        type: string
        enum:
        - kVMware
        - kHyperV
        - kAcropolis
        - kKVM
        - kAWS
        - kGCP
        - kAzure
        - kPhysical
        - kPure
        - kNimble
        - kNetapp
        - kGenericNas
        - kIsilon
        - kFlashBlade
        - kGPFS
        - kElastifile
        - kO365
        - kHyperFlex
        - kKubernetes
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        x-nullable: true
        x-order: 3
      connectionId:
        description: Specifies the id of the connection from where this source is
          reachable. This should only be set for a source being registered by a tenant
          user.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
    x-cohesity-discriminator-details:
      propertyName: environment
  CommonSourceRegistrationRequestParams:
    description: Specifies the parameters which are common between all Protection
      Source registrations.
    type: object
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Protection Source.
        type: string
        enum:
        - kVMware
        - kHyperV
        - kAcropolis
        - kKVM
        - kAWS
        - kGCP
        - kAzure
        - kPhysical
        - kPure
        - kNimble
        - kNetapp
        - kGenericNas
        - kIsilon
        - kFlashBlade
        - kGPFS
        - kElastifile
        - kO365
        - kHyperFlex
        - kKubernetes
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        x-nullable: true
        x-order: 0
      isInternalEncrypted:
        description: Specifies if credentials are encrypted by internal key.
        type: boolean
        x-nullable: true
        x-order: 1
      encryptionKey:
        description: Specifies the key that user has encrypted the credential with.
        type: string
        x-nullable: true
        x-order: 2
      connectionId:
        description: Specifies the id of the connection from where this source is
          reachable. This should only be set for a source being registered by a tenant
          user.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
    x-cohesity-discriminator-details:
      propertyName: environment
  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
        format: int64
        x-nullable: true
        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
        items:
          $ref: '#/definitions/FilenamePatternToDirectory'
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 3
      overwritingPolicy:
        description: Specifies a policy to be used while recovering existing databases.
        type: string
        enum:
        - FailIfExists
        - Overwrite
        x-nullable: true
        x-order: 4
      multiStageRestoreOptions:
        description: Specifies the parameters related to multi stage Sql restore.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/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
        x-nullable: true
        x-order: 6
  CommonStandbyResourceParams:
    description: Specifies the params for standby resource.
    type: object
    title: Standby resoure Params.
    properties:
      recoveryPointObjectiveSecs:
        description: Specifies the recovery point objective time user expects for
          this standby resource.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
  CommonTargetConfiguration:
    description: Specifies common parameters required while setting up additional
      protection target configuration.
    type: object
    title: Common Target Configuration.
    required:
    - schedule
    - retention
    properties:
      schedule:
        description: Specifies the Id for a backup copy policy. This is generated
          when the policy is created
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/TargetSchedule'
      retention:
        description: Specifies the Retention period of backup in days, months or years
          to retain copied Snapshots on the target.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Retention'
      copyOnRunSuccess:
        description: Specifies if Snapshots are copied from the first completely successful
          Protection Group Run or the first partially successful Protection Group
          Run occurring at the start of the replication schedule. <br> If true, Snapshots
          are copied from the first Protection Group Run occurring at the start of
          the replication schedule that was completely successful i.e. Snapshots for
          all the Objects in the Protection Group were successfully captured. <br>
          If false, Snapshots are copied from the first Protection Group Run occurring
          at the start of the replication schedule, even if first Protection Group
          Run was not completely successful i.e. Snapshots were not captured for all
          Objects in the Protection Group.
        type: boolean
        x-nullable: true
        x-order: 2
      configId:
        description: Specifies the unique identifier for the target getting added.
          This field need to be passed only when policies are being updated.
        type: string
        x-nullable: true
        x-order: 3
  CommonTdmCloneSnapshotParams:
    description: Specifies the common properties of a clone snapshot.
    type: object
    properties:
      label:
        description: Specifies the label for the snapshot.
        type: string
        x-nullable: true
        x-order: 0
  CommonTdmCloneTaskParams:
    description: Specifies the common params for a TDM clone task.
    type: object
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment of the TDM Clone task.
        type: string
        enum:
        - kSQL
        - kOracle
        x-nullable: true
        x-order: 0
      protectionGroupId:
        description: Specifies the ID of an existing protection group, which should
          start protecting this clone. Specifying this implies that the clone is eligible
          for automated snapshots based on the policy configuration. If this is specified,
          policyId should also be specified and protectionGroupName should not be
          specified.
        type: string
        x-nullable: true
        x-order: 1
      protectionGroupName:
        description: Specifies the name of a new protection group, which should be
          created to protect this clone. Specifying this implies that the clone is
          eligible for automated snapshots based on the policy configuration. If this
          is specified, policyId should also be specified and protectionGroupId should
          not be specified.
        type: string
        x-nullable: true
        x-order: 2
      policyId:
        description: Specifies the ID of the policy, which should be used to protect
          this clone. This is useful for automatic snapshots. This must be specified
          if either of protectionGroupId and protectionGroupName is specified.
        type: string
        x-nullable: true
        x-order: 3
  CommonTdmCloneTaskRequestParams:
    description: Specifies the common request params for a TDM clone task.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmCloneTaskParams'
    - type: object
      required:
      - snapshotId
      - targetHostId
      properties:
        snapshotId:
          description: Specifies the snapshot ID, from which the clone is to be created.
          type: string
          x-nullable: true
          x-order: 0
        targetHostId:
          description: Specifies the ID of the host, where the clone needs to be created.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
        pointInTimeUsecs:
          description: Specifies the timestamp (in usecs from epoch) for creating
            the clone at a point in time in the past.
          type: integer
          format: int64
          x-nullable: true
          x-order: 2
  CommonTdmCloneTaskResponseParams:
    description: Specifies the common response params for a TDM clone task.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmCloneTaskParams'
    - type: object
      properties:
        snapshot:
          description: Specifies the details of the snapshot used for cloning.
          allOf:
          - $ref: '#/definitions/ObjectSnapshot'
          x-nullable: true
          x-order: 0
        parent:
          description: Specifies the details of the parent object of the clone.
          allOf:
          - $ref: '#/definitions/ObjectSummary'
          x-nullable: true
          x-order: 1
        target:
          description: Specifies the details of the target, where the clone is created.
          allOf:
          - $ref: '#/definitions/ObjectSummary'
          x-nullable: true
          x-order: 2
        view:
          description: Specifies the details of the view, which is used for the clone.
          allOf:
          - $ref: '#/definitions/ViewParams'
          x-nullable: true
          x-order: 3
  CommonTdmObjectResponseParams:
    description: Specifies the common parameters for a TDM object response.
    type: object
    required:
    - id
    - environment
    properties:
      id:
        description: Specifies the unique ID of the object.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
      status:
        description: Specifies the current status of the object.
        type: string
        enum:
        - scheduled
        - inProgress
        - succeeded
        - failed
        - canceled
        x-nullable: true
        x-order: 2
      environment:
        description: Specifies the environment of the object.
        type: string
        enum:
        - kSQL
        - kOracle
        x-nullable: true
        x-order: 3
      createdByUser:
        description: Specifies the user, who created the object.
        allOf:
        - $ref: '#/definitions/User'
        x-order: 4
      lastAction:
        description: Specifies the details of the last action performed on this object.
        allOf:
        - $ref: '#/definitions/TdmObjectTimelineEvent'
        x-order: 5
      sizeBytes:
        description: Specifies the size (in bytes) of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      parent:
        description: Specifies the parent of the object.
        allOf:
        - $ref: '#/definitions/ObjectSummary'
        x-order: 7
    x-cohesity-discriminator-details:
      propertyName: environment
  CommonTdmObjectTimelineEventsResponseParams:
    description: Specifies the common parameters for the TDM object timeline events
      response.
    type: object
    required:
    - id
    - action
    properties:
      id:
        description: Specifies the unique ID of the event.
        type: string
        x-nullable: true
        x-order: 0
      createdAt:
        description: Specifies the time (in usecs from epoch) at which the event was
          created.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      createdByUser:
        description: Specifies the user, who triggered the event.
        allOf:
        - $ref: '#/definitions/User'
        x-nullable: true
        x-order: 2
      status:
        description: Specifies the current status of the event.
        type: string
        enum:
        - scheduled
        - inProgress
        - succeeded
        - failed
        - canceled
        x-nullable: true
        x-order: 3
      errorMessage:
        description: Specifies the error message if the event is in failed state.
        type: string
        x-nullable: true
        x-order: 4
      description:
        description: Specifies the description of the event, as provided by the user.
        type: string
        x-nullable: true
        x-order: 5
      eventGroupId:
        description: Specifies the ID of the group this event belongs to. Events with
          same group ID are considered to be a single timeline for the TDM object.
          Different group IDs mean different timelines for the TDM object.
        type: string
        x-nullable: true
        x-order: 6
      action:
        description: Specifies the action for the event.
        type: string
        enum:
        - clone
        - teardown
        - refresh
        - snapshot
        - rewind
        x-nullable: true
        x-order: 7
    x-cohesity-discriminator-details:
      propertyName: action
  CommonTdmRefreshTaskResponseParams:
    description: Specifies the common response params for a TDM refresh task.
    type: object
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment of the TDM refresh task.
        type: string
        enum:
        - kOracle
        x-nullable: true
        x-order: 0
      parent:
        description: Specifies the details of the parent object of the clone.
        allOf:
        - $ref: '#/definitions/ObjectSummary'
        x-nullable: true
        x-order: 1
      target:
        description: Specifies the details of the target, where the clone is created.
        allOf:
        - $ref: '#/definitions/ObjectSummary'
        x-nullable: true
        x-order: 2
      snapshot:
        description: Specifies the details of the snapshot used for refresh.
        allOf:
        - $ref: '#/definitions/ObjectSnapshot'
        x-nullable: true
        x-order: 3
      view:
        description: Specifies the details of the view, which is used for the clone.
        allOf:
        - $ref: '#/definitions/ViewParams'
        x-nullable: true
        x-order: 4
    x-cohesity-discriminator-details:
      propertyName: environment
  CommonTdmTaskRequestParams:
    description: Specifies the common parameters used in TDM Task Creation.
    type: object
    required:
    - action
    properties:
      name:
        description: Specifies the name of the task.
        type: string
        x-nullable: true
        x-order: 0
      action:
        description: Specifies the TDM Task action.
        type: string
        enum:
        - clone
        - teardown
        - refresh
        - snapshot
        - rewind
        x-nullable: true
        x-order: 1
    x-cohesity-discriminator-details:
      propertyName: action
  CommonTdmTaskResponseParams:
    description: Specifies the common parameters for a TDM task response.
    type: object
    required:
    - id
    - action
    properties:
      id:
        description: Specifies the unique ID of the task.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the task.
        type: string
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the time (in usecs from epoch) when the task was started.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      endTimeUsecs:
        description: Specifies the time (in usecs from epoch) when the task was completed.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      status:
        description: Specifies the current status of the task.
        type: string
        enum:
        - scheduled
        - inProgress
        - succeeded
        - failed
        - canceled
        x-nullable: true
        x-order: 4
      action:
        description: Specifies the TDM Task action.
        type: string
        enum:
        - clone
        - teardown
        - refresh
        - snapshot
        - rewind
        x-nullable: true
        x-order: 5
      createdByUser:
        description: Specifies the user, who created this task.
        allOf:
        - $ref: '#/definitions/User'
        x-order: 6
      progressTaskId:
        description: Specifies the ID for tracking progress of this task.
        type: string
        x-nullable: true
        x-order: 7
    x-cohesity-discriminator-details:
      propertyName: action
  CommonTieringPolicy:
    description: Specifies the common tiering params between uptiering and downtiering.
    type: object
    properties:
      enableAuditLogging:
        description: Specifies whether to audit log the file tiering activity.
        type: boolean
        default: false
        x-nullable: true
        x-order: 0
      fileSize:
        x-order: 1
        $ref: '#/definitions/FileSizePolicy'
      filePath:
        x-order: 2
        $ref: '#/definitions/FileFilteringPolicy'
  CommonVmwareObjectParams:
    description: Specifies the common object parameters required for VMware protection.
    type: object
    properties:
      excludeDisks:
        description: Specifies a list of disks to exclude from being protected. This
          is only applicable to VM objects.
        type: array
        items:
          $ref: '#/definitions/DiskInfo'
        x-order: 0
      truncateExchangeLogs:
        description: Specifies whether or not to truncate MS Exchange logs while taking
          an app consistent snapshot of this object. This is only applicable to objects
          which have a registered MS Exchange app.
        type: boolean
        x-nullable: true
        x-order: 1
  CommonVmwareProtectionParams:
    description: Specifies the common parameters which are specific to VMware related
      protection.
    type: object
    properties:
      appConsistentSnapshot:
        description: Specifies whether or not to quiesce apps and the file system
          in order to take app consistent snapshots.
        type: boolean
        x-nullable: true
        x-order: 0
      fallbackToCrashConsistentSnapshot:
        description: Specifies whether or not to fallback to a crash consistent snapshot
          in the event that an app consistent snapshot fails. This parameter defaults
          to true and only changes the behavior of the operation if 'appConsistentSnapshot'
          is set to 'true'.
        type: boolean
        x-nullable: true
        x-order: 1
      skipPhysicalRDMDisks:
        description: Specifies whether or not to skip backing up physical RDM disks.
          Physical RDM disks cannot be backed up, so if you attempt to backup a VM
          with physical RDM disks and this value is set to 'false', then those VM
          backups will fail.
        type: boolean
        x-nullable: true
        x-order: 2
      indexingPolicy:
        description: Specifies the indexing policy for VMs in this group.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/IndexingPolicy'
      prePostScript:
        description: Specifies the pre and post script parameters associated with
          a given backup.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/PrePostScriptParams'
      leverageSanTransport:
        description: If this field is set to true, then the backup for the objects
          will be performed using dedicated storage area network (SAN) instead of
          LAN or managment network.
        type: boolean
        x-nullable: true
        x-order: 5
      enableNBDSSLFallback:
        description: If this field is set to true and SAN transport backup fails,
          then backup will fallback to use NBDSSL transport. This field only applies
          if 'leverageSanTransport' is set to true.
        type: boolean
        x-nullable: true
        x-order: 6
  ConnectionSubnet:
    description: Specify the subnet used in connection.
    type: object
    title: Connection Subnet.
    properties:
      ip:
        description: Specifies the IP address part of the CIDR notation.
        type: string
        x-nullable: true
        x-order: 0
      maskBits:
        description: Specifies the number of set bits in the subnet mask.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
  ConnectorConnectionInfo:
    description: Specifies the connection info of a connector.
    type: object
    title: Connection Info.
    properties:
      isActive:
        description: Specifies whether the connector is currently connected to cohesity
          server.
        type: boolean
        x-nullable: true
        x-order: 0
      message:
        description: Specifies possible error message when the connector is not able
          to connect.
        type: string
        x-nullable: true
        x-order: 1
      lastConnectedTimestampMsecs:
        description: Specifies last timestamp for which connection status was known.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  ConnectorType:
    description: connector type.
    type: object
    title: Connector Type.
    properties:
      type:
        description: connector type.
        type: string
        x-cohesity-enum: connector_type
        x-order: 0
  ConstructMetaInfoParams:
    description: Params to construct meta info
    type: object
    title: ConstructMetaInfoParams
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Protection group
        type: string
        enum:
        - kOracle
        x-nullable: true
        x-order: 0
      oracleParams:
        description: Oracle Params to construct meta info for alternate restore or
          clone.
        allOf:
        - $ref: '#/definitions/ConstructRestoreMetaInfoOracleParams'
        - x-nullable: true
        x-order: 1
  ConstructMetaInfoResult:
    description: Result to store meta-info from an object snapshot and additional
      information.
    type: object
    title: ConstructMetaInfoResult
    properties:
      environment:
        description: Specifies the environment type of the Protection group
        type: string
        enum:
        - kOracle
        x-nullable: true
        x-order: 0
      oracleParams:
        description: Specifies 3 Maps required to fill pfile text box.
        allOf:
        - $ref: '#/definitions/OracleRestoreMetaInfoResult'
        - x-nullable: true
        x-order: 1
  ConstructRestoreMetaInfoOracleParams:
    description: Params to fetch oracle restore meta info
    type: object
    title: ConstructRestoreMetaInfoOracleParams
    required:
    - dbName
    - baseDir
    - homeDir
    - isClone
    properties:
      dbName:
        description: Specifies the name of the Oracle database that we restore to.
        type: string
        x-nullable: true
        x-order: 0
      baseDir:
        description: Specifies the base directory of Oracle at destination.
        type: string
        x-nullable: true
        x-order: 1
      homeDir:
        description: Specifies the home directory of Oracle at destination.
        type: string
        x-nullable: true
        x-order: 2
      dbFileDestination:
        description: Specifies the location to put the database files(datafiles, logfiles
          etc.)
        type: string
        x-nullable: true
        x-order: 3
      isClone:
        description: Specifies whether operation is clone or not
        type: boolean
        x-nullable: true
        x-order: 4
      isGranularRestore:
        description: Specifies whether the operation is granular restore or not.
        type: boolean
        x-nullable: true
        x-order: 5
  ContainerDatabaseInfo:
    description: Object details about Oracle container database.
    type: object
    properties:
      pluggableDatabaseList:
        description: Specifies the list of Pluggable databases within a container
          database.
        type: array
        items:
          $ref: '#/definitions/PluggableDatabaseInfo'
        x-nullable: true
        x-order: 0
  ContinuousSnapshotParams:
    description: Specifies the source snapshots to be taken even if there is a pending
      run in a protection group.
    type: object
    title: Continuous Snapshot Params
    required:
    - isEnabled
    properties:
      isEnabled:
        description: Specifies whether source snapshots should be taken even if there
          is a pending run.
        type: boolean
        x-nullable: true
        x-order: 0
      maxAllowedSnapshots:
        description: Specifies the maximum number of source snapshots allowed for
          a given object in a protection group. This is only applicable if isContinuousSnapshottingEnabled
          is set to true.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
  CouchbaseIndexedObject:
    description: Specifies a Couchbase indexed object.
    title: CouchbaseIndexedObject
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        type:
          description: Specifies the Couchbase Object Type. For Couchbase this is
            alywas set to Bucket.
          type: string
          enum:
          - CouchbaseBuckets
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the id of the indexed object.
          type: string
          x-nullable: true
          x-order: 1
  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
        allOf:
        - $ref: '#/definitions/RecoverCouchbaseParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RecoverCouchbaseParams'
  CouchbaseSourceRegistrationParams:
    description: Specifies parameters to register Couchbase source.
    title: Register Couchbase source request parameters.
    allOf:
    - $ref: '#/definitions/Credentials'
    - type: object
      required:
      - seeds
      - isSslRequired
      - httpPort
      - carrierPort
      properties:
        seeds:
          description: Specifies the IP Addresses or hostnames of the Couchbase cluster
            seed nodes.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            type: string
          x-order: 0
        isSslRequired:
          description: Set to true if connection to couchbase has to be using SSL.
          type: boolean
          x-nullable: true
          x-order: 1
        httpPort:
          description: HTTP direct or HTTP SSL port.
          type: integer
          format: int32
          x-nullable: true
          x-order: 2
        carrierPort:
          description: Carrier direct or Carrier SSL port.
          type: integer
          format: int32
          x-nullable: true
          x-order: 3
  CreateActiveDirectoryRequest:
    description: Specifies the request to create an Active Directory.
    type: object
    allOf:
    - $ref: '#/definitions/CommonActiveDirectoryParams'
    - type: object
      required:
      - domainName
      - activeDirectoryAdminParams
      properties:
        domainName:
          description: Specifies the domain name of the Active Directory.
          type: string
          pattern: ^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$
          x-nullable: true
          x-order: 0
        activeDirectoryAdminParams:
          description: Specifies the params of a user with administrative privilege
            of this Active Directory.
          type: object
          allOf:
          - $ref: '#/definitions/ActiveDirectoryAdminParams'
          - x-nullable: true
          x-nullable: true
          x-order: 1
        overwriteMachineAccounts:
          description: Specifies if specified machine accounts should overwrite existing
            machine accounts.
          type: boolean
          x-nullable: true
          x-order: 2
  CreateClientcsrResponseBody:
    description: Specifies the response to creating the CSRs.
    title: Create CSR response
    properties:
      publicKeyServer:
        description: Specifies the public key generated for this CSR for the server.
        type: string
        x-nullable: true
        x-order: 0
      csrServer:
        description: Specifies the CSR generated for the server.
        type: string
        x-nullable: true
        x-order: 1
      publicKeyClient:
        description: Specifies the public key generated for this CSR for the client.
        type: string
        x-nullable: true
        x-order: 2
      csrClient:
        description: Specifies the CSR generated for the client.
        type: string
        x-nullable: true
        x-order: 3
      fileCsrServer:
        description: Specifies the path to CSR generated for the server
        type: string
        x-nullable: true
        x-order: 4
      fileCsrClient:
        description: Specifies the path to CSR generated for the client
        type: string
        x-nullable: true
        x-order: 5
  CreateClusterParams:
    description: Specifies the parameters required to create cluster.
    type: object
    title: Create Cluster Request Parameters.
    required:
    - name
    - type
    - enableEncryption
    - networkConfig
    properties:
      name:
        description: Specifies the name of the new cluster.
        type: string
        x-nullable: true
        x-order: 0
      type:
        description: Specifies the type of the new cluster.
        type: string
        enum:
        - Physical
        - Virtual
        - Cloud
        - Rigel
        - Unknown
        x-nullable: true
        x-order: 1
      enableEncryption:
        description: Specifies whether or not to enable encryption. If encryption
          is enabled, all data on the Cluster will be encrypted. This can only be
          enabled at Cluster creation time and cannot be disabled later.
        type: boolean
        x-nullable: true
        x-order: 2
      networkConfig:
        description: Specifies all of the parameters needed for network configuration
          of the new Cluster.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/ClusterCreateNetworkConfig'
      proxyServerConfig:
        description: Specifies the proxy to use for external HTTP traffic.
        x-order: 4
        $ref: '#/definitions/ClusterProxyServerConfig'
      physicalClusterParams:
        description: Specifies the parameters which are specific to creation of physical
          cluster. It is required if clusterType is Physical.
        x-order: 5
        $ref: '#/definitions/ClusterCreatePhysicalParams'
      virtualClusterParams:
        description: Specifies the parameters which are specific to creation of virtual
          cluster. It is required if clusterType is Virtual.
        x-order: 6
        $ref: '#/definitions/ClusterCreateVirtualParams'
      cloudClusterParams:
        description: Specifies the parameters which are specific to creation of cloud
          cluster. It is required if clusterType is Cloud.
        x-order: 7
        $ref: '#/definitions/ClusterCreateCloudParams'
      rigelClusterParams:
        description: Specifies the parameters which are specific to creation of rigel
          cluster. It is required if clusterType is Rigel.
        x-order: 8
        $ref: '#/definitions/ClusterCreateRigelParams'
  CreateCsrRequest:
    description: Specifies the request to create a CSR.
    title: Create CSR Request.
    allOf:
    - $ref: '#/definitions/CommonCsrRequestParams'
  CreateCsrResponseBody:
    description: Specifies the response to create a CSR.
    title: Create CSR response
    allOf:
    - $ref: '#/definitions/CommonCsrResponseParams'
  CreateKeystoneRequest:
    description: Specifies the parameters to create a Keystone configuration.
    type: object
    allOf:
    - $ref: '#/definitions/Keystone'
  CreateMcmClaimRequest:
    description: Specifies the request params to claim an entity to Helios.
    type: object
    title: Request params to claim an entity to Helios.
    required:
    - entityType
    properties:
      entityType:
        description: Specfies the type of entity.
        type: string
        enum:
        - Rigel
        - Cluster
        x-order: 0
      rigelParams:
        description: Specifies the request params to claim Rigel to Helios.
        x-order: 1
        $ref: '#/definitions/McmRigelClaimRequestParams'
      clusterParams:
        description: Specifies the request params to claim cluster to Helios.
        x-order: 2
        $ref: '#/definitions/McmClusterClaimRequestParams'
  CreateMcmClaimResponseBody:
    description: Specifies the response of claiming an entity to Helios.
    type: object
    title: Response of claiming an entity to Helios.
    properties:
      entityType:
        description: Specfies the type of entity.
        type: string
        enum:
        - Rigel
        - Cluster
        x-nullable: true
        x-order: 0
      rigelParams:
        description: Specifies the response of Rigel claim to Helios.
        type: object
        x-order: 1
        $ref: '#/definitions/McmRigelClaimResponseParams'
      clusterParams:
        description: Specifies the response of cluster claim to Helios.
        type: object
        x-order: 2
        $ref: '#/definitions/McmClusterClaimResponseParams'
  CreateOrUpdateBifrostConnectionRequest:
    description: Specify the params to create or update a connection of Bifrost.
    type: object
    title: Create Or Update Bifrost Connection Request.
    required:
    - tenantId
    - subnet
    properties:
      tenantId:
        description: Specifies the id of the tenant which the connection belongs to.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the connection.
        type: string
        x-nullable: true
        x-order: 1
      subnet:
        description: Specifies the connection subnet.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/ConnectionSubnet'
      certificateVersion:
        description: Specifies the version of the connection's certificate. The version
          is used to revoke/renew connection's certificates.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  CreateOrUpdateBifrostConnectorRequest:
    description: Specify the params to create or update a Bifrost connector.
    type: object
    title: Create Or Update Bifrost connector Request.
    required:
    - connectionId
    - tenantId
    - name
    properties:
      connectionId:
        description: Specifies the Id of the connection which this connector belongs
          to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      tenantId:
        description: Specifies the id of the tenant which the connector belongs to.
        type: string
        x-nullable: true
        x-order: 1
      name:
        description: Specifies the name of the connector.
        type: string
        x-nullable: true
        x-order: 2
  CreateOrUpdateDataTieringTaskRequest:
    description: Specifies the request to create or update a data tiering task.
    title: Create Or Update data tiering task Request.
    allOf:
    - $ref: '#/definitions/CommonDataTieringTaskParams'
    - type: object
      properties:
        downtieringPolicy:
          description: Specifies downtiering policy for Data Tiering
          type: object
          x-cohesity-discriminator-value: Downtier
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/DowntieringPolicy'
        uptieringPolicy:
          description: Specifies uptiering policy for Data Tiering
          type: object
          x-cohesity-discriminator-value: Uptier
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/UptieringPolicy'
  CreateOrUpdateProtectionGroupRequest:
    description: Specifies the request to create or update a Protection Group.
    title: Create Or Update Protection Group Request.
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareProtectionGroupParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/AcropolisProtectionGroupParams'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/KubernetesProtectionGroupParams'
        mssqlParams:
          description: Specifies the parameters specific to MSSQL Protection Group.
          type: object
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/MSSQLProtectionGroupParams'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle Protection
            Group.
          type: object
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/OracleProtectionGroupParams'
        viewParams:
          description: Specifies the parameters which are specific to View related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kView
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ViewProtectionGroupParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/PureProtectionGroupParams'
        nimbleParams:
          description: Specifies the parameters which are specific to Nimble related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNimble
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/NimbleProtectionGroupParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/HyperVProtectionGroupParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/AwsProtectionGroupParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/AzureProtectionGroupParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/GcpProtectionGroupParams'
        kvmParams:
          description: Specifies the parameters which are specific to Kvm related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/KvmProtectionGroupParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/PhysicalProtectionGroupParams'
        adParams:
          description: Specifies the parameters which are specific to Active Directory
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAD
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/ADProtectionGroupParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/Office365ProtectionGroupParams'
        netappParams:
          description: Specifies the parameters which are specific to NetApp related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/NetappProtectionGroupParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic Nas
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/GenericNasProtectionGroupParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/IsilonProtectionGroupParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to Flashblade related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/FlashbladeProtectionGroupParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/GpfsProtectionGroupParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Protection
            Groups
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/ElastifileProtectionGroupParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/CassandraProtectionGroupParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/MongoDBProtectionGroupParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/HdfsProtectionGroupParams'
        hbaseParams:
          description: Specifies the parameters which are specific to HBase Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 27
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        remoteAdapterParams:
          description: Specifies the parameters which are specific to Remote Adapter
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kRemoteAdapter
          x-nullable: true
          x-order: 28
          $ref: '#/definitions/RemoteAdapterProtectionGroupParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchangee related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 29
          $ref: '#/definitions/ExchangeProtectionGroupParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 30
          $ref: '#/definitions/UdaProtectionGroupParams'
  CreateProtectedObjectsRequest:
    description: Specifies the request for creating an object backup.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the list of objects to be protected. Multiple objects
            from different adapters can be provided as input.
          type: array
          items:
            $ref: '#/definitions/EnvSpecificObjectProtectionRequestParams'
          x-nullable: true
          x-order: 0
    - $ref: '#/definitions/CommonObjectProtectParams'
  CreateProtectedObjectsResponse:
    description: Specifies the protected objects response.
    type: object
    properties:
      protectedObjects:
        description: Specifies the list of protected objects.
        type: array
        items:
          $ref: '#/definitions/ObjectProtectionSummary'
        x-nullable: true
        x-order: 0
  CreateProtectionGroupRunRequest:
    description: Specifies the request to create a protection run. On success, the
      system will accept the request and return the Protection Group id for which
      the run is supposed to start. The actual run may start at a later time if the
      system is busy. Consumers must query the Protection Group to see the run.
    type: object
    required:
    - runType
    properties:
      runType:
        description: Type of protection run. 'kRegular' indicates an incremental (CBT)
          backup. Incremental backups utilizing CBT (if supported) are captured of
          the target protection objects. The first run of a kRegular schedule captures
          all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup
          (all blocks) of the target protection objects are always captured and Change
          Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup.
          Capture the database transaction logs to allow rolling back to a specific
          point in time. 'kSystem' indicates system volume backup. It produces an
          image for bare metal recovery.
        type: string
        enum:
        - kRegular
        - kFull
        - kLog
        - kSystem
        - kHydrateCDP
        x-nullable: true
        x-order: 0
      objects:
        description: Specifies the list of objects to be protected by this Protection
          Group run. These can be leaf objects or non-leaf objects in the protection
          hierarchy. This must be specified only if a subset of objects from the Protection
          Groups needs to be protected.
        type: array
        items:
          x-nullable: true
          $ref: '#/definitions/RunObject'
        x-order: 1
      targetsConfig:
        description: Specifies the remote, archival or cloudSpin targets where the
          snapshot is backed up.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/RunTargetsConfiguration'
  CreateProtectionGroupRunResponseBody:
    description: Specifies the response for create a protection run. On success, the
      system will accept the request and return the Protection Group id for which
      the run is supposed to start. The actual run may start at a later time if the
      system is busy. Consumers must query the Protection Group to see the run.
    type: object
    title: Create protection run response.
    properties:
      protectionGroupId:
        description: Specifies id of the Protection Group which must be polled for
          seeing the new run.
        type: string
        x-nullable: true
        x-order: 0
  CreateRecoveryRequest:
    description: Specifies the request parameters to create a Recovery.
    title: Create Recovery request params.
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverVmwareParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/RecoverVmwareParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAwsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/RecoverAwsParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGcpParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/RecoverGcpParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAzureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/RecoverAzureParams'
        kvmParams:
          description: Specifies the parameters which are specific to KVM related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKvmParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/RecoverKvmParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAcropolisParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/RecoverAcropolisParams'
        mssqlParams:
          description: Specifies the parameters which are specific to MsSQL related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverSqlParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/RecoverSqlParams'
        netappParams:
          description: Specifies the parameters which are specific to Netapp related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverNetappParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/RecoverNetappParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic NAS
            related Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGenericNasParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/RecoverGenericNasParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverIsilonParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/RecoverIsilonParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to FlashBlade related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverFlashbladeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/RecoverFlashbladeParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverElastifileParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/RecoverElastifileParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGpfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/RecoverGpfsParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPhysicalParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/RecoverPhysicalParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverHyperVParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/RecoverHyperVParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchange related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverExchangeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/RecoverExchangeParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CassandraParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/CassandraParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/UdaParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/UdaParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CouchbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/CouchbaseParams'
        hbaseParams:
          description: Specifies the parameters which are specific to Hbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHbase
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/HbaseParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HdfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/HdfsParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HiveParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/HiveParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/MongodbParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/MongodbParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/RecoverPureParams'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKubernetesParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/RecoverKubernetesParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverO365Params'
          - x-nullable: true
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/RecoverO365Params'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverOracleParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/RecoverOracleParams'
  CreateRemoteDiskStatus:
    description: Specifies the status of creating remote disk.
    type: object
    properties:
      mountPath:
        description: Specifies the NFS mount path of the remote disk.
        type: string
        x-nullable: true
        x-order: 0
      nodeId:
        description: Specifies the node id of the disk. If not specified, the disk
          will be evenly distributed across all the nodes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      tier:
        description: Specifies the tier of the disk
        type: string
        enum:
        - PCIeSSD
        - SATA-SSD
        - SATA-HDD
        - CLOUD
        x-nullable: true
        x-order: 2
      status:
        description: Specifies the creating status of this disk.
        type: string
        enum:
        - Succeeded
        - Failed
        x-nullable: true
        x-order: 3
      message:
        description: Specifies the error message when creating remote disk fails.
        type: string
        x-nullable: true
        x-order: 4
  CreateRigelConnectionRequest:
    description: Specify the params to create a connection of Rigel.
    type: object
    title: Create Rigel Connection Request.
    allOf:
    - $ref: '#/definitions/CommonCreateOrUpdateRigelConnectionRequest'
    - type: object
      required:
      - connectionId
      properties:
        connectionId:
          description: Specifies the id of the connection.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
  CreateRigelConnectorRequest:
    description: Specify the params to create a Rigel connector.
    type: object
    title: Create Rigel connector Request.
    allOf:
    - $ref: '#/definitions/CommonCreateOrUpdateRigelConnectorRequest'
    - type: object
      required:
      - connectorId
      properties:
        connectorId:
          description: Specifies the Id of the connector.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
  CreateTdmTaskRequest:
    description: Specifies the request parameters to create a TDM task.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmTaskRequestParams'
    - type: object
      properties:
        cloneParams:
          x-cohesity-discriminator-value: clone
          x-order: 0
          $ref: '#/definitions/TdmCloneTaskRequestParams'
        snapshotParams:
          x-cohesity-discriminator-value: snapshot
          x-order: 1
          $ref: '#/definitions/TdmSnapshotTaskParams'
        refreshParams:
          x-cohesity-discriminator-value: refresh
          x-order: 2
          $ref: '#/definitions/TdmRefreshTaskRequestParams'
        teardownParams:
          x-cohesity-discriminator-value: teardown
          x-order: 3
          $ref: '#/definitions/TdmTeardownTaskRequestParams'
  CreateUserSessionRequestParams:
    description: Specifies user session request parameters
    type: object
    properties:
      username:
        description: Specifies the login name of the Cohesity user
        type: string
        x-nullable: true
        x-order: 0
      password:
        description: Specifies the password of the Cohesity user
        type: string
        x-nullable: true
        x-order: 1
      domain:
        description: Specifies the domain the user is logging in to. For a local user
          the domain is LOCAL. For LDAP/AD user, the domain will map to a LDAP connection
          string. A user is uniquely identified by a combination of username and domain.
          LOCAL is the default domain.
        type: string
        x-nullable: true
        x-order: 2
      certificate:
        description: Specifies the certificate for cert based authentication.
        type: string
        x-nullable: true
        x-order: 3
      privateKey:
        description: Specifies the private key for cert based authentication.
        type: string
        x-nullable: true
        x-order: 4
  CreateView:
    description: Specifies the information required for creating a new View w/o required
      fields.
    type: object
    title: Create View.
    allOf:
    - type: object
      properties:
        storageDomainId:
          description: 'Specifies the id of the Storage Domain (View Box) where the
            View will be

            created.'
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        caseInsensitiveNamesEnabled:
          description: 'Specifies whether to support case insensitive file/folder
            names. This

            parameter can only be set during create and cannot be changed.'
          type: boolean
          x-nullable: true
          x-order: 1
        objectServicesMappingConfig:
          description: 'Specifies the Object Services key mapping config of the view.
            This parameter can only

            be set during create and cannot be changed.

            Configuration of Object Services key mapping.

            Specifies the type of Object Services key mapping config.'
          type: string
          enum:
          - Random
          - Short
          - Long
          - Hierarchical
          x-nullable: true
          x-order: 2
        viewProtectionConfig:
          description: Specifies the protection config of the View.
          allOf:
          - $ref: '#/definitions/ViewProtectionConfig'
          - x-nullable: true
          x-order: 3
    - $ref: '#/definitions/UpdateViewParam'
  CreateViewFailoverRequest:
    description: Specifies the request parameters to create a view failover task.
    type: object
    required:
    - type
    properties:
      type:
        description: Specifies the failover type.<br> 'Planned' indicates this is
          a planned failover.<br> 'Unplanned' indicates this is an unplanned failover,
          which is used when source cluster is down.
        type: string
        enum:
        - Planned
        - Unplanned
        x-nullable: true
        x-order: 0
      plannedFailoverParams:
        description: Specifies parameters to create a planned failover.
        allOf:
        - $ref: '#/definitions/PlannedFailoverParams'
        - x-nullable: true
        x-order: 1
      unplannedFailoverParams:
        description: Specifies parameters to create an unplanned failover.
        allOf:
        - $ref: '#/definitions/UnplannedFailoverParams'
        - x-nullable: true
        x-order: 2
  CreateViewRequest:
    description: Specifies the information required for creating a new View.
    type: object
    title: Create View Request.
    allOf:
    - $ref: '#/definitions/CreateView'
    - type: object
      required:
      - name
      - category
      - storageDomainId
      - protocolAccess
      - qos
  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
        x-nullable: true
        x-order: 0
  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
  CsrKeyType:
    description: Csr Key Type
    type: object
    title: CsrKeyType
    properties:
      csrKeyType:
        description: Specifies the csr key type.
        type: string
        enum:
        - rsa
        - ecdsa
        x-order: 0
  CsrServiceName:
    description: Csr Service Name
    type: object
    title: CsrServiceName
    properties:
      csrServiceName:
        description: Specifies the csr service name.
        type: string
        enum:
        - iris
        x-order: 0
  DSESolrInfo:
    description: Contains details about DSE Solr.
    type: object
    title: Authentication details for DSE solr.
    required:
    - solrNodes
    - solrPort
    properties:
      solrNodes:
        description: Solr node IP Addresses
        type: array
        items:
          type: string
        x-order: 0
      solrPort:
        description: Solr node Port.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
  DataTieringAnalysisGroup:
    description: Specifies the data tiering analysis group.
    type: object
    allOf:
    - $ref: '#/definitions/CommonDataTieringAnalysisGroupParams'
    - type: object
      properties:
        id:
          description: Specifies the ID of the data tiering analysis group.
          type: string
          x-nullable: true
          x-order: 0
        lastRun:
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/DataTieringAnalysisGroupRun'
          readOnly: true
  DataTieringAnalysisGroupRun:
    description: Specifies the data tiering analysis group run.
    type: object
    properties:
      id:
        description: Specifies the ID of the data tiering analysis group run.
        type: string
        x-nullable: true
        x-order: 0
      objects:
        description: 'Specifies the objects details analyzed during data tiering analysis

          group run.'
        type: array
        items:
          $ref: '#/definitions/DataTieringObjectInfo'
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the start time of analysis run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      endTimeUsecs:
        description: Specifies the end time of analysis run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      analysisInfo:
        description: Specifies the data tiering analysis details.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/DataTieringAnalysisInfo'
  DataTieringAnalysisGroups:
    description: Specifies the data tiering analysis groups.
    type: array
    items:
      $ref: '#/definitions/DataTieringAnalysisGroup'
    x-nullable: true
  DataTieringAnalysisInfo:
    description: Specifies the data tiering analysis details.
    type: object
    properties:
      tagsInfo:
        description: Array of Tag objects.
        type: array
        items:
          $ref: '#/definitions/DataTieringTagObject'
        x-nullable: true
        x-order: 0
      progress:
        x-order: 1
        $ref: '#/definitions/ProgressSummary'
      status:
        description: "Status of the analysis run.\n'Running' indicates that the run\
          \ is still running.\n'Canceled' indicates that the run has been canceled.\n\
          'Canceling' indicates that the run is in the process of being\n canceled.\n\
          'Failed' indicates that the run has failed.\n'Missed' indicates that the\
          \ run was unable to take place at the\n scheduled time because the previous\
          \ run was still happening.\n'Succeeded' indicates that the run has finished\
          \ successfully.\n'SucceededWithWarning' indicates that the run finished\n\
          \ successfully, but there were some warning messages.\n'OnHold' indicates\
          \ that the run has On hold."
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 2
      message:
        description: message from the last analysis run stating the error message
          in case of error in analysis run or warning message if the run finished
          successfully, but there were some warning messages.
        type: string
        x-nullable: true
        x-order: 3
  DataTieringObjectAnalysisInfo:
    description: Specifies the data tiering object analysis details.
    type: object
    properties:
      status:
        description: "Status of the analysis run.\n'Running' indicates that the run\
          \ is still running.\n'Canceled' indicates that the run has been canceled.\n\
          'Canceling' indicates that the run is in the process of being\n canceled.\n\
          'Failed' indicates that the run has failed.\n'Missed' indicates that the\
          \ run was unable to take place at the\n scheduled time because the previous\
          \ run was still happening.\n'Succeeded' indicates that the run has finished\
          \ successfully.\n'SucceededWithWarning' indicates that the run finished\n\
          \ successfully, but there were some warning messages.\n'OnHold' indicates\
          \ that the run has On hold."
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 0
      message:
        description: 'A message about the error if encountered while performing data

          tiering analysis.'
        type: string
        x-nullable: true
        x-order: 1
      stats:
        description: Specifies the source share analysis stats.
        type: array
        items:
          $ref: '#/definitions/DataTieringShareStats'
        x-nullable: true
        x-order: 2
  DataTieringObjectInfo:
    description: Specifies the data tiering analysis group run object details.
    type: object
    allOf:
    - $ref: '#/definitions/ProtectionObjectInput'
    - type: object
      properties:
        analysisInfo:
          description: Specifies the data tiering object analysis details.
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/DataTieringObjectAnalysisInfo'
  DataTieringSchedule:
    description: Specifies the data tiering schedule.
    type: object
    properties:
      unit:
        description: Specifies how often to migrate data from source to target
        type: string
        enum:
        - Days
        - Weeks
        - Months
        x-nullable: true
        x-order: 0
      daySchedule:
        description: 'Specifies settings that define a schedule for a data tiering
          runs to

          start every n days.'
        type: object
        x-order: 1
        $ref: '#/definitions/DaySchedule'
      weekSchedule:
        description: 'Specifies settings that define a schedule for a data tiering
          runs to

          start on certain days of week.'
        type: object
        x-order: 2
        $ref: '#/definitions/WeekSchedule'
      monthSchedule:
        description: 'Specifies settings that define a schedule for a data tiering
          runs to

          on specific week and specific days of that week.'
        type: object
        x-order: 3
        $ref: '#/definitions/MonthSchedule'
      startTime:
        description: Specifies the start time for the data tiering task.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/TimeOfDay'
  DataTieringShareStats:
    description: Specifies the source shares analysis stats.
    type: object
    properties:
      fileTypeTag:
        description: Specifies the file type bucket.
        type: string
        x-nullable: true
        x-order: 0
      fileSizeTag:
        description: Specifies the file size bucket.
        type: string
        x-nullable: true
        x-order: 1
      accessTimeTag:
        description: Specifies the access time bucket.
        type: string
        x-nullable: true
        x-order: 2
      modTimeTag:
        description: Specifies the modification time bucket.
        type: string
        x-nullable: true
        x-order: 3
      fileCount:
        description: Specifies the file count.
        type: integer
        format: uint64
        x-nullable: true
        x-order: 4
      totalSize:
        description: Specifies the total count.
        type: integer
        format: uint64
        x-nullable: true
        x-order: 5
      id:
        description: Specifies the unique identifer for stat.
        type: integer
        format: uint64
        x-nullable: true
        x-order: 6
  DataTieringSource:
    description: Specifies the source data tiering details.
    type: object
    properties:
      environment:
        description: Specifies the environment type of the data tiering source.
        type: string
        enum:
        - kGenericNas
        - kIsilon
        - kNetapp
        x-nullable: true
        x-order: 0
      genericNasParams:
        description: 'Specifies the parameters which are specific to data tiering
          generic

          NAS source.'
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/GenericNasDataTieringParams'
      isilonParams:
        description: 'Specifies the parameters which are specific to data tiering
          Isilon

          NAS source.'
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/IsilonDataTieringParams'
      netappParams:
        description: 'Specifies the parameters which are specific to data tiering
          Netapp

          NAS source.'
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/NetappDataTieringParams'
  DataTieringTag:
    type: object
    title: Specifies label and value of tags.
    properties:
      label:
        description: Specifies label of tag.
        type: string
        x-nullable: true
        x-order: 0
      value:
        description: Specifies value of tag.
        type: string
        x-nullable: true
        x-order: 1
  DataTieringTagConfig:
    description: Array of data tiering tag objects.
    type: object
    required:
    - tagsInfo
    properties:
      id:
        description: Specifies the ID of the data tiering analysis group.
        type: string
        x-nullable: true
        x-order: 0
        readOnly: true
      tagsInfo:
        description: Array of Tag objects.
        type: array
        items:
          $ref: '#/definitions/DataTieringTagObject'
        x-nullable: true
        x-order: 1
  DataTieringTagObject:
    type: object
    title: Specifies the tag information of type and array of (label, value).
    properties:
      type:
        description: Specifies type of tag.
        type: string
        x-nullable: true
        x-order: 0
      tags:
        description: Array of tag label and value.
        type: array
        items:
          $ref: '#/definitions/DataTieringTag'
        x-nullable: true
        x-order: 1
  DataTieringTarget:
    description: Specifies the target data tiering details.
    type: object
    required:
    - viewName
    - storageDomainId
    properties:
      viewName:
        description: Specifies the view name.
        type: string
        x-nullable: true
        x-order: 0
      mountPath:
        description: Specifies the mount path inside the view.
        type: string
        x-nullable: true
        x-order: 1
      storageDomainId:
        description: Specifies the Storage Domain ID where the view will be kept.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
    x-nullable: true
  DataTieringTask:
    description: Specifies the data tiering task details.
    type: object
    allOf:
    - $ref: '#/definitions/CommonDataTieringTaskResponse'
    - type: object
      properties:
        downtieringPolicy:
          description: Specifies downtiering policy for data tiering task.
          type: object
          x-cohesity-discriminator-value: Downtier
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/DowntieringPolicy'
        uptieringPolicy:
          description: Specifies uptiering policy for data tiering task.
          type: object
          x-cohesity-discriminator-value: Uptier
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/UptieringPolicy'
  DataTieringTaskRun:
    description: Specifies the data tiering task run.
    type: object
    properties:
      id:
        description: Specifies the id of the data tiering task run.
        type: string
        x-nullable: true
        x-order: 0
      startTimeUsecs:
        description: Specifies the start time of task run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      endTimeUsecs:
        description: Specifies the end time of task run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      tieringInfo:
        description: Specifies the data tiering tiering task details.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/TieringInfo'
  DataTieringTaskRunRequest:
    description: Specifies the request to run tiering task once.
    title: Run once data tiering task request.
    properties:
      uptierPath:
        description: 'Ignore the uptiering policy and uptier the directory pointed
          by the

          ''uptierPath''. If path is ''/'', then uptier everything.'
        type: string
        x-nullable: true
        x-order: 0
  DataTieringTaskStats:
    description: Specifies the stats of data tiering task.
    type: object
    allOf:
    - $ref: '#/definitions/BackupDataStats'
    - type: object
      properties:
        entityCount:
          description: Specifies total entity count.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        changedEntityCount:
          description: Specifies changed entity count.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
        isTieringGoalMet:
          description: Specifies whether tiering goal has been met.
          type: boolean
          default: false
          x-nullable: true
          x-order: 2
        totalTieredBytes:
          description: Specifies total amount of data successfully tiered from the
            NAS source.
          type: integer
          format: int64
          x-nullable: true
          x-order: 3
  DataTieringTasks:
    description: The list of data tiering tasks.
    type: array
    items:
      x-cohesity-discriminator-ref: CommonDataTieringTaskResponse
      $ref: '#/definitions/CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2f'
    x-nullable: true
  DataUsageStats:
    description: 'Specifies the data usage metric of the data stored on the Cohesity

      Cluster or Storage Domains (View Boxes).'
    type: object
    title: Data Usage Statistics.
    properties:
      cloudDataWrittenBytes:
        description: 'Specifies the total data written on cloud tiers, as computed
          by the

          Cohesity Cluster.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      cloudDataWrittenBytesTimestampUsec:
        description: Specifies Timestamp of CloudDataWrittenBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      cloudTotalPhysicalUsageBytes:
        description: 'Specifies the total cloud capacity, as computed by the Cohesity
          Cluster,

          after the size of the data has been reduced by change-block tracking,

          compression and deduplication.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      cloudTotalPhysicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of CloudTotalPhysicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      dataInBytes:
        description: 'Specifies the data read from the protected objects by the Cohesity

          Cluster before any data reduction using deduplication and compression.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      dataInBytesAfterDedup:
        description: 'Specifies the size of the data has been reduced by change-block

          tracking and deduplication but before compression or data is replicated
          to

          other nodes as per RF or Erasure Coding policy.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      dataInBytesAfterDedupTimestampUsec:
        description: Specifies Timestamp of DataInBytesAfterDedup.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      dataInBytesTimestampUsec:
        description: Specifies Timestamp of DataInBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      dataProtectLogicalUsageBytes:
        description: Specifies the logical data used by Data Protect on Cohesity cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
      dataProtectLogicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of DataProtectLogicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
      dataProtectPhysicalUsageBytes:
        description: Specifies the physical data used by Data Protect on Cohesity
          cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 10
      dataProtectPhysicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of DataProtectPhysicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 11
      dataWrittenBytes:
        description: 'Specifies the data written after it has been reduced by deduplication

          and compression. This does not include resiliency impact.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 12
      dataWrittenBytesTimestampUsec:
        description: Specifies Timestamp of DataWrittenBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 13
      fileServicesLogicalUsageBytes:
        description: Specifies the logical data used by File services on Cohesity
          cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 14
      fileServicesLogicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of FileServicesLogicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 15
      fileServicesPhysicalUsageBytes:
        description: Specifies the physical data used by File services on Cohesity
          cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 16
      fileServicesPhysicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of FileServicesPhysicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 17
      localDataWrittenBytes:
        description: 'Specifies the total data written on local tiers, as computed
          by the

          Cohesity Cluster, after the size of the data has been reduced by

          change-block tracking, deduplication and compression. This does not

          include resiliency impact.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 18
      localDataWrittenBytesTimestampUsec:
        description: Specifies Timestamp of LocalDataWrittenBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 19
      localTierResiliencyImpactBytes:
        description: 'Specifies the size of the data has been replicated to other
          nodes as per

          RF or Erasure Coding policy.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 20
      localTierResiliencyImpactBytesTimestampUsec:
        description: Specifies Timestamp of LocalTierResiliencyImpactBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 21
      localTotalPhysicalUsageBytes:
        description: 'Specifies the total local capacity, as computed by the Cohesity
          Cluster,

          after the size of the data has been reduced by change-block tracking,

          compression and deduplication.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 22
      localTotalPhysicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of LocalTotalPhysicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 23
      outdatedLogicalUsageBytes:
        description: 'Specifies the logical usage as computed by the Cohesity Cluster.
          This

          field is computed on a same frequency as ''StorageConsumedBytes'',

          and it may not be the latest value. It is used to compute reduction ratio.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 24
      outdatedLogicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of OutdatedLogicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 25
      storageConsumedBytes:
        description: 'Specifies the total capacity, as computed by the Cohesity Cluster,

          after the size of the data has been reduced by change-block tracking,

          compression and deduplication. This includes resiliency impact.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 26
      storageConsumedBytesTimestampUsec:
        description: Specifies Timestamp of StorageConsumedBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 27
      totalLogicalUsageBytes:
        description: 'Provides the combined data residing on protected objects.

          The size of data before reduction by deduplication and compression.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 28
      totalLogicalUsageBytesTimestampUsec:
        description: Specifies Timestamp of TotalLogicalUsageBytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 29
      uniquePhysicalDataBytes:
        description: Specifies the unique physical data usage in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 30
  DatabaseEntityInfo:
    description: Object details about Oracle database entity info.
    type: object
    properties:
      containerDatabaseInfo:
        description: Specifies the information about container database.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/ContainerDatabaseInfo'
  DatastoreParams:
    description: Specifies the datastore params.
    type: object
    title: Datastore params.
    properties:
      id:
        description: Specifies the Id of the datastore.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      maxConcurrentStreams:
        description: Specifies the max concurrent stream per datastore.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
  DaySchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start after certain number of days.
    title: Days Schedule
    allOf:
    - $ref: '#/definitions/FrequencySchedule'
  DbRecoveryOverWritingPolicy:
    description: DB Recovery Overwriting Policy.
    type: object
    title: DB Recovery Overwriting Policy.
    properties:
      dbRecoveryOverWritingPolicy:
        description: 'Specifies the overwriting policies in case of SQL App Recoveries. '
        type: string
        enum:
        - FailIfExists
        - Overwrite
        x-order: 0
  DeleteActiveDirectoryRequest:
    description: Specifies the request to delete an Active Directory.
    type: object
    required:
    - activeDirectoryAdminParams
    properties:
      activeDirectoryAdminParams:
        description: Specifies the params of a user with administrative privilege
          of this Active Directory. This field is mandatory if machine accounts are
          updated.
        type: object
        allOf:
        - $ref: '#/definitions/ActiveDirectoryAdminParams'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  DeleteRigelConnectorRequest:
    description: Specify the params to delete a Rigel connector.
    type: object
    title: Delete Rigel Connector Request.
    required:
    - tenantId
    properties:
      tenantId:
        description: Specifies the id of the tenant which the connector belongs to.
        type: string
        x-nullable: true
        x-order: 0
  DeviceTreeLeafNode:
    description: Specifies the parameters of a leaf node in device tree.
    type: object
    properties:
      diskName:
        description: Specifies the disk name.
        type: string
        x-nullable: true
        x-order: 0
      partitionNumber:
        description: Specifies the paritition number.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
      offsetBytes:
        description: Specifies the offset in bytes where data for the LVM volume (for
          which this device tree is being build) starts relative to the start of the
          partition.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      lengthBytes:
        description: Specifies The length of data in bytes for the LVM volume (for
          which this device tree is being built). It does not include size of the
          LVM meta data.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  DeviceTreeNode:
    description: Specifies the tree structure of a logical volume. The leaves are
      slices of partitions and the other nodes are assemled by combining nodes in
      some mode.
    type: object
    properties:
      isLeaf:
        description: Specifies if the node is a leaf node.
        type: boolean
        x-nullable: true
        x-order: 0
      leafNodeParams:
        description: Specifies the parameters for a leaf node.
        allOf:
        - $ref: '#/definitions/DeviceTreeLeafNode'
        - x-nullable: true
        x-order: 1
      nonLeafNodeParams:
        description: Specifies the parameters for a non leaf node.
        allOf:
        - $ref: '#/definitions/DeviceTreeNonLeafNode'
        - x-nullable: true
        x-order: 2
  DeviceTreeNonLeafNode:
    description: Specifies the parameters of a non leaf node in device tree.
    type: object
    properties:
      type:
        description: Specifies the children nodes combine type.
        type: string
        enum:
        - Linear
        - Stripe
        - Mirror
        - Raid5
        - Raid6
        - Zero
        - Thin
        - ThinPool
        - Snapshot
        - Cache
        - CachePool
        x-nullable: true
        x-order: 0
      deviceLength:
        description: Specifies the length of device.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      deviceId:
        description: Specifies the id of device.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      childrenNodes:
        description: Specifies a list of children nodes.
        type: array
        items:
          $ref: '#/definitions/DeviceTreeNode'
        x-nullable: true
        x-order: 3
  Disk:
    description: Specifies the details of a disk that belongs to a node.
    type: object
    title: Disk details
    properties:
      id:
        description: Specifies id to uniquely identify a disk.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      serialNumber:
        description: Specifies serial number of disk.
        type: string
        x-nullable: true
        x-order: 1
      capacityInBytes:
        description: Specifies capacity of disk in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      model:
        description: Specifies product model of disk.
        type: string
        x-nullable: true
        x-order: 3
      nodeId:
        description: Specifies node id of the node that this disk belong to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      status:
        description: Specifies status of the disk.
        type: string
        enum:
        - Online
        - Offline
        - Removing
        - OkToRemove
        - Blacklist
        - New
        - Empty
        - Unknown
        - Activating
        x-order: 5
      type:
        description: Specifies type of the disk.
        type: string
        enum:
        - SystemDisk
        - BootDisk
        - DataDisk
        - NvmeSsdDisk
        - SataSsdDisk
        - HddDisk
        - Unknown
        x-order: 6
      location:
        description: Specifies location of the disk in node.
        type: string
        x-nullable: true
        x-order: 7
  DiskIdentify:
    description: Specifies the parameters needed to identify disk.
    type: object
    title: Disk identify params.
    required:
    - nodeId
    - serialNumber
    - identify
    properties:
      nodeId:
        description: Specifies the node id of node that disk belongs to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      serialNumber:
        description: Specifies serial number of disk.
        type: string
        x-nullable: true
        x-order: 1
      identify:
        description: Turn on/off led light if it is set to true/false
        type: boolean
        x-nullable: true
        x-order: 2
  DiskInfo:
    description: Specifies information about a disk.
    type: object
    title: Disk Information
    required:
    - busNumber
    - unitNumber
    properties:
      controllerType:
        description: Specifies the disk controller type.
        type: string
        enum:
        - kScsi
        - kIde
        - kSata
        x-nullable: true
        x-order: 0
      unitNumber:
        description: Specifies the disk file name. This is the VMDK name and not the
          flat file name.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      busNumber:
        description: Specifies the Id of the controller bus that controls the disk.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  DiskRemovalParams:
    description: Specifies parameters to initiate/cancel disk removal.
    type: object
    title: Disk Removal Parameters.
    required:
    - cancel
    properties:
      cancel:
        description: If true, cancels disk removal which is already in progress.
        type: boolean
        x-nullable: true
        x-order: 0
  DiskStatus:
    description: Disk Status
    type: object
    title: Disk Status
    properties:
      diskStatus:
        description: Disk Status
        type: string
        enum:
        - Active
        - Offline
        - Deleting
        - Deleted
        - DataVipNotReachable
        - FileSystemNotAccessible
        - FileSystemDeleted
        - Mounting
        - Migrating
        - Unknown
        x-order: 0
  DiskTiers:
    description: Disk Tiers
    type: object
    title: Disk Tiers
    properties:
      diskTiers:
        description: Disk Tiers
        type: string
        enum:
        - PCIeSSD
        - SATA-SSD
        - SATA-HDD
        - CLOUD
        x-order: 0
  DiskType:
    description: Type of disk.
    type: object
    title: Disk type.
    properties:
      status:
        description: Specifies type of the disk.
        type: string
        enum:
        - SystemDisk
        - BootDisk
        - DataDisk
        - NvmeSsdDisk
        - SataSsdDisk
        - HddDisk
        - Unknown
        x-order: 0
  DisksList:
    description: Specifies the list of disks that belong to node.
    type: object
    title: List of Disks
    properties:
      disksList:
        description: Specifies the list of disks.
        type: array
        items:
          $ref: '#/definitions/Disk'
        x-nullable: true
        x-order: 0
  DnsServersInfo:
    description: List of DNS servers in cluster.
    type: object
    title: DnsServersInfo
    properties:
      dnsServers:
        description: List of DNS servers in cluster.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
  DocumentsFilterType:
    description: Enumeration of all the document filter option.
    type: object
    title: Enumeration of all the document filter option.
    properties:
      DocumentsFilterType:
        description: Enumeration of all the document filter option.
        type: string
        enum:
        - NONE
        - ID
        - CONTENT
        x-order: 0
  DomainController:
    description: Specifies a domain controller.
    type: object
    required:
    - name
    properties:
      name:
        description: Specifies the domain controller name.
        type: string
        x-nullable: true
        x-order: 0
      status:
        description: Specifies the connection status.
        type: string
        enum:
        - Reachable
        - Unreachable
        - Incompatible
        x-nullable: true
        x-order: 1
        readOnly: true
  DomainControllerStatus:
    description: Connection status of domain controller.
    type: object
    title: Domain Controller Status
    properties:
      domainControllerStatus:
        description: Specifies the connection status of a domain controller.
        type: string
        enum:
        - Reachable
        - Unreachable
        - Incompatible
        x-order: 0
  DomainControllers:
    description: Specifies the domain controllers of a domain.
    type: object
    properties:
      domainName:
        description: Specifies the domain name.
        type: string
        x-nullable: true
        x-order: 0
      controllers:
        description: Specifies a list of domain controllers of the domain.
        type: array
        items:
          type: object
          $ref: '#/definitions/DomainController'
        x-nullable: true
        x-order: 1
  DomainControllersResponse:
    description: Specifies the response of get domain controllers request.
    type: object
    properties:
      domainControllers:
        description: A list of domain names with a list of it's domain controllers.
        type: array
        items:
          $ref: '#/definitions/DomainControllers'
        x-nullable: true
        x-order: 0
  DomainScopeParams:
    description: Specifies the parameters for domain type scope
    type: object
    required:
    - domainName
    properties:
      domainName:
        description: Specifies the domain name.
        type: string
        x-nullable: true
        x-order: 0
  DownTieringFileSelectionType:
    description: Data down-tiering file selection type.
    type: object
    title: Data down-tiering file selection type.
    properties:
      type:
        description: Specifies the data down-tiering file selection type.
        type: string
        enum:
        - OlderThan
        - LastAccessed
        - LastModified
        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
        x-nullable: true
        x-order: 0
      object:
        description: Specifies the snapshot object from which to download files and
          folders.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
      filesAndFolders:
        description: Specifies the list of files and folders to download.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/FilesAndFoldersObject'
        x-nullable: true
        x-order: 2
  DownloadFilesAndFoldersResponseParams:
    description: Specifies the parameters to create a download files and folders Recovery.
    type: object
    title: Download Files And Folders Recovery Params.
    properties:
      id:
        description: Specifies the id of the Recovery.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the recovery task. This field must be set
          and must be a unique name.
        type: string
        x-nullable: true
        x-order: 1
      object:
        description: Specifies the snapshot object from which to download files and
          folders.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
      filesAndFolders:
        description: Specifies the list of files and folders to download.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/FilesAndFoldersObject'
        x-nullable: true
        x-order: 3
  DowntieringFileAgePolicy:
    description: 'Specifies the file''s selection rule by file age for down tiering
      data

      tiering task eg.

      1. select files older than 10 days.

      2. select files last accessed 2 weeks ago.

      3. select files last modified 1 month ago.'
    type: object
    properties:
      condition:
        description: Specifies the condition for the file age.
        type: string
        enum:
        - OlderThan
        - LastAccessed
        - LastModified
        x-nullable: true
        x-order: 0
      ageMsecs:
        description: Specifies the number of msecs used for file selection.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  DowntieringPolicy:
    description: Specifies the data downtiering policy.
    type: object
    allOf:
    - type: object
      properties:
        qosPolicy:
          description: 'Specifies whether the data tiering task will be written to
            HDD or

            SSD.'
          type: string
          enum:
          - kBackupHDD
          - kBackupSSD
          - kTestAndDevHigh
          - kBackupAll
          x-nullable: true
          x-order: 0
        indexingPolicy:
          description: 'Specifies settings for indexing files found in an Object

            (such as a VM) so these files can be searched and recovered. This

            also specifies inclusion and exclusion rules that determine the

            directories to index.'
          type: object
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/IndexingPolicy'
        retention:
          x-order: 2
          $ref: '#/definitions/Retention'
        skipBackSymlink:
          description: 'Specifies whether to create a symlink for the migrated data
            from

            source to target.'
          type: boolean
          default: true
          x-nullable: true
          x-order: 3
        autoOrphanDataCleanup:
          description: 'Specifies whether to remove the orphan data from the target
            if the

            symlink is removed from the source.'
          type: boolean
          default: true
          x-nullable: true
          x-order: 4
        tieringGoal:
          description: 'Specifies the maximum amount of data that should be present
            on source

            after downtiering.'
          type: integer
          format: int64
          x-nullable: true
          x-order: 5
        fileAge:
          x-order: 6
          $ref: '#/definitions/DowntieringFileAgePolicy'
    - $ref: '#/definitions/CommonTieringPolicy'
  EbsVolumeExclusionParams:
    description: Specifies the parameters to exclude EBS volumes attached to EC2 instances
      at global and object level. A volume satisfying any of these criteria will be
      excluded.
    type: object
    title: EBS Volume Exclusion Params.
    properties:
      volumeIds:
        description: Array of volume IDs that are to be excluded. This is only for
          object level exclusion.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      maxVolumeSizeBytes:
        description: Any volume larger than this size will be excluded.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      volumeTypes:
        description: Array of volume types to exclude. Eg - gp2, gp3.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
      deviceNames:
        description: Array of device names to exclude. Eg - /dev/sda.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 3
    x-nullable: true
  ElastifileObjectProtectionParams:
    description: Specifies the parameters which are specific to Elastifile object
      protection.
    type: object
    properties:
      protocol:
        description: Specifies the protocol of the NAS device being backed up.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 0
  ElastifileObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to Elastifile object
      protection.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to be protected.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/definitions/ProtectionObjectInput'
          x-order: 0
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/ElastifileObjectProtectionParams'
  ElastifileObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to Elastifile object
      protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/ElastifileObjectProtectionParams'
  ElastifileObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters which are specific to Elastifile
      object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/ElastifileObjectProtectionParams'
  ElastifileProtectionGroupObjectParams:
    description: Specifies an object protected by an Elastifile Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  ElastifileProtectionGroupParams:
    description: Specifies the parameters which are specific to Elastifile related
      Protection Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ElastifileProtectionGroupObjectParams'
        x-order: 0
      directCloudArchive:
        description: Specifies whether or not to store the snapshots in this run directly
          in an Archive Target instead of on the Cluster. If this is set to true,
          the associated policy must have exactly one Archive Target associated with
          it and the policy must be set up to archive after every run. Also, a Storage
          Domain cannot be specified. Default behavior is 'false'.
        type: boolean
        x-nullable: true
        x-order: 1
      nativeFormat:
        description: Specifies whether or not to enable native format for direct archive
          job. This field is set to true if native format should be used for archiving.
        type: boolean
        x-nullable: true
        x-order: 2
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/IndexingPolicy'
      protocol:
        description: Specifies the protocol of the NAS device being backed up.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 4
      continueOnError:
        description: Specifies whether or not the Protection Group should continue
          regardless of whether or not an error was encountered.
        type: boolean
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether the protection group should use encryption
          while backup or not.
        type: boolean
        x-nullable: true
        x-order: 6
      fileLockConfig:
        description: Optional config that enables file locking for this view. It cannot
          be disabled during the edit of a view, if it has been enabled during the
          creation of the view. Also, it cannot be enabled if it was disabled during
          the creation of the view.
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/FileLevelDataLockConfig'
      fileFilters:
        description: Specifies file paths to include or exclude.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/FileFilteringPolicy'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 10
        readOnly: true
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the protection group.
        type: object
        x-nullable: true
        x-order: 11
        $ref: '#/definitions/HostBasedBackupScriptParams'
      filterIpConfig:
        description: Specifies the list of IP addresses that are allowed or denied
          at the job level. Allowed IPs and Denied IPs cannot be used together.
        type: object
        x-nullable: true
        x-order: 12
        $ref: '#/definitions/FilterIpConfig'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          full or incremental backup of the NAS source.
        x-nullable: true
        x-order: 13
        $ref: '#/definitions/NasThrottlingConfig'
    x-nullable: true
  ElastifileRegistrationParams:
    description: Specifies parameters to register an Elastifile Source.
    type: object
    title: Elastifile Protection Source.
    required:
    - endpoint
    - credentials
    properties:
      endpoint:
        description: Specifies the Hostname or IP Address Endpoint for the Elastifile
          Source.
        type: string
        x-nullable: true
        x-order: 0
      credentials:
        description: Specifies the credentials for an Elastifile Source.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Credentials'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          registration of the NAS source.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/NasThrottlingConfig'
  Email:
    description: Specifies an email or an email folder.
    title: Email
    allOf:
    - type: object
      properties:
        id:
          description: Specifies the id of the email object.
          type: string
          x-nullable: true
          x-order: 0
        userObjectInfo:
          description: Specifies the User object info for which this email belongs
            to.
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/ObjectSummary'
        folderName:
          description: Specify the name of the email folder.
          type: string
          x-nullable: true
          x-order: 2
        isEmailFolder:
          description: Specify if the object is an email folder.
          type: boolean
          x-nullable: true
          x-order: 3
        emailSubject:
          description: Specifies the subject of this email.
          type: string
          x-nullable: true
          x-order: 4
        hasAttachment:
          description: Specifies whether email has an attachment.
          type: boolean
          x-nullable: true
          x-order: 5
        senderAddress:
          description: Specifies the sender's email address.
          type: string
          x-nullable: true
          x-order: 6
        recipientAddresses:
          description: '"Specifies the email addresses of all receipients of this
            email."'
          type: array
          items:
            type: string
          x-nullable: true
          x-order: 7
        ccRecipientAddresses:
          description: '"Specifies the email addresses of all the CC receipients of
            this

            email."'
          type: array
          items:
            type: string
          x-nullable: true
          x-order: 8
        bccRecipientAddresses:
          description: '"Specifies the email addresses of all the BCC receipients
            of this

            email."'
          type: array
          items:
            type: string
          x-nullable: true
          x-order: 9
        sentTimeSecs:
          description: '"Specifies the Unix timestamp epoch in seconds at which this

            email is sent."'
          type: integer
          format: int64
          x-nullable: true
          x-order: 10
        receivedTimeSecs:
          description: '"Specifies the Unix timestamp epoch in seconds at which this

            email is received."'
          type: integer
          format: int64
          x-nullable: true
          x-order: 11
        protectionGroupId:
          description: '"Specifies the Protection Group id protecting the mailbox."'
          type: string
          x-nullable: true
          x-order: 12
        storageDomainId:
          description: '"Specifies the Storage Domain id where the backup data of
            Object

            is present."'
          type: integer
          format: int64
          x-nullable: true
          x-order: 13
        tenantId:
          description: '"Specify the tenant id to which this email belongs to."'
          type: string
          x-nullable: true
          x-order: 14
    - $ref: '#/definitions/TagObject'
  EnvSpecificObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to adapter identified
      by enviournment.
    type: object
    properties:
      environment:
        description: Specifies the environment for current object.
        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-nullable: true
        x-order: 0
      vmwareParams:
        description: Specifies the parameters which are specific to VMware related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VmwareObjectProtectionRequestParams'
      genericNasParams:
        description: Specifies the parameters which are specific to Generic Nas related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/GenericNasObjectProtectionRequestParams'
      gpfsParams:
        description: Specifies the parameters which are specific to Gpfs related Object
          Backup.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/GpfsObjectProtectionRequestParams'
      elastifileParams:
        description: Specifies the parameters which are specific to Elastifile related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ElastifileObjectProtectionRequestParams'
      netappParams:
        description: Specifies the parameters which are specific to Netapp related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/NetappObjectProtectionRequestParams'
      isilonParams:
        description: Specifies the parameters which are specific to Isilon related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/IsilonObjectProtectionRequestParams'
      flashbladeParams:
        description: Specifies the parameters which are specific to Flashblade related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/FlashbladeObjectProtectionRequestParams'
      mssqlParams:
        description: Specifies the parameters which are specific to Mssql related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/MssqlObjectProtectionRequestParams'
      office365UserMailboxParams:
        description: Specifies the parameters which are specific to Microsoft 365
          user mailbox related Object Backup.
        type: object
        x-nullable: true
        x-order: 9
        $ref: '#/definitions/Office365UserMailboxObjectProtectionRequestParams'
  EnvSpecificObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to adapter identified
      by enviournment.
    type: object
    properties:
      environment:
        description: Specifies the environment for current object.
        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-nullable: true
        x-order: 0
      vmwareParams:
        description: Specifies the parameters which are specific to VMware related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VmwareObjectProtectionResponseParams'
      genericNasParams:
        description: Specifies the parameters which are specific to Generic Nas related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/GenericNasObjectProtectionResponseParams'
      gpfsParams:
        description: Specifies the parameters which are specific to Gpfs related Object
          Backup.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/GpfsObjectProtectionResponseParams'
      elastifileParams:
        description: Specifies the parameters which are specific to Elastifile related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ElastifileObjectProtectionResponseParams'
      netappParams:
        description: Specifies the parameters which are specific to Netapp related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/NetappObjectProtectionResponseParams'
      isilonParams:
        description: Specifies the parameters which are specific to Isilon related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/IsilonObjectProtectionResponseParams'
      flashbladeParams:
        description: Specifies the parameters which are specific to Flashblade related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/FlashbladeObjectProtectionResponseParams'
      mssqlParams:
        description: Specifies the parameters which are specific to Mssql related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/MssqlObjectProtectionResponseParams'
      office365UserMailboxParams:
        description: Specifies the parameters which are specific to Microsoft 365
          user mailbox related Object Backup.
        type: object
        x-nullable: true
        x-order: 9
        $ref: '#/definitions/Office365UserMailboxObjectProtectionResponseParams'
  EnvSpecificObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters which are specific to adapter identified
      by enviournment.
    type: object
    properties:
      environment:
        description: Specifies the environment for current object.
        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-nullable: true
        x-order: 0
      vmwareParams:
        description: Specifies the parameters which are specific to VMware related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VmwareObjectProtectionUpdateRequestParams'
      genericNasParams:
        description: Specifies the parameters which are specific to Generic Nas related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/GenericNasObjectProtectionUpdateRequestParams'
      gpfsParams:
        description: Specifies the parameters which are specific to Gpfs related Object
          Backup.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/GpfsObjectProtectionUpdateRequestParams'
      elastifileParams:
        description: Specifies the parameters which are specific to Elastifile related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ElastifileObjectProtectionUpdateRequestParams'
      netappParams:
        description: Specifies the parameters which are specific to Netapp related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/NetappObjectProtectionUpdateRequestParams'
      isilonParams:
        description: Specifies the parameters which are specific to Isilon related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/IsilonObjectProtectionUpdateRequestParams'
      flashbladeParams:
        description: Specifies the parameters which are specific to Flashblade related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/FlashbladeObjectProtectionUpdateRequestParams'
      mssqlParams:
        description: Specifies the parameters which are specific to Mssql related
          Object Backup.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/MssqlObjectProtectionUpdateRequestParams'
      office365UserMailboxParams:
        description: Specifies the parameters which are specific to Microsoft 365
          user mailbox related Object Backup.
        type: object
        x-nullable: true
        x-order: 9
        $ref: '#/definitions/Office365UserMailboxObjectProtectionUpdateRequestParams'
  Environment:
    description: Environment type.
    type: object
    title: Environment type.
    properties:
      environment:
        description: Specifies Environment type.
        type: string
        enum:
        - kVMware
        - kHyperV
        - kSQL
        - kView
        - kRemoteAdapter
        - kPhysical
        - kPure
        - kAzure
        - kNetapp
        - kGenericNas
        - kAcropolis
        - kIsilon
        - kKVM
        - kAWS
        - kExchange
        - kOracle
        - kGCP
        - kFlashBlade
        - kO365
        - kHyperFlex
        - kAD
        - kGPFS
        - kKubernetes
        - kNimble
        - kElastifile
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        x-order: 0
  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
        x-nullable: true
        x-order: 0
      message:
        description: Specifies the error message.
        type: string
        x-nullable: true
        x-order: 1
  EsxiRegistrationParams:
    description: Specifies parameters to register VMware ESXi host.
    title: Register VMware ESXi host request parameters.
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationParams'
    - type: object
      properties:
        minFreeDatastoreSpaceForBackupGb:
          description: Specifies the minimum free space (in GB) expected to be available
            in the datastore where the virtual disks of the VM being backed up reside.
            If the space available is lower than the specified value, backup will
            be aborted.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        maxConcurrentStreams:
          description: If this value is > 0 and the number of streams concurrently
            active on a datastore is equal to it, then any further requests to access
            the datastore would be denied until the number of active streams reduces.
            This applies for all the datastores in the specified host.
          type: integer
          format: int32
          x-nullable: true
          x-order: 1
        dataStoreParams:
          description: Specifies the datastore specific params.
          type: array
          items:
            $ref: '#/definitions/DatastoreParams'
          x-nullable: true
          x-order: 2
  ExchangeAppParams:
    description: Specifies the Exchange special parameters for the Protection Group.
    type: object
    title: Exchange App Parameters.
    properties:
      appId:
        description: Specifies the application id of the Exchange database which has
          to be protected.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      appName:
        description: Specifies the application name of the Exchange database which
          has to be protected.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  ExchangeIndexedObject:
    description: Specifies the Exchange Indexed object.
    title: ExchangeIndexedObject
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        objectName:
          description: Specifies the name of the Exchange mailbox.
          type: string
          x-nullable: true
          x-order: 0
        email:
          description: Specifies the email corresponding to the mailbox.
          type: string
          x-nullable: true
          x-order: 1
        databaseName:
          description: Specifies the name of the Exchange database corresponding to
            the mailbox.
          type: string
          x-nullable: true
          x-order: 2
  ExchangeProtectionGroupObjectParams:
    description: Specifies the object identifier to for the exchange protection group.
    type: object
    title: Exchange Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the registered Exchange DAG(Database Availability
          Group) source or Exchange physical source.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the registered Exchange DAG(Database Availability
          Group) source or Exchange physical source.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      appParams:
        description: Specifies the specific parameters required for Exchange app configuration.
        type: array
        items:
          type: object
          $ref: '#/definitions/ExchangeAppParams'
        x-nullable: true
        x-order: 2
  ExchangeProtectionGroupParams:
    description: Specifies the parameters which are specific to Exchange related Protection
      Groups.
    type: object
    title: Exchange Protection Group Parameters.
    required:
    - objects
    properties:
      objects:
        description: Specifies the list of object ids to be protected.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ExchangeProtectionGroupObjectParams'
        x-order: 0
      excludeDatabaseIds:
        description: Specifies the list of IDs of the databases to not be protected
          by this Protection Group. This can be used to ignore specific databases
          under Exchange Server/DAG which has been included for protection.
        type: array
        items:
          type: integer
          format: int64
          x-nullable: true
        x-order: 1
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the mailboxes
          of an Exchange database. The name, email and guid corresponding to the mailbox
          are indexed for every mailbox.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/IndexingPolicy'
      backupsCopyOnly:
        description: Specifies whether the backups should be copy-only.
        type: boolean
        x-nullable: true
        x-order: 3
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/ExchangeDatabaseRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      restoreType:
        description: Specifies the type of exchange restore.
        type: string
        enum:
        - RestoreView
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ViewOptions'
  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
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/RecoverExchangeAppSnapshotParams'
  ExistingGroupParam:
    description: Specifies the parameters for using existing protection group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the protection group id.
        type: string
        x-nullable: true
        x-order: 0
  ExtendedRetentionPolicy:
    description: Specifies additional retention policies to apply to backup snapshots.
    type: object
    title: Extended Retention Policy.
    required:
    - schedule
    - retention
    properties:
      schedule:
        description: Specifies the schedule settings for extended retention.
        type: object
        minimum: 1
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/ExtendedRetentionSchedule'
      retention:
        description: Specifies the Retention period of a backup in days, months or
          years.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Retention'
      runType:
        description: 'The backup run type to which this extended retention applies
          to. If this is not set, the extended retention will be applicable to all
          non-log backup types. Currently, the only value that can be set here is
          Full.

          ''Regular'' indicates a incremental (CBT) backup. Incremental backups utilizing
          CBT (if supported) are captured of the target protection objects. The first
          run of a Regular schedule captures all the blocks.

          ''Full'' indicates a full (no CBT) backup. A complete backup (all blocks)
          of the target protection objects are always captured and Change Block Tracking
          (CBT) is not utilized.

          ''Log'' indicates a Database Log backup. Capture the database transaction
          logs to allow rolling back to a specific point in time.

          ''System'' indicates a system backup. System backups are used to do bare
          metal recovery of the system to a specific point in time.'
        type: string
        enum:
        - Regular
        - Full
        - Log
        - System
        x-nullable: true
        x-order: 2
      configId:
        description: Specifies the unique identifier for the target getting added.
          This field need to be passed olny when policies are updated.
        type: string
        x-nullable: true
        x-order: 3
  ExtendedRetentionSchedule:
    description: Specifies a schedule frequency and schedule unit for Extended Retentions.
    type: object
    title: Extended Retention Schedule
    required:
    - unit
    properties:
      unit:
        description: Specifies the unit interval for retention of Snapshots. <br>'Runs'
          means that the Snapshot copy retained after the number of Protection Group
          Runs equals the number specified in the frequency. <br>'Hours' means that
          the Snapshot copy retained hourly at the frequency set in the frequency,
          for example if scheduleFrequency is 2, the copy occurs every 2 hours. <br>'Days'
          means that the Snapshot copy gets retained daily at the frequency set in
          the frequency. <br>'Weeks' means that the Snapshot copy is retained weekly
          at the frequency set in the frequency. <br>'Months' means that the Snapshot
          copy is retained monthly at the frequency set in the Frequency. <br>'Years'
          means that the Snapshot copy is retained yearly at the frequency set in
          the Frequency.
        type: string
        enum:
        - Runs
        - Hours
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 0
      frequency:
        description: 'Specifies a factor to multiply the unit by, to determine the
          retention schedule.

          For example if set to 2 and the unit is hourly, then Snapshots from the
          first eligible Job Run for every 2 hour period is retained.'
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  FCICluster:
    description: Specifies the details of a Failover Cluster Instance.
    type: object
    properties:
      id:
        description: Specifies the unique identifier of the FCI.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the FCI.
        type: string
        x-nullable: true
        x-order: 1
      error:
        description: Specifies the error information if any associated with this FCI
          cluster.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/Error'
      resourceInfo:
        description: Specifies the resource information about the FCI.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/AppResource'
      servers:
        description: 'Specifies the list of SQL servers which belongs to the given
          FCI. '
        type: array
        items:
          $ref: '#/definitions/SQLServer'
        x-nullable: true
        x-order: 4
      isSelectedByDefault:
        description: Indicates to the UI whether this FCI cluster should be selected
          by default
        type: boolean
        x-nullable: true
        x-order: 5
  FailedProtectionGroupDetails:
    description: Specifies a list of ids of Protection Group that failed to update
      along with error details
    type: object
    properties:
      protectionGroupId:
        description: Specifies the id of the failed protection group.
        type: string
        x-nullable: true
        x-order: 0
      errorMessage:
        description: Specifies the error mesage for failed protection group.
        type: string
        x-nullable: true
        x-order: 1
  FailedRunDetails:
    description: Specifies a list of ids of Protection Group Runs that failed to update
      along with error details
    type: object
    properties:
      runId:
        description: Specifies the id of the failed run.
        type: string
        x-nullable: true
        x-order: 0
      errorMessage:
        description: Specifies the error mesage for failed run.
        type: string
        x-nullable: true
        x-order: 1
  Failover:
    description: Specifies the details of a failover.
    type: object
    properties:
      id:
        description: Specifies the failover id.
        type: string
        x-nullable: true
        x-order: 0
      type:
        description: Specifies the failover type.
        type: string
        enum:
        - Planned
        - Unplanned
        x-nullable: true
        x-order: 1
      status:
        description: Specifies the failover status.
        type: string
        enum:
        - Running
        - Succeeded
        - Failed
        x-nullable: true
        x-order: 2
      errorMessage:
        description: Specifies the error details if failover status is 'Failed'.
        type: string
        x-nullable: true
        x-order: 3
      startTimeUsecs:
        description: Specifies the failover start time in micro seconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      endTimeUsecs:
        description: Specifies the failover complete time in micro seconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      replications:
        description: Specifies a list of replications in this failover.
        type: array
        items:
          $ref: '#/definitions/FailoverReplication'
        x-nullable: true
        x-order: 6
  FailoverCreateRunResponse:
    description: Specifies the response upon creating a special run during failover
      workflow.
    type: object
    properties:
      failoverId:
        description: Specifies the unique failover Id which will be generated by orchestrator.
          This Id will be used to uniquely identify current failover operation.
        type: string
        x-nullable: true
        x-order: 0
  FailoverObject:
    description: Specifies the details about the objects being failed over.
    type: object
    title: Failover Objects
    required:
    - objectId
    properties:
      objectId:
        description: Specifies the object Id involved in failover operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
  FailoverReplicaCluster:
    description: Specifies the details about replication cluster involved in the failover
      operation.
    type: object
    title: Failover source cluster.
    required:
    - objects
    properties:
      objects:
        description: Specifies the details about the objects being failed over. In
          case if view based orchastrator is calling this then they should pass a
          object id for replicated view entity which belongs to the live tracking
          view on replication cluster.
        type: array
        items:
          $ref: '#/definitions/FailoverObject'
        x-nullable: true
        x-order: 0
      protectionGroupId:
        description: Specifies the protection group id from the replication cluster
          from where the objects being failed over. If this is not specified then
          it will be infer from the list of objects being failed over. The protection
          group id must be specified in this format <cluster_id>:<cluster_incarnation_id:jobid>
        type: string
        x-nullable: true
        x-order: 1
  FailoverReplication:
    description: Specifies the details of a failover replication.
    type: object
    properties:
      id:
        description: Specifies the replication id.
        type: string
        x-nullable: true
        x-order: 0
      status:
        description: Specifies the replication status.
        type: string
        enum:
        - Running
        - Succeeded
        - Failed
        x-nullable: true
        x-order: 1
      errorMessage:
        description: Specifies the error details if replication status is 'Failed'.
        type: string
        x-nullable: true
        x-order: 2
      startTimeUsecs:
        description: Specifies the replication start time in micro seconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      endTimeUsecs:
        description: Specifies the replication complete time in micro seconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      percentageCompleted:
        description: Specifies the percentage completed in the replication.
        type: integer
        format: int32
        x-nullable: true
        x-order: 5
      logicalSizeBytes:
        description: Specifies the total amount of logical data to be transferred
          for this replication.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      logicalBytesTransferred:
        description: Specifies the number of logical bytes transferred for this replication
          so far. This value can never exceed the total logical size of the replicated
          view.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      physicalBytesTransferred:
        description: Specifies the number of bytes sent over the wire for this replication
          so far.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
      targetClusterId:
        description: Specifies the failover target cluster id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
      targetClusterIncarnationId:
        description: Specifies the failover target cluster incarnation id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 10
      targetClusterName:
        description: Specifies the failover target cluster name.
        type: string
        x-nullable: true
        x-order: 11
  FailoverRunConfiguration:
    description: Specifies the configuration required for execting special run as
      a part of failover workflow. This special run is triggered during palnned failover
      to sync the source cluster to replication cluster with minimum possible delta.
      Please note that if this object is passed then this special run will ignore
      the other archivals and retention settings.
    type: object
    required:
    - replicationClusterId
    - objects
    - protectionGroupId
    properties:
      replicationClusterId:
        description: Specifies the replication cluster Id where planned run will replicate
          objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      objects:
        description: Specifies the list of all local entity ids of all the objects
          being failed from the source cluster.
        type: array
        items:
          $ref: '#/definitions/FailoverObject'
        x-nullable: true
        x-order: 1
      protectionGroupId:
        description: Specifies the active protection group id on the source cluster
          from where the objects are being failed over.
        type: string
        x-nullable: true
        x-order: 2
      runType:
        description: Specifies the type of the backup run to be triggered by this
          request. If this is not set defaults to incremental backup.
        type: string
        enum:
        - kAll
        - kLog
        - kSystem
        - kIncremental
        - kFull
        x-order: 3
      viewId:
        description: If failover is initiated by view based orchastrator, then this
          field specifies the local view id of source cluster which is being failed
          over.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      cancelNonFailoverRuns:
        description: If set to true, other ongoing runs backing up the same set of
          entities being failed over will be initiated for cancellation. Non conflicting
          run operations such as replications to other clusters, archivals will not
          be cancelled. If set to false, then new run will wait for all the pending
          operations to finish normally before scheduling a new backup/replication.
        type: boolean
        x-nullable: true
        x-order: 5
      pauseNextRuns:
        description: If this is set to true then unless failover operation is completed,
          all the next runs will be pasued.
        type: boolean
        x-nullable: true
        x-order: 6
  FailoverRunsResponse:
    description: Specifies the response upon creating a special run during failover
      workflow.
    type: object
    properties:
      failoverPlannedRuns:
        description: Specifies the list of planned runs created during various planeed
          failover workflows. Each planned run is uniqely identified by falioverId
          and runId.
        type: array
        items:
          $ref: '#/definitions/PlannedRunPollStatus'
        x-nullable: true
        x-order: 0
  FailoverSourceCluster:
    description: Specifies the details about source cluster involved in the failover
      operation.
    type: object
    title: Failover source cluster.
    required:
    - id
    properties:
      id:
        description: Specifies the source cluster Id involved in failover operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      incarnationId:
        description: Specifies the source cluster incarnation Id involved in failover
          operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
        readOnly: true
      protectionGroupId:
        description: Specifies the protection group Id involved in failover operation.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
      viewId:
        description: If failover is initiated by view based orchastrator, then this
          field specifies the local view id of source cluster which is being failed
          over.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
        readOnly: true
  FallbackUserIdMappingParams:
    description: Specifies a fallback param for Unix and Windows users mapping.
    type: object
    required:
    - type
    properties:
      type:
        description: Specifies the type of the mapping.
        type: string
        enum:
        - Rid
        - Fixed
        x-order: 0
      fixedTypeParams:
        description: Specifies the params for Fixed mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdFixedTypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  File:
    description: Specifies a File.
    title: File
    allOf:
    - type: object
      properties:
        name:
          description: Specifies the file name.
          type: string
          x-nullable: true
          x-order: 0
        path:
          description: Specifies the path to this file.
          type: string
          x-nullable: true
          x-order: 1
        type:
          description: Specifies the file type.
          type: string
          enum:
          - File
          - Directory
          - Symlink
          x-nullable: true
          x-order: 2
        protectionGroupId:
          description: '"Specifies the protection group id which contains this file."'
          type: string
          x-nullable: true
          x-order: 3
        protectionGroupName:
          description: '"Specifies the protection group name which contains this file."'
          type: string
          x-nullable: true
          x-order: 4
        storageDomainId:
          description: '"Specifies the Storage Domain id where the backup data of
            Object

            is present."'
          type: integer
          format: int64
          x-nullable: true
          x-order: 5
        sourceInfo:
          description: Specifies the Source Object information.
          allOf:
          - $ref: '#/definitions/ObjectSummary'
          - x-nullable: true
          x-order: 6
    - $ref: '#/definitions/TagObject'
  FileExtensionFilter:
    type: object
    properties:
      fileExtensionsList:
        description: The list of file extensions to apply
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      isEnabled:
        description: If set, it enables the file extension filter
        type: boolean
        x-nullable: true
        x-order: 1
      mode:
        description: 'The mode applied to the list of file extensions

          ''Whitelist'' indicates a whitelist extension filter.

          ''Blacklist'' indicates a blacklist extension filter.'
        type: string
        enum:
        - Whitelist
        - Blacklist
        x-nullable: true
        x-order: 2
  FileFilteringPolicy:
    description: 'Specifies a set of filters for a file based Protection Group.

      These values are strings which can represent a prefix or suffix.

      Example: ''/tmp'' or ''*.mp4''. For file based Protection Groups, all files

      under prefixes specified by the ''includeFilters'' list will be protected

      unless they are explicitly excluded by the ''excludeFilters'' list.'
    type: object
    properties:
      includeList:
        description: Specifies the list of included files for this Protection Group.
        type: array
        items:
          type: string
        x-order: 0
      excludeList:
        description: 'Specifies the list of excluded files for this protection

          Protection Group. Exclude filters have a higher priority than include

          filters.'
        type: array
        items:
          type: string
        x-order: 1
  FileLevelDataLockConfig:
    description: 'Specifies a config to lock files in a view - to protect from malicious
      or

      an accidental attempt to delete or modify the files in this view.'
    type: object
    title: File Level Data Lock Configurations.
    properties:
      autoLockAfterDurationIdleMsecs:
        description: 'Specifies the duration to lock a file that has not been accessed
          or

          modified (ie. has been idle) for a certain duration of time in

          milliseconds. Do not set if it is required to disable auto lock.'
        type: integer
        format: uint64
        x-nullable: true
        x-order: 0
      defaultRetentionDurationMsecs:
        description: 'Specifies a global default retention duration for files in this
          view, if

          file lock is enabled for this view. Also, it is a required field if file

          lock is enabled. Set to -1 if the required default retention period is

          forever.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      expiryTimestampMsecs:
        description: Specifies a definite timestamp in milliseconds for retaining
          the file.
        type: integer
        format: uint64
        x-nullable: true
        x-order: 2
      lockingProtocol:
        description: 'Specifies the supported mechanisms to explicity lock a file
          from NFS/SMB

          interface. Supported locking protocols: SetReadOnly, SetAtime.

          ''SetReadOnly'' is compatible with Isilon/Netapp behaviour. This locks the

          file and the retention duration is determined in this order:

          1) atime, if set by user/application and within min and max retention

          duration.

          2) Min retention duration, if set.

          3) Otherwise, file is switched to expired data automatically.

          ''SetAtime'' is compatible with Data Domain behaviour.'
        type: string
        enum:
        - SetReadOnly
        - SetAtime
        x-nullable: true
        x-order: 3
      maxRetentionDurationMsecs:
        description: 'Specifies a maximum duration in milliseconds for which any file
          in this

          view can be retained for. Set to -1 if the required retention duration is

          forever. If set, it should be greater than or equal to the default

          retention period as well as the min retention period.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      minRetentionDurationMsecs:
        description: 'Specifies a minimum retention duration in milliseconds after
          a file gets

          locked. The file cannot be modified or deleted during this timeframe. Set

          to -1 if the required retention duration is forever. This should be set

          less than or equal to the default retention duration.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      mode:
        description: 'Specifies the mode of file level datalock.

          Enterprise mode can be upgraded to Compliance mode, but Compliance mode

          cannot be downgraded to Enterprise mode.

          Compliance: This mode would disallow all user to delete/modify file or

          view under any condition when it ''s in locked status except for deleting

          view when the view is empty.

          Enterprise: This mode would follow the rules as compliance mode for

          normal users. But it would allow the storage admin

          (1) to delete view or file anytime no matter

          it is in locked status or expired.

          (2) to rename the view

          (3) to bring back the retention period when it''s in locked mode

          A lock mode of a file in a view can be in one of the following:

          ''Compliance'': Default mode of datalock, in this mode, Data Security Admin

          cannot modify/delete this view when datalock is in effect. Data Security

          Admin can delete this view when datalock is expired.

          ''kEnterprise'' : In this mode, Data Security Admin can change view name
          or

          delete view when datalock is in effect. Datalock in this mode can be

          upgraded to ''Compliance'' mode.'
        type: string
        enum:
        - Compliance
        - Enterprise
        x-nullable: true
        x-order: 6
  FileSizePolicy:
    description: 'Specifies the file''s selection rule by file size eg.

      1. select files greather than 10 Bytes.

      2. select files less than 20 TiB.

      3. select files greather than 5 MiB.

      type: object'
    properties:
      condition:
        description: Specifies condition for the file selection.
        type: string
        enum:
        - GreaterThan
        - SmallerThan
        x-nullable: true
        x-order: 0
      nBytes:
        description: Specifies the number of bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  FileSizeRuleCondition:
    description: Data tiering task file size rule condition type.
    type: object
    title: Data tiering task file size rule condition type.
    properties:
      type:
        description: Specifies the data tiering task file size rule condition type.
        type: string
        enum:
        - GreaterThan
        - SmallerThan
        x-order: 0
  FileType:
    description: Describes file types.
    type: object
    title: File Type.
    properties:
      enum:
        description: Specifies the file type
        type: string
        enum:
        - File
        - Directory
        - Symlink
        x-order: 0
  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
        x-nullable: true
        x-order: 0
      filenamePattern:
        description: 'Specifies a pattern to be matched with filenames. This can be
          a

          regex expression.'
        type: string
        x-nullable: true
        x-order: 1
  FilerAuditLogConfigs:
    description: Specifies the filer audit log configs.
    type: object
    properties:
      sharePermissions:
        description: Specifies a list of share level permissions.
        type: array
        items:
          $ref: '#/definitions/SmbPermission'
        x-nullable: true
        x-order: 0
      subnetWhitelist:
        description: Specifies a list of Subnets with IP addresses that have permissions
          to access a Cohesity View containing filer audit logs.
        type: array
        items:
          $ref: '#/definitions/Subnet'
        x-nullable: true
        x-order: 1
      overrideGlobalSubnetWhitelist:
        description: Specifies whether view level client subnet whitelist overrides
          cluster and global setting.
        type: boolean
        x-nullable: true
        x-order: 2
      smbMountPaths:
        description: Specifies a list of SMB mount paths of a Cohesity View containing
          filer audit logs.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      nfsMountPath:
        description: This field is currently deprecated. Please use NFS MountPaths
          which would be an array of strings.
        type: string
        x-nullable: true
        x-order: 4
        readOnly: true
      nfsMountPaths:
        description: Specifies a list of NFS mount paths of a Cohesity View containing
          filer audit logs.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 5
        readOnly: true
  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
        x-nullable: true
        x-order: 0
      isDirectory:
        description: Specifies whether the file or folder object is a directory.
        type: boolean
        x-nullable: true
        x-order: 1
  Filter:
    description: Specifies the filter details.
    type: object
    properties:
      filterString:
        description: Specifies the filter string using wildcard supported strings
          or regular expressions.
        type: string
        x-nullable: true
        x-order: 0
      isRegularExpression:
        description: Specifies whether the provided filter string is a regular expression
          or not. This need to be explicitly set to true if user is trying to filter
          by regular expressions. Not providing this value in case of regular expression
          can result in unintended results. The default value is assumed to be false.
        type: boolean
        default: false
        x-nullable: true
        x-order: 1
  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
        enum:
        - NONE
        - ID
        - CONTENT
        x-nullable: true
        x-order: 0
      idRegex:
        description: A regular expression to match Documents ID's to be restored.
        type: string
        x-nullable: true
        x-order: 1
      filterExpression:
        description: A filter expression to match Documents content to be restored.
        type: string
        x-nullable: true
        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
        items:
          type: string
        x-nullable: true
        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
        items:
          type: string
        x-nullable: true
        x-order: 1
  FilterObjectsRequest:
    description: Specifies the filter details.
    type: object
    required:
    - filterType
    - filters
    - objectIds
    properties:
      filterType:
        description: Specifies the type of filtering user wants to perform. Currently,
          we only support exclude type of filter.
        type: string
        enum:
        - exclude
        x-nullable: true
        x-order: 0
      filters:
        description: Specifies the list of filters that need to be applied on given
          list of discovered objects.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/Filter'
        x-nullable: true
        x-order: 1
      objectIds:
        description: Specifies a list of non leaf object ids to filter the leaf level
          objects. Non leaf object such host (physical or vm) or database instance
          can be specified.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 2
      applicationEnvironment:
        description: Specifies the type of application enviornment needed for filtering
          to be applied on. This is needed because in case of applications like SQL,
          Oracle, a single source can contain multiple application enviornments.
        type: string
        enum:
        - kSQL
        x-nullable: true
        x-order: 3
      tenantIds:
        description: TenantIds contains list of the tenant for which objects are to
          be returned.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 4
      includeTenants:
        description: If true, the response will include objects which belongs to all
          tenants which the current user has permission to see. Default value is false.
        type: boolean
        default: false
        x-nullable: true
        x-order: 5
  FilteredObject:
    description: Specifies the filter details.
    type: object
    properties:
      id:
        description: Specifies object id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      sourceId:
        description: Specifies the source id to which this object belongs to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  FilteredObjectsResponseBody:
    description: Specifies the filter details.
    type: object
    properties:
      filteredObjects:
        description: Specifies the list of filtered Objects.
        type: array
        items:
          $ref: '#/definitions/FilteredObject'
        x-nullable: true
        x-order: 0
  FixedIssue:
    description: Specifies the description of a fixed issue.
    title: Fixed Issue.
    properties:
      id:
        description: Specifies a unique number of the bug.
        type: integer
        format: int64
        x-order: 0
      releaseNote:
        description: Specifies the description of fix made for the issue.
        type: string
        x-order: 1
  FlashBladeRegistrationInfo:
    description: Specifies the information specific to flashblade registration.
    type: object
    required:
    - apiToken
    properties:
      ip:
        description: Specifies management ip of pure flashblade server.
        type: string
        x-nullable: true
        x-order: 0
      apiToken:
        description: Specifies the api token of the pure flashblade.
        type: string
        x-nullable: true
        x-order: 1
  FlashbladeObjectParams:
    description: Specifies the common parameters for Flashblade objects.
    type: object
    properties:
      supportedNasMountProtocols:
        description: Specifies a list of NAS mount protocols supported by this object.
        type: array
        items:
          type: string
          enum:
          - kNfs
          - kCifs2
          - kHttp
        x-nullable: true
        x-order: 0
  FlashbladeObjectProtectionParams:
    description: Specifies the parameters which are specific to Flashblade object
      protection.
    type: object
    properties:
      protocol:
        description: Specifies the protocol of the NAS device being backed up.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 0
  FlashbladeObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to Flashblade object
      protection.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to be protected.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/definitions/ProtectionObjectInput'
          x-order: 0
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/FlashbladeObjectProtectionParams'
  FlashbladeObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to Flashblade object
      protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/FlashbladeObjectProtectionParams'
  FlashbladeObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters which are specific to Flashblade
      object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/FlashbladeObjectProtectionParams'
  FlashbladeParams:
    description: Specifies the information related to Registered Pure Flashblade.
    type: object
    properties:
      registrationParams:
        description: Specifies the parameters to register a VMware Protection Source.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/FlashBladeRegistrationInfo'
      uuid:
        description: Specifies uuid of the pure flashblade server.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      assignedDataVips:
        description: Specifies list of data vips that are assigned to cohesity cluster
          to create nfs share mountpoints.
        type: array
        minItems: 1
        items:
          type: string
        x-nullable: true
        x-order: 2
      assignedCapacityBytes:
        description: Specifies the capacity in bytes assigned on pure flashblade for
          remote storage usage on cohesity cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      isDedicatedStorage:
        description: If true, cohesity cluster uses all available capacity on pure
          flashblade for remote storage.
        type: boolean
        x-nullable: true
        x-order: 4
      availableDataVips:
        description: Available data vips configured on pure flashblade.
        type: array
        items:
          type: string
          x-nullable: true
        x-order: 5
        readOnly: true
      availableCapacity:
        description: Available capacity on pure flashblade.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
        readOnly: true
      createdFileSystemCount:
        description: Number of new file systems created on pure flashblade when assignedCapacityBytes
          is updated.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
        readOnly: true
      updatedFileSystemCount:
        description: Number of file systems that are updated on pure flashblade when
          assignedCapacityBytes is updated.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
        readOnly: true
      softwareOsVersion:
        description: Software OS and version running on pure flashblade
        type: string
        x-nullable: true
        x-order: 9
        readOnly: true
      name:
        description: Name of the pure flashblade specified on pure storage.
        type: string
        x-nullable: true
        x-order: 10
        readOnly: true
      totalCapacity:
        description: Total capacity of pure flashblade.
        type: integer
        format: int64
        x-nullable: true
        x-order: 11
        readOnly: true
  FlashbladeProtectionGroupObjectParams:
    description: Specifies an object protected by a Flashblade Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  FlashbladeProtectionGroupParams:
    description: Specifies the parameters which are specific to Flashblade related
      Protection Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/FlashbladeProtectionGroupObjectParams'
        x-order: 0
      directCloudArchive:
        description: Specifies whether or not to store the snapshots in this run directly
          in an Archive Target instead of on the Cluster. If this is set to true,
          the associated policy must have exactly one Archive Target associated with
          it and the policy must be set up to archive after every run. Also, a Storage
          Domain cannot be specified. Default behavior is 'false'.
        type: boolean
        x-nullable: true
        x-order: 1
      nativeFormat:
        description: Specifies whether or not to enable native format for direct archive
          job. This field is set to true if native format should be used for archiving.
        type: boolean
        x-nullable: true
        x-order: 2
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/IndexingPolicy'
      protocol:
        description: Specifies the preferred protocol to use if this device supports
          multiple protocols.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 4
      continueOnError:
        description: Specifies whether or not the Protection Group should continue
          regardless of whether or not an error was encountered.
        type: boolean
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether the protection group should use encryption
          while backup or not.
        type: boolean
        x-nullable: true
        x-order: 6
      fileLockConfig:
        description: Optional config that enables file locking for this view. It cannot
          be disabled during the edit of a view, if it has been enabled during the
          creation of the view. Also, it cannot be enabled if it was disabled during
          the creation of the view.
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/FileLevelDataLockConfig'
      fileFilters:
        description: Specifies file paths to include or exclude.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/FileFilteringPolicy'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 10
        readOnly: true
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the protection group.
        type: object
        x-nullable: true
        x-order: 11
        $ref: '#/definitions/HostBasedBackupScriptParams'
      filterIpConfig:
        description: Specifies the list of IP addresses that are allowed or denied
          at the job level. Allowed IPs and Denied IPs cannot be used together.
        type: object
        x-nullable: true
        x-order: 12
        $ref: '#/definitions/FilterIpConfig'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          full or incremental backup of the NAS source.
        x-nullable: true
        x-order: 13
        $ref: '#/definitions/NasThrottlingConfig'
    x-nullable: true
  FlashbladeProtocol:
    description: Flashblade Protocol type.
    type: object
    title: Flashblade Protocol type.
    properties:
      flashbladeProtocol:
        description: Specifies Flashblade Protocol type.
        type: string
        enum:
        - kNfs
        - kCifs2
        - kHttp
        x-order: 0
  FlashbladeRegistrationParams:
    description: Specifies parameters to register an Flashblade Source.
    type: object
    title: Flashblade Protection Source.
    required:
    - endpoint
    properties:
      endpoint:
        description: Specifies the Hostname or IP Address Endpoint for the Flashblade
          Source.
        type: string
        x-nullable: true
        x-order: 0
      apiToken:
        description: Specifies the API Token of the Flashblade Source
        type: string
        x-nullable: true
        x-order: 1
      backUpSMBVolumes:
        description: Specifies whether or not to back up SMB Volumes.
        type: boolean
        x-nullable: true
        x-order: 2
      smbCredentials:
        description: Specifies the credentials for SMB Volumes. Must be specified
          if backUpSMBVolumes is set to true.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/SmbMountCredentials'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          registration of the NAS source.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/NasThrottlingConfig'
  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
        enum:
        - kCluster
        - kSourceVM
        - kCustom
        x-nullable: true
        x-order: 0
      fleetNetworkParams:
        description: Specifies the network security groups within above VPC.
        allOf:
        - $ref: '#/definitions/FleetNetworkParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      fleetTags:
        description: Specifies the network security groups within above VPC.
        type: array
        items:
          $ref: '#/definitions/FleetTags'
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        x-order: 0
      subnet:
        description: Specifies subnet for the fleet.
        type: string
        x-nullable: true
        x-order: 1
  FleetSubnetType:
    description: Fleet Subnet Type
    type: object
    title: Fleet Subnet Type
    properties:
      fleetSubnetType:
        description: Specifies the fleet type of the subnet.
        type: string
        enum:
        - kCluster
        - kSourceVM
        - kCustom
        x-order: 0
  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
        x-nullable: true
        x-order: 0
      value:
        description: Specifies value for the fleet tag.
        type: string
        x-nullable: true
        x-order: 1
  FolderItem:
    description: Specifies an email folder to recover.
    type: object
    required:
    - key
    properties:
      key:
        description: Specifies the email folder key.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      recoverEntireFolder:
        description: Specifies whether to recover the whole email folder.
        type: boolean
        x-nullable: true
        x-order: 1
      itemIds:
        description: Specifies a list of item ids to recover. This field is applicable
          only if 'recoverEntireFolder' is false.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
  FreeDisk:
    description: Specifies the details of a free disk.
    type: object
    title: FreeDisk
    required:
    - serialNumber
    properties:
      location:
        description: Specifies the location of disk.
        type: string
        x-nullable: true
        x-order: 0
      serialNumber:
        description: Specifies serial number of disk.
        type: string
        x-nullable: true
        x-order: 1
      path:
        description: Specifies path of disk.
        type: string
        x-nullable: true
        x-order: 2
      sizeInBytes:
        description: Size of disk.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  FrequencySchedule:
    description: Specifies settings that define a daily schedule for a Protection
      Policy.
    type: object
    title: Daily Schedule
    required:
    - frequency
    properties:
      frequency:
        description: 'Specifies a factor to multiply the unit by, to determine the
          backup schedule. <br> Example: If ''frequency'' set to 2 and the unit is
          ''Hours'', then Snapshots are backed up every 2 hours. <br> This field is
          only applicable if unit is ''Minutes'', ''Hours'' or ''Days''.'
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 0
  FullBackupPolicy:
    description: Specifies full backup settings for a Protection Group.
    type: object
    title: Full Backup Schedule and Retention.
    required:
    - schedule
    properties:
      schedule:
        description: Specifies the schedule settings for full backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/FullSchedule'
  FullSchedule:
    description: Specifies settings that defines how frequent full backup will be
      performed for a Protection Group.
    type: object
    title: Full Schedule
    required:
    - unit
    properties:
      unit:
        description: 'Specifies how often to start new runs of a Protection Group.
          <br>''Days'' specifies that Protection Group run starts periodically on
          every day. For full backup schedule, currently we only support frequecny
          of 1 which indicates that full backup will be performed daily. <br>''Weeks''
          specifies that new Protection Group runs start weekly on certain days specified
          using ''dayOfWeek'' field. <br>''Months'' specifies that new Protection
          Group runs start monthly on certain day of specific week. This schedule
          needs ''weekOfMonth'' and ''dayOfWeek'' fields to be set. <br>''ProtectOnce''
          specifies that groups using this policy option will run only once and after
          that group will permanently be disabled. <br> Example: To run the Protection
          Group on Second Sunday of Every Month, following schedule need to be set:
          <br> unit: ''Month'' <br> dayOfWeek: ''Sunday'' <br> weekOfMonth: ''Second'''
        type: string
        enum:
        - Days
        - Weeks
        - Months
        - ProtectOnce
        x-nullable: true
        x-order: 0
      daySchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of days.
        type: object
        x-order: 1
        $ref: '#/definitions/DaySchedule'
      weekSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on certain number of days in a week.
        type: object
        x-order: 2
        $ref: '#/definitions/WeekSchedule'
      monthSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on specific week in a month and specific days of that week.
        type: object
        x-order: 3
        $ref: '#/definitions/MonthSchedule'
  FullScheduleUnit:
    description: Full Schedule Units
    type: object
    title: FullScheduleUnit
    properties:
      fullScheduleUnit:
        description: Specifies the full schedule unit (including ProtectOnce policy).
        type: string
        enum:
        - Days
        - Weeks
        - Months
        - ProtectOnce
        x-order: 0
  GcpNativeProtectionGroupObjectParams:
    description: Specifies the object parameters to create GCP Native Protection Group.
    type: object
    title: GCP Native Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  GcpNativeProtectionGroupParams:
    description: Specifies the parameters which are specific to GCP related Protection
      Groups using GCP native snapshot APIs. Atlease one of tags or objects must be
      specified.
    type: object
    title: GCP Native Protection Group Request Params.
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/GcpNativeProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      indexingPolicy:
        description: Specifies the indexing policy for VMs in this Group.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/IndexingPolicy'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 4
        readOnly: true
  GcpProtectionGroupParams:
    description: Specifies the parameters which are specific to GCP related Protection
      Groups.
    type: object
    title: GCP Protection Group Request Params.
    required:
    - protectionType
    properties:
      protectionType:
        description: Specifies the GCP Protection Group type.
        type: string
        enum:
        - kNative
        x-order: 0
      nativeProtectionTypeParams:
        description: Specifies the parameters which are specific to GCP related Protection
          Groups using GCP native snapshot APIs.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/GcpNativeProtectionGroupParams'
  GcpProtectionGroupType:
    description: GCP Protection Group type.
    type: object
    title: GCP Protection Group type.
    properties:
      environment:
        description: Specifies GCP Protection Group type.
        type: string
        enum:
        - kNative
        x-order: 0
  GcpTargetParamsForRecoverFileAndFolder:
    description: Specifies the parameters for a GCP recovery target.
    type: object
    title: GCP Target Params for Recover File And Folder
    required:
    - targetVm
    - recoverToOriginalPaths
    - targetVmCredentials
    properties:
      targetVm:
        description: Specifies the target VM to recover files and folders to.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      recoverToOriginalPaths:
        description: Specifies whether to recover files to original places.
        type: boolean
        x-nullable: true
        x-order: 1
      targetVmCredentials:
        description: Specifies credentials to access the target VM.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      alternateBaseDirectory:
        description: Specifies a base directory under which all files and folders
          will be recovered. This is required if recoverToOriginalPaths is set to
          false.
        type: string
        x-nullable: true
        x-order: 3
      overwriteOriginals:
        description: Specifies whether to override the existing files. Default is
          true.
        type: boolean
        x-nullable: true
        x-order: 4
      preserveAttributes:
        description: Specifies whether to preserve original attributes. Default is
          true.
        type: boolean
        x-nullable: true
        x-order: 5
      continueOnError:
        description: Specifies whether to continue recovering other files if one of
          files or folders failed to recover. Default value is false.
        type: boolean
        x-nullable: true
        x-order: 6
      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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/GcpVmRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 3
  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: '#/definitions/RecoverGcpVmNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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
        format: int64
        x-nullable: true
        x-order: 0
      subnetName:
        description: Specifies the name of the subnet.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      vpcName:
        description: Specifies the name of the vpc network.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
  GenericNasDataTieringParams:
    description: Specifies the parameters which are specific to NAS related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ProtectionObjectInput'
        x-order: 0
  GenericNasObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to Generic NAS object
      protection.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to be protected.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/definitions/ProtectionObjectInput'
          x-order: 0
    - $ref: '#/definitions/CommonNasProtectionParams'
  GenericNasObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to Generic NAS object
      protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
  GenericNasObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters which are specific to Generic NAS
      object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
  GenericNasProtectionGroupExtraParams:
    description: Specifies the extra parameters which are specific to NAS related
      Protection Groups.
    type: object
    properties:
      directCloudArchive:
        description: Specifies whether or not to store the snapshots in this run directly
          in an Archive Target instead of on the Cluster. If this is set to true,
          the associated policy must have exactly one Archive Target associated with
          it and the policy must be set up to archive after every run. Also, a Storage
          Domain cannot be specified. Default behavior is 'false'.
        type: boolean
        x-nullable: true
        x-order: 0
      nativeFormat:
        description: Specifies whether or not to enable native format for direct archive
          job. This field is set to true if native format should be used for archiving.
        type: boolean
        x-nullable: true
        x-order: 1
  GenericNasProtectionGroupParams:
    description: Specifies the parameters which are specific to NAS related Protection
      Groups.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to be included in the Protection Group.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/definitions/ProtectionObjectInput'
          x-order: 0
    - $ref: '#/definitions/CommonGenericNasProtectionParams'
    - $ref: '#/definitions/GenericNasProtectionGroupExtraParams'
  GenericNasRegistrationParams:
    description: Specifies parameters to register GenericNas MountPoint.
    type: object
    title: Generic NAS Protection Source.
    required:
    - mountPoint
    - mode
    properties:
      mountPoint:
        description: Specifies the MountPoint for Generic NAS Source.
        type: string
        x-nullable: true
        x-order: 0
      mode:
        description: 'Specifies the mode of the source.

          ''kNfs3'' indicates NFS mode.

          ''kCifs1'' indicates SMB mode.'
        type: string
        enum:
        - kNfs3
        - kCifs1
        x-nullable: true
        x-order: 1
      description:
        description: Specifies the Description for Generic NAS Source.
        type: string
        x-nullable: true
        x-order: 2
      skipValidation:
        description: Specifies if validation has to be skipped while registering the
          mount point.
        type: boolean
        x-nullable: true
        x-order: 3
      smbMountCredentials:
        description: Specifies the credentials to mount a SMB view. Must be specified
          if protocol is set to SMB.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/SmbMountCredentials'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          registration of the NAS source.
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/NasThrottlingConfig'
  GetCsrListResponseBody:
    description: Specifies the list of CSRs.
    type: array
    title: Get CSR List response
    items:
      $ref: '#/definitions/CommonCsrResponseParams'
    x-nullable: true
  GetIndexedObjectSnapshotsResponseBody:
    description: Specifies the snapshots of an indexed object.
    type: object
    properties:
      snapshots:
        description: Specifies a list of snapshots containing the indexed object.
        type: array
        items:
          $ref: '#/definitions/IndexedObjectSnapshot'
        x-nullable: true
        x-order: 0
  GetObjectRunsResponseBody:
    description: Specifies the response body of the get object run request.
    title: Get Object Run Response Body.
    properties:
      protectionRuns:
        description: Specifies the protection runs of the given object.
        type: array
        items:
          $ref: '#/definitions/ObjectProtectionRunSummary'
        x-order: 0
      paginationInfo:
        description: Specifies the information needed in order to support pagination.
          This will not be included for the last page of results.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/PaginationInfo'
  GetObjectSnapshotsResponseBody:
    description: Specifies the list of object snapshots.
    type: object
    title: Object Snapshots.
    properties:
      snapshots:
        description: Specifies the list of snapshots.
        type: array
        items:
          $ref: '#/definitions/ObjectSnapshot'
        x-nullable: true
        x-order: 0
  GetPITRangesProtectedObjectResponseBody:
    description: Specifies the points in time available for restore as a set of one
      or more time ranges. If the number of available ranges exceeds 1000, then the
      latest 1000 will be returned.
    type: object
    title: Points in time for restore
    properties:
      timeRanges:
        description: Specifies the time ranges within which this object can be restored
          to any point in time. If the number of available ranges exceeds 1000, then
          the latest 1000 will be returned.
        type: array
        items:
          $ref: '#/definitions/RecoveryTimeRangeInfo'
        x-nullable: true
        x-order: 0
  GetProtectedObjectResponse:
    description: Specifies the protected objects response.
    type: object
    properties:
      object:
        description: Specifies the protected object backup configuration and lastRun
          details if it has happned.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/ProtectedObjectInfo'
  GetProtectedObjectsResponse:
    description: Specifies the protected objects response.
    type: object
    properties:
      objects:
        description: Specifies the protected object backup configuration and lastRun
          details if it has happned.
        type: array
        items:
          $ref: '#/definitions/ProtectedObjectInfo'
        x-nullable: true
        x-order: 0
      paginationInfo:
        description: Specifies the information needed in order to support pagination.
          This will not be included for the last page of results.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/PaginationInfo'
  GetProtectionRunProgressBody:
    description: Specifies the progress of a protection run.
    type: object
    properties:
      localRun:
        description: Progress for the local backup run.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/BackupRunProgressInfo'
      archivalRun:
        description: Progress for the archival run.
        type: array
        items:
          $ref: '#/definitions/ArchivalTargetProgressInfo'
        x-nullable: true
        x-order: 1
      replicationRun:
        description: Progress for the replication run.
        type: array
        items:
          $ref: '#/definitions/ReplicationTargetProgressInfo'
        x-nullable: true
        x-order: 2
  GetProtectionRunsStatusResponseBody:
    description: Specifies a list of protection runs stats taken at different time.
    properties:
      protectionRunsStatsList:
        description: Specifies a list of protection runs stats taken at different
          time.
        type: array
        items:
          $ref: '#/definitions/ProtectionRunsStatsList'
        x-nullable: true
        x-order: 0
  GetTagsResult:
    description: List tags result
    type: array
    title: List tags result.
    items:
      $ref: '#/definitions/Tag'
  GetViewFailoverResponseBody:
    description: Specifies planned failovers and unplanned failovers of a view.
    type: object
    properties:
      failovers:
        description: Specifies a list of failovers.
        type: array
        items:
          $ref: '#/definitions/Failover'
        x-nullable: true
        x-order: 0
  GetViewTemplatesResult:
    description: 'Specifies the list of view template returned that matched the specified
      filter

      criteria.'
    type: object
    title: Get view templates Result.
    properties:
      Templates:
        description: 'Array of view template.

          Specifies the list of view templates returned in this response.'
        type: array
        items:
          $ref: '#/definitions/Template'
        x-nullable: true
        x-order: 0
  GetViewsResult:
    description: 'Specifies the list of Views returned that matched the specified
      filter

      criteria.'
    type: object
    title: Get Views Result.
    properties:
      views:
        description: 'Array of Views.

          Specifies the list of Views returned in this response.

          The list is sorted by decreasing View ids.'
        type: array
        items:
          $ref: '#/definitions/View'
        x-nullable: true
        x-order: 0
      lastResult:
        description: 'If false, more Views are available to return. If the number
          of

          Views to return exceeds the number of Views specified in maxCount

          (default of 1000) of the original GET /public/views request,

          the first set of Views are returned and this field returns false.

          To get the next set of Views, in the next GET /public/views request

          send the last id from the previous viewList.'
        type: boolean
        x-nullable: true
        x-order: 1
      count:
        description: 'Number of views returned. This will only be returned if ViewCountOnly
          is

          set in arguments.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  GoogleTier:
    description: Specifies the settings for a Google tier.
    type: object
    allOf:
    - $ref: '#/definitions/CommonCloudTierSettings'
    - type: object
      required:
      - tierType
      properties:
        tierType:
          description: Specifies the Google tier types.
          type: string
          enum:
          - kGoogleStandard
          - kGoogleRegional
          - kGoogleMultiRegional
          - kGoogleNearline
          - kGoogleColdline
          x-nullable: true
          x-order: 0
  GoogleTieringLevels:
    description: Google Tiering Levels
    type: object
    title: Google Tiering Levels.
    properties:
      type:
        description: Google Tiering Levels
        type: string
        enum:
        - kGoogleStandard
        - kGoogleRegional
        - kGoogleMultiRegional
        - kGoogleNearline
        - kGoogleColdline
        x-order: 0
  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
        minLength: 1
        items:
          $ref: '#/definitions/GoogleTier'
        x-nullable: true
        x-order: 0
  GpfsObjectProtectionParams:
    description: Specifies the parameters which are specific to Gpfs object protection.
    type: object
    properties:
      protocol:
        description: Specifies the protocol of the NAS device being backed up.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 0
  GpfsObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to Gpfs object protection.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to be protected.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/definitions/ProtectionObjectInput'
          x-order: 0
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/GpfsObjectProtectionParams'
  GpfsObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to Gpfs object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/GpfsObjectProtectionParams'
  GpfsObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters which are specific to Gpfs object
      protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/GpfsObjectProtectionParams'
  GpfsProtectionGroupObjectParams:
    description: Specifies an object protected by a GPFS Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  GpfsProtectionGroupParams:
    description: Specifies the parameters which are specific to GPFS related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/GpfsProtectionGroupObjectParams'
        x-order: 0
      directCloudArchive:
        description: Specifies whether or not to store the snapshots in this run directly
          in an Archive Target instead of on the Cluster. If this is set to true,
          the associated policy must have exactly one Archive Target associated with
          it and the policy must be set up to archive after every run. Also, a Storage
          Domain cannot be specified. Default behavior is 'false'.
        type: boolean
        x-nullable: true
        x-order: 1
      nativeFormat:
        description: Specifies whether or not to enable native format for direct archive
          job. This field is set to true if native format should be used for archiving.
        type: boolean
        x-nullable: true
        x-order: 2
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/IndexingPolicy'
      protocol:
        description: Specifies the preferred protocol to use if this device supports
          multiple protocols.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 4
      continueOnError:
        description: Specifies whether or not the Protection Group should continue
          regardless of whether or not an error was encountered during protection
          group run.
        type: boolean
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether the protection group should use encryption
          while backup or not.
        type: boolean
        x-nullable: true
        x-order: 6
      fileLockConfig:
        description: Optional config that enables file locking for this view. It cannot
          be disabled during the edit of a view, if it has been enabled during the
          creation of the view. Also, it cannot be enabled if it was disabled during
          the creation of the view.
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/FileLevelDataLockConfig'
      fileFilters:
        description: Specifies file paths to include or exclude.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/FileFilteringPolicy'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 10
        readOnly: true
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the protection group.
        type: object
        x-nullable: true
        x-order: 11
        $ref: '#/definitions/HostBasedBackupScriptParams'
      filterIpConfig:
        description: Specifies the list of IP addresses that are allowed or denied
          at the job level. Allowed IPs and Denied IPs cannot be used together.
        type: object
        x-nullable: true
        x-order: 12
        $ref: '#/definitions/FilterIpConfig'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          full or incremental backup of the NAS source.
        x-nullable: true
        x-order: 13
        $ref: '#/definitions/NasThrottlingConfig'
    x-nullable: true
  GpfsRegistrationParams:
    description: Specifies parameters to register an GPFS Source.
    type: object
    title: GPFS Protection Source.
    required:
    - endpoint
    - credentials
    properties:
      endpoint:
        description: Specifies the Hostname or IP Address Endpoint for the GPFS Source.
        type: string
        x-nullable: true
        x-order: 0
      credentials:
        description: Specifies the credentials for an GPFS Source.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Credentials'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          registration of the NAS source.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/NasThrottlingConfig'
  Group:
    description: Specifies a user group object.
    type: object
    title: User Group
    properties:
      name:
        description: Specifies the name of the user group.
        type: string
        x-nullable: true
        x-order: 0
      sid:
        description: Specifies the sid of the user group.
        type: string
        x-nullable: true
        x-order: 1
      domain:
        description: Specifies the domain of the user group.
        type: string
        x-nullable: true
        x-order: 2
  HBaseAdditionalParams:
    description: Additional params for HBase protection source.
    type: object
    title: HBAse Additional Params.
    properties:
      zookeeperQuorum:
        description: The 'Zookeeper Quorum' for this HBase.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
        readOnly: true
      dataRootDirectory:
        description: The 'Data root directory' for this HBase.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      authType:
        description: Authentication type.
        type: string
        enum:
        - KERBEROS
        - NONE
        x-nullable: true
        x-order: 2
        readOnly: true
  HDFSIndexedObject:
    description: Specifies an HDFS indexed object.
    title: HDFSIndexedObject
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        type:
          description: Specifies the HDFS Object Type.
          type: string
          enum:
          - HDFSFolders
          - HDFSFiles
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the id of the indexed object.
          type: string
          x-nullable: true
          x-order: 1
  HadoopAuthType:
    description: Enumeration of all the Hadoop Authentication types.
    type: object
    title: Enumeration of all the Hadoop Authentication types.
    properties:
      HadoopAuthType:
        description: Enumeration of all the Hadoop Authentication types.
        type: string
        enum:
        - KERBEROS
        - NONE
        x-order: 0
  HadoopConnectionParams:
    description: Specifies the parameters to connect to a seed node and fetch information
      from its config file.
    title: Parameters to connect and query hdfs config file.
    required:
    - host
    - configurationDirectory
    properties:
      host:
        description: IP or hostname of any host from which the  configuration file
          can be read.
        type: string
        x-order: 0
      configurationDirectory:
        description: The directory containing the application specific config file.
          .
        type: string
        x-order: 1
      sshPasswordCredentials:
        description: SSH username + password required for reading configuration file
          and for scp backup.Either 'sshPasswordCredential' or 'sshPrivateKeyCredential'
          are required.
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: SSH password.
            type: string
            x-order: 0
          username:
            description: SSH username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 2
      sshPrivateKeyCredentials:
        description: SSH  userID + privateKey required for reading configuration file
          and for scp backup.
        type: object
        required:
        - userId
        - privateKey
        properties:
          passphrase:
            description: Passphrase for the private key.
            type: string
            x-order: 0
          privateKey:
            description: The private key.
            type: string
            x-order: 1
          userId:
            description: userId for PrivateKey credentials.
            type: string
            x-order: 2
        x-nullable: true
        x-order: 3
  HbaseIndexedObject:
    description: Specifies an Hbase indexed object.
    title: HbaseIndexedObject
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        type:
          description: Specifies the Hbase Object Type.
          type: string
          enum:
          - HbaseNamespaces
          - HbaseTables
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the id of the indexed object.
          type: string
          x-nullable: true
          x-order: 1
  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
        allOf:
        - $ref: '#/definitions/RecoverHbaseParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RecoverHbaseParams'
  HbaseSourceRegistrationParams:
    description: Specifies parameters to register an HBase source.
    title: Register HBase source request parameters.
    allOf:
    - $ref: '#/definitions/HBaseAdditionalParams'
    - type: object
      required:
      - host
      - configurationDirectory
      - hdfsSourceRegistrationID
      properties:
        host:
          description: IP or hostname of any host from which the HBase configuration
            file hbase-site.xml can be read.
          type: string
          x-order: 0
        configurationDirectory:
          description: The directory containing the hbase-site.xml.
          type: string
          x-order: 1
        sshPasswordCredentials:
          description: SSH username + password required for reading configuration
            file. Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials' are
            required.
          type: object
          required:
          - username
          - password
          properties:
            password:
              description: SSH password.
              type: string
              x-order: 0
            username:
              description: SSH username.
              type: string
              x-order: 1
          x-nullable: true
          x-order: 2
        sshPrivateKeyCredentials:
          description: SSH  userID + privateKey required for reading configuration
            file.
          type: object
          required:
          - userId
          - privateKey
          properties:
            passphrase:
              description: Passphrase for the private key.
              type: string
              x-order: 0
            privateKey:
              description: The private key.
              type: string
              x-order: 1
            userId:
              description: userId for PrivateKey credentials.
              type: string
              x-order: 2
          x-nullable: true
          x-order: 3
        hdfsSourceRegistrationID:
          description: Protection Source registration id of the HDFS on which this
            HBase is running.
          type: integer
          format: int64
          x-order: 4
        kerberosPrincipal:
          description: The kerberos principal to be used to connect to this Hbase
            source.
          type: string
          x-nullable: true
          x-order: 5
  HbaseSourceRegistrationUpdateParams:
    description: Specifies parameters to update registeration of an HBase source.
    title: Update HBase source registration parameters.
    properties:
      host:
        description: IP or hostname of any host from which the HBase configuration
          file hbase-site.xml can be read.
        type: string
        x-nullable: true
        x-order: 0
      configurationDirectory:
        description: The directory containing the hbase-site.xml.
        type: string
        x-nullable: true
        x-order: 1
      sshPasswordCredentials:
        description: SSH username + password required for reading configuration file.
          Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials' are required.
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: SSH password.
            type: string
            x-order: 0
          username:
            description: SSH username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 2
      sshPrivateKeyCredentials:
        description: SSH  userID + privateKey required for reading configuration file.
        type: object
        required:
        - userId
        - privateKey
        properties:
          passphrase:
            description: Passphrase for the private key.
            type: string
            x-order: 0
          privateKey:
            description: The private key.
            type: string
            x-order: 1
          userId:
            description: userId for PrivateKey credentials.
            type: string
            x-order: 2
        x-nullable: true
        x-order: 3
      kerberosPrincipal:
        description: The kerberos principal to be used to connect to this Hbase source.
        type: string
        x-nullable: true
        x-order: 4
  HdfsAdditionalParams:
    description: Additional params for Hdfs protection source.
    type: object
    title: Hdfs Additional Params.
    properties:
      namenodeAddress:
        description: The HDFS Namenode IP or hostname.
        type: string
        x-order: 0
        readOnly: true
      webhdfsPort:
        description: The HDFS WebHDFS port.
        type: integer
        format: int32
        x-order: 1
        readOnly: true
      authType:
        description: Authentication type.
        type: string
        enum:
        - KERBEROS
        - NONE
        x-nullable: true
        x-order: 2
        readOnly: true
  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
        allOf:
        - $ref: '#/definitions/RecoverHdfsParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RecoverHdfsParams'
  HdfsProtectionGroupParams:
    description: Specifies the parameters for HDFS Protection Group.
    type: object
    required:
    - hdfsSourceId
    properties:
      includePaths:
        description: Specifies the paths to be included in the Protection Group.
        type: array
        minItems: 1
        items:
          type: string
        x-order: 0
      excludePaths:
        description: Specifies the paths to be excluded in the Protection Group. excludePaths
          will ovrride includePaths.
        type: array
        items:
          type: string
        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
        format: int32
        x-nullable: true
        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
        format: int64
        x-nullable: true
        x-order: 3
      hdfsSourceId:
        description: The object ID of the HDFS source for this protection group.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      sourceId:
        description: Object ID of the Source on which this protection was run .
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
        readOnly: true
      indexingPolicy:
        description: Specifies settings for indexing files found in an Object so these
          files can be searched and recovered. This also specifies inclusion and exclusion
          rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/IndexingPolicy'
      sourceName:
        description: Specifies the name of the Source on which this protection was
          run.
        type: string
        x-nullable: true
        x-order: 7
        readOnly: true
  HdfsSourceRegistrationParams:
    description: Specifies parameters to register an HDFS source.
    title: Register HDFS source request parameters.
    allOf:
    - $ref: '#/definitions/HdfsAdditionalParams'
    - type: object
      required:
      - host
      - configurationDirectory
      - hadoopDistribution
      - hadoopVersion
      properties:
        host:
          description: IP or hostname of any host from which the HDFS configuration
            files core-site.xml and hdfs-site.xml can be read.
          type: string
          x-order: 0
        configurationDirectory:
          description: The directory containing the core-site.xml and hdfs-site.xml
            configuration files.
          type: string
          x-order: 1
        sshPasswordCredentials:
          description: SSH username + password required for reading configuration
            file. Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials' are
            required.
          type: object
          required:
          - username
          - password
          properties:
            password:
              description: SSH password.
              type: string
              x-order: 0
            username:
              description: SSH username.
              type: string
              x-order: 1
          x-nullable: true
          x-order: 2
        sshPrivateKeyCredentials:
          description: SSH  userID + privateKey required for reading configuration
            file.
          type: object
          required:
          - userId
          - privateKey
          properties:
            passphrase:
              description: Passphrase for the private key.
              type: string
              x-order: 0
            privateKey:
              description: The private key.
              type: string
              x-order: 1
            userId:
              description: userId for PrivateKey credentials.
              type: string
              x-order: 2
          x-nullable: true
          x-order: 3
        kerberosPrincipal:
          description: The kerberos principal to be used to connect to this HDFS source.
          type: string
          x-nullable: true
          x-order: 4
        hadoopDistribution:
          description: The hadoop distribution for this cluster. This can be either
            'CDH' or 'HDP'
          type: string
          enum:
          - CDH
          - HDP
          x-order: 5
        hadoopVersion:
          description: The hadoop version for this cluster.
          type: string
          x-order: 6
  HdfsSourceRegistrationUpdateParams:
    description: Specifies parameters to update the registeration of an HDFS source.
    title: Update HDFS source request parameters.
    properties:
      host:
        description: IP or hostname of any host from which the HDFS configuration
          files core-site.xml and hdfs-site.xml can be read.
        type: string
        x-nullable: true
        x-order: 0
      configurationDirectory:
        description: The directory containing the core-site.xml and hdfs-site.xml
          configuration files.
        type: string
        x-nullable: true
        x-order: 1
      sshPasswordCredentials:
        description: SSH username + password required for reading configuration file.
          Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials' are required.
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: SSH password.
            type: string
            x-order: 0
          username:
            description: SSH username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 2
      sshPrivateKeyCredentials:
        description: SSH  userID + privateKey required for reading configuration file.
        type: object
        required:
        - userId
        - privateKey
        properties:
          passphrase:
            description: Passphrase for the private key.
            type: string
            x-order: 0
          privateKey:
            description: The private key.
            type: string
            x-order: 1
          userId:
            description: userId for PrivateKey credentials.
            type: string
            x-order: 2
        x-nullable: true
        x-order: 3
      kerberosPrincipal:
        description: The kerberos principal to be used to connect to this HDFS source.
        type: string
        x-nullable: true
        x-order: 4
  HeliosArchivalConfig:
    description: Specifies settings for copying Snapshots External Targets (such as
      AWS or Tape). This also specifies the retention policy that should be applied
      to Snapshots after they have been copied to the specified target.
    title: Archival Target Configuration
    allOf:
    - $ref: '#/definitions/HeliosCommonTargetConfiguration'
  HeliosBackupPolicy:
    description: Specifies the backup schedule and retentions of a Protection Policy.
    type: object
    title: Backup Schedule and Retention.
    properties:
      regular:
        description: Specifies the Incremental and Full policy settings and also the
          common Retention policy settings.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosRegularBackupPolicy'
      log:
        description: Specifies the Log backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/HeliosLogBackupPolicy'
      bmr:
        description: Specifies the BMR backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/HeliosBmrBackupPolicy'
      cdp:
        description: Specifies the settings for CDP (Continious Data Protection) Protection
          policy.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/HeliosCdpBackupPolicy'
  HeliosBlackoutWindow:
    description: List of Blackout Windows. If specified, this field defines blackout
      periods when backups are not triggered..
    type: object
    title: Blackout Window
    properties:
      day:
        description: Specifies a day in the week when no new Protection Group Runs
          should be started such as 'Sunday'. If not set, the time range applies to
          all days. Specifies a day in a week such as 'Sunday', 'Monday', etc.
        type: string
        enum:
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        x-nullable: true
        x-order: 0
      startTime:
        description: Specifies the start time of the blackout time range.
        title: Blackout Start Time.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/TimeOfDay'
      endTime:
        description: Specifies the end time of the blackout time range.
        title: Blackout End Time.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/TimeOfDay'
      configId:
        description: Specifies the unique identifier for the blackout getting added.
          This field should only be set if policy is getting updated.
        type: string
        x-nullable: true
        x-order: 3
  HeliosBmrBackupPolicy:
    description: Specifies the BMR schedule in case of physical source protection.
    type: object
    title: BMR Backup (Physical) Schedule and Retention.
    properties:
      schedule:
        description: Specifies the schedule settings for BMR backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosBmrSchedule'
      retention:
        description: Specifies the Retention period of a backup in days, months or
          years.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/HeliosRetention'
  HeliosBmrSchedule:
    description: Specifies settings that defines how frequent bmr backup will be performed
      for a Protection Group.
    type: object
    title: Bmr Schedule
    properties:
      unit:
        description: Specifies how often to start new runs of a Protection Group.
          <br>'Weeks' specifies that new Protection Group runs start weekly on certain
          days specified using 'dayOfWeek' field. <br>'Months' specifies that new
          Protection Group runs start monthly on certain day of specific week.
        type: string
        enum:
        - Weeks
        - Months
        x-nullable: true
        x-order: 0
      weekSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on certain number of days in a week.
        type: object
        x-order: 1
        $ref: '#/definitions/HeliosWeekSchedule'
      monthSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on specific week in a month and specific days of that week.
        type: object
        x-order: 2
        $ref: '#/definitions/HeliosMonthSchedule'
  HeliosCdpBackupPolicy:
    description: Specifies CDP (Continious Data Protection) backup settings for a
      Protection Group.
    type: object
    title: Continious Data Protection (CDP) Policy.
    properties:
      retention:
        description: Specifies the Retention period of a log backup in days, months
          or years.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosCdpRetention'
  HeliosCdpRetention:
    description: Specifies the retention of a CDP backup.
    type: object
    properties:
      unit:
        description: Specificies the Retention Unit of a CDP backup measured in minutes
          or hours.
        type: string
        enum:
        - Minutes
        - Hours
        x-nullable: true
        x-order: 0
      duration:
        description: Specifies the duration for a cdp backup retention.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  HeliosClaimRequest:
    description: Specifies the request to register to Helios.
    type: object
    title: Register to Helios.
    required:
    - registrationToken
    properties:
      registrationToken:
        description: Specifies the Helios registration token.
        type: string
        x-nullable: true
        x-order: 0
  HeliosCloudSpinConfig:
    description: Specifies settings for copying Snapshots to Cloud. This also specifies
      the retention policy that should be applied to Snapshots after they have been
      copied to Cloud.
    title: CloudSpin Target Configuration.
    allOf:
    - $ref: '#/definitions/HeliosCommonTargetConfiguration'
  HeliosCommonTargetConfiguration:
    description: Specifies common parameters required while setting up additional
      protection target configuration.
    type: object
    title: Common Target Configuration.
    properties:
      schedule:
        description: Specifies the Id for a backup copy policy. This is generated
          when the policy is created
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosTargetSchedule'
      retention:
        description: Specifies the Retention period of backup in days, months or years
          to retain copied Snapshots on the target.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/HeliosRetention'
      copyOnRunSuccess:
        description: Specifies if Snapshots are copied from the first completely successful
          Protection Group Run or the first partially successful Protection Group
          Run occurring at the start of the replication schedule. <br> If true, Snapshots
          are copied from the first Protection Group Run occurring at the start of
          the replication schedule that was completely successful i.e. Snapshots for
          all the Objects in the Protection Group were successfully captured. <br>
          If false, Snapshots are copied from the first Protection Group Run occurring
          at the start of the replication schedule, even if first Protection Group
          Run was not completely successful i.e. Snapshots were not captured for all
          Objects in the Protection Group.
        type: boolean
        x-nullable: true
        x-order: 2
      configId:
        description: Specifies the unique identifier for the target getting added.
          This field need to be passed only when helios policies are updated.
        type: string
        x-nullable: true
        x-order: 3
  HeliosDaySchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start after certain number of days.
    title: Days Schedule
    allOf:
    - $ref: '#/definitions/HeliosFrequencySchedule'
  HeliosExtendedRetentionPolicy:
    description: Specifies additional retention policies to apply to backup snapshots.
    type: object
    title: Extended Retention Policy.
    properties:
      schedule:
        description: Specifies the schedule settings for extended retention.
        type: object
        minimum: 1
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosExtendedRetentionSchedule'
      retention:
        description: Specifies the Retention period of a backup in days, months or
          years.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/HeliosRetention'
      configId:
        description: Specifies the unique identifier for the extedned  retention getting
          added. This field should only be set if policy is getting updated.
        type: string
        x-nullable: true
        x-order: 2
      runType:
        description: 'The backup run type to which this extended retention applies
          to. If this is not set, the extended retention will be applicable to all
          non-log backup types. Currently, the only value that can be set here is
          Full.

          ''Regular'' indicates a incremental (CBT) backup. Incremental backups utilizing
          CBT (if supported) are captured of the target protection objects. The first
          run of a Regular schedule captures all the blocks.

          ''Full'' indicates a full (no CBT) backup. A complete backup (all blocks)
          of the target protection objects are always captured and Change Block Tracking
          (CBT) is not utilized.

          ''Log'' indicates a Database Log backup. Capture the database transaction
          logs to allow rolling back to a specific point in time.

          ''System'' indicates a system backup. System backups are used to do bare
          metal recovery of the system to a specific point in time.'
        type: string
        enum:
        - Regular
        - Full
        - Log
        - System
        x-nullable: true
        x-order: 3
  HeliosExtendedRetentionSchedule:
    description: Specifies a schedule frequency and schedule unit for Extended Retentions.
    type: object
    title: Extended Retention Schedule
    properties:
      unit:
        description: Specifies the unit interval for retention of Snapshots. <br>'Runs'
          means that the Snapshot copy retained after the number of Protection Group
          Runs equals the number specified in the frequency. <br>'Hours' means that
          the Snapshot copy retained hourly at the frequency set in the frequency,
          for example if scheduleFrequency is 2, the copy occurs every 2 hours. <br>'Days'
          means that the Snapshot copy gets retained daily at the frequency set in
          the frequency. <br>'Weeks' means that the Snapshot copy is retained weekly
          at the frequency set in the frequency. <br>'Months' means that the Snapshot
          copy is retained monthly at the frequency set in the Frequency. <br>'Years'
          means that the Snapshot copy is retained yearly at the frequency set in
          the Frequency.
        type: string
        enum:
        - Runs
        - Hours
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 0
      frequency:
        description: 'Specifies a factor to multiply the unit by, to determine the
          retention schedule.

          For example if set to 2 and the unit is hourly, then Snapshots from the
          first eligible Job Run for every 2 hour period is retained.'
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  HeliosFrequencySchedule:
    description: Specifies settings that define a daily schedule for a Protection
      Policy.
    type: object
    properties:
      frequency:
        description: 'Specifies a factor to multiply the unit by, to determine the
          backup schedule. <br> Example: If ''frequency'' set to 2 and the unit is
          ''Hours'', then Snapshots are backed up every 2 hours. If selected unit
          is ''Weeks'' or ''Months'' then frequency will only be applied if policy
          type is DMaas.'
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 0
  HeliosFullBackupPolicy:
    description: Specifies full backup settings for a Protection Group.
    type: object
    title: Full Backup Schedule and Retention.
    properties:
      schedule:
        description: Specifies the schedule settings for full backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosFullSchedule'
  HeliosFullSchedule:
    description: Specifies settings that defines how frequent full backup will be
      performed for a Protection Group.
    type: object
    title: Full Schedule
    properties:
      unit:
        description: 'Specifies how often to start new runs of a Protection Group.
          <br>''Days'' specifies that Protection Group run starts periodically on
          every day. For full backup schedule, currently we only support frequecny
          of 1 which indicates that full backup will be performed daily. <br>''Weeks''
          specifies that new Protection Group runs start weekly on certain days specified
          using ''dayOfWeek'' field. <br>''Months'' specifies that new Protection
          Group runs start monthly on certain day of specific week. This schedule
          needs ''weekOfMonth'' and ''dayOfWeek'' fields to be set. <br> Example:
          To run the Protection Group on Second Sunday of Every Month, following schedule
          need to be set: <br> unit: ''Month'' <br> dayOfWeek: ''Sunday'' <br> weekOfMonth:
          ''Second'''
        type: string
        enum:
        - Days
        - Weeks
        - Months
        x-nullable: true
        x-order: 0
      daySchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of days.
        type: object
        x-order: 1
        $ref: '#/definitions/HeliosDaySchedule'
      weekSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on certain number of days in a week.
        type: object
        x-order: 2
        $ref: '#/definitions/HeliosWeekSchedule'
      monthSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on specific week in a month and specific days of that week.
        type: object
        x-order: 3
        $ref: '#/definitions/HeliosMonthSchedule'
  HeliosHourSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start after certain number of hours.
    title: Hours Schedule
    allOf:
    - $ref: '#/definitions/HeliosFrequencySchedule'
  HeliosIncrementalBackupPolicy:
    description: Specifies incremental backup settings for a Protection Group.
    type: object
    title: Incremental Backup Schedule and Retention.
    properties:
      schedule:
        description: Specifies the schedule settings for incremental backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosIncrementalSchedule'
  HeliosIncrementalSchedule:
    description: Specifies settings that defines how frequent backup will be performed
      for a Protection Group.
    type: object
    title: Run Schedule
    required:
    - unit
    properties:
      unit:
        description: 'Specifies how often to start new runs of a Protection Group.
          <br>''Minutes'' specifies that Protection Group run starts periodically
          after certain number of minutes specified in ''frequency'' field. <br>''Hours''
          specifies that Protection Group run starts periodically after certain number
          of hours specified in ''frequency'' field. <br>''Days'' specifies that Protection
          Group run starts periodically after certain number of days specified in
          ''frequency'' field. <br>''Week'' specifies that new Protection Group runs
          start weekly on certain days specified using ''dayOfWeek'' field. <br>''Month''
          specifies that new Protection Group runs start monthly on certain day of
          specific week. This schedule needs ''weekOfMonth'' and ''dayOfWeek'' fields
          to be set. <br> Example: To run the Protection Group on Second Sunday of
          Every Month, following schedule need to be set: <br> unit: ''Month'' <br>
          dayOfWeek: ''Sunday'' <br> weekOfMonth: ''Second'''
        type: string
        enum:
        - Minutes
        - Hours
        - Days
        - Weeks
        - Months
        x-nullable: true
        x-order: 0
      minuteSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of minutes.
        type: object
        x-order: 1
        $ref: '#/definitions/HeliosMinuteSchedule'
      hourSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of hours.
        type: object
        x-order: 2
        $ref: '#/definitions/HeliosHourSchedule'
      daySchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of days.
        type: object
        x-order: 3
        $ref: '#/definitions/HeliosDaySchedule'
      weekSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on certain number of days in a week.
        type: object
        x-order: 4
        $ref: '#/definitions/HeliosWeekSchedule'
      monthSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on specific week in a month and specific days of that week.
        type: object
        x-order: 5
        $ref: '#/definitions/HeliosMonthSchedule'
  HeliosLogBackupPolicy:
    description: Specifies log backup settings for a Protection Group.
    type: object
    title: Log Backup (Databases) Schedule and Retention.
    properties:
      schedule:
        description: Specifies the schedule settings for log backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosLogSchedule'
      retention:
        description: Specifies the Retention period of a log backup in days, months
          or years.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/HeliosRetention'
  HeliosLogSchedule:
    description: Specifies settings that defines how frequent log backup will be performed
      for a Protection Group.
    type: object
    title: Log Schedule
    properties:
      unit:
        description: Specifies how often to start new Protection Group Runs of a Protection
          Group. <br>'Minutes' specifies that Protection Group run starts periodically
          after certain number of minutes specified in 'frequency' field. <br>'Hours'
          specifies that Protection Group run starts periodically after certain number
          of hours specified in 'frequency' field.
        type: string
        enum:
        - Minutes
        - Hours
        x-nullable: true
        x-order: 0
      minuteSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of minutes.
        type: object
        x-order: 1
        $ref: '#/definitions/HeliosMinuteSchedule'
      hourSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of hours.
        type: object
        x-order: 2
        $ref: '#/definitions/HeliosHourSchedule'
  HeliosMinuteSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start after certain number of minutes.
    title: Minutes Schedule
    allOf:
    - $ref: '#/definitions/HeliosFrequencySchedule'
  HeliosMonthSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to on specific week and specific days of that week.
    title: Month Schedule
    allOf:
    - $ref: '#/definitions/HeliosWeekSchedule'
    - type: object
      properties:
        weekOfMonth:
          description: 'Specifies the week of the month (such as ''Third'') in a Monthly
            Schedule specified by unit field as ''Months''. <br>This field is used
            in combination with ''dayOfWeek'' to define the day in the month to start
            the Protection Group Run. <br> Example: if ''weekOfMonth'' is set to ''Third''
            and day is set to ''Monday'', a backup is performed on the third Monday
            of every month.'
          type: string
          enum:
          - First
          - Second
          - Third
          - Fourth
          - Last
          x-nullable: true
          x-order: 0
  HeliosPoliciesResponseWithPagination:
    description: Specifies the list of Policies.
    type: object
    properties:
      policies:
        description: Specifies a list of policies.
        type: array
        items:
          $ref: '#/definitions/HeliosPolicyResponse'
        x-nullable: true
        x-order: 0
  HeliosPolicyRequest:
    description: Specifies the request parameters to cretae a policy.
    allOf:
    - $ref: '#/definitions/HeliosProtectionPolicy'
  HeliosPolicyResponse:
    description: Specifies the details about the Policy.
    allOf:
    - $ref: '#/definitions/HeliosProtectionPolicy'
    - type: object
      properties:
        id:
          description: Specifies a unique policy id assigned by the Helios.
          type: string
          x-nullable: true
          x-order: 0
        numLinkedPolicies:
          description: In case of global policy response, specifies the number of
            policies linked to this global policy on the cluster.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
  HeliosProtectionPolicy:
    description: Specifies common fields required to define Protection Policy on Helios.
    type: object
    required:
    - name
    - type
    properties:
      name:
        description: Specifies the name of the Protection Policy.
        type: string
        x-nullable: true
        x-order: 0
      type:
        description: Specifies the type of the Protection Policy to be created on
          Helios.
        type: string
        enum:
        - GlobalPolicy
        - DMaaSPolicy
        x-nullable: true
        x-order: 1
      backupPolicy:
        description: Specifies the backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/HeliosBackupPolicy'
      description:
        description: Specifies the description of the Protection Policy.
        type: string
        x-nullable: true
        x-order: 3
      blackoutWindow:
        description: List of Blackout Windows. If specified, this field defines blackout
          periods when new Group Runs are not started. If a Group Run has been scheduled
          but not yet executed and the blackout period starts, the behavior depends
          on the policy field AbortInBlackoutPeriod.
        type: array
        title: Blackout Window
        items:
          $ref: '#/definitions/HeliosBlackoutWindow'
        x-nullable: true
        x-order: 4
      extendedRetention:
        description: Specifies additional retention policies that should be applied
          to the backup snapshots. A backup snapshot will be retained up to a time
          that is the maximum of all retention policies that are applicable to it.
        type: array
        title: Extended Retention
        items:
          $ref: '#/definitions/HeliosExtendedRetentionPolicy'
        x-nullable: true
        x-order: 5
      remoteTargetPolicy:
        description: Specifies the remote, archival or cloudSpin targets where the
          snapshot is backed up.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/HeliosTargetsConfiguration'
      retryOptions:
        description: Specifies the retry options of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/HeliosRetryOptions'
      dataLock:
        description: "Specifies WORM retention type for the snapshots. When a WORM\
          \ retention type is specified, the snapshots of the Protection Groups using\
          \ this policy will be kept until the maximum of the snapshot retention time.\
          \ During that time, the snapshots cannot be deleted. \n'Compliance' implies\
          \ WORM retention is set for compliance reason. \n'Administrative' implies\
          \ WORM retention is set for administrative purposes."
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 8
  HeliosProtectionPolicyIdentifier:
    description: Specifies Protection Policy Identifier.
    type: object
    title: Protection Policy Identifier.
    properties:
      protectionPolicyId:
        description: Specifies Protection Policy id.
        type: string
        x-nullable: true
        x-order: 0
      protectionPolicyName:
        description: Specifies Protection Policy name.
        type: string
        x-nullable: true
        x-order: 1
  HeliosRegConfig:
    description: Specifies the Helios Registration Config.
    type: object
    title: Helios Registration Config.
    properties:
      entityType:
        description: Specifies the type of entity that is registered on Helios.
        type: string
        enum:
        - Rigel
        - Cluster
        x-nullable: true
        x-order: 0
      rigelRegConfig:
        description: Specifies the Rigel Registration Config.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RigelRegConfig'
  HeliosRegStatus:
    description: helios reg status.
    type: object
    title: Helios reg Status.
    properties:
      type:
        description: Helios reg Status.
        type: string
        enum:
        - NotDone
        - InProgress
        - Success
        - Failed
        x-order: 0
  HeliosRegularBackupPolicy:
    description: Specifies the Incremental and Full policy settings and also the common
      Retention policy settings."
    type: object
    title: Incremental, Full and Retention Policy.
    properties:
      incremental:
        description: Specifies the Incremental backup schedule and retention of a
          Protection Policy.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HeliosIncrementalBackupPolicy'
      full:
        description: Specifies the Full backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/HeliosFullBackupPolicy'
      retention:
        description: Specifies the Retention period for incremental and full backup
          in days, months or years.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/HeliosRetention'
  HeliosReplicationConfig:
    description: Specifies settings for copying Snapshots to Remote Clusters. This
      also specifies the retention policy that should be applied to Snapshots after
      they have been copied to the specified target.
    title: Replication Target Configuration
    allOf:
    - $ref: '#/definitions/HeliosCommonTargetConfiguration'
    - type: object
      properties:
        targetType:
          description: Specifies the type of target to which replication need to be
            performed.
          type: string
          enum:
          - RemoteCluster
          - AWS
          - Azure
          x-nullable: true
          x-order: 0
  HeliosRetention:
    description: Specifies the retention of a backup.
    type: object
    properties:
      unit:
        description: 'Specificies the Retention Unit of a backup measured in days,
          months or years. <br> If unit is ''Months'', then number specified in duration
          is multiplied to 30. <br> Example: If duration is 4 and unit is ''Months''
          then number of retention days will be 30 * 4 = 120 days. <br> If unit is
          ''Years'', then number specified in duration is multiplied to 365. <br>
          If duration is 2 and unit is ''Months'' then number of retention days will
          be 365 * 2 = 730 days.'
        type: string
        enum:
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 0
      duration:
        description: Specifies the duration for a backup retention. <br> Example.
          If duration is 7 and unit is Months, the retention of a backup is 7 * 30
          = 210 days.
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 1
      tiers:
        description: Specifies the list of tiers where backup will be moved. This
          will be populated only if poilcy type is DMaaS.
        type: array
        items:
          $ref: '#/definitions/HeliosTier'
        x-order: 2
        readOnly: true
  HeliosRetryOptions:
    description: Retry Options of a Protection Policy when a Protection Group run
      fails.
    type: object
    properties:
      retries:
        description: 'Specifies the number of times to retry capturing Snapshots before

          the Protection Group Run fails.'
        type: integer
        format: int32
        minimum: 0
        x-nullable: true
        x-order: 0
      retryIntervalMins:
        description: Specifies the number of minutes before retrying a failed Protection
          Group.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  HeliosTargetSchedule:
    description: Specifies a schedule frequency and schedule unit for copying Snapshots
      to backup targets.
    type: object
    title: Schedule
    properties:
      unit:
        description: Specifies the frequency that Snapshots should be copied to the
          specified target. Used in combination with multiplier. <br>'Runs' means
          that the Snapshot copy occurs after the number of Protection Group Runs
          equals the number specified in the frequency. <br>'Hours' means that the
          Snapshot copy occurs hourly at the frequency set in the frequency, for example
          if scheduleFrequency is 2, the copy occurs every 2 hours. <br>'Days' means
          that the Snapshot copy occurs daily at the frequency set in the frequency.
          <br>'Weeks' means that the Snapshot copy occurs weekly at the frequency
          set in the frequency. <br>'Months' means that the Snapshot copy occurs monthly
          at the frequency set in the Frequency. <br>'Years' means that the Snapshot
          copy occurs yearly at the frequency set in the scheduleFrequency.
        type: string
        enum:
        - Runs
        - Hours
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 0
      frequency:
        description: 'Specifies a factor to multiply the unit by, to determine the
          copy schedule.

          For example if set to 2 and the unit is hourly, then Snapshots from the
          first eligible Job Run for every 2 hour period is copied.'
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  HeliosTargetsConfiguration:
    description: Specifies the replication, archival and cloud spin targets of Protection
      Policy.
    type: object
    properties:
      replicationTargets:
        type: array
        items:
          $ref: '#/definitions/HeliosReplicationConfig'
        x-order: 0
      archivalTargets:
        type: array
        items:
          $ref: '#/definitions/HeliosArchivalConfig'
        x-order: 1
      cloudSpinTargets:
        type: array
        items:
          $ref: '#/definitions/HeliosCloudSpinConfig'
        x-order: 2
  HeliosTier:
    description: Specifies the Helios Tier details.
    type: object
    properties:
      type:
        description: Specifies the tier type.
        type: string
        enum:
        - S3
        - Glacier
        x-nullable: true
        x-order: 0
      isDefaultTier:
        description: Specifies whether the current tier will be the default tier for
          primary retention.
        type: boolean
        x-nullable: true
        x-order: 1
      unit:
        description: Specificies the time unit after which backup will be moved to
          next tier.
        type: string
        enum:
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 2
      moveAfter:
        description: Specifies the duration after which the backup will be moved to
          next tier.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  HeliosWeekSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start on certain days of week.
    title: Week Schedule
    allOf:
    - $ref: '#/definitions/HeliosFrequencySchedule'
    - type: object
      properties:
        dayOfWeek:
          description: 'Specifies a list of days of the week when to start Protection
            Group Runs. <br> Example: To run a Protection Group on every Monday and
            Tuesday, set the schedule with following values: <br>  unit: ''Weeks''
            <br>  dayOfWeek: [''Monday'',''Tuesday'']'
          type: array
          items:
            type: string
            enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          x-nullable: true
          x-order: 0
  HiveAdditionalParams:
    description: Additional params for Hive protection source.
    type: object
    title: Hive Additional Params.
    properties:
      metastoreAddress:
        description: The MetastoreAddress for this Hive.
        type: string
        x-order: 0
        readOnly: true
      metastorePort:
        description: The MetastorePort for this Hive.
        type: integer
        format: int32
        x-order: 1
        readOnly: true
      authType:
        description: Authentication type.
        type: string
        enum:
        - KERBEROS
        - NONE
        x-nullable: true
        x-order: 2
        readOnly: true
  HiveIndexedObject:
    description: Specifies a Hive indexed object.
    title: HiveIndexedObject
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        type:
          description: Specifies the Hive Object Type.
          type: string
          enum:
          - HiveDatabases
          - HiveTables
          - HivePartitions
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the id of the indexed object.
          type: string
          x-nullable: true
          x-order: 1
  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
        allOf:
        - $ref: '#/definitions/RecoverHiveParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RecoverHiveParams'
  HiveSourceRegistrationParams:
    description: Specifies parameters to register Hive source.
    title: Register Hive source request parameters.
    allOf:
    - $ref: '#/definitions/HiveAdditionalParams'
    - type: object
      required:
      - host
      - configurationDirectory
      - hdfsSourceRegistrationID
      properties:
        host:
          description: IP or hostname of any host from which the Hive configuration
            file hive-site.xml can be read.
          type: string
          x-order: 0
        configurationDirectory:
          description: The directory containing the hive-site.xml.
          type: string
          x-order: 1
        sshPasswordCredentials:
          description: SSH username + password required for reading configuration
            file.Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials' are
            required.
          type: object
          required:
          - username
          - password
          properties:
            password:
              description: SSH password.
              type: string
              x-order: 0
            username:
              description: SSH username.
              type: string
              x-order: 1
          x-nullable: true
          x-order: 2
        sshPrivateKeyCredentials:
          description: SSH  userID + privateKey required for reading configuration
            file.
          type: object
          required:
          - userId
          - privateKey
          properties:
            passphrase:
              description: Passphrase for the private key.
              type: string
              x-order: 0
            privateKey:
              description: The private key.
              type: string
              x-order: 1
            userId:
              description: userId for PrivateKey credentials.
              type: string
              x-order: 2
          x-nullable: true
          x-order: 3
        hdfsSourceRegistrationID:
          description: Protection Source registration id of the HDFS on which this
            Hive is running.
          type: integer
          format: int64
          x-order: 4
        kerberosPrincipal:
          description: The kerberos principal to be used to connect to this Hive source.
          type: string
          x-nullable: true
          x-order: 5
  HiveSourceRegistrationUpdateParams:
    description: Specifies parameters to update registration of Hive source.
    title: Update Registeration of Hive source .
    properties:
      host:
        description: IP or hostname of any host from which the Hive configuration
          file hive-site.xml can be read.
        type: string
        x-nullable: true
        x-order: 0
      configurationDirectory:
        description: The directory containing the hive-site.xml.
        type: string
        x-nullable: true
        x-order: 1
      sshPasswordCredentials:
        description: SSH username + password required for reading configuration file.
          Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials' are required.
        type: object
        required:
        - username
        - password
        properties:
          password:
            description: SSH password.
            type: string
            x-order: 0
          username:
            description: SSH username.
            type: string
            x-order: 1
        x-nullable: true
        x-order: 2
      sshPrivateKeyCredentials:
        description: SSH  userID + privateKey required for reading configuration file.
        type: object
        required:
        - userId
        - privateKey
        properties:
          passphrase:
            description: Passphrase for the private key.
            type: string
            x-order: 0
          privateKey:
            description: The private key.
            type: string
            x-order: 1
          userId:
            description: userId for PrivateKey credentials.
            type: string
            x-order: 2
        x-nullable: true
        x-order: 3
      kerberosPrincipal:
        description: The kerberos principal to be used to connect to this Hive source.
        type: string
        x-nullable: true
        x-order: 4
  HostBasedBackupScriptParams:
    description: Specifies params of a pre/post scripts to be executed before and
      after a backup run.
    type: object
    title: Host Based Backup Script Params
    required:
    - host
    properties:
      host:
        description: Specifies the host and its params.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/ScriptHost'
      preScript:
        description: Specifies the pre script and its params.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/CommonPreBackupScriptParams'
      postScript:
        description: Specifies the post script and its params.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/CommonPostBackupScriptParams'
  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
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the host object.
        type: string
        x-nullable: true
        x-order: 1
      environment:
        description: Specifies the environment of the object.
        type: string
        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-nullable: true
        x-order: 2
  HostSettingCheck:
    description: Specifies the host checking details.
    type: object
    properties:
      type:
        description: Specifies the type of host checking that was performed.
        type: string
        enum:
        - IsAgentPortAccessible
        - IsAgentRunning
        - IsSQLWriterRunning
        - AreSQLInstancesRunning
        - CheckServiceLoginsConfig
        - CheckSQLFCIVIP
        - CheckSQLDiskSpace
        x-nullable: true
        x-order: 0
      result:
        description: Specifies the result of host checking performed by agent.
        type: string
        enum:
        - Pass
        - Fail
        - Warning
        x-nullable: true
        x-order: 1
  HourSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start after certain number of hours.
    title: Hours Schedule
    allOf:
    - $ref: '#/definitions/FrequencySchedule'
  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
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/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
        x-nullable: true
        x-order: 1
      targetVmCredentials:
        description: Specifies credentials to access the target VM.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        x-order: 0
      targetVmCredentials:
        description: Specifies credentials to access the target VM.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  HyperVProtectionGroupObjectParams:
    description: Specifies the object parameters to create HyperV Protection Group.
    type: object
    title: HyperV Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  HyperVProtectionGroupParams:
    description: Specifies the parameters which are specific to HyperV related Protection
      Groups.
    type: object
    title: HyperV Protection Group Request Params.
    properties:
      protectionType:
        description: Specifies the Protection Group type. If not specified, then backup
          method is auto determined. Specifying RCT, will forcibly use RCT backup
          for all VMs in this Protection Group. Available only for VMs with hardware
          version 8.0 and above, but is more efficient. Specifying VSS, will forcibly
          use VSS backup for all VMs in this Protection Group. Available for VMs with
          hardware version 5.0 and above but is slower than RCT backup.
        type: string
        enum:
        - kAuto
        - kRCT
        - kVSS
        x-nullable: true
        x-order: 0
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        uniqueItems: true
        items:
          $ref: '#/definitions/HyperVProtectionGroupObjectParams'
        x-order: 1
      excludeObjectIds:
        description: Specifies the list of IDs of the objects to not be protected
          by this Protection Group. This can be used to ignore specific objects under
          a parent object which has been included for protection.
        type: array
        items:
          type: integer
          format: int64
          x-nullable: true
        x-order: 2
      vmTagIds:
        description: 'Array of Array of VM Tag Ids that Specify VMs to Protect. Optionally
          specify a list of VMs to protect by listing Protection Source ids of VM
          Tags in this two dimensional array. Using this two dimensional array of
          Tag ids, the Cluster generates a list of VMs to protect which are derived
          from intersections of the inner arrays and union of the outer array, as
          shown by the following example. To protect only ''Eng'' VMs in the East
          and all the VMs in the West, specify the following tag id array: [ [1101,
          2221], [3031] ], where 1101 is the ''Eng'' VM Tag id, 2221 is the ''East''
          VM Tag id and 3031 is the ''West'' VM Tag id. The inner array [1101, 2221]
          produces a list of VMs that are both tagged with ''Eng'' and ''East'' (an
          intersection). The outer array combines the list from the inner array with
          list of VMs tagged with ''West'' (a union). The list of resulting VMs are
          protected by this Protection Group.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      excludeVmTagIds:
        description: 'Array of Arrays of VM Tag Ids that Specify VMs to Exclude. Optionally
          specify a list of VMs to exclude from protecting by listing Protection Source
          ids of VM Tags in this two dimensional array. Using this two dimensional
          array of Tag ids, the Cluster generates a list of VMs to exclude from protecting,
          which are derived from intersections of the inner arrays and union of the
          outer array, as shown by the following example. For example a Datacenter
          is selected to be protected but you want to exclude all the ''Former Employees''
          VMs in the East and West but keep all the VMs for ''Former Employees'' in
          the South which are also stored in this Datacenter, by specifying the following
          tag id array: [ [1000, 2221], [1000, 3031] ], where 1000 is the ''Former
          Employee'' VM Tag id, 2221 is the ''East'' VM Tag id and 3031 is the ''West''
          VM Tag id. The first inner array [1000, 2221] produces a list of VMs that
          are both tagged with ''Former Employees'' and ''East'' (an intersection).
          The second inner array [1000, 3031] produces a list of VMs that are both
          tagged with ''Former Employees'' and ''West'' (an intersection). The outer
          array combines the list of VMs from the two inner arrays. The list of resulting
          VMs are excluded from being protected this Job.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 4
      appConsistentSnapshot:
        description: Specifies whether or not to quiesce apps and the file system
          in order to take app consistent snapshots. If not specified or false then
          snapshots will not be app consistent.
        type: boolean
        x-nullable: true
        x-order: 5
      fallbackToCrashConsistentSnapshot:
        description: Specifies whether or not to fallback to a crash consistent snapshot
          in the event that an app consistent snapshot fails.
        type: boolean
        x-nullable: true
        x-order: 6
      cloudMigration:
        description: Specifies whether or not to move the workload to the cloud.
        type: boolean
        x-nullable: true
        x-order: 7
      indexingPolicy:
        description: Specifies settings for indexing files found in an Object (such
          as a VM) so these files can be searched and recovered. This also specifies
          inclusion and exclusion rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/IndexingPolicy'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 10
        readOnly: true
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      targetVmCredentials:
        description: Specifies the credentials for the target VM.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      absolutePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
  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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for mounting to the original target.
        allOf:
        - $ref: '#/definitions/HyperVMountVolumesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for mounting to a new target.
        allOf:
        - $ref: '#/definitions/HyperVMountVolumesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      readOnlyMount:
        description: Specifies whether to perform a read-only mount. Default is false.
        type: boolean
        x-nullable: true
        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
        items:
          type: string
        x-nullable: true
        x-order: 4
      mountedVolumeMapping:
        description: Specifies the mapping of original volumes and mounted volumes
        type: array
        items:
          $ref: '#/definitions/MountedVolumeMapping'
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for recovering to the original target.
        allOf:
        - $ref: '#/definitions/HyperVRecoverFilesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for recovering to a new target.
        allOf:
        - $ref: '#/definitions/HyperVRecoverFilesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      overwriteExisting:
        description: Specifies whether to override the existing files. Default is
          true.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveAttributes:
        description: Specifies whether to preserve original attributes. Default is
          true.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/HyperVVmRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      preserveUuids:
        description: Specifies whether to preserve uuids of recovered VMs. Default
          is false.
        type: boolean
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoverHyperVVmNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverHyperVVmOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  HypervSnapshotParams:
    description: Specifies parameters of HyperV type snapshots.
    type: object
    properties:
      protectionType:
        description: Specifies the protection type of HyperV snapshots.
        type: string
        enum:
        - kAuto
        - kRCT
        - kVSS
        x-nullable: true
        x-order: 0
  IdMappingParams:
    description: Specifies the params of the user id mapping info of an Active Directory.
    type: object
    required:
    - sidMappedToUnixRootUser
    - userIdMappingParams
    properties:
      sidMappedToUnixRootUser:
        description: Specifies the sid of an Active Directory domain user mapping
          to unix root user.
        type: string
        x-nullable: true
        x-order: 0
      userIdMappingParams:
        description: Specifies the information about how the Unix and Windows users
          are mapped for this domain.
        type: object
        allOf:
        - $ref: '#/definitions/UserIdMappingParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  ImportCertificateByClientcsrRequest:
    description: Specifies the request to import a certificate.
    type: object
    required:
    - certificateServer
    - certificateClient
    properties:
      certificateServer:
        description: Specifies the server certificate to be imported.
        type: string
        x-nullable: true
        x-order: 0
      certificateClient:
        description: Specifies the client certificate to be imported.
        type: string
        x-nullable: true
        x-order: 1
  ImportCertificateByClientcsrResponseBody:
    description: Specifies the response to import a certificate.
    type: object
    title: Import Certificate Response
    properties:
      certificateServer:
        description: Specifies the server certificate.
        type: string
        x-nullable: true
        x-order: 0
      privateKey:
        description: Specifies the private key of agent.
        type: string
        x-nullable: true
        x-order: 1
      fileServerCert:
        description: Specifies the path to the file to be uploaded to server. This
          file has the server cert, id and encrypted private key
        type: string
        x-nullable: true
        x-order: 2
  IncrementalBackupPolicy:
    description: Specifies incremental backup settings for a Protection Group.
    type: object
    title: Incremental Backup Schedule and Retention.
    required:
    - schedule
    properties:
      schedule:
        description: Specifies the schedule settings for incremental backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/IncrementalSchedule'
  IncrementalSchedule:
    description: Specifies settings that defines how frequent backup will be performed
      for a Protection Group.
    type: object
    title: Run Schedule
    required:
    - unit
    properties:
      unit:
        description: 'Specifies how often to start new runs of a Protection Group.
          <br>''Minutes'' specifies that Protection Group run starts periodically
          after certain number of minutes specified in ''frequency'' field. <br>''Hours''
          specifies that Protection Group run starts periodically after certain number
          of hours specified in ''frequency'' field. <br>''Days'' specifies that Protection
          Group run starts periodically after certain number of days specified in
          ''frequency'' field. <br>''Week'' specifies that new Protection Group runs
          start weekly on certain days specified using ''dayOfWeek'' field. <br>''Month''
          specifies that new Protection Group runs start monthly on certain day of
          specific week. This schedule needs ''weekOfMonth'' and ''dayOfWeek'' fields
          to be set. <br> Example: To run the Protection Group on Second Sunday of
          Every Month, following schedule need to be set: <br> unit: ''Month'' <br>
          dayOfWeek: ''Sunday'' <br> weekOfMonth: ''Second'''
        type: string
        enum:
        - Minutes
        - Hours
        - Days
        - Weeks
        - Months
        x-nullable: true
        x-order: 0
      minuteSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of minutes.
        type: object
        x-order: 1
        $ref: '#/definitions/MinuteSchedule'
      hourSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of hours.
        type: object
        x-order: 2
        $ref: '#/definitions/HourSchedule'
      daySchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of days.
        type: object
        x-order: 3
        $ref: '#/definitions/DaySchedule'
      weekSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on certain number of days in a week.
        type: object
        x-order: 4
        $ref: '#/definitions/WeekSchedule'
      monthSchedule:
        description: Specifies the week Schedule for Protection Group to start runs
          on specific week in a month and specific days of that week.
        type: object
        x-order: 5
        $ref: '#/definitions/MonthSchedule'
  IndexedCassandraType:
    description: Cassandra object Types for search.
    type: object
    title: Cassandra object Types for search.
    properties:
      type:
        description: Specifies the Cassandra object Types for search.
        type: string
        enum:
        - CassandraKeyspaces
        - CassandraTables
        x-order: 0
  IndexedCouchbaseType:
    description: Couchbase object Types for search.
    type: object
    title: Couchbase object Types for search.
    properties:
      type:
        description: Specifies the Couchbase object Types for search.
        type: string
        enum:
        - CouchbaseBuckets
        x-order: 0
  IndexedHDFSType:
    description: HDFS object Types for search.
    type: object
    title: HDFS object Types for search.
    properties:
      type:
        description: Specifies the HDFS object Types for search.
        type: string
        enum:
        - HDFSFolders
        - HDFSFiles
        x-order: 0
  IndexedHbaseType:
    description: Hbase object Types for search.
    type: object
    title: Hbase object Types for search.
    properties:
      type:
        description: Specifies the Hbase object Types for search.
        type: string
        enum:
        - HbaseNamespaces
        - HbaseTables
        x-order: 0
  IndexedHiveType:
    description: Hive object Types for search.
    type: object
    title: Hive object Types for search.
    properties:
      type:
        description: Specifies the Hive object Types for search.
        type: string
        enum:
        - HiveDatabases
        - HiveTables
        - HivePartitions
        x-order: 0
  IndexedMongoType:
    description: MongoDB object Types for search.
    type: object
    title: MongoDB object Types for search.
    properties:
      type:
        description: Specifies the MongoDB object Types for search.
        type: string
        enum:
        - MongoDatabases
        - MongoCollections
        x-order: 0
  IndexedObjectSnapshot:
    description: Specifies a snapshot containing the indexed object.
    type: object
    properties:
      indexedObjectName:
        description: Specifies the indexed object name.
        type: string
        x-nullable: true
        x-order: 0
      objectSnapshotid:
        description: Specifies snapshot id of the object containing this indexed object.
        type: string
        x-nullable: true
        x-order: 1
      snapshotTimestampUsecs:
        description: Specifies a unix timestamp when the object snapshot was taken
          in micro seconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      runType:
        description: Specifies the type of protection run created this snapshot.
        type: string
        enum:
        - kRegular
        - kFull
        - kLog
        - kSystem
        - kHydrateCDP
        x-nullable: true
        x-order: 3
      protectionGroupId:
        description: Specifies the protection group id which contains this snapshot.
        type: string
        x-nullable: true
        x-order: 4
      protectionGroupName:
        description: Specifies the protection group name which contains this snapshot.
        type: string
        x-nullable: true
        x-order: 5
      storageDomainId:
        description: Specifies the storage domain id containing this snapshot.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      attempts:
        description: Specifies the number of runs have been executed before the run
          completed successfully.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      sizeBytes:
        description: Specifies the indexed object size in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
      lastModifiedTimeUsecs:
        description: Specifies the last time file was modified in unix timestamp.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
      externalTargetInfo:
        description: Specifies the external target information if this is an archival
          snapshot.
        allOf:
        - $ref: '#/definitions/ArchivalTargetSummaryInfo'
        - x-nullable: true
        x-nullable: true
        x-order: 10
  IndexedObjectType:
    description: Indexed object Type.
    type: object
    title: Indexed object type.
    properties:
      type:
        description: Specifies the indexed object type.
        type: string
        enum:
        - Emails
        - Files
        - CassandraObjects
        - CouchbaseObjects
        - HbaseObjects
        - HiveObjects
        - MongoObjects
        - HDFSObjects
        - ExchangeObjects
        - PublicFolders
        x-order: 0
  IndexingPolicy:
    description: Specifies settings for indexing files found in an Object (such as
      a VM) so these files can be searched and recovered. This also specifies inclusion
      and exclusion rules that determine the directories to index.
    type: object
    title: Indexing Policy.
    required:
    - enableIndexing
    properties:
      enableIndexing:
        description: Specifies if the files found in an Object (such as a VM) should
          be indexed. If true (the default), files are indexed.
        type: boolean
        x-order: 0
      includePaths:
        description: 'Array of Indexed Directories. Specifies a list of directories
          to index. Regular expression can also be specified to provide the directory
          paths. Example: /Users/<wildcard>/AppData'
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 1
      excludePaths:
        description: 'Array of Excluded Directories. Specifies a list of directories
          to exclude from indexing.Regular expression can also be specified to provide
          the directory paths. Example: /Users/<wildcard>/AppData'
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
  InitFailoverRequest:
    description: Specifies the failover request parameters to initiate a failover.
    type: object
    title: Init Failover Request.
    properties:
      sourceCluster:
        description: Specifies the details about source cluster involved in the failover
          operation.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/FailoverSourceCluster'
      replicationCluster:
        description: Specifies the details about replcaition cluster involved in the
          failover operation.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/FailoverReplicaCluster'
  InitFailoverResponse:
    description: Specifies the response after succesfully initiating the failover
      request.
    type: object
    properties:
      replicaToSourceObjects:
        description: Specifies the list of corrosponding source objects mapped with
          replica objects provided at the time of initiating failover request.
        type: array
        items:
          $ref: '#/definitions/SourceReplicaObject'
        x-nullable: true
        x-order: 0
      sourceClusterInfo:
        description: Specifies the information about source cluster in failover workflow.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/FailoverSourceCluster'
  InterfaceRoleType:
    description: Role of a network interface.
    type: object
    title: Interface Role Type
    properties:
      interfaceRoleType:
        description: Specifies the network interface role.
        type: string
        enum:
        - Primary
        - Secondary
        - Undefined
        x-order: 0
  IpPreference:
    description: Preferred IP address mode of the cluster
    type: object
    title: IP Address Preference
    properties:
      ipPreference:
        description: Specifies the ip preference of cluster.
        type: string
        enum:
        - Ipv4
        - Ipv6
        x-order: 0
  IsilonDataTieringParams:
    description: Specifies the parameters which are specific to Isilon related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ProtectionObjectInput'
        x-order: 0
  IsilonObjectParams:
    description: Specifies the common parameters for Isilon objects.
    type: object
    properties:
      supportedNasMountProtocols:
        description: Specifies a list of NAS mount protocols supported by this object.
        type: array
        items:
          type: string
          enum:
          - kNfs
          - kSmb
        x-nullable: true
        x-order: 0
  IsilonObjectProtectionParams:
    description: Specifies the parameters which are specific to Isilon object protection.
    type: object
    properties:
      protocol:
        description: Specifies the protocol of the NAS device being backed up.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 0
      continuousSnapshots:
        description: Specifies the source snapshots to be taken even if there is a
          pending run in a protection group.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/ContinuousSnapshotParams'
      useChangelist:
        description: Specify whether to use the Isilon Changelist API to directly
          discover changed files/directories for faster incremental backup. Cohesity
          will keep an extra snapshot which will be deleted by the next successful
          backup.
        type: boolean
        x-nullable: true
        x-order: 2
  IsilonObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to Isilon object protection.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to be protected.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/definitions/ProtectionObjectInput'
          x-order: 0
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/IsilonObjectProtectionParams'
  IsilonObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to Isilon object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/IsilonObjectProtectionParams'
  IsilonObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters which are specific to Isilon object
      protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/IsilonObjectProtectionParams'
  IsilonProtectionGroupObjectParams:
    description: Specifies an object protected by a Isilon Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  IsilonProtectionGroupParams:
    description: Specifies the parameters which are specific to Isilon related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/IsilonProtectionGroupObjectParams'
        x-order: 0
      directCloudArchive:
        description: Specifies whether or not to store the snapshots in this run directly
          in an Archive Target instead of on the Cluster. If this is set to true,
          the associated policy must have exactly one Archive Target associated with
          it and the policy must be set up to archive after every run. Also, a Storage
          Domain cannot be specified. Default behavior is 'false'.
        type: boolean
        x-nullable: true
        x-order: 1
      nativeFormat:
        description: Specifies whether or not to enable native format for direct archive
          job. This field is set to true if native format should be used for archiving.
        type: boolean
        x-nullable: true
        x-order: 2
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/IndexingPolicy'
      protocol:
        description: Specifies the preferred protocol to use if this device supports
          multiple protocols.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 4
      continueOnError:
        description: Specifies whether or not the Protection Group should continue
          regardless of whether or not an error was encountered during protection
          group run.
        type: boolean
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether the protection group should use encryption
          while backup or not.
        type: boolean
        x-nullable: true
        x-order: 6
      fileLockConfig:
        description: Optional config that enables file locking for this view. It cannot
          be disabled during the edit of a view, if it has been enabled during the
          creation of the view. Also, it cannot be enabled if it was disabled during
          the creation of the view.
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/FileLevelDataLockConfig'
      fileFilters:
        description: Specifies file paths to include or exclude.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/FileFilteringPolicy'
      useChangelist:
        description: Specify whether to use the Isilon Changelist API to directly
          discover changed files/directories for faster incremental backup. Cohesity
          will keep an extra snapshot which will be deleted by the next successful
          backup.
        type: boolean
        x-nullable: true
        x-order: 9
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 10
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 11
        readOnly: true
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the protection group.
        type: object
        x-nullable: true
        x-order: 12
        $ref: '#/definitions/HostBasedBackupScriptParams'
      continuousSnapshots:
        description: Specifies the source snapshots to be taken even if there is a
          pending run in a protection group.
        type: object
        x-nullable: true
        x-order: 13
        $ref: '#/definitions/ContinuousSnapshotParams'
      filterIpConfig:
        description: Specifies the list of IP addresses that are allowed or denied
          at the job level. Allowed IPs and Denied IPs cannot be used together.
        type: object
        x-nullable: true
        x-order: 14
        $ref: '#/definitions/FilterIpConfig'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          full or incremental backup of the NAS source.
        x-nullable: true
        x-order: 15
        $ref: '#/definitions/NasThrottlingConfig'
    x-nullable: true
  IsilonProtocol:
    description: Isilon Protocol type.
    type: object
    title: Isilon Protocol type.
    properties:
      isilonProtocol:
        description: Specifies Isilon Protocol type.
        type: string
        enum:
        - kNfs
        - kSmb
        x-order: 0
  IsilonRegistrationParams:
    description: Specifies parameters to register an Isilon Source.
    type: object
    title: Isilon Protection Source.
    required:
    - endpoint
    - credentials
    properties:
      endpoint:
        description: Specifies the IP Address Endpoint for the Isilon Source.
        type: string
        x-nullable: true
        x-order: 0
      credentials:
        description: Specifies the credentials for an Isilon Source.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Credentials'
      backUpSMBVolumes:
        description: Specifies whether or not to back up SMB Volumes.
        type: boolean
        x-nullable: true
        x-order: 2
      smbCredentials:
        description: Specifies the credentials for SMB Volumes. Must be specified
          if backUpSMBVolumes is set to true.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/SmbMountCredentials'
      filterIpConfig:
        description: Specifies the list of IP addresses that are allowed or denied
          at the job level. Allowed IPs and Denied IPs cannot be used together.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/FilterIpConfig'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          registration of the NAS source.
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/NasThrottlingConfig'
  KerberosProvider:
    description: Specifies the the Kerberos Provider details.
    type: object
    required:
    - kdcServers
    - adminServer
    - realmName
    - hostAlias
    properties:
      id:
        description: Specifies the id.
        type: string
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 0
        readOnly: true
      realmName:
        description: Specifies the realm name.
        type: string
        x-nullable: true
        x-order: 1
      kdcServers:
        description: Specifies a list of Key distribution Centre(KDC) Severs.
        type: array
        items:
          type: string
        x-omitempty: true
        x-order: 2
      adminServer:
        description: 'Specifies the admin server used for registration from

          the list of KDC servers.'
        type: string
        x-nullable: true
        x-order: 3
      ldapProviderId:
        description: Specifies the LDAP provider id to be mapped
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      overwritehostAlias:
        description: 'Specifies if specified host alias should

          overwrite existing host alias.'
        type: boolean
        x-nullable: true
        x-order: 5
      hostAlias:
        description: Specifies the DNS routable host alias names.
        type: array
        items:
          type: string
          pattern: ^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,13}[a-zA-Z0-9])$
        x-omitempty: true
        x-order: 6
  KerberosProviders:
    description: Response of Kerberos Providers.
    type: object
    properties:
      kerberosProviders:
        description: A list of registered Kerberos Providers.
        type: array
        items:
          $ref: '#/definitions/KerberosProvider'
        x-omitempty: true
        x-order: 0
  KeyValuePair:
    description: Specifies a map structure to store Key and Values.
    type: object
    title: KeyValuePair
    required:
    - key
    - value
    properties:
      key:
        description: key
        type: string
        x-nullable: true
        x-order: 0
      value:
        description: value
        type: string
        x-nullable: true
        x-order: 1
  Keystone:
    description: Specifies a Keystone.
    allOf:
    - $ref: '#/definitions/KeystoneCredentials'
    - type: object
      required:
      - name
      - authUrl
      properties:
        name:
          description: Specifies the Keystone configuration name.
          type: string
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the Keystone configuration id.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
          readOnly: true
        authUrl:
          description: Specifies the url points to the Keystone service.
          type: string
          x-nullable: true
          x-order: 2
  KeystoneAdminParams:
    description: Specifies administrator credentials of a Keystone.
    type: object
    required:
    - domain
    - username
    properties:
      domain:
        description: Specifies the administrator domain name.
        type: string
        x-nullable: true
        x-order: 0
      username:
        description: Specifies the username of Keystone administrator.
        type: string
        x-nullable: true
        x-order: 1
      password:
        description: Specifies the password of Keystone administrator.
        type: string
        x-nullable: true
        x-order: 2
  KeystoneCredentials:
    description: Specifies user credentials of a Keystone server.
    type: object
    required:
    - adminCreds
    - scope
    properties:
      adminCreds:
        description: Specifies parameters related to Keystone administrator.
        type: object
        allOf:
        - $ref: '#/definitions/KeystoneAdminParams'
        - x-nullable: true
        x-order: 0
      scope:
        description: Specifies parameters related to Keystone scope.
        type: object
        allOf:
        - $ref: '#/definitions/KeystoneScopeParams'
        - x-nullable: true
        x-order: 1
  KeystoneScopeParams:
    description: Specifies scope paramteres of a Keystone.
    type: object
    required:
    - type
    properties:
      type:
        description: Specifies the scope type.
        type: string
        enum:
        - Project
        - Domain
        x-nullable: true
        x-order: 0
      projectScopeParams:
        description: Specifies the parameter for project type scope.
        type: object
        allOf:
        - $ref: '#/definitions/ProjectScopeParams'
        - x-nullable: true
        x-order: 1
      domainScopeParams:
        description: Specifies the parameters for domain type scope.
        type: object
        allOf:
        - $ref: '#/definitions/DomainScopeParams'
        - x-nullable: true
        x-order: 2
  KeystoneScopeType:
    description: Scope type of a Keystone configuration.
    type: object
    title: Keystone Scope Type
    properties:
      keystoneScopeType:
        description: Specifies the scope type of a Keystone configuration.
        type: string
        enum:
        - Project
        - Domain
        x-order: 0
  Keystones:
    description: Specifies a list of Keystones.
    type: object
    properties:
      keystones:
        description: Specifies a list of Keystones.
        type: array
        items:
          $ref: '#/definitions/Keystone'
        x-order: 0
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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
        x-nullable: true
        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: '#/definitions/KubernetesNamespaceRecoveryNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  KubernetesProtectionGroupObjectParams:
    description: Specifies the object parameters to create Kubernetes Protection Group.
    type: object
    title: Kubernetes ProtectionGroup Object Params
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  KubernetesProtectionGroupParams:
    description: Specifies the parameters which are related to Kubernetes Protection
      Groups.
    type: object
    properties:
      objects:
        description: Specifies the objects included in the Protection Group.
        type: array
        uniqueItems: true
        items:
          $ref: '#/definitions/KubernetesProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-order: 1
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      labelIds:
        description: Array of array of label IDs that specify labels to protect. Optionally
          specify a list of labels to protect by listing protection source ids of
          labels in this two dimensional array. Using this two dimensional array of
          label IDs, the cluster generates a list of namespaces to protect, which
          are derived from intersections of the inner arrays and union of the outer
          array.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 4
      excludeLabelIds:
        description: Array of arrays of label IDs that specify labels to exclude.
          Optionally specify a list of labels to exclude from protecting by listing
          protection source ids of labels in this two dimensional array. Using this
          two dimensional array of label IDs, the Cluster generates a list of namespaces
          to exclude from protecting, which are derived from intersections of the
          inner arrays and union of the outer array.
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-order: 5
  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
        minItems: 1
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoveryTargetConfig:
        description: Specifies the recovery target configuration of the Namespace
          recovery.
        allOf:
        - $ref: '#/definitions/KubernetesNamespaceRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 3
  KvmProtectionGroupObjectParams:
    description: Specifies an object protected by a KVM Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the virtual machine.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  KvmProtectionGroupParams:
    description: Specifies the parameters which are specific to Kvm related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/KvmProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the object ids to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      indexingPolicy:
        description: Specifies settings for indexing files found in an Object (such
          as a VM) so these files can be searched and recovered. This also specifies
          inclusion and exclusion rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/IndexingPolicy'
      appConsistentSnapshot:
        description: Specifies whether or not to quiesce apps and the file system
          in order to take app consistent snapshots. If not specified or false then
          snapshots will not be app consistent.
        type: boolean
        x-nullable: true
        x-order: 5
    x-nullable: true
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        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: '#/definitions/KvmVmRecoveryTargetConfig'
        - x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoverKvmVmNewSourceConfig'
        - x-nullable: true
        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: '#/definitions/RecoverKvmVmOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  Language:
    description: Language
    type: object
    title: Language
    properties:
      language:
        description: Specifies the language.
        type: string
        enum:
        - en-us
        - ja-jp
        - zh-cn
        x-order: 0
  ListTrustedCasResult:
    description: Specifies the basic info about CA Root Certificate.
    type: object
    properties:
      certificates:
        description: 'Array of trusted certificates.

          Specifies the list of certificates returned in this response.

          List is not sorted.'
        type: array
        items:
          $ref: '#/definitions/TrustedCa'
        x-nullable: true
        x-order: 0
  LocalDiskStatus:
    description: Status of local disk.
    type: object
    title: Disk status.
    properties:
      status:
        description: Specifies status of the local disk.
        type: string
        enum:
        - Online
        - Offline
        - Removing
        - OkToRemove
        - Blacklist
        - New
        - Empty
        - Unknown
        - Activating
        x-order: 0
  Locale:
    description: Locale type.
    type: object
    title: Locale type.
    properties:
      locale:
        description: Specifies Locale type.
        type: string
        x-cohesity-enum: locale_type
        x-order: 0
  LogBackupPolicy:
    description: Specifies log backup settings for a Protection Group.
    type: object
    title: Log Backup (Databases) Schedule and Retention.
    required:
    - schedule
    - retention
    properties:
      schedule:
        description: Specifies the schedule settings for log backup.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/LogSchedule'
      retention:
        description: Specifies the Retention period of a log backup in days, months
          or years.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Retention'
  LogSchedule:
    description: Specifies settings that defines how frequent log backup will be performed
      for a Protection Group.
    type: object
    title: Log Schedule
    required:
    - unit
    properties:
      unit:
        description: Specifies how often to start new Protection Group Runs of a Protection
          Group. <br>'Minutes' specifies that Protection Group run starts periodically
          after certain number of minutes specified in 'frequency' field. <br>'Hours'
          specifies that Protection Group run starts periodically after certain number
          of hours specified in 'frequency' field.
        type: string
        enum:
        - Minutes
        - Hours
        x-nullable: true
        x-order: 0
      minuteSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of minutes.
        type: object
        x-order: 1
        $ref: '#/definitions/MinuteSchedule'
      hourSchedule:
        description: Specifies the days Schedule for Protection Group to start runs
          after certain number of hours.
        type: object
        x-order: 2
        $ref: '#/definitions/HourSchedule'
  LogicalVolumeInfo:
    description: Specifies the logical volume info for LVM or LDM volume.
    type: object
    properties:
      volumeGroupUuid:
        description: Specifies the volume group uuid.
        type: string
        x-nullable: true
        x-order: 0
      volumeGroupName:
        description: Specifies the volume group name.
        type: string
        x-nullable: true
        x-order: 1
      logicalVolumeUuid:
        description: Specifies the logical volume uuid.
        type: string
        x-nullable: true
        x-order: 2
      logicalVolumeName:
        description: Specifies the logical volume name.
        type: string
        x-nullable: true
        x-order: 3
      deviceTree:
        description: Specifies the tree structure of the logical volume.
        allOf:
        - $ref: '#/definitions/DeviceTreeNode'
        - x-nullable: true
        x-order: 4
  MSSQLFileProtectionGroupHostParams:
    description: Specifies the host specific parameters for a host container in this
      protection group. Objects specified here should only be MSSQL root containers
      and will not be protected unless they are also specified in the 'objects' list.
      This list is just for specifying source level settings.
    type: object
    title: MSSQL File Protection Group Container Params
    required:
    - hostId
    properties:
      hostId:
        description: Specifies the id of the host container on which databases are
          hosted.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      hostName:
        description: Specifies the name of the host container on which databases are
          hosted.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      disableSourceSideDeduplication:
        description: Specifies whether or not to disable source side deduplication
          on this source. The default behavior is false unless the user has set 'performSourceSideDeduplication'
          to true.
        type: boolean
        x-nullable: true
        x-order: 2
  MSSQLFileProtectionGroupObjectParams:
    description: Specifies the object params to create File based MSSQL Protection
      Group.
    type: object
    title: MSSQL File Protection Group Object params.
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object being protected. If this is a
          non leaf level object, then the object will be auto-protected unless leaf
          objects are specified for exclusion.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object being protected.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      sourceType:
        description: Specifies the type of source being protected.
        type: string
        x-cohesity-enum: host_object_environment_type
        x-nullable: true
        x-order: 2
        readOnly: true
  MSSQLFileProtectionGroupParams:
    description: Specifies the params to create a File based MSSQL Protection Group.
    title: File based MSSQL Protection Group Request Params.
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the list of object params to be protected.
          type: array
          minItems: 1
          items:
            $ref: '#/definitions/MSSQLFileProtectionGroupObjectParams'
          x-nullable: true
          x-order: 0
        performSourceSideDeduplication:
          description: Specifies whether or not to perform source side deduplication
            on this Protection Group.
          type: boolean
          x-nullable: true
          x-order: 1
        additionalHostParams:
          description: Specifies settings which are to be applied to specific host
            containers in this protection group.
          type: array
          items:
            $ref: '#/definitions/MSSQLFileProtectionGroupHostParams'
          x-order: 2
    - $ref: '#/definitions/CommonMSSQLProtectionGroupParams'
  MSSQLNativeProtectionGroupObjectParams:
    description: Specifies the object params to create File based MSSQL Protection
      Group.
    type: object
    title: MSSQL File Protection Group Object params.
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object being protected. If this is a
          non leaf level object, then the object will be auto-protected unless leaf
          objects are specified for exclusion.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object being protected.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      sourceType:
        description: Specifies the type of source being protected.
        type: string
        x-cohesity-enum: host_object_environment_type
        x-nullable: true
        x-order: 2
        readOnly: true
  MSSQLNativeProtectionGroupParams:
    description: Specifies the params to create a Native based MSSQL Protection Group.
    title: Native based MSSQL Protection Group Request Params.
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the list of object params to be protected.
          type: array
          minItems: 1
          items:
            $ref: '#/definitions/MSSQLNativeProtectionGroupObjectParams'
          x-nullable: true
          x-order: 0
        numStreams:
          description: Specifies the number of streams to be used.
          type: integer
          format: int32
          x-nullable: true
          x-order: 1
        withClause:
          description: Specifies the WithClause to be used.
          type: string
          x-nullable: true
          x-order: 2
    - $ref: '#/definitions/CommonMSSQLProtectionGroupParams'
  MSSQLProtectionGroupParams:
    description: Specifies the parameters specific to MSSQL Protection Group.
    type: object
    title: MSSQL Protection Group Params.
    required:
    - protectionType
    properties:
      protectionType:
        description: Specifies the MSSQL Protection Group type.
        type: string
        enum:
        - kFile
        - kVolume
        - kNative
        x-order: 0
      fileProtectionTypeParams:
        description: Specifies the File based MSSQL Protection Group params.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/MSSQLFileProtectionGroupParams'
      volumeProtectionTypeParams:
        description: Specifies the Volume based MSSQL Protection Group params.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/MSSQLVolumeProtectionGroupParams'
      nativeProtectionTypeParams:
        description: Specifies the Native based MSSQL Protection Group params.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/MSSQLNativeProtectionGroupParams'
  MSSQLVolumeProtectionGroupHostParams:
    description: Specifies the host specific parameters for a host container in this
      protection group. Objects specified here should only be MSSQL root containers
      and will not be protected unless they are also specified in the 'objects' list.
      This list is just for specifying source level settings.
    type: object
    title: MSSQL Volume Protection Group Container Params
    required:
    - hostId
    properties:
      hostId:
        description: Specifies the id of the host container on which databases are
          hosted.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      hostName:
        description: Specifies the name of the host container on which databases are
          hosted.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      volumeGuids:
        description: Specifies the list of volume GUIDs to be protected. If not specified,
          all the volumes of the host will be protected. Note that volumes of host
          on which databases are hosted are protected even if its not mentioned in
          this list.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
      enableSystemBackup:
        description: Specifies whether to enable system/bmr backup using 3rd party
          tools installed on agent host.
        type: boolean
        x-nullable: true
        x-order: 3
  MSSQLVolumeProtectionGroupObjectParams:
    description: Specifies the object params to create File based MSSQL Protection
      Group.
    type: object
    title: MSSQL File Protection Group Object params.
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object being protected. If this is a
          non leaf level object, then the object will be auto-protected unless leaf
          objects are specified for exclusion.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object being protected.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      sourceType:
        description: Specifies the type of source being protected.
        type: string
        x-cohesity-enum: host_object_environment_type
        x-nullable: true
        x-order: 2
        readOnly: true
  MSSQLVolumeProtectionGroupParams:
    description: Specifies the params to create a Volume based MSSQL Protection Group.
    title: Volume based MSSQL Protection Group Request Params.
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the list of object ids to be protected.
          type: array
          minItems: 1
          items:
            $ref: '#/definitions/MSSQLVolumeProtectionGroupObjectParams'
          x-nullable: true
          x-order: 0
        incrementalBackupAfterRestart:
          description: Specifies whether or to perform incremental backups the first
            time after a server restarts. By default, a full backup will be performed.
          type: boolean
          x-nullable: true
          x-order: 1
        indexingPolicy:
          x-order: 2
          $ref: '#/definitions/IndexingPolicy'
        backupDbVolumesOnly:
          description: Specifies whether to only backup volumes on which the specified
            databases reside. If not specified (default), all the volumes of the host
            will be protected.
          type: boolean
          x-nullable: true
          x-order: 3
        additionalHostParams:
          description: Specifies settings which are to be applied to specific host
            containers in this protection group.
          type: array
          items:
            $ref: '#/definitions/MSSQLVolumeProtectionGroupHostParams'
          x-order: 4
    - $ref: '#/definitions/CommonMSSQLProtectionGroupParams'
  MachineAccount:
    description: Specifies a machine account.
    type: object
    required:
    - name
    properties:
      name:
        description: Specifies the machine account name.
        type: string
        pattern: ^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,13}[a-zA-Z0-9])$
        x-nullable: true
        x-order: 0
      dnsHostName:
        description: Specifies the DNS host name of the machine account.
        type: string
        x-nullable: true
        x-order: 1
      encryption:
        description: Specifies a list of encryption types apply to the machine account.
        type: array
        uniqueItems: true
        items:
          type: string
          enum:
          - DES-CBC-CRC
          - DES-CBC-MD5
          - RC4-HMAC
          - AES128-CTS-HMAC-SHA1-96
          - AES256-CTS-HMAC-SHA1-96
        x-nullable: true
        x-order: 2
  MachineAccountEncryptionType:
    description: Machine account encryption type.
    type: object
    title: Machine Account Encryption Type
    properties:
      type:
        description: Specifies the encryption type of a machine account.
        type: string
        enum:
        - DES-CBC-CRC
        - DES-CBC-MD5
        - RC4-HMAC
        - AES128-CTS-HMAC-SHA1-96
        - AES256-CTS-HMAC-SHA1-96
        x-order: 0
  MailboxParam:
    description: Specifies parameters to recover a Mailbox.
    type: object
    properties:
      recoverEntireMailbox:
        description: Specifies whether to recover the whole Mailbox.
        type: boolean
        x-nullable: true
        x-order: 0
      recoverFolders:
        description: Specifies a list of email folders to recover.
        type: array
        items:
          $ref: '#/definitions/FolderItem'
        x-nullable: true
        x-order: 1
  McmClaimEntityType:
    description: Entity type.
    type: object
    title: Entity type.
    properties:
      type:
        description: Entity type.
        type: string
        enum:
        - Rigel
        - Cluster
        x-order: 0
  McmClusterClaimRequestParams:
    description: Specifies the request params to claim clusters to Helios.
    type: object
    title: Request params to claim cluster to Helios.
    required:
    - clusterId
    - clusterIncarnationId
    - claimToken
    - clusterName
    properties:
      clusterId:
        description: Specifies the cluster id.
        type: integer
        format: int64
        x-order: 0
      clusterIncarnationId:
        description: Specifies the cluster incarnation id.
        type: integer
        format: int64
        x-order: 1
      clusterName:
        description: Specifies the cluster name.
        type: string
        x-order: 2
      claimToken:
        description: Claim token used for authentication.
        type: string
        x-order: 3
  McmClusterClaimResponseParams:
    description: Specifies the response of claiming a cluster to Helios.
    type: object
    title: Response of claiming a cluster to Helios.
    properties:
      clusterId:
        description: Specifies the cluster id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      clusterIncarnationId:
        description: Specifies the cluster incarnation id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      clusterName:
        description: Specifies the cluster name.
        type: string
        x-nullable: true
        x-order: 2
      sfAccountId:
        description: Specifies the Salesforce account id used to claim the cluster.
        type: string
        x-nullable: true
        x-order: 3
      clusterCertificate:
        description: Specifies the Cluster certificate.
        type: string
        x-nullable: true
        x-order: 4
      clusterPrivateKey:
        description: Specifies the Cluster private key.
        type: string
        x-nullable: true
        x-order: 5
      passphrase:
        description: Specifies the passphrase (if used) to encrypt the cluster private
          key.
        type: string
        x-nullable: true
        x-order: 6
      clusterCaChain:
        description: Specifies the CA chain that is used to sign the Cluster certificate.
        type: string
        x-nullable: true
        x-order: 7
      heliosCertificate:
        description: Specifies the Helios certificate that can be used to authenticate
          api calls made from Helios to cluster.
        type: string
        x-nullable: true
        x-order: 8
  McmClusterIdentifier:
    description: Specifies the MCM cluster identifier.
    type: object
    title: MCM Cluster Identifier.
    properties:
      clusterId:
        description: Specifies the cluster id of the cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      clusterIncarnationId:
        description: Specifies the incarnation id of the cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      regionId:
        description: Specifies the region id of the cluster. Only valid for DMaaS
          clusters.
        type: string
        x-nullable: true
        x-order: 2
  McmObjectActivityType:
    description: Object activity type.
    type: object
    title: Object activity type.
    properties:
      type:
        description: Specifies type of the object activity.
        type: string
        enum:
        - BackupRun
        - Restore
        - ArchivalRun
        x-order: 0
  McmRigelClaimRequestParams:
    description: Specifies the request params to claim Rigel to Helios.
    type: object
    title: Request params to claim Rigel to Helios.
    required:
    - rigelGuid
    - claimToken
    properties:
      rigelGuid:
        description: Unique id for rigel instance.
        type: integer
        format: int64
        x-order: 0
      claimToken:
        description: Claim token used for authentication.
        type: string
        x-order: 1
      rigelType:
        description: Specifies the Rigel type that is being claimed.
        type: string
        enum:
        - OnPrem
        - Cloud
        x-nullable: true
        x-order: 2
      clusterId:
        description: Specifies the cluster id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      clusterIncarnationId:
        description: Specifies the cluster incarnation id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      rigelName:
        description: Specifies the Rigel name.
        type: string
        x-nullable: true
        x-order: 5
      rigelIp:
        description: Specifies the Rigel IP.
        type: string
        x-nullable: true
        x-order: 6
      softwareVersion:
        description: Specifies the Rigel Software version.
        type: string
        x-nullable: true
        x-order: 7
  McmRigelClaimResponseParams:
    description: Specifies the response of claiming a Rigel to Helios.
    type: object
    title: Response of claiming a Rigel to Helios.
    properties:
      rigelGuid:
        description: Unique id for rigel instance.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      connectionId:
        description: Connection id for rigel instance.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      tenantId:
        description: Tenant id associated with the claimed rigel.
        type: string
        x-nullable: true
        x-order: 2
      rigelType:
        description: Specifies the Rigel type that is being claimed.
        type: string
        enum:
        - OnPrem
        - Cloud
        x-nullable: true
        x-order: 3
      rigelCertificate:
        description: Specifies the Rigel certificate.
        type: string
        x-nullable: true
        x-order: 4
      rigelPrivateKey:
        description: Specifies the Rigel private key.
        type: string
        x-nullable: true
        x-order: 5
      rigelCaChain:
        description: Specifies the CA chain that is used to sign the Rigel certificate.
        type: string
        x-nullable: true
        x-order: 6
      tenantCaChain:
        description: Specifies the Tenant CA chain.
        type: array
        items:
          type: string
          x-nullable: true
        x-nullable: true
        x-order: 7
      heliosCertificate:
        description: Specifies the Helios certificate that can be used to authenticate
          api calls made from Helios to Rigel.
        type: string
        x-nullable: true
        x-order: 8
      dataplaneEndpoint:
        description: Endpoint for associated data plane.
        type: string
        x-nullable: true
        x-order: 9
  McmSignupRequestStatus:
    description: MCM signup request status type.
    type: object
    title: MCM signup request status type.
    properties:
      type:
        description: MCM signup request status type.
        type: string
        enum:
        - Open
        - InProgress
        - Denied
        - Finished
        x-order: 0
  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
        format: int64
        x-nullable: true
        x-order: 0
      targetPathVec:
        description: Specifies the target paths to be used for DB migration.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 1
  MinuteSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start after certain number of minutes.
    title: Minutes Schedule
    allOf:
    - $ref: '#/definitions/FrequencySchedule'
  ModifyCiphersRequestBody:
    description: Specifies ciphers to enable/disable on the cluster.
    type: object
    title: Request to enable/disable a list of ciphers.
    required:
    - enable
    - ciphers
    properties:
      enable:
        description: If true, the ciphers passed in will be enabled on the cluster
          and all other ciphers will be disabled. If false, the ciphers specified
          will be disabled and all other ciphers on the cluster will be enabled.
        type: boolean
        x-order: 0
      ciphers:
        description: Specifies a list of ciphers to enable/disable on the cluster.
        type: array
        items:
          type: string
          enum:
          - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
          - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
          - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
          - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
          - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
          - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
          - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
          - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
          - TLS_RSA_WITH_AES_256_GCM_SHA384
          - TLS_RSA_WITH_AES_128_GCM_SHA256
          - TLS_RSA_WITH_AES_256_CBC_SHA
          - TLS_RSA_WITH_AES_128_CBC_SHA
        x-order: 1
  MongoDBAuthType:
    description: Enumeration of all the MongoDB Authentication types.
    type: object
    title: Enumeration of all the MongoDB Authentication types.
    properties:
      MongoDBAuthType:
        description: Enumeration of all the MongoDB Authentication.
        type: string
        enum:
        - SCRAM
        - LDAP
        - NONE
        - KERBEROS
        x-order: 0
  MongoDBCdpJobInfo:
    description: Specifies the CDP related information for a given MongoDB protection
      group. This will only be populated when the protection group is configured with
      a CDP policy.
    type: object
    properties:
      latestRecoveryPointInTimeUsecs:
        description: Specifies the latest available recovery point timestamp (in microseconds
          from epoch)
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
  MongoDBProtectionGroupParams:
    description: Specifies the parameters for MongoDB Protection Group.
    allOf:
    - $ref: '#/definitions/NoSqlProtectionGroupParams'
    - type: object
      properties:
        cdpInfo:
          description: Specifies the CDP related information for a given protection
            group. This field will only be populated when protection group is configured
            with a CDP policy.
          allOf:
          - $ref: '#/definitions/MongoDBCdpJobInfo'
          - x-nullable: true
          x-order: 0
          readOnly: true
      x-cohesity-discriminator-value: kMongoDB
      x-nullable: true
  MongoDBSourceRegistrationParams:
    description: Specifies parameters to register MongoDB source.
    type: object
    title: Register MongoDB source request parameters.
    required:
    - hosts
    - authType
    - isSslRequired
    - useSecondaryForBackup
    properties:
      hosts:
        description: Specify the MongoS hosts for a sharded cluster and the MongoD
          hosts for a non-sharded cluster. You can specify a sub-set of the hosts.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: string
        x-order: 0
      authType:
        description: MongoDB authentication type.
        type: string
        enum:
        - SCRAM
        - LDAP
        - NONE
        - KERBEROS
        x-nullable: true
        x-order: 1
      username:
        description: Specifies the username of the MongoDB cluster. Should be set
          if 'authType' is 'LDAP' or 'SCRAM'.
        type: string
        x-nullable: true
        x-order: 2
      principal:
        description: Specifies the principal name of the MongoDB cluster. Should be
          set if 'authType' is 'KERBEROS'.
        type: string
        x-nullable: true
        x-order: 3
      password:
        description: Specifies the password for the MongoDB cluster. Should be set
          if 'authType' is 'LDAP' or 'SCRAM'.
        type: string
        x-nullable: true
        x-order: 4
      authenticatingDatabase:
        description: Authenticating Database for this cluster. Should be set if 'authType'
          is 'LDAP' or 'SCRAM'.
        type: string
        x-nullable: true
        x-order: 5
      isSslRequired:
        description: Set to true if connection to MongoDB has to be over SSL.
        type: boolean
        x-order: 6
      useSecondaryForBackup:
        description: Set this to true if you want the system to peform backups from
          secondary nodes.
        type: boolean
        x-order: 7
      secondaryNodeTag:
        description: MongoDB Secondary node tag. Required only if 'useSecondaryForBackup'
          is true.The system will use this to identify the secondary nodes for reading
          backup data.
        type: string
        x-order: 8
  MongoIndexedObject:
    description: Specifies a Mongo indexed object.
    title: MongoIndexedObject
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        type:
          description: Specifies the Mongo Object Type.
          type: string
          enum:
          - MongoDatabases
          - MongoCollections
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the id of the indexed object.
          type: string
          x-nullable: true
          x-order: 1
        cdpInfo:
          description: Specifies the Continuous Data Protection (CDP) details about
            this object. This is only available if this object if protected by a CDP
            enabled policy.
          type: object
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/CdpObjectInfo'
  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
        title: Recover MongoDB params.
        allOf:
        - $ref: '#/definitions/RecoverMongodbParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RecoverMongodbParams'
  MonthSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to on specific week and specific days of that week.
    title: Month Schedule
    allOf:
    - $ref: '#/definitions/WeekSchedule'
    - type: object
      required:
      - weekOfMonth
      properties:
        weekOfMonth:
          description: 'Specifies the week of the month (such as ''Third'') in a Monthly
            Schedule specified by unit field as ''Months''. <br>This field is used
            in combination with ''dayOfWeek'' to define the day in the month to start
            the Protection Group Run. <br> Example: if ''weekOfMonth'' is set to ''Third''
            and day is set to ''Monday'', a backup is performed on the third Monday
            of every month.'
          type: string
          enum:
          - First
          - Second
          - Third
          - Fourth
          - Last
          x-nullable: true
          x-order: 0
  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: '#/definitions/HyperVTargetParamsForMountVolume'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/PhysicalTargetParamsForMountVolume'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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: '#/definitions/VmwareTargetParamsForMountVolume'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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
        x-nullable: true
        x-order: 0
      mountedVolume:
        description: Specifies the name of the point where the volume is mounted.
        type: string
        x-nullable: true
        x-order: 1
      fileSystemType:
        description: Specifies the type of the file system of the volume.
        type: string
        x-nullable: true
        x-order: 2
  MsGroupParam:
    description: Specifies parameters to recover MS group.
    type: object
    required:
    - recoverObject
    properties:
      recoverObject:
        description: Specifies the MS group recover Object info.
        allOf:
        - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        - x-nullable: true
        x-order: 0
      recoverEntireGroup:
        description: Specifies if the entire Group (mailbox + site) is to be restored.
        type: boolean
        x-nullable: true
        x-order: 1
      mailboxRestoreType:
        description: Specifies whether mailbox restore is full or granular.
        type: string
        enum:
        - kFull
        - kPartial
        x-nullable: true
        x-order: 2
      siteRestoreType:
        description: Specifies whether site restore is full or granular.
        type: string
        enum:
        - kFull
        - kPartial
        x-nullable: true
        x-order: 3
  MsSQLCommonConnectionParams:
    description: Specifies the common parameters to connect to a SQL node/cluster
    type: object
    required:
    - hostIdentifier
    properties:
      hostIdentifier:
        description: Specifies the unique identifier to locate the SQL node or cluster.
          The host identifier can be IP address or FQDN.
        type: string
        x-order: 0
  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
        x-nullable: true
        x-order: 0
  MssqlConnectionParams:
    description: Specifies the parameters to connect to a SQL node/cluster using given
      IP or hostname FQDN.
    type: object
    allOf:
    - $ref: '#/definitions/MsSQLCommonConnectionParams'
  MssqlConnectionResponseParams:
    description: Specifies the response parameters after connecting to a SQL node/cluster
      using given IP or hostname FQDN.
    type: object
    allOf:
    - $ref: '#/definitions/MsSQLCommonConnectionParams'
    - type: object
      properties:
        error:
          description: Specifies the error information if any associated with the
            app topology response.
          type: object
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/Error'
        skipConnectionDiscovery:
          description: Specifies whether to skip the discovery phase of all SQL servers,
            AAG groups etc during registration process.
          type: boolean
          x-nullable: true
          x-order: 1
        servers:
          description: Specifies the list of SQL servers. If SQL server is a part
            of avalibility group then it will be returned in aagServers field. This
            will include the list of all standalone SQL servers and servers belonging
            to any FCI enviournment.
          type: array
          items:
            $ref: '#/definitions/SQLServer'
          x-nullable: true
          x-order: 2
        fciClusters:
          description: Specifies the list of FCI (Failover Cluster Instaces) Clusters.
            This will contain the list of all failover pools under a windows cluster.
            FCI clusters which are part of AAG, will be returned seperatly under aagServers
            field.
          type: array
          items:
            $ref: '#/definitions/FCICluster'
          x-nullable: true
          x-order: 3
        aagGroups:
          description: Specifies the list of AAG (Always on Avalibility) groups.
          type: array
          items:
            $ref: '#/definitions/AAGGroup'
          x-nullable: true
          x-order: 4
  MssqlFileObjectProtection:
    description: Specifies the object params to create File based MSSQL Object Protection
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object being protected. If this is a
          non leaf level object, then the object will be auto-protected unless leaf
          objects are specified for exclusion.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
  MssqlFileObjectProtectionParams:
    description: Specifies the params to create a File based MSSQL Object Protection.
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the list of objects to be protected.
          type: array
          minItems: 1
          items:
            $ref: '#/definitions/MssqlFileObjectProtection'
          x-nullable: true
          x-order: 0
    - $ref: '#/definitions/CommonMSSQLProtectionGroupParams'
  MssqlNativeObjectProtection:
    description: Specifies the object params to create Native based MSSQL Object Protection.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object being protected. If this is a
          non leaf level object, then the object will be auto-protected unless leaf
          objects are specified for exclusion.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
  MssqlNativeObjectProtectionParams:
    description: Specifies the params to create a Native based MSSQL Object Protection.
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the list of objects to be protected.
          type: array
          minItems: 1
          items:
            $ref: '#/definitions/MssqlNativeObjectProtection'
          x-nullable: true
          x-order: 0
        numStreams:
          description: Specifies the number of streams to be used.
          type: integer
          format: int32
          x-nullable: true
          x-order: 1
        withClause:
          description: Specifies the WithClause to be used.
          type: string
          x-nullable: true
          x-order: 2
    - $ref: '#/definitions/CommonMSSQLProtectionGroupParams'
  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
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/HostInformation'
      aagInfo:
        description: Specifies the Always on Avalibility (AAG) information if associated
          with the SQL Object.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/AAGInfo'
  MssqlObjectProtectionParams:
    description: Specifies the parameters specific to MSSQL Object Protection.
    type: object
    required:
    - objectProtectionType
    properties:
      objectProtectionType:
        description: Specifies the MSSQL Object Protection type.
        type: string
        enum:
        - kFile
        - kVolume
        - kNative
        x-order: 0
      fileObjectProtectionTypeParams:
        description: Specifies the File based MSSQL Object Protection params.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/MssqlFileObjectProtectionParams'
      nativeObjectProtectionTypeParams:
        description: Specifies the Native based MSSQL Object Protection params.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/MssqlNativeObjectProtectionParams'
  MssqlObjectProtectionRequestParams:
    description: Specifies the request parameters specific to MSSQL object protection.
    type: object
    allOf:
    - $ref: '#/definitions/MssqlObjectProtectionParams'
  MssqlObjectProtectionResponseParams:
    description: Specifies the response parameters specific to MSSQL object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonMssqlObjectProtectionParams'
  MssqlObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters specific to MSSQL object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonMssqlObjectProtectionParams'
  MssqlProtectionGroupType:
    description: MSSQL Protection Group type.
    type: object
    title: MSSQL Protection Group type.
    properties:
      environment:
        description: Specifies MSSQL Protection Group type.
        type: string
        enum:
        - kFile
        - kVolume
        - kNative
        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
        x-nullable: true
        x-order: 0
      enableAutoSync:
        description: Set this to true if you want to enable auto sync for multi stage
          restore.
        type: boolean
        x-nullable: true
        x-order: 1
  NasFullThrottlingConfig:
    description: Specifies the throttling configuration during full backup run.
    type: object
    title: NAS Full Backup Throttling Params
    properties:
      maxMetadataFetchPercentage:
        description: Specifies the percentage value of maximum concurrent metadata
          to be fetched during full backup of the source.
        type: integer
        format: int32
        x-nullable: true
        x-order: 0
      maxReadWritePercentage:
        description: Specifies the percentage value of maximum concurrent read/write
          during full backup of the source.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
  NasIncrementalThrottlingConfig:
    type: object
    title: NAS Full Backup Throttling Params
    properties:
      maxMetadataFetchPercentage:
        description: Specifies the percentage value of maximum concurrent metadata
          to be fetched during incremental backup of the source.
        type: integer
        format: int32
        x-nullable: true
        x-order: 0
      maxReadWritePercentage:
        description: Specifies the percentage value of maximum concurrent read/write
          during incremental backup of the source.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
  NasProtocol:
    description: Nas Protocol type.
    type: object
    title: Nas Protocol type.
    properties:
      nasProtocol:
        description: Specifies Nas Protocol type.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-order: 0
  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
        format: int64
        x-nullable: true
        x-order: 0
  NasThrottlingConfig:
    description: Specifies the source throttling parameters to be used during full
      or incremental backup of the NAS source.
    type: object
    title: Nas Source and Protection Throttling Configuration
    properties:
      fullBackupConfig:
        description: Specifies the throttling configuration during full backup run.
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/NasFullThrottlingConfig'
      incrementalBackupConfig:
        description: Specifies the throttling configuration during incremental backup
          run.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/NasIncrementalThrottlingConfig'
  NetappDataTieringParams:
    description: Specifies the parameters which are specific to Netapp related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ProtectionObjectInput'
        x-order: 0
  NetappObjectParams:
    description: Specifies the common parameters for Netapp objects.
    type: object
    properties:
      supportedNasMountProtocols:
        description: Specifies a list of NAS mount protocols supported by this object.
        type: array
        items:
          type: string
          enum:
          - kNfs
          - kCifs
          - kIscsi
          - kFc
          - kFcache
          - kHttp
          - kNdmp
          - kManagement
          - kNvme
        x-nullable: true
        x-order: 0
      volumeType:
        description: Specifies the Netapp volume type.
        type: string
        enum:
        - ReadWrite
        - LoadSharing
        - DataProtection
        - DataCache
        - Temp
        - UnkownType
        x-nullable: true
        x-order: 1
  NetappObjectProtectionParams:
    description: Specifies the parameters which are specific to Netapp object protection.
    type: object
    properties:
      protocol:
        description: Specifies the protocol of the NAS device being backed up.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      snapshotLabel:
        description: Specifies the incremental and full snapshot label for Data-Protect
          Netapp Volumes backup. If field is set , incremental and full snapshot label
          has to be provided. If field is not set, the snapshot label will be automatically
          set using timestamp.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/SnapshotLabel'
      backupExistingSnapshot:
        description: Specifies that snapshot label is not set for Data-Protect Netapp
          Volumes backup. If field is set to true, existing oldest snapshot is used
          for backup and subsequent incremental will be selected in ascending order
          of snapshot create time on the source. If snapshot label is set, this field
          is set to false.
        type: boolean
        x-nullable: true
        x-order: 3
      continuousSnapshots:
        description: Specifies the source snapshots to be taken even if there is a
          pending run in a protection group.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ContinuousSnapshotParams'
  NetappObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to Netapp object protection.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to be protected.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/definitions/ProtectionObjectInput'
          x-order: 0
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/NetappObjectProtectionParams'
  NetappObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to Netapp object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/NetappObjectProtectionParams'
  NetappObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters which are specific to Netapp object
      protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonNasProtectionParams'
    - $ref: '#/definitions/NetappObjectProtectionParams'
  NetappProtectionGroupObjectParams:
    description: Specifies an object protected by a Netapp Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  NetappProtectionGroupParams:
    description: Specifies the parameters which are specific to Netapp related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/NetappProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      directCloudArchive:
        description: Specifies whether or not to store the snapshots in this run directly
          in an Archive Target instead of on the Cluster. If this is set to true,
          the associated policy must have exactly one Archive Target associated with
          it and the policy must be set up to archive after every run. Also, a Storage
          Domain cannot be specified. Default behavior is 'false'.
        type: boolean
        x-nullable: true
        x-order: 2
      nativeFormat:
        description: Specifies whether or not to enable native format for direct archive
          job. This field is set to true if native format should be used for archiving.
        type: boolean
        x-nullable: true
        x-order: 3
      snapshotLabel:
        description: Specifies the incremental and full snapshot label for Data-Protect
          Netapp Volumes backup. If field is set , incremental and full snapshot label
          has to be provided. If field is not set, the snapshot label will be automatically
          set using timestamp.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/SnapshotLabel'
      backupExistingSnapshot:
        description: Specifies that snapshot label is not set for Data-Protect Netapp
          Volumes backup. If field is set to true, existing oldest snapshot is used
          for backup and subsequent incremental will be selected in ascending order
          of snapshot create time on the source. If snapshot label is set, this field
          is set to false.
        type: boolean
        x-nullable: true
        x-order: 5
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/IndexingPolicy'
      protocol:
        description: Specifies the preferred protocol to use if this device supports
          multiple protocols.
        type: string
        enum:
        - kNoProtocol
        - kNfs3
        - kCifs1
        - kCifs2
        - kCifs3
        x-nullable: true
        x-order: 7
      continueOnError:
        description: Specifies whether or not the Protection Group should continue
          regardless of whether or not an error was encountered during protection
          group run.
        type: boolean
        x-nullable: true
        x-order: 8
      encryptionEnabled:
        description: Specifies whether the protection group should use encryption
          while backup or not.
        type: boolean
        x-nullable: true
        x-order: 9
      fileLockConfig:
        description: Optional config that enables file locking for this view. It cannot
          be disabled during the edit of a view, if it has been enabled during the
          creation of the view. Also, it cannot be enabled if it was disabled during
          the creation of the view.
        x-nullable: true
        x-order: 10
        $ref: '#/definitions/FileLevelDataLockConfig'
      fileFilters:
        description: Specifies file paths to include or exclude.
        type: object
        x-nullable: true
        x-order: 11
        $ref: '#/definitions/FileFilteringPolicy'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 12
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 13
        readOnly: true
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the protection group.
        type: object
        x-nullable: true
        x-order: 14
        $ref: '#/definitions/HostBasedBackupScriptParams'
      continuousSnapshots:
        description: Specifies the source snapshots to be taken even if there is a
          pending run in a protection group.
        type: object
        x-nullable: true
        x-order: 15
        $ref: '#/definitions/ContinuousSnapshotParams'
      isSourceInitiatedProtection:
        description: Specifies if this is a source initated backup where the source
          pushes the data like snapmirror based backup for netapp. If this is set
          to true, keyMappingConfig must also be set.
        type: boolean
        x-nullable: true
        x-order: 16
      filterIpConfig:
        description: Specifies the list of IP addresses that are allowed or denied
          at the job level. Allowed IPs and Denied IPs cannot be used together.
        type: object
        x-nullable: true
        x-order: 17
        $ref: '#/definitions/FilterIpConfig'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          full or incremental backup of the NAS source.
        x-nullable: true
        x-order: 18
        $ref: '#/definitions/NasThrottlingConfig'
    x-nullable: true
  NetappProtocol:
    description: Netapp Protocol type.
    type: object
    title: Netapp Protocol type.
    properties:
      netappProtocol:
        description: Specifies Netapp Protocol type.
        type: string
        enum:
        - kNfs
        - kCifs
        - kIscsi
        - kFc
        - kFcache
        - kHttp
        - kNdmp
        - kManagement
        - kNvme
        x-order: 0
  NetappRegistrationParams:
    description: Specifies parameters to register an Netapp Source.
    type: object
    title: Netapp Protection Source.
    required:
    - sourceType
    - endpoint
    - credentials
    properties:
      sourceType:
        description: Specifies the Netapp source type. Can be either kCluster or kVServer
          (SVM).
        type: boolean
        x-nullable: true
        x-order: 0
      endpoint:
        description: Specifies the Hostname or IP Address Endpoint for the Netapp
          Source.
        type: string
        x-nullable: true
        x-order: 1
      credentials:
        description: Specifies the credentials for an Netapp Source.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/Credentials'
      backUpSMBVolumes:
        description: Specifies whether or not to back up SMB Volumes.
        type: boolean
        x-nullable: true
        x-order: 3
      smbCredentials:
        description: Specifies the credentials for SMB Volumes. Must be specified
          if backUpSMBVolumes is set to true.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/SmbMountCredentials'
      filterIpConfig:
        description: Specifies the list of IP addresses that are allowed or denied
          at the job level. Allowed IPs and Denied IPs cannot be used together.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/FilterIpConfig'
      throttlingConfig:
        description: Specifies the source throttling parameters to be used during
          registration of the NAS source.
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/NasThrottlingConfig'
  NetworkConnectionInfo:
    description: Specify the network connection information.
    type: object
    title: Network Connection.
    properties:
      domainName:
        description: Specifies the domain name of the network connection.
        type: string
        x-nullable: true
        x-order: 0
      networkGateway:
        description: Specifies the network Gateway of the network connection.
        type: string
        x-nullable: true
        x-order: 1
      dns:
        description: Specifies the DNS Server of the network connection.
        type: string
        x-nullable: true
        x-order: 2
      ntp:
        description: Specifies the NTP Server of the network connection.
        type: string
        x-nullable: true
        x-order: 3
  NetworkInterface:
    description: Specifies the parameters of a network interface.
    type: object
    title: Network Interface
    properties:
      name:
        description: Specifies the name of the network interface.
        type: string
        x-nullable: true
        x-order: 0
      type:
        description: Specifies the type of the network interface.
        type: string
        enum:
        - Physical
        - Bond
        - Bridge
        - Group
        - Vlan
        - VlanPhysical
        - VlanBond
        - VlanGroup
        - VlanBridge
        - Invalid
        x-nullable: true
        x-order: 1
      staticIP:
        description: Specifies the static IP of the network interface.
        type: string
        x-nullable: true
        x-order: 2
      virtualIP:
        description: Specifies the virtual IP of the network interface.
        type: string
        x-nullable: true
        x-order: 3
      gateway:
        description: Specifies the gateway of the network interface.
        type: string
        x-nullable: true
        x-order: 4
      mtu:
        description: Specifies the MTU of the network interface.
        type: integer
        format: int32
        x-nullable: true
        x-order: 5
      subnet:
        description: Specifies the subnet of the network interface.
        type: string
        x-nullable: true
        x-order: 6
      isUp:
        description: Specifies whether or not the interface is up.
        type: boolean
        x-nullable: true
        x-order: 7
      group:
        description: Specifies the group to which this interface belongs.
        type: string
        x-nullable: true
        x-order: 8
      role:
        description: Specifies the interface role.
        type: string
        enum:
        - Primary
        - Secondary
        - Undefined
        x-nullable: true
        x-order: 9
      defaultRoute:
        description: Specifies whether or not this interface is the default route.
        type: boolean
        x-nullable: true
        x-order: 10
      bondSlaveNames:
        description: Specifies the names of the bond slaves for this interface.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 11
      bondSlaveSlots:
        description: Specifies the slots of the bond slaves for this interface.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 12
      bondingMode:
        description: Specifies the bonding mode of this interface.
        type: string
        enum:
        - ActiveBackup
        - 802_3ad
        - BalanceAlb
        - Invalid
        x-nullable: true
        x-order: 13
      macAddress:
        description: Specifies the MAC address of this interface.
        type: string
        x-nullable: true
        x-order: 14
      isConnected:
        description: Specifies whether or not this interface is connected.
        type: boolean
        x-nullable: true
        x-order: 15
      speed:
        description: Specifies the speed of this interface.
        type: string
        enum:
        - 1Gbit/s
        - 10Gbit/s
        - 25Gbit/s
        - 40Gbit/s
        - 100Gbit/s
        - Unknown
        x-nullable: true
        x-order: 16
  NetworkInterfaceType:
    description: Type of a network interface.
    type: object
    title: Network Interface Type
    properties:
      networkInterfaceType:
        description: Specifies the network interface type.
        type: string
        enum:
        - Physical
        - Bond
        - Bridge
        - Group
        - Vlan
        - VlanPhysical
        - VlanBond
        - VlanGroup
        - VlanBridge
        - Invalid
        x-order: 0
  NewGroupParam:
    description: Specifies the parameters for using a new protection group.
    type: object
    required:
    - name
    - policyId
    - storageDomainId
    properties:
      name:
        description: Specifies the name of the new protection group.
        type: string
        x-nullable: true
        x-order: 0
      policyId:
        description: Specifies the policy id of the new protection group.
        type: string
        x-nullable: true
        x-order: 1
      storageDomainId:
        description: Specifies the storage domain id of the new protection group.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  NfsConfig:
    description: Specifies the NFS config settings for this View.
    type: object
    properties:
      enableNfsViewDiscovery:
        description: If set, it enables discovery of view for NFS.
        type: boolean
        x-nullable: true
        x-order: 0
      nfsAllSquash:
        description: Specifies the NFS all squash config.
        allOf:
        - $ref: '#/definitions/NfsSquash'
        - x-nullable: true
        x-order: 1
      nfsRootPermissions:
        description: Specifies the NFS root permission config of the view file system.
        allOf:
        - $ref: '#/definitions/NfsRootPermissions'
        - x-nullable: true
        x-order: 2
      nfsRootSquash:
        description: Specifies the NFS root squash config.
        allOf:
        - $ref: '#/definitions/NfsSquash'
        - x-nullable: true
        x-order: 3
      enableNfsUnixAuthentication:
        description: If set, it enables NFS UNIX Authentication
        type: boolean
        x-nullable: true
        x-order: 4
      enableNfsKerberosAuthentication:
        description: If set, it enables NFS Kerberos Authentication
        type: boolean
        x-nullable: true
        x-order: 5
      enableNfsKerberosIntegrity:
        description: If set, it enables NFS Kerberos Integrity
        type: boolean
        x-nullable: true
        x-order: 6
      enableNfsKerberosPrivacy:
        description: If set, it enables NFS Kerberos Privacy
        type: boolean
        x-nullable: true
        x-order: 7
  NfsRootPermissions:
    description: Specifies the config of NFS root permission of a view file system.
    type: object
    title: NfsRootPermissions
    properties:
      gid:
        description: Unix GID for the root of the file system.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 0
      mode:
        description: Unix mode bits for the root of the file system.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 1
      uid:
        description: Unix UID for the root of the file system.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 2
  NfsSquash:
    type: object
    title: NfsSquash specifies the squash config for client subnet whitelist.
    properties:
      gid:
        description: GID mapped for all clients.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 0
      uid:
        description: UID mapped for all clients.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 1
  NicSpeedType:
    description: Speed of a network interface.
    type: object
    title: NIC Speed Type
    properties:
      nicSpeedType:
        description: Specifies the network interface speed.
        type: string
        enum:
        - 1Gbit/s
        - 10Gbit/s
        - 25Gbit/s
        - 40Gbit/s
        - 100Gbit/s
        - Unknown
        x-order: 0
  NimbleProtectionGroupObjectParams:
    description: Specifies the object parameters to create Nimble Protection Group.
    type: object
    title: Nimble Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  NimbleProtectionGroupParams:
    description: Specifies the parameters which are specific to Nimble related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/NimbleProtectionGroupObjectParams'
        x-order: 0
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
    x-nullable: true
  NisNetgroup:
    description: Specifies an NIS netgroup.
    type: object
    required:
    - name
    - domain
    properties:
      name:
        description: Specifies the netgroup name.
        type: string
        x-nullable: true
        x-order: 0
      domain:
        description: Specifies the domain name for the netgroup.
        type: string
        x-nullable: true
        x-order: 1
      nfsAccess:
        description: Specifies NFS protocol acess level for clients from the netgroup.
        type: string
        enum:
        - kDisabled
        - kReadOnly
        - kReadWrite
        x-nullable: true
        x-order: 2
      nfsSquash:
        description: 'Specifies which nfsSquash Mounted.

          ''kNone'' mounts none.

          ''kRootSquash'' mounts nfsRootSquash. Whether clients from this subnet can

          mount as root on NFS.

          ''kAllSquash'' mounts nfsAllSquash. Whether all clients from this subnet
          can

          map view with view_all_squash_uid/view_all_squash_gid configured in

          the view.'
        type: string
        enum:
        - kNone
        - kRootSquash
        - kAllSquash
        x-nullable: true
        x-order: 3
  NisNetgroups:
    description: Response of NIS Netgroups.
    type: object
    properties:
      nisNetgroups:
        description: A list of NIS Netgroups.
        type: array
        items:
          $ref: '#/definitions/NisNetgroup'
        x-nullable: true
        x-order: 0
  NisProvider:
    description: Specifies an NIS Provider.
    type: object
    required:
    - domain
    - masterServerHostname
    properties:
      domain:
        description: Specifies the Domain Name of NIS Provider.
        type: string
        x-nullable: true
        x-order: 0
      masterServerHostname:
        description: Specifies the hostname of Master Server.
        type: string
        x-nullable: true
        x-order: 1
      slaveServers:
        description: Specifies a list of slave servers in the NIS Domain.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
      tenantIds:
        description: Specifies the list of tenant Ids for NIS Provider.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 3
  NisProviders:
    description: Response of NIS Providers.
    type: object
    properties:
      nisProviders:
        description: A list of NIS Providers.
        type: array
        items:
          $ref: '#/definitions/NisProvider'
        x-nullable: true
        x-order: 0
  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
        x-nullable: true
        x-order: 0
      value:
        description: specifies the value of the property.
        type: string
        x-nullable: true
        x-order: 1
  NoSqlProtectionGroupObjectParams:
    description: Specifies an object protected by a Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  NoSqlProtectionGroupParams:
    description: Specifies the source specific parameters for this Protection Group.
    type: object
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/NoSqlProtectionGroupObjectParams'
        x-order: 0
      concurrency:
        description: Specifies the maximum number of concurrent IO Streams that will
          be created to exchange data with the cluster.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
      bandwidthMBPS:
        description: Specifies the maximum network bandwidth that each concurrent
          IO Stream can use for exchanging data with the cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 3
      sourceId:
        description: Object ID of the Source on which this protection was run .
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
        readOnly: true
      sourceName:
        description: Specifies the name of the Source on which this protection was
          run.
        type: string
        x-nullable: true
        x-order: 5
        readOnly: true
  NodeFreeDisks:
    description: Sepcifies the free disks of a node.
    type: object
    title: NodeFreeDisks
    required:
    - nodeId
    - freeDisks
    properties:
      nodeId:
        description: Specifies the id of a node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      freeDisks:
        description: Specifies list of free disks of node.
        type: array
        items:
          $ref: '#/definitions/FreeDisk'
        x-nullable: true
        x-order: 1
      chassisSerial:
        description: Chassis serial number.
        type: string
        x-nullable: true
        x-order: 2
      slot:
        description: Slot number of node
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      errorMessage:
        description: Error message of disks assimilation request.
        type: string
        x-nullable: true
        x-order: 4
        readOnly: true
  NodeGroup:
    description: Specifies common fields required to define Node Group.
    type: object
    title: Node Group
    required:
    - name
    properties:
      name:
        description: Specifies the name of the Node Group.
        type: string
        x-order: 0
      node-ids:
        description: List of Node Ids that are part of this node group.
        type: array
        title: Node Ids
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      id:
        description: Id of the node group.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
      type:
        description: Type of the node group.
        type: integer
        format: int32
        x-nullable: true
        x-order: 3
      bgpInstance:
        description: BGP config information.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/BgpInstance'
      subnetInfo:
        description: Subnet information in node group.
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/SubnetInfo'
      dnsServersInfo:
        description: DNS servers information in node group.
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/DnsServersInfo'
  NodeGroupRequest:
    description: Specifies the request to create a Node Group.
    title: Node Group Request.
    allOf:
    - $ref: '#/definitions/NodeGroup'
    - type: object
  NodeGroupResponse:
    description: Specifies the details of Node Groups.
    title: Node Group Response
    properties:
      nodeGroups:
        description: Specifies the details of a Node Group.
        type: array
        title: Node Groups
        items:
          $ref: '#/definitions/NodeGroup'
        x-nullable: true
        x-order: 0
  NodeIdentifyParams:
    description: Specifies the parameter to identify node.
    type: object
    title: Node Identify Request Parameters.
    required:
    - identify
    properties:
      identify:
        description: Turn on/off node led light if set to true/false respectively.
        type: boolean
        x-nullable: true
        x-order: 0
  NodeInterfaces:
    description: Specifies the interfaces present on a Node.
    type: object
    title: Node Interfaces
    properties:
      id:
        description: Specifies the id of the node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      interfaces:
        description: Specifies the list of network interfaces present on this Node.
        type: array
        items:
          $ref: '#/definitions/NetworkInterface'
        x-order: 1
  NodePowerOperation:
    type: object
    title: NodePowerOperation
    required:
    - operation
    properties:
      operation:
        description: The operation clould be poweroff, reboot.
        type: string
        enum:
        - poweroff
        - reboot
        x-nullable: true
        x-order: 0
      nodeId:
        description: Id of the node to do the specified operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  NodeRemovalParams:
    description: Specifies parameters to initiate/cancel node removal.
    type: object
    title: Node Removal Parameters.
    required:
    - cancel
    properties:
      cancel:
        description: If true, cancels node removal that is already in progress.
        type: boolean
        x-nullable: true
        x-order: 0
  NodeResetState:
    description: Node reset state information
    type: object
    title: NodeResetState
    properties:
      nodeId:
        description: Node Id
        type: integer
        format: int64
        x-go-name: NodeId
        x-nullable: true
        x-order: 0
      nodeIp:
        description: Node Ip.
        type: string
        x-go-name: NodeIp
        x-nullable: true
        x-order: 1
      state:
        description: Reset state.
        type: string
        x-go-name: State
        x-nullable: true
        x-order: 2
  NodeUnitProgress:
    description: Specifies the progress of the patch operation on a node.
    title: Patch Operation Node Unit Progress.
    properties:
      nodeIp:
        description: Specifies the IP address of the node.
        type: string
        x-nullable: true
        x-order: 0
      inProgress:
        description: Specifies whether a operation is in progress on the node.
        type: boolean
        x-nullable: true
        x-order: 1
      patchLevelTransition:
        description: Specifies the patch level transition of the patch operation.
          For Apply operation, patch level goes up for each operation. For Revert
          operation, patch level goes down. Patch level zero is the base level where
          no patch was applied.
        type: string
        x-nullable: true
        x-order: 2
      percentage:
        description: Specifies the percentage of completion of the patch operation
          on the node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      timeTakenSeconds:
        description: Specifies the time taken so far in this patch unit operation
          on the node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      nodeMessage:
        description: Specifies a message about the patch operation on the node.
        type: string
        x-nullable: true
        x-order: 5
  NumWeekInMonth:
    description: Num Week In Month type.
    type: object
    title: Num Week In Month type.
    properties:
      numWeekInMonth:
        description: Specifies Num Week In Month type.
        type: string
        enum:
        - First
        - Second
        - Third
        - Fourth
        - Last
        x-order: 0
  O365ProtectionGroupType:
    description: O365 Protection Group type.
    type: object
    title: O365 Protection Group type.
    properties:
      environment:
        description: Specifies O365 Protection Group type.
        type: string
        enum:
        - kMailbox
        - kOneDrive
        - kSharePoint
        - kPublicFolders
        - kGroups
        - kTeams
        x-order: 0
  O365SearchEmailsRequestParams:
    description: Specifies email search request params specific to O365 environment.
    type: object
    title: O365 Search Emails Request Params
    properties:
      domainIds:
        description: Specifies the domain Ids in which mailboxes are registered.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 0
      mailboxIds:
        description: Specifies the mailbox Ids which contains the emails/folders.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
  Object:
    description: Specifies information about an object.
    title: Object information
    allOf:
    - $ref: '#/definitions/CommonObjectSummary'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware objects.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareObjectEntityParams'
        isilonParams:
          description: Specifies the parameters for Isilon object.
          allOf:
          - $ref: '#/definitions/IsilonObjectParams'
          - x-nullable: true
          x-order: 1
        netappParams:
          description: Specifies the parameters for NetApp object.
          allOf:
          - $ref: '#/definitions/NetappObjectParams'
          - x-nullable: true
          x-order: 2
        genericNasParams:
          description: Specifies the parameters for GenericNas object.
          allOf:
          - $ref: '#/definitions/CommonNasObjectParams'
          - x-nullable: true
          x-order: 3
        flashbladeParams:
          description: Specifies the parameters for Flashblade object.
          allOf:
          - $ref: '#/definitions/FlashbladeObjectParams'
          - x-nullable: true
          x-order: 4
        elastifileParams:
          description: Specifies the parameters for Elastifile object.
          allOf:
          - $ref: '#/definitions/CommonNasObjectParams'
          - x-nullable: true
          x-order: 5
        gpfsParams:
          description: Specifies the parameters for GPFS object.
          allOf:
          - $ref: '#/definitions/CommonNasObjectParams'
          - x-nullable: true
          x-order: 6
        mssqlParams:
          description: Specifies the parameters for Msssql object.
          allOf:
          - $ref: '#/definitions/MssqlObjectEntityParams'
          - x-nullable: true
          x-order: 7
        oracleParams:
          description: Specifies the parameters for Oracle object.
          allOf:
          - $ref: '#/definitions/OracleObjectEntityParams'
          - x-nullable: true
          x-order: 8
  ObjectActionRequest:
    description: Specifies the request to peform an action on an Object.
    title: Peform an action on an Object.
    allOf:
    - $ref: '#/definitions/CommonObjectActionRequest'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the actions for VMware Objects.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareObjectActionParams'
  ObjectArchivalSnapshotInfo:
    description: Specifies the Archival snapshot information for the object.
    title: Object Archival Snapshot Information
    allOf:
    - type: object
      properties:
        snapshotId:
          description: Specifies the id of the archival snapshot for the object.
          type: string
          x-nullable: true
          x-order: 0
        logicalSizeBytes:
          description: Specifies the logical size of this snapshot in bytes.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
    - $ref: '#/definitions/ArchivalTargetSummaryInfo'
  ObjectBackupSnapshotStatus:
    description: Object Backup Snapshot Status type.
    type: object
    title: Object Backup Snapshot Status type.
    properties:
      objectBackupSnapshotStatus:
        description: Specifies Object Backup Snapshot Status type.
        type: string
        enum:
        - kInProgress
        - kSuccessful
        - kFailed
        - kWaitingForNextAttempt
        - kWarning
        x-order: 0
  ObjectEnvironment:
    description: Specifies object environment.
    type: object
    title: Object Environment
    properties:
      type:
        description: Specifies type of object environment.
        type: string
        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: 0
  ObjectIdentifier:
    description: Specifies the basic info to identify an object.
    title: Object Identifier.
    properties:
      id: &id002
        description: Specifies object id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name: &id003
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
      sourceId: &id004
        description: Specifies registered source id to which object belongs.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      sourceName: &id005
        description: Specifies registered source name to which object belongs.
        type: string
        x-nullable: true
        x-order: 3
      environment: &id006
        description: Specifies the environment of the object.
        type: string
        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-nullable: true
        x-order: 4
  ObjectLastRun:
    description: Specifies last run info of an object.
    allOf:
    - $ref: '#/definitions/ObjectSummary'
    - type: object
      properties:
        runId:
          description: Specifies the last run id.
          type: string
          x-nullale: true
          x-order: 0
        protectionGroupName:
          description: Specifies the protection group name of last run.
          type: string
          x-nullable: true
          x-order: 1
        protectionGroupId:
          description: Specifies the protection group id of last run.
          type: string
          x-nullable: true
          x-order: 2
        policyName:
          description: Specifies the policy name of last run.
          type: string
          x-nullable: true
          x-order: 3
        policyId:
          description: Specifies the policy id of last run.
          type: string
          x-nullable: true
          x-order: 4
        backupRunStatus:
          description: Specifies the status of last local back up run.
          type: string
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-nullable: true
          x-order: 5
        archivalRunStatus:
          description: Specifies the status of last archival run.
          type: string
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-nullable: true
          x-order: 6
        replicationRunStatus:
          description: Specifies the status of last replication run.
          type: string
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-nullable: true
          x-order: 7
        isSlaViolated:
          description: Specifies if the sla is violated in last run.
          type: boolean
          x-nullable: true
          x-order: 8
  ObjectLinkingParams:
    description: Specifies the parameters required for linking objects. This is currently
      used as a part of vm migration workflow.
    type: object
    allOf:
    - $ref: '#/definitions/CommonObjectsActionParams'
  ObjectLinkingRequest:
    description: Request for linking replicated objects to failover objects on replication
      cluster.
    type: object
    properties:
      objectMap:
        description: Specifies the objectMap that will be used to create linking between
          given replicated source entity and newly restored entity on erplication
          cluster.
        type: array
        items:
          $ref: '#/definitions/ReplicaFailoverObject'
        x-nullable: true
        x-order: 0
  ObjectLocalSnapshotInfo:
    description: Specifies the Local snapshot information for the object.
    type: object
    title: Object Local Snapshot Information.
    properties:
      snapshotId:
        description: Specifies the id of the local snapshot for the object.
        type: string
        x-nullable: true
        x-order: 0
      logicalSizeBytes:
        description: Specifies the logical size of this snapshot in bytes.
        type: integer
        format: int64
        x-nullable: true
        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: '#/definitions/CommonRecoverObjectSnapshotParams'
        - x-nullable: true
        x-order: 0
      mailboxParams:
        description: Specifies parameters to recover a Mailbox.
        allOf:
        - $ref: '#/definitions/MailboxParam'
        - x-nullable: true
        x-order: 1
  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: '#/definitions/CommonRecoverObjectSnapshotParams'
        - x-nullable: true
        x-order: 0
      msTeamParam:
        description: Specifies parameters to recover a Microsoft 365 Team.
        allOf:
        - $ref: '#/definitions/MsTeamParam'
        - x-nullable: true
        x-order: 1
  ObjectOneDriveParam:
    description: Specifies OneDrive recovery parameters associated with a user.
    type: object
    properties:
      ownerInfo:
        description: Specifies the OneDrive owner info.
        allOf:
        - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        - x-nullable: true
        x-order: 0
      oneDriveParams:
        description: Specifies parameters to recover a OneDrive.
        type: array
        items:
          $ref: '#/definitions/OneDriveParam'
        x-nullable: true
        x-order: 1
  ObjectProgressInfo:
    description: Specifies the progress of an object.
    type: object
    allOf:
    - $ref: '#/definitions/ObjectIdentifier'
    - $ref: '#/definitions/ProgressTaskInfo'
    - type: object
      properties:
        failedAttempts:
          description: Specifies progress for failed attempts of this object.
          type: array
          items:
            $ref: '#/definitions/ProgressTaskInfo'
          x-nullable: true
          x-order: 0
  ObjectProtectionGroupSummary:
    description: Specifies a summary of a protection group protecting this object.
    type: object
    properties:
      name:
        description: Specifies the protection group name.
        type: string
        x-nullable: true
        x-order: 0
      id:
        description: Specifies the protection group id.
        type: string
        x-nullable: true
        x-order: 1
      policyName:
        description: Specifies the policy name for this group.
        type: string
        x-nullable: true
        x-order: 2
      policyId:
        description: Specifies the policy id for this group.
        type: string
        x-nullable: true
        x-order: 3
      lastBackupRunStatus:
        description: Specifies the status of last local back up run.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 4
      lastArchivalRunStatus:
        description: Specifies the status of last archival run.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 5
      lastReplicationRunStatus:
        description: Specifies the status of last replication run.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 6
      lastRunSlaViolated:
        description: Specifies if the sla is violated in last run.
        type: boolean
        x-nullable: true
        x-order: 7
  ObjectProtectionInfo:
    description: Specifies the object info on clsuter.
    type: object
    properties:
      objectId:
        description: Specifies the object id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      sourceId:
        description: Specifies the source id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      regionId:
        description: Specifies the region id where this object belongs to.
        type: string
        x-nullable: true
        x-order: 2
      clusterId:
        description: Specifies the cluster id where this object belongs to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      clusterIncarnationId:
        description: Specifies the cluster incarnation id where this object belongs
          to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      protectionGroups:
        description: Specifies a list of protection groups protecting this object.
        type: array
        items:
          $ref: '#/definitions/ObjectProtectionGroupSummary'
        x-nullable: true
        x-order: 5
      objectBackupConfiguration:
        description: Specifies a list of object protections.
        type: array
        items:
          $ref: '#/definitions/ProtectionSummary'
        x-nullable: true
        x-order: 6
      lastRunStatus:
        description: Specifies the status of the object's last protection run.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 7
  ObjectProtectionRunInfo:
    description: Specifies the run info for a run protecting an object.
    title: Object Protection Run Info.
    properties:
      runId:
        description: Specifies the ID of the protection run.
        type: string
        x-nullable: true
        x-order: 0
      runType:
        description: Type of Protection run. 'kRegular' indicates an incremental (CBT)
          backup. Incremental backups utilizing CBT (if supported) are captured of
          the target protection objects. The first run of a kRegular schedule captures
          all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup
          (all blocks) of the target protection objects are always captured and Change
          Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup.
          Capture the database transaction logs to allow rolling back to a specific
          point in time. 'kSystem' indicates system volume backup. It produces an
          image for bare metal recovery.
        type: string
        enum:
        - kRegular
        - kFull
        - kLog
        - kSystem
        - kHydrateCDP
        x-nullable: true
        x-order: 1
      isSlaViolated:
        description: Indicated if SLA has been violated for this run.
        type: boolean
        x-nullable: true
        x-order: 2
      protectionGroupId:
        description: ProtectionGroupId to which this run belongs. This will only be
          populated if the object is protected by a protection group.
        type: string
        x-nullable: true
        x-order: 3
      protectionGroupName:
        description: Name of the Protection Group to which this run belongs. This
          will only be populated if the object is protected by a protection group.
        type: string
        x-nullable: true
        x-order: 4
      isLocalSnapshotsDeleted:
        description: Specifies if snapshots for this run has been deleted.
        type: boolean
        x-nullable: true
        x-order: 5
      isReplicationRun:
        description: Specifies if this protection run is a replication run.
        type: boolean
        x-nullable: true
        x-order: 6
      isCloudArchivalDirect:
        description: Specifies whether the run is a CAD run if cloud archive direct
          feature is enabled. If this field is true, the primary backup copy will
          only be available at the given archived location.
        type: boolean
        x-nullable: true
        x-order: 7
      policyId:
        description: Specifies the unique id of the Protection Policy associated with
          the Protection Run. The Policy provides retry settings Protection Schedules,
          Priority, SLA, etc.
        type: string
        x-nullable: true
        x-order: 8
      policyName:
        description: Specifies Specifies the name of the Protection Policy.
        type: string
        x-nullable: true
        x-order: 9
      storageDomainId:
        description: Specifies the Storage Domain (View Box) ID where this Protection
          Run writes data.
        type: integer
        format: int64
        x-nullable: true
        x-order: 10
      permissions:
        description: Specifies the list of tenants that have permissions for this
          protection group run.
        type: array
        items:
          $ref: '#/definitions/Tenant'
        x-nullable: true
        x-order: 11
      originClusterIdentifier:
        description: Specifies the information of the primary cluster if this run
          is a replication run.
        x-nullable: true
        x-order: 12
        $ref: '#/definitions/ClusterIdentifier'
      originProtectionGroupId:
        description: ProtectionGroupId to which this run belongs on the primary cluster
          if this run is a replication run.
        type: string
        x-nullable: true
        x-order: 13
      localSnapshotInfo:
        description: Information about local snapshot run for this object.
        x-nullable: true
        x-order: 14
        $ref: '#/definitions/BackupRun'
      originalBackupInfo:
        description: Information about snapshot run on the original cluster. This
          only applies to replication run.
        x-nullable: true
        x-order: 15
        $ref: '#/definitions/BackupRun'
      replicationInfo:
        description: Information about replication run for this object.
        x-nullable: true
        x-order: 16
        $ref: '#/definitions/ReplicationRun'
      archivalInfo:
        description: Information about archival run for this object.
        x-nullable: true
        x-order: 17
        $ref: '#/definitions/ArchivalRun'
      cloudSpinInfo:
        description: Information about Cloud Spin run for this object.
        x-nullable: true
        x-order: 18
        $ref: '#/definitions/CloudSpinRun'
      onLegalHold:
        description: Specifies if object's snapshot is on legal hold.
        type: boolean
        x-nullable: true
        x-order: 19
      dataLock:
        description: "Specifies WORM retention type for the local backeup. When a\
          \ WORM retention type is specified, the snapshots of the Protection Groups\
          \ using this policy will be kept until the maximum of the snapshot retention\
          \ time. During that time, the snapshots cannot be deleted. \n'Compliance'\
          \ implies WORM retention is set for compliance reason. \n'Administrative'\
          \ implies WORM retention is set for administrative purposes."
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 20
  ObjectProtectionRunSummary:
    description: Specifies the response body of the get object runs request.
    title: Object Protection Run Summary.
    allOf:
    - $ref: '#/definitions/ObjectIdentifier'
    - $ref: '#/definitions/ObjectProtectionRunInfo'
  ObjectProtectionStatsSummary:
    description: Specifies the count and size of protected and unprotected objects
      for a given environment.
    type: object
    title: Object Protection Stats Summary
    properties:
      environment:
        description: Specifies the environment of the object.
        type: string
        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-go-name: Environment
        x-nullable: true
        x-order: 0
      protectedCount:
        description: Specifies the count of the protected leaf objects.
        type: integer
        format: int64
        x-go-name: ProtectedCount
        x-nullable: true
        x-order: 1
      unprotectedCount:
        description: Specifies the count of the unprotected leaf objects.
        type: integer
        format: int64
        x-go-name: UnprotectedCount
        x-nullable: true
        x-order: 2
      protectedSizeBytes:
        description: Specifies the protected logical size in bytes.
        type: integer
        format: int64
        x-go-name: ProtectedSizeBytes
        x-nullable: true
        x-order: 3
      unprotectedSizeBytes:
        description: Specifies the unprotected logical size in bytes.
        type: integer
        format: int64
        x-go-name: UnprotectedSizeBytes
        x-nullable: true
        x-order: 4
  ObjectProtectionSummary:
    description: Specifies the summary of a protected object.
    type: object
    allOf:
    - $ref: '#/definitions/ObjectSummary'
    - type: object
      properties:
        error:
          description: Specifies the error message if an error occurred during creation
            of the object protection.
          type: string
          x-nullable: true
          x-order: 0
  ObjectRunResult:
    description: Snapshot, replication, archival results for an object.
    type: object
    title: Snapshot, replication, archival results for an object.
    properties:
      object:
        description: Summary information about the object.
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/ObjectSummary'
      localSnapshotInfo:
        description: Information about local snapshot run for this object.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/BackupRun'
      originalBackupInfo:
        description: Information about snapshot run on the original cluster. This
          only applies to replication run.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/BackupRun'
      replicationInfo:
        description: Information about replication run for this object.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/ReplicationRun'
      archivalInfo:
        description: Information about archival run for this object.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ArchivalRun'
      cloudSpinInfo:
        description: Information about Cloud Spin run for this object.
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/CloudSpinRun'
      onLegalHold:
        description: Specifies if object's snapshot is on legal hold.
        type: boolean
        x-nullable: true
        x-order: 6
  ObjectServicesKeyMapping:
    description: Specifies object services key mapping config for view.
    type: object
    title: View object services key mapping config.
    properties:
      type:
        description: Specifies object services key mapping config for view.
        type: string
        enum:
        - Random
        - Short
        - Long
        - Hierarchical
        x-order: 0
  ObjectSnapshot:
    description: Specifies an Object Snapshot.
    type: object
    title: Object Snapshot.
    properties:
      id:
        description: Specifies the id of the snapshot.
        type: string
        x-nullable: true
        x-order: 0
      snapshotTargetType:
        description: Specifies the target type where the Object's snapshot resides.
        type: string
        enum:
        - Local
        - Archival
        x-nullable: true
        x-order: 1
      indexingStatus:
        description: Specifies the indexing status of objects in this snapshot.<br>
          'InProgress' indicates the indexing is in progress.<br> 'Done' indicates
          indexing is done.<br> 'NoIndex' indicates indexing is not applicable.<br>
          'Error' indicates indexing failed with error.
        type: string
        enum:
        - InProgress
        - Done
        - NoIndex
        - Error
        x-nullable: true
        x-order: 2
      protectionGroupId:
        description: Specifies id of the Protection Group.
        type: string
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 3
      protectionGroupName:
        description: Specifies name of the Protection Group.
        type: string
        x-nullable: true
        x-order: 4
      protectionGroupRunId:
        description: Specifies id of the Protection Group Run.
        type: string
        pattern: ^\d+:\d+$
        x-nullable: true
        x-order: 5
      runInstanceId:
        description: Specifies the instance id of the protection run which create
          the snapshot.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      runStartTimeUsecs:
        description: Specifies the start time of the run in micro seconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      sourceGroupId:
        description: Specifies the source protection group id in case of replication.
        type: string
        x-nullable: true
        x-order: 8
      runType:
        description: Specifies the type of protection run created this snapshot.
        type: string
        enum:
        - kRegular
        - kFull
        - kLog
        - kSystem
        - kHydrateCDP
        x-nullable: true
        x-order: 9
      environment:
        description: Specifies the snapshot environment.
        type: string
        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-nullable: true
        x-order: 10
      snapshotTimestampUsecs:
        description: Specifies the timestamp in Unix time epoch in microseconds when
          the snapshot is taken for the specified Object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 11
      expiryTimeUsecs:
        description: Specifies the expiry time of the snapshot in Unix timestamp epoch
          in microseconds. If the snapshot has no expiry, this property will not be
          set.
        type: integer
        format: int64
        x-nullable: true
        x-order: 12
      externalTargetInfo:
        description: Specifies the external target information if this is an archival
          snapshot.
        allOf:
        - $ref: '#/definitions/ArchivalTargetSummaryInfo'
        - x-nullable: true
        x-nullable: true
        x-order: 13
      storageDomainId:
        description: Specifies the Storage Domain id where the snapshot of object
          is present.
        type: integer
        format: int64
        x-nullable: true
        x-order: 14
      hasDataLock:
        description: Specifies if this snapshot has datalock.
        type: boolean
        x-nullable: true
        x-order: 15
      onLegalHold:
        description: Specifies if this snapshot is on legalhold.
        type: boolean
        x-nullable: true
        x-order: 16
      objectId:
        description: Specifies the object id which the snapshot is taken from.
        type: integer
        format: int64
        x-nullable: true
        x-order: 17
      objectName:
        description: Specifies the object name which the snapshot is taken from.
        type: string
        x-nullable: true
        x-order: 18
      sourceId:
        description: Specifies the object source id which the snapshot is taken from.
        type: integer
        format: int64
        x-nullable: true
        x-order: 19
      physicalParams:
        description: Specifies the parameters specific to Physical type snapshot.
        allOf:
        - $ref: '#/definitions/PhysicalSnapshotParams'
        - x-nullable: true
        x-order: 20
      hypervParams:
        description: Specifies the parameters specific to HyperV type snapshot.
        allOf:
        - $ref: '#/definitions/HypervSnapshotParams'
        - x-nullable: true
        x-order: 21
      awsParams:
        description: Specifies the parameters specific to AWS type snapshot.
        allOf:
        - $ref: '#/definitions/AwsSnapshotParams'
        - x-nullable: true
        x-order: 22
      azureParams:
        description: Specifies the parameters specific to Azure type snapshot.
        allOf:
        - $ref: '#/definitions/AzureSnapshotParams'
        - x-nullable: true
        x-order: 23
      netappParams:
        description: Specifies the parameters specific to NetApp type snapshot.
        allOf:
        - $ref: '#/definitions/NetappObjectParams'
        - x-nullable: true
        x-order: 24
      isilonParams:
        description: Specifies the parameters specific to Isilon type snapshot.
        allOf:
        - $ref: '#/definitions/IsilonObjectParams'
        - x-nullable: true
        x-order: 25
      gpfsParams:
        description: Specifies the parameters specific to GPFS type snapshot.
        allOf:
        - $ref: '#/definitions/CommonNasObjectParams'
        - x-nullable: true
        x-order: 26
      flashbladeParams:
        description: Specifies the parameters specific to Flashblade type snapshot.
        allOf:
        - $ref: '#/definitions/FlashbladeObjectParams'
        - x-nullable: true
        x-order: 27
      genericNasParams:
        description: Specifies the parameters specific to Generic NAS type snapshot.
        allOf:
        - $ref: '#/definitions/CommonNasObjectParams'
        - x-nullable: true
        x-order: 28
      elastifileParams:
        description: Specifies the parameters specific to NetApp type snapshot.
        allOf:
        - $ref: '#/definitions/CommonNasObjectParams'
        - x-nullable: true
        x-order: 29
  ObjectSnapshotVolumeInfo:
    description: Detail info of an object snapshot volume.
    allOf:
    - $ref: '#/definitions/CommonObjectSnapshotVolumeParams'
  ObjectSnapshotsInfo:
    description: Specifies the snapshots information for every Protection Group for
      a given object.
    type: object
    title: Object Snapshots Information.
    properties:
      localSnapshotInfo:
        description: Specifies the local snapshot information.
        allOf:
        - $ref: '#/definitions/ObjectLocalSnapshotInfo'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      archivalSnapshotsInfo:
        description: Specifies the archival snapshots information.
        type: array
        items:
          $ref: '#/definitions/ObjectArchivalSnapshotInfo'
        x-nullable: true
        x-order: 1
      indexingStatus:
        description: Specifies the indexing status of objects in this snapshot.<br>
          'InProgress' indicates the indexing is in progress.<br> 'Done' indicates
          indexing is done.<br> 'NoIndex' indicates indexing is not applicable.<br>
          'Error' indicates indexing failed with error.
        type: string
        enum:
        - InProgress
        - Done
        - NoIndex
        - Error
        x-nullable: true
        x-order: 2
      protectionGroupId:
        description: Specifies id of the Protection Group.
        type: string
        x-nullable: true
        x-order: 3
      protectionGroupName:
        description: Specifies name of the Protection Group.
        type: string
        x-nullable: true
        x-order: 4
      runInstanceId:
        description: Specifies the instance id of the protection run which create
          the snapshot.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      sourceGroupId:
        description: Specifies the source protection group id in case of replication.
        type: string
        x-nullable: true
        x-order: 6
      storageDomainId:
        description: Specifies the Storage Domain id where the backup data of Object
          is present.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      storageDomainName:
        description: Specifies the name of Storage Domain id where the backup data
          of Object is present
        type: string
        x-nullable: true
        x-order: 8
      protectionRunId:
        description: Specifies the id of Protection Group Run.
        type: string
        x-nullable: true
        x-order: 9
      runType:
        description: Specifies the type of protection run created this snapshot.
        type: string
        enum:
        - kRegular
        - kFull
        - kLog
        - kSystem
        - kHydrateCDP
        x-nullable: true
        x-order: 10
      protectionRunStartTimeUsecs:
        description: Specifies the start time of Protection Group Run in Unix timestamp
          epoch in microseconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 11
      protectionRunEndTimeUsecs:
        description: Specifies the end time of Protection Group Run in Unix timestamp
          epoch in microseconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 12
  ObjectStats:
    description: Specifies the object stats.
    type: object
    title: Object Stats.
    properties:
      snapshotsSummary:
        description: Specifies a summary of the object snapshots.
        type: array
        items:
          $ref: '#/definitions/SnapshotsSummary'
        x-nullable: true
        x-order: 0
  ObjectSummary:
    description: Specifies the Object Summary.
    title: Object Summary
    allOf:
    - $ref: '#/definitions/ObjectIdentifier'
    - type: object
      properties:
        objectHash: &id007
          description: Specifies the hash identifier of the object.
          type: string
          x-nullable: true
          x-order: 0
        objectType: &id008
          description: Specifies the type of the object.
          type: string
          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-nullable: true
          x-order: 1
        logicalSizeBytes: &id009
          description: Specifies the logical size of object in bytes.
          type: integer
          format: int64
          x-nullable: true
          x-order: 2
        uuid: &id010
          description: Specifies the uuid which is a unique identifier of the object.
          type: string
          x-nullable: true
          x-order: 3
        protectionType: &id011
          description: Specifies the protection type of the object if any.
          type: string
          enum:
          - kAgent
          - kNative
          - kSnapshotManager
          - kRDSSnapshotManager
          - kAuroraSnapshotManager
          - kFile
          - kVolume
          x-nullable: true
          x-order: 4
        osType: &id012
          description: Specifies the operating system type of the object.
          type: string
          enum:
          - kLinux
          - kWindows
          - kAix
          - kSolaris
          - kSapHana
          - kOther
          x-nullable: true
          x-order: 5
        vCenterSummary: &id013
          description: Specifies the vCenter object details.
          type: object
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/ObjectTypeVCenterParams'
  ObjectType:
    description: Specifies Object type.
    type: object
    title: Object type.
    properties:
      objectType:
        description: Specifies Object type.
        type: string
        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: 0
  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
        x-nullable: true
        x-order: 0
  ObjectUnLinkingParams:
    description: Specifies the parameters required for unlinking objects. This is
      currently used as a part of vm migration workflow.
    type: object
    allOf:
    - $ref: '#/definitions/CommonObjectsActionParams'
  ObjectWithChildren:
    description: Specifies information of the object and its children objects.
    title: Object information
    allOf:
    - $ref: '#/definitions/Object'
    - type: object
      properties:
        objects:
          description: Specifies a list of child nodes for this specific node.
          type: array
          items:
            $ref: '#/definitions/ObjectWithChildren'
          x-go-name: ObjectNode
          x-order: 0
  Objects:
    description: Specifies the list of objects.
    type: object
    title: Objects
    properties:
      objects:
        description: Specifies the list of objects.
        type: array
        items:
          x-cohesity-discriminator-ref: CommonObjectSummary
          $ref: '#/definitions/CommonObjectSummaryf0e8a175-a9e2-409b-8c0e-4b53b0423501'
        x-nullable: true
        x-order: 0
  ObjectsActionRequest:
    description: Specifies the type of the action need to be performed on given set
      of objects.
    type: object
    properties:
      action:
        description: Specifies the action type that need to be performed.
        type: string
        enum:
        - Link
        - UnLink
        x-nullable: true
        x-order: 0
      linkParams:
        description: Specifies the parameters for object linking.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/ObjectLinkingParams'
      unLinkParams:
        description: Specifies the parameters for object unlinking.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/ObjectUnLinkingParams'
  ObjectsBulkAction:
    description: Describes the object bulk action status.
    type: object
    properties:
      type:
        description: Specifies the bulk action type.
        type: string
        enum:
        - Link
        - UnLink
        x-order: 0
  ObjectsLastRun:
    description: Last protection run info of objects.
    type: object
    properties:
      objectLastRuns:
        description: Specifies a list of last protection runs of objects.
        type: array
        items:
          $ref: '#/definitions/ObjectLastRun'
        x-nullable: true
        x-order: 0
  ObjectsSearchResponseBody:
    description: Specifies the Objects search result.
    type: object
    title: Objects Search Result
    properties:
      objects:
        description: Specifies the list of Objects.
        type: array
        items:
          $ref: '#/definitions/SearchObject'
        x-nullable: true
        x-order: 0
      paginationCookie:
        description: Specifies the pagination cookie with which subsequent parts of
          the response can be fetched.
        type: string
        x-nullable: true
        x-order: 1
      count:
        description: Specifies the number of objects to be fetched for the specified
          pagination cookie.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
  Office365ObjectProtectionCommonParams:
    description: Specifies the parameters which are specific to Microsoft 365 Object
      Protection.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Object Protection.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/Office365ObjectProtectionObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Object Protection.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/IndexingPolicy'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 4
        readOnly: true
  Office365ObjectProtectionObjectParams:
    description: Specifies the object parameters to create a Microsoft 365 Object
      Protection.
    type: object
    title: Microsoft 365 Object Protection Object Params
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  Office365OneDriveProtectionGroupParams:
    description: Specifies the parameters which are specific to Office 365 OneDrive
      related Protection Groups.
    type: object
    title: Office 365 OneDrive Protection Group Parameters.
    properties:
      excludeFolders:
        description: Array of Excluded OneDrive folders. Specifies filters to match
          OneDrive folders which should be excluded when backing up Office 365 source.
          Two kinds of filters are supported. a) prefix which always starts with '/'.
          b) posix which always starts with empty quotes(''). Regular expressions
          are not supported. If not specified, all the mailboxes will be protected.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
  Office365OutlookProtectionGroupParams:
    description: Specifies the parameters which are specific to Office 365 Outlook
      related Protection Groups.
    type: object
    title: Office 365(O365) Outlook Protection Group Parameters.
    properties:
      excludeFolders:
        description: Array of Excluded Outlook folders. Specifies filters to match
          Outlook folders which should be excluded when backing up Office 365 source.
          Two kinds of filters are supported. a) prefix which always starts with '/'.
          b) posix which always starts with empty quotes(''). Regular expressions
          are not supported. If not specified, all the mailboxes will be protected.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
  Office365ProtectionGroupObjectParams:
    description: Specifies the object parameters to create a Office 365 Protection
      Group.
    type: object
    title: Office 365 ProtectionGroup Object Params
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  Office365ProtectionGroupParams:
    description: Specifies the parameters which are specific to Office 365 related
      Protection Groups.
    type: object
    title: Office 365(o365) Protection Group Parameters.
    required:
    - objects
    - protectionTypes
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/Office365ProtectionGroupObjectParams'
        x-order: 0
      excludeObjectIds:
        description: Specifies the objects to be excluded in the Protection Group.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/IndexingPolicy'
      protectionTypes:
        description: Specifies the Office 365 Protection Group types.
        type: array
        minItems: 1
        items:
          type: string
          enum:
          - kMailbox
          - kOneDrive
          - kSharePoint
          - kPublicFolders
          - kGroups
          - kTeams
        x-order: 3
      outlookProtectionTypeParams:
        description: Specifies the parameters specific to Outlook Protection Group
          type.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/Office365OutlookProtectionGroupParams'
      oneDriveProtectionTypeParams:
        description: Specifies the parameters specific to OneDrive Protection Group
          type.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/Office365OneDriveProtectionGroupParams'
      publicFoldersProtectionTypeParams:
        description: Specifies the parameters specific to PublicFolders Protection
          Group type.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/Office365PublicFoldersProtectionGroupParams'
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 8
        readOnly: true
  Office365PublicFoldersProtectionGroupParams:
    description: Specifies the parameters which are specific to Office 365 PublicFolders
      related Protection Groups.
    type: object
    title: Office 365(O365) PublicFolders Protection Group Parameters.
    properties:
      excludeFolders:
        description: Array of Excluded Public folders. Specifies filters to match
          PublicFolder folders which should be excluded when backing up Office 365
          source. Two kinds of filters are supported. a) prefix which always starts
          with '/'. b) posix which always starts with empty quotes(''). Regular expressions
          are not supported. If not specified, all the PublicFolders will be protected.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
  Office365UserMailboxObjectProtectionRequestParams:
    description: Specifies the request parameters specific to Microsoft 365 User Mailbox
      object protection.
    type: object
    allOf:
    - $ref: '#/definitions/Office365ObjectProtectionCommonParams'
  Office365UserMailboxObjectProtectionResponseParams:
    description: Specifies the response parameters specific to Microsoft 365 User
      Mailbox object protection.
    type: object
    allOf:
    - $ref: '#/definitions/Office365ObjectProtectionCommonParams'
  Office365UserMailboxObjectProtectionUpdateRequestParams:
    description: Specifies the update parameters specific to Microsoft 365 User Mailbox
      object protection.
    type: object
    allOf:
    - $ref: '#/definitions/Office365ObjectProtectionCommonParams'
  OneDriveItem:
    description: Specifies a OneDrive item to recover.
    type: object
    properties:
      id:
        description: Specifies the item id.
        type: string
        x-nullable: true
        x-order: 0
      itemPath:
        description: Specifies the path to the OneDrive item.
        type: string
        x-nullable: true
        x-order: 1
      isFile:
        description: Specifies if the item is a file.
        type: boolean
        x-nullable: true
        x-order: 2
  OneDriveParam:
    description: Specifies parameters to recover a OneDrive.
    type: object
    properties:
      id:
        description: Specifies the OneDrive id.
        type: string
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      recoverItems:
        description: Specifies a list of OneDrive items to recover.
        type: array
        items:
          $ref: '#/definitions/OneDriveItem'
        x-nullable: true
        x-order: 2
  OracleCloneObject:
    description: Specifies the information about an Oracle clone object.
    type: object
    allOf:
    - $ref: '#/definitions/CommonOracleCloneParams'
    - type: object
      properties:
        dbVersion:
          description: Specifies the version of the Oracle database.
          type: string
          x-nullable: true
          x-order: 0
  OracleCloneRefreshTask:
    description: Specifies the information about an Oracle refresh task.
    type: object
    allOf:
    - $ref: '#/definitions/OracleCloneObject'
  OracleCloneTask:
    description: Specifies the information about an Oracle clone task.
    type: object
    allOf:
    - $ref: '#/definitions/PrePostScriptParams'
    - $ref: '#/definitions/CommonOracleCloneParams'
  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
        x-nullable: true
        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
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/OracleSbtHostParams'
  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
        format: int32
        x-nullable: true
        x-order: 0
      credentials:
        description: Specifies the Database credentials.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Credentials'
      databaseUniqueName:
        description: Specifies the unique Name of the database.
        type: string
        x-nullable: true
        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
        x-nullable: true
        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
        format: int32
        x-nullable: true
        x-order: 4
      databaseNodeList:
        description: Specifies the Node info from where we are allowed to take the
          backup/restore.
        type: array
        items:
          $ref: '#/definitions/OracleDatabaseHost'
        x-go-name: DatabaseHosts
        x-nullable: true
        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
        format: int32
        x-nullable: true
        x-order: 6
      enableDgPrimaryBackup:
        description: Specifies whether the database having the Primary role within
          Data Guard configuration is to be backed up.
        type: boolean
        x-nullable: true
        x-order: 7
      rmanBackupType:
        description: Specifies the type of Oracle RMAN backup requested
        type: string
        enum:
        - kImageCopy
        - kBackupSets
        - kSbt
        x-order: 8
  OracleObjectEntityParams:
    description: Object details for Oracle.
    type: object
    properties:
      databaseEntityInfo:
        description: Specifies the database entity information about the type of Oracle
          database.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/DatabaseEntityInfo'
      hostInfo:
        description: Specifies the host information for the Oracle object.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/HostInformation'
  OraclePdbObjectInfo:
    description: Specifies information PDB object to restore.
    type: object
    required:
    - dbName
    - dbId
    properties:
      dbId:
        description: Specifies pluggable database id.
        type: string
        x-nullable: true
        x-order: 0
      dbName:
        description: Specifies name of the DB.
        type: string
        x-nullable: true
        x-order: 1
  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
        x-nullable: true
        x-order: 0
      pdbObjects:
        description: Specifies list of PDB objects to restore.
        type: array
        items:
          $ref: '#/definitions/OraclePdbObjectInfo'
        x-nullable: true
        x-order: 1
      restoreToExistingCdb:
        description: Specifies if pdbs should be restored to an existing CDB.
        type: boolean
        x-nullable: true
        x-order: 2
  OracleProtectionGroupDbParams:
    description: Specifies the parameters of individual databases to create Oracle
      Protection Group.
    type: object
    title: Oracle Protection Group Database Params.
    properties:
      databaseId:
        description: Specifies the id of the Oracle database.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      databaseName:
        description: Specifies the name of the Oracle database.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      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
        items:
          $ref: '#/definitions/OracleDbChannel'
        x-nullable: true
        x-order: 2
  OracleProtectionGroupObjectParams:
    description: Specifies the object identifier to create Oracle Protection Group.
    type: object
    title: Oracle Protection Group Object Identifier.
    required:
    - sourceId
    properties:
      sourceId:
        description: Specifies the id of the host on which databases are hosted.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      sourceName:
        description: Specifies the name of the host on which databases are hosted.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      dbParams:
        description: Specifies the properties of the Oracle databases.
        type: array
        items:
          $ref: '#/definitions/OracleProtectionGroupDbParams'
        x-nullable: true
        x-order: 2
  OracleProtectionGroupParams:
    description: Specifies the parameters to create Oracle Protection Group.
    type: object
    title: Oracle Protection Group Parameters.
    required:
    - objects
    properties:
      objects:
        description: Specifies the list of object ids to be protected.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/OracleProtectionGroupObjectParams'
        x-nullable: true
        x-order: 0
      persistMountpoints:
        description: Specifies whether the mountpoints created while backing up Oracle
          DBs should be persisted.
        type: boolean
        x-nullable: true
        x-order: 1
      vlanParams:
        description: Specifies the VLAN preference that is selected by the user for
          doing backup.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/VlanParams'
  OracleRecoveryGranularityType:
    description: Describe the restore granular level.
    type: object
    title: Oracle recovery granularity type.
    properties:
      environment:
        description: Specifies oracle restore granularity level
        type: string
        enum:
        - kPDB
        x-order: 0
  OracleRestoreMetaInfoResult:
    description: Result to store oracle meta-info from snapshot id and other oracle
      params.
    type: object
    title: OracleRestoreMetaInfoResult
    properties:
      restrictedPfileParamMap:
        description: Specifies map for restricted pfile params.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
        x-nullable: true
        x-order: 0
      inheritedPfileParamMap:
        description: Specifies map for inherited pfile params.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
        x-nullable: true
        x-order: 1
      cohesityPfileParamMap:
        description: Specifies map for cohesity controlled pfile params.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
        x-nullable: true
        x-order: 2
  OracleRmanBackup:
    description: Specifies Oracle RMAN backup requested type.
    type: object
    title: Oracle RMAN backup requested type.
    properties:
      oracleRmanBackup:
        description: Specifies Oracle RMAN backup requested type.
        type: string
        enum:
        - kImageCopy
        - kBackupSets
        - kSbt
        x-order: 0
  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
        x-nullable: true
        x-order: 0
      viewFsPath:
        description: Specifies the Cohesity view path.
        type: string
        x-nullable: true
        x-order: 1
      vipList:
        description: Specifies the list of Cohesity primary VIPs.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
      vlanInfoList:
        description: Specifies the Vlan information for Cohesity cluster.
        type: array
        items:
          $ref: '#/definitions/OracleVlanInfo'
        x-nullable: true
        x-order: 3
  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: '#/definitions/CommonRecoverOracleAppTargetParams'
  OracleTier:
    description: Specifies the settings for a Oracle tier.
    type: object
    allOf:
    - $ref: '#/definitions/CommonCloudTierSettings'
    - type: object
      required:
      - tierType
      properties:
        tierType:
          description: Specifies the Oracle tier types.
          type: string
          enum:
          - kOracleTierStandard
          - kOracleTierArchive
          x-nullable: true
          x-order: 0
  OracleTieringLevels:
    description: Oracle Tiering Levels
    type: object
    title: Oracle Tiering Levels.
    properties:
      type:
        description: Oracle Tiering Levels
        type: string
        enum:
        - kOracleTierStandard
        - kOracleTierArchive
        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
        minLength: 1
        items:
          $ref: '#/definitions/OracleTier'
        x-nullable: true
        x-order: 0
  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
        items:
          type: string
        x-nullable: true
        x-order: 0
      gateway:
        description: Specifies the gateway of this VLAN.
        type: string
        x-nullable: true
        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
        x-nullable: true
        x-order: 3
  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
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the catalog.
        type: string
        x-nullable: true
        x-order: 1
      vCenterUuid:
        description: Specifies the UUID of network associated with the Vcenter.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
  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
        x-nullable: true
        x-order: 0
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/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
        x-nullable: true
        x-order: 0
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 2
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/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-nullable: true
        x-order: 5
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 2
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/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-nullable: true
        x-order: 5
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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-nullable: true
        x-order: 6
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 2
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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-nullable: true
        x-order: 4
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 2
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/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-nullable: true
        x-order: 5
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 2
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/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-nullable: true
        x-order: 5
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        x-nullable: true
        x-order: 0
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 2
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/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-nullable: true
        x-order: 5
        $ref: '#/definitions/RecoveryVlanConfig'
  PaginationInfo:
    description: Specifies information needed to support pagination.
    type: object
    properties:
      cookie:
        description: Specifies a cookie which can be passed in by the user in order
          to retrieve the next page of results.
        type: string
        x-nullable: true
        x-order: 0
  PatchDetail:
    description: Detail of a patch. It gives the service and version information of
      the the patch.
    properties:
      service:
        description: Specifies the name of the service.
        type: string
        x-nullable: true
        x-order: 0
      component:
        description: Specifies the user friendly name of the service.
        type: string
        x-nullable: true
        x-order: 1
      version:
        description: Specifies the existing version of the service. This is the available
          service patch version if exists. If there is no patch available, then it
          is the applied patch version if applied. If both don't exist, it is the
          base version of the service.
        type: string
        x-nullable: true
        x-order: 2
      import_version:
        description: Specifies the version of the imported service patch.
        type: string
        x-nullable: true
        x-order: 3
      status:
        description: Specifies the status of the patch whether it is accepted or rejected.
          A patch is rejected if it is older than the version available or applied
          on the cluster.
        type: string
        x-nullable: true
        x-order: 4
  PatchOperation:
    description: Specifies a patch operation.
    title: Patch Operation.
    properties:
      service:
        description: Specifies the name of the service.
        type: string
        x-order: 0
      component:
        description: Specifies the description of the service.
        type: string
        x-order: 1
      version:
        description: Specifies the version of the patch.
        type: string
        x-order: 2
      versionReplaced:
        description: Specifies the version it replaced.
        type: string
        x-order: 3
      operation:
        description: Specifies what patch management operation was performed
        type: string
        x-order: 4
      operationTimeMsecs:
        description: Specifies the time when the patch operation was done in Unix
          epoch in milliseconds.
        type: integer
        format: int64
        x-order: 5
      user:
        description: Specifies the user who performed the operation.
        type: string
        x-order: 6
      domain:
        description: Specifies the domain of the user.
        type: string
        x-order: 7
  PatchOperationStatus:
    description: Specifies the status of the current or the last patch operation.
    title: Patch Operation Status.
    properties:
      inProgress:
        description: Specifies whether a operation is in progress now.
        type: boolean
        x-nullable: true
        x-order: 0
      operation:
        description: Specifies the patch operation. It is either apply or revert patch
          operation.
        type: string
        x-nullable: true
        x-order: 1
      percentage:
        description: Specifies the percentage of completion of the current patch operation
          in progress or the last patch operation completed.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      timeRemainingSeconds:
        description: Specifies the time remaining to complete the patch operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      timeTakenSeconds:
        description: Specifies the time taken so far to complete the patch operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      servicesProgress:
        description: Specifies the details of patch operation services at each patch
          level.
        type: array
        items:
          $ref: '#/definitions/ServiceUnitProgress'
        x-nullable: true
        x-order: 5
      operationMessage:
        description: Specifies a message about the patch operation.
        type: string
        x-nullable: true
        x-order: 6
  PatchesDetails:
    description: Details of patches in a patch or a hotfix.
    type: array
    items:
      $ref: '#/definitions/PatchDetail'
  PatchesHistory:
    description: Specifies the history of patch operations.
    type: array
    items:
      $ref: '#/definitions/PatchOperation'
  PauseActionObjectLevelParams:
    description: Specifies the request parameters for Pause action on a Protected
      object.
    type: object
    allOf:
    - $ref: '#/definitions/ProtectionObjectInput'
  PauseActionObjectLevelResponse:
    description: Specifies the infomration about status of pause action.
    type: object
    properties:
      error:
        description: If the action fails for this object, then error will be return
          here.
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/Error'
  PermissionInfo:
    description: Specifies the list of users, groups and users that have permissions
      for a given object.
    type: object
    title: Permissions Information
    properties:
      objectId:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      users:
        description: Specifies the list of users which has the permissions to the
          object.
        type: array
        items:
          $ref: '#/definitions/User'
        x-nullable: true
        x-order: 1
      groups:
        description: Specifies the list of user groups which has permissions to the
          object.
        type: array
        items:
          $ref: '#/definitions/Group'
        x-nullable: true
        x-order: 2
      tenant:
        description: Specifies the tenant which has access to the object.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/Tenant'
  PhysicalFileBackupPathParams:
    type: object
    required:
    - includedPath
    properties:
      includedPath:
        description: Specifies a path to be included on the source. All paths under
          this path will be included unless they are specifically mentioned in excluded
          paths.
        type: string
        x-order: 0
      excludedPaths:
        description: Specifies a set of paths nested under the include path which
          should be excluded from the Protection Group.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 1
      skipNestedVolumes:
        description: Specifies whether to skip any nested volumes (both local and
          network) that are mounted under include path. Applicable only for windows
          sources.
        type: boolean
        x-nullable: true
        x-order: 2
  PhysicalFileProtectionGroupObjectParams:
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object protected.
        type: integer
        format: int64
        x-order: 0
      name:
        description: Specifies the name of the object protected.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      filePaths:
        description: Specifies a list of file paths to be protected by this Protection
          Group.
        type: array
        items:
          $ref: '#/definitions/PhysicalFileBackupPathParams'
        x-order: 2
      usesPathLevelSkipNestedVolumeSetting:
        description: Specifies whether path level or object level skip nested volume
          setting will be used.
        type: boolean
        x-nullable: true
        x-order: 3
      nestedVolumeTypesToSkip:
        description: Specifies mount types of nested volumes to be skipped.
        type: array
        items:
          type: string
        x-order: 4
      followNasSymlinkTarget:
        description: Specifies whether to follow NAS target pointed by symlink for
          windows sources.
        type: boolean
        x-nullable: true
        x-order: 5
      metadataFilePath:
        description: Specifies the path of metadatafile on source. This file contains
          absolute paths of files that needs to be backed up on the same source.
        type: string
        x-nullable: true
        x-order: 6
  PhysicalFileProtectionGroupParams:
    description: Specifies the parameters which are specific to Physical related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the list of objects protected by this Protection Group.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/PhysicalFileProtectionGroupObjectParams'
        x-order: 0
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/IndexingPolicy'
      performSourceSideDeduplication:
        description: Specifies whether or not to perform source side deduplication
          on this Protection Group.
        type: boolean
        x-nullable: true
        x-order: 2
      quiesce:
        description: Specifies Whether to take app-consistent snapshots by quiescing
          apps and the filesystem before taking a backup.
        type: boolean
        x-nullable: true
        x-order: 3
      continueOnQuiesceFailure:
        description: Specifies whether to continue backing up on quiesce failure.
        type: boolean
        x-nullable: true
        x-order: 4
      prePostScript:
        description: Specifies the pre and post script parameters associated with
          a protection group.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/PrePostScriptParams'
      dedupExclusionSourceIds:
        description: Specifies ids of sources for which deduplication has to be disabled.
        type: array
        items:
          type: integer
          format: int64
        x-order: 6
      globalExcludePaths:
        description: Specifies global exclude filters which are applied to all sources
          in a job.
        type: array
        items:
          type: string
        x-order: 7
    x-nullable: true
  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
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/RecoverTarget'
      serverCredentials:
        description: Specifies credentials to access the target server. This is required
          if the server is of Linux OS.
        allOf:
        - $ref: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  PhysicalProtectionGroupParams:
    description: Specifies the parameters specific to Physical Protection Group.
    type: object
    title: Physical Protection Group Params.
    required:
    - protectionType
    properties:
      protectionType:
        description: Specifies the Physical Protection Group type.
        type: string
        enum:
        - kFile
        - kVolume
        x-order: 0
      volumeProtectionTypeParams:
        description: Specifies the Volume based Physical Protection Group params.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/PhysicalVolumeProtectionGroupParams'
      fileProtectionTypeParams:
        description: Specifies the File based Physical Protection Group params.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/PhysicalFileProtectionGroupParams'
  PhysicalSnapshotParams:
    description: Specifies paramsters of Physical type snapshots.
    type: object
    properties:
      protectionType:
        description: Specifies the protection type of Physical snapshots.
        type: string
        enum:
        - kFile
        - kVolume
        x-nullable: true
        x-order: 0
  PhysicalSourceRegistrationParams:
    description: Specifies parameters to register physical server.
    type: object
    title: Register physical sever request parameters.
    required:
    - endpoint
    properties:
      endpoint:
        description: Specifies the endpoint IPaddress, URL or hostname of the physical
          host.
        type: string
        x-go-name: Endpoint
        x-order: 0
      forceRegister:
        description: The agent running on a physical host will fail the registration
          if it is already registered as part of another cluster. By setting this
          option to true, agent can be forced to register with the current cluster.
        type: boolean
        x-go-name: ForceRegister
        x-nullable: 'true'
        x-order: 1
  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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for mounting to the original target.
        allOf:
        - $ref: '#/definitions/PhysicalMountVolumesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for mounting to a new target.
        allOf:
        - $ref: '#/definitions/PhysicalMountVolumesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      readOnlyMount:
        description: Specifies whether to perform a read-only mount. Default is false.
        type: boolean
        x-nullable: true
        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
        items:
          type: string
        x-nullable: true
        x-order: 4
      mountedVolumeMapping:
        description: Specifies the mapping of original volumes and mounted volumes
        type: array
        items:
          $ref: '#/definitions/MountedVolumeMapping'
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-order: 0
      restoreToOriginalPaths:
        description: If this is true, then files will be restored to original paths.
        type: boolean
        x-nullable: true
        x-order: 1
      overwriteExisting:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      alternateRestoreDirectory:
        description: Specifies the directory path where restore should happen if restore_to_original_paths
          is set to false.
        type: string
        x-nullable: true
        x-order: 3
      preserveAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        x-order: 4
      preserveTimestamps:
        description: Whether to preserve the original time stamps.
        type: boolean
        x-nullable: true
        x-order: 5
      preserveAcls:
        description: Whether to preserve the ACLs of the original file.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 8
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      volumeMapping:
        description: Specifies the mapping from source volumes to destination volumes.
        type: array
        items:
          $ref: '#/definitions/RecoverVolumeMapping'
        x-nullable: true
        x-order: 1
      forceUnmountVolume:
        description: Specifies whether volume would be dismounted first during LockVolume
          failure. If not specified, default is false.
        type: boolean
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 3
  PhysicalVolumeProtectionGroupObjectParams:
    description: Specifies object parameters for creating physical volume Protection
      Groups.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object protected.
        type: integer
        format: int64
        x-order: 0
      name:
        description: Specifies the name of the object protected.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      volumeGuids:
        description: Specifies the list of GUIDs of volumes protected. If empty, then
          all volumes will be protected by default.
        type: array
        items:
          type: string
        x-order: 2
      enableSystemBackup:
        description: Specifies whether or not to take a system backup. Applicable
          only for windows sources.
        type: boolean
        x-nullable: true
        x-order: 3
  PhysicalVolumeProtectionGroupParams:
    description: Specifies the parameters which are specific to Volume based physical
      Protection Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/PhysicalVolumeProtectionGroupObjectParams'
        x-order: 0
      indexingPolicy:
        description: Specifies the fields required to enable indexing of the protected
          objects such as files and directories.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/IndexingPolicy'
      performSourceSideDeduplication:
        description: Specifies whether or not to perform source side deduplication
          on this Protection Group.
        type: boolean
        x-nullable: true
        x-order: 2
      quiesce:
        description: Specifies Whether to take app-consistent snapshots by quiescing
          apps and the filesystem before taking a backup
        type: boolean
        x-nullable: true
        x-order: 3
      continueOnQuiesceFailure:
        description: Specifies whether to continue backing up on quiesce failure
        type: boolean
        x-nullable: true
        x-order: 4
      incrementalBackupAfterRestart:
        description: Specifies whether or not to perform an incremental backup after
          the server restarts. This is applicable to windows environments.
        type: boolean
        x-nullable: true
        x-order: 5
      prePostScript:
        description: Specifies the pre and post script parameters associated with
          a protection group.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/PrePostScriptParams'
      dedupExclusionSourceIds:
        description: Specifies ids of sources for which deduplication has to be disabled.
        type: array
        items:
          type: integer
          format: int64
        x-order: 7
      excludedVssWriters:
        description: Specifies writer names which should be excluded from physical
          volume based backups.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 8
    x-nullable: true
  PlannedFailoverParams:
    description: Specifies parameters of a planned failover.
    type: object
    required:
    - type
    properties:
      type:
        description: Spcifies the planned failover type.<br> 'Prepare' indicates this
          is a preparation for failover.<br> 'Finalize' indicates this is finalization
          of failover. After this is done, the view can be used as source view.
        type: string
        enum:
        - Prepare
        - Finalize
        x-nullable: true
        x-order: 0
      preparePlannedFailverParams:
        description: Specifies parameters of preparation of a planned failover.
        allOf:
        - $ref: '#/definitions/PreparePlannedFailverParams'
        - x-nullable: true
        x-order: 1
  PlannedRunPollStatus:
    description: Specifies whether run has been scheduled or not and also returns
      the unique run id along with failoverId upon scheduling the run.
    type: object
    properties:
      failoverId:
        description: Specifies the unique failover Id which will be generated by orchestrator.
          This Id will be used to uniquely identify current failover operation.
        type: string
        x-nullable: true
        x-order: 0
      waitingOnOtherRunCancellations:
        description: If cancelNonFailoverRuns was passed as true during creation of
          run for current failover then this will return the status of other run cacellations.
          If other runs are still pending for cancellations then this will be returned
          as true otherwise it will be return as false.
        type: boolean
        x-nullable: true
        x-order: 1
      runId:
        description: If run has been scheduled then this field will be populated with
          unique run id.
        type: string
        x-nullable: true
        x-order: 2
      protectionGroupId:
        description: Specifies the protection group id to which this run belongs.
        type: string
        x-nullable: true
        x-order: 3
  PluggableDatabaseInfo:
    description: Specifies the information about Pluggable databases.
    type: object
    properties:
      databaseId:
        description: Specifies the database Id of the Pluggable DB.
        type: string
        x-nullable: true
        x-order: 0
      databaseName:
        description: Specifies the name of the Pluggable DB.
        type: string
        x-nullable: true
        x-order: 1
  PolicyScheduledBackup:
    description: Policy Scheduled Backup type.
    type: object
    title: Policy Scheduled Backup type.
    properties:
      PolicyScheduledBackup:
        description: Specifies Scheduled Backup type.
        type: string
        enum:
        - Regular
        - Full
        - Log
        - System
        x-order: 0
  PolicyTemplateResponse:
    description: Specifies the details about the Protection Policy.
    title: Protection Policy
    allOf:
    - $ref: '#/definitions/ProtectionPolicy'
    - type: object
      properties:
        id:
          description: Specifies a unique Policy id assigned by the Cohesity Cluster.
          type: string
          x-nullable: true
          x-order: 0
        numLinkedPolicies:
          description: Specifies the number of policies linked to this policy template.
            Only applicable in case of policy template.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
        isUsable:
          description: This field is set to true if this policy template qualifies
            to create more policies. If the template is partially filled and can not
            create a working policy then this field will be set to false.
          type: boolean
          x-nullable: true
          x-order: 2
  PolicyTemplatesResponseWithPagination:
    description: Specifies the details about the Protection Policy Templates.
    type: object
    title: Protection Policy Template Response.
    properties:
      policies:
        description: Specifies a list of protection policies.
        type: array
        items:
          $ref: '#/definitions/PolicyTemplateResponse'
        x-nullable: true
        x-order: 0
  PrePostScriptParams:
    description: Specifies the params for pre and post scripts.
    type: object
    title: Pre and Post Script Params.
    properties:
      preScript:
        description: Specifies the pre backup script params. This script will be executed
          before starting backup run.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/CommonPreBackupScriptParams'
      postScript:
        description: Specifies the post backup script params. This script will be
          executed after backup run finishes.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/CommonPostBackupScriptParams'
  PreparePlannedFailverParams:
    description: Specifies parameters of preparation of a planned failover.
    type: object
    properties:
      reverseReplication:
        description: Specifies whether a reverse replication needs to be set for the
          view on target cluster after failover.
        type: boolean
        x-nullable: true
        x-order: 0
  PrimaryArchivalTarget:
    description: Specifies the primary archival settings. Mainly used for cloud direct
      archive (CAD) policy where primary backup is stored on archival target.
    type: object
    required:
    - targetId
    properties:
      targetId:
        description: Specifies the Archival target id to take primary backup.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      targetName:
        description: Specifies the Archival target name where Snapshots are copied.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      tierSettings:
        description: Specifies the Archival target name where Snapshots are copied.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/TierLevelSettings'
  PrimaryBackupTarget:
    description: Specifies the primary backup target settings for regular backups.
      If the backup target field is not specified then backup will be taken locally
      on the Cohesity cluster.
    type: object
    properties:
      targetType:
        description: Specifies the primary backup location where backups will be stored.
          If not specified, then default is assumed as local backup on Cohesity cluster.
        type: string
        default: Local
        enum:
        - Local
        - Archival
        x-nullable: true
        x-order: 0
      archivalTargetSettings:
        description: Specifies the archival backup target details. This is applicable
          only if targetType is set to 'archival'.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/PrimaryArchivalTarget'
  PrimaryBackupTargetLocation:
    description: Primary Backup Target Location.
    type: object
    title: Primary Backup Target Location.
    properties:
      type:
        description: Primary Backup Target Location.
        type: string
        enum:
        - Local
        - Archival
        x-order: 0
  PrivateKeyCredentials:
    description: Specifies the credentials for certificate based authentication.
    type: object
    title: Private key credentials
    required:
    - userId
    - privateKey
    properties:
      userId:
        description: Specifies the userId to access target entity.
        type: string
        x-order: 0
      privateKey:
        description: Specifies the private key to access target entity.
        type: string
        x-order: 1
      passphrase:
        description: Specifies the passphrase to access target entity.
        type: string
        x-order: 2
  ProgreeTaskStatus:
    description: Progress Task Status
    type: object
    title: ProgressTaskStatus
    properties:
      progressaskStatus:
        description: Specifies the progress task status.
        type: string
        enum:
        - Active
        - Finished
        - FinishedWithError
        - Canceled
        - FinishedGarbageCollected
        x-order: 0
  ProgressStats:
    description: Specifies the stats within progress.
    type: object
    properties:
      fileWalkDone:
        description: Specifies whether the file system walk is done. Only applicable
          to file based backups.
        type: boolean
        x-nullable: true
        x-order: 0
      totalFileCount:
        description: Specifies the total number of file and directory entities visited
          in this backup. Only applicable to file based backups.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      backupFileCount:
        description: Specifies the total number of file and directory entities that
          are backed up in this run. Only applicable to file based backups.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  ProgressSummary:
    description: Specifies the progress summary.
    type: object
    properties:
      success:
        description: Specifies the successful count.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      failed:
        description: Specifies the failed count.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      total:
        description: Specifies the total count.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  ProgressTask:
    description: This specifies the details about the Progress Task.
    title: Progress Task
    allOf:
    - type: object
      properties:
        id:
          description: Specifies the task id of the Progress task.
          type: string
          x-nullable: true
          x-order: 0
    - $ref: '#/definitions/ProgressTaskInfo'
  ProgressTaskEvent:
    description: Specifies the details about the various events which are created
      during the execution of Progress Task.
    type: object
    properties:
      message:
        description: Specifies the log message describing the current event.
        type: string
        x-nullable: true
        x-order: 0
      occuredAtUsecs:
        description: Specifies the time of the event occurance in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  ProgressTaskInfo:
    description: Specifies the details about a Progress Task.
    type: object
    title: Progress Task
    properties:
      status:
        description: Specifies the current status of the progress task.
        type: string
        enum:
        - Active
        - Finished
        - FinishedWithError
        - Canceled
        - FinishedGarbageCollected
        x-nullable: true
        x-order: 0
      percentageCompleted:
        description: Specifies the current completed percentage of the progress task.
        type: number
        format: float
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the start time of the progress task in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      endTimeUsecs:
        description: Specifies the end time of the progress task in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      expectedRemainingTimeUsecs:
        description: Specifies the expected remaining time of the progress task in
          Unix epoch Timestamp(in microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      events:
        description: Specifies the event log created for progress Task.
        type: array
        items:
          $ref: '#/definitions/ProgressTaskEvent'
        x-order: 5
      stats:
        description: Specifies the stats within the progress.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/ProgressStats'
  ProgressTasks:
    description: List of Progress Tasks.
    type: object
    title: Progress Tasks
    properties:
      progressTasks:
        description: Specifies the list of Progress Task.
        type: array
        items:
          $ref: '#/definitions/ProgressTask'
        x-nullable: true
        x-order: 0
  ProjectScopeParams:
    description: Specifies the parameters for project type scope.
    type: object
    required:
    - projectName
    - domainName
    properties:
      projectName:
        description: Specifies the project name.
        type: string
        x-nullable: true
        x-order: 0
      domainName:
        description: Specifies the domain name of the project.
        type: string
        x-nullable: true
        x-order: 1
  ProtectdObjectsActionRequest:
    description: Specifies the request for performing various actions on protected
      objects.
    type: object
    required:
    - action
    properties:
      action:
        description: Specifies the action type to be performed on object getting protected.
          Based on selected action, provide the action params.
        type: string
        enum:
        - Pause
        - Resume
        - UnProtect
        - ProtectNow
        x-order: 0
      pauseParams:
        description: If provided action is 'Pause' then this object should be provided
          as input.
        type: object
        x-order: 1
        $ref: '#/definitions/ProtectedObjectPauseActionParams'
      resumeParams:
        description: If provided action is 'Resume' then this object should be provided
          as input.
        type: object
        x-order: 2
        $ref: '#/definitions/ProtectedObjectResumeActionParams'
      runNowParams:
        description: If provided action is 'RunNow' then this object should be provided
          as input.
        type: object
        x-order: 3
        $ref: '#/definitions/ProtectedObjectRunNowActionParams'
      unProtectParams:
        description: If provided action is 'UnProtect' then this object should be
          provided as input.
        type: object
        x-order: 4
        $ref: '#/definitions/ProtectedObjectUnProtectActionParams'
  ProtectedObject:
    description: Specifies the Protected Object with last Run's snapshot information
      per Protection Group.
    title: Protected Object
    allOf:
    - $ref: '#/definitions/Object'
    - type: object
      properties:
        sourceInfo:
          description: Specifies the Source Object information.
          allOf:
          - $ref: '#/definitions/ObjectSummary'
          - x-nullable: true
          x-nullable: true
          x-order: 0
        latestSnapshotsInfo:
          description: Specifies the latest snapshot information for every Protection
            Group for a given object.
          type: array
          items:
            $ref: '#/definitions/ObjectSnapshotsInfo'
          x-nullable: true
          x-order: 1
  ProtectedObjectActionResponse:
    description: Specifies the response upon performing an action on protected objects.
    type: object
    properties:
      action:
        description: Specifies the action type to be performed on object getting protected.
          Based on selected action, provide the action params.
        type: string
        enum:
        - Pause
        - Resume
        - UnProtect
        - ProtectNow
        x-order: 0
      objects:
        description: Specifies the list of objects on which the provided action was
          performed.
        type: array
        items:
          $ref: '#/definitions/ActionObjectLevelResponse'
        x-order: 1
  ProtectedObjectBackupConfig:
    description: Specifies the backup configuration for protected object.
    type: object
    allOf:
    - $ref: '#/definitions/CommonObjectProtectParams'
    - $ref: '#/definitions/EnvSpecificObjectProtectionResponseParams'
    - type: object
      properties:
        isAutoProtectConfig:
          description: Specifies whether or not this configuration is applied to an
            autoprotected object rather than this specific object.
          type: boolean
          x-nullable: true
          x-order: 0
        autoProtectParentId:
          description: Specifies the parent ID of the object which the backup configuration
            is applied to if this is an auto protect config.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
        isPaused:
          description: Specifies whether or not protection has been paused on this
            object.
          type: boolean
          x-nullable: true
          x-order: 2
        isActive:
          description: Specifies whether or not protection has been deactivated on
            this object.
          type: boolean
          x-nullable: true
          x-order: 3
  ProtectedObjectGroupBackupConfig:
    description: Specifies the parameters of a protection group which is protecting
      an object.
    type: object
    properties:
      protectionGroupId:
        description: Specifies the protection group id, if given object is also protected
          by a protection group.
        type: string
        x-nullable: true
        x-order: 0
      protectionGroupName:
        description: Specifies the protection group name, if given object is also
          protected by a protection group.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  ProtectedObjectInfo:
    description: Specifies the details of a protected object.
    type: object
    allOf:
    - $ref: '#/definitions/ObjectSummary'
    - type: object
      properties:
        permissions:
          description: Specifies the list of tenants that have permissions for this
            accessing given protected object.
          type: array
          items:
            $ref: '#/definitions/Tenant'
          x-nullable: true
          x-order: 0
        objectBackupConfiguration:
          description: Specifies the object based protection info associated with
            this object.
          type: object
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/ProtectedObjectBackupConfig'
        protectionGroupConfigurations:
          description: Specifies the protection info associated with every object.
            There can be multiple instances of protection info since the same object
            can be protected in multiple protection groups.
          type: array
          items:
            $ref: '#/definitions/ProtectedObjectGroupBackupConfig'
          x-nullable: true
          x-order: 2
        lastRun:
          description: Specifies the last run information for a given object. This
            is the most recent run across all protection groups and object backup
            config.
          type: object
          x-order: 3
          $ref: '#/definitions/ObjectProtectionRunSummary'
  ProtectedObjectPauseActionParams:
    description: Specifies the request parameters for Pause action on Protected objects.
    type: object
    properties:
      objects:
        description: Specifies the list of objects to perform an action. If provided
          object id is not explicitly protected by object protection, then given action
          will not be performed on that.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/PauseActionObjectLevelParams'
        x-order: 0
  ProtectedObjectResumeActionParams:
    description: Specifies the request parameters for Resume action on Protected objects.
    type: object
    properties:
      objects:
        description: Specifies the list of objects to perform an action. If provided
          object id is not explicitly protected by object protection, then given action
          will not be performed on that.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ResumeActionObjectLevelParams'
        x-order: 0
  ProtectedObjectRunNowActionParams:
    description: Specifies the request parameters for RunNow action on Protected objects.
    type: object
    properties:
      objects:
        description: Specifies the list of objects to perform an action. If provided
          object id is not explicitly protected by object protection, then given action
          will not be performed on that.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/RunNowActionObjectLevelParams'
        x-order: 0
  ProtectedObjectUnProtectActionParams:
    description: Specifies the request parameters for Unprotect action on Protected
      objects.
    type: object
    properties:
      objects:
        description: Specifies the list of objects to perform an action. If provided
          object id is not explicitly protected by object protection, then given action
          will not be performed on that.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/UnprotectActionObjectLevelParams'
        x-order: 0
  ProtectedObjectsSearchMetadata:
    description: Specifies the metadata information about the Protection Groups, Protection
      Policy etc., for search result
    type: object
    title: Protected Objects Search Metadata
    properties:
      uniqueProtectionGroupIdentifiers:
        description: Specifies the list of unique Protection Group identifiers for
          all the Objects returned in the response.
        type: array
        items:
          $ref: '#/definitions/ProtectionGroupIdentifier'
        x-nullable: true
        x-order: 0
  ProtectedObjectsSearchResponseBody:
    description: Specifies the Protected Objects search result.
    type: object
    title: Protected Objects Search Result
    properties:
      objects:
        description: Specifies the list of Protected Objects.
        type: array
        items:
          $ref: '#/definitions/ProtectedObject'
        x-nullable: true
        x-order: 0
      metadata:
        description: Specifies the metadata information about the Protection Groups,
          Protection Policy etc., for search result.
        allOf:
        - $ref: '#/definitions/ProtectedObjectsSearchMetadata'
        - x-nullable: true
        x-order: 1
      numResults:
        description: Specifies the total number of search results which matches the
          search criteria.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  ProtectionGroup:
    description: Protection Group  response.
    type: object
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareProtectionGroupParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/AcropolisProtectionGroupParams'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/KubernetesProtectionGroupParams'
        mssqlParams:
          description: Specifies the parameters specific to MSSQL Protection Group.
          type: object
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/MSSQLProtectionGroupParams'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle Protection
            Group.
          type: object
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/OracleProtectionGroupParams'
        viewParams:
          description: Specifies the parameters which are specific to View related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kView
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ViewProtectionGroupParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/PureProtectionGroupParams'
        nimbleParams:
          description: Specifies the parameters which are specific to Nimble related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNimble
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/NimbleProtectionGroupParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/HyperVProtectionGroupParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/AwsProtectionGroupParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/AzureProtectionGroupParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/GcpProtectionGroupParams'
        kvmParams:
          description: Specifies the parameters which are specific to Kvm related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/KvmProtectionGroupParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/PhysicalProtectionGroupParams'
        adParams:
          description: Specifies the parameters which are specific to Active Directory
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAD
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/ADProtectionGroupParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/Office365ProtectionGroupParams'
        netappParams:
          description: Specifies the parameters which are specific to NetApp related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/NetappProtectionGroupParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic Nas
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/GenericNasProtectionGroupParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/IsilonProtectionGroupParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to Flashblade related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/FlashbladeProtectionGroupParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/GpfsProtectionGroupParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/ElastifileProtectionGroupParams'
        remoteAdapterParams:
          description: Specifies the parameters which are specific to Remote Adapter
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kRemoteAdapter
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/RemoteAdapterProtectionGroupParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchangee related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/ExchangeProtectionGroupParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/CassandraProtectionGroupParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/MongoDBProtectionGroupParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 27
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 28
          $ref: '#/definitions/HdfsProtectionGroupParams'
        hbaseParams:
          description: Specifies the parameters which are specific to HBase Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 29
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 30
          $ref: '#/definitions/UdaProtectionGroupParams'
  ProtectionGroupAlertingPolicy:
    description: Specifies a policy for alerting users of the status of a Protection
      Group.
    type: object
    required:
    - backupRunStatus
    properties:
      backupRunStatus:
        description: Specifies the run status for which the user would like to receive
          alerts.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: string
          enum:
          - kSuccess
          - kFailure
          - kSlaViolation
        x-order: 0
      alertTargets:
        description: Specifies a list of targets to receive the alerts.
        type: array
        items:
          $ref: '#/definitions/AlertTarget'
        x-order: 1
  ProtectionGroupIdentifier:
    description: Specifies Protection Group Identifier.
    type: object
    title: Protection Group Identifier.
    properties:
      protectionGroupId:
        description: Specifies Protection Group id.
        type: string
        x-nullable: true
        x-order: 0
      protectionGroupName:
        description: Specifies Protection Group name.
        type: string
        x-nullable: true
        x-order: 1
  ProtectionGroupInfo:
    description: Specifies basic information about a Protection Group.
    type: object
    title: Protection Group Info
    properties:
      groupId:
        description: Specifies the id of the Protection Group.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      groupName:
        description: Specifies the name of the Protection Group.
        type: string
        x-nullable: true
        x-order: 1
      type:
        description: 'Specifies the type of the Protection Group such as View or Puppeteer.

          ''Puppeteer'' refers to a Remote Adapter Group.

          Supported environment types such as ''View'', ''SQL'', ''VMware'', etc.

          NOTE: ''Puppeteer'' refers to Cohesity''s Remote Adapter.

          ''VMware'' indicates the VMware Protection Source environment.

          ''HyperV'' indicates the HyperV Protection Source environment.

          ''SQL'' indicates the SQL Protection Source environment.

          ''View'' indicates the View Protection Source environment.

          ''Puppeteer'' indicates the Cohesity''s Remote Adapter.

          ''Physical'' indicates the physical Protection Source environment.

          ''Pure'' indicates the Pure Storage Protection Source environment.

          ''Nimble'' indicates the Nimble Storage Protection Source environment.

          ''Azure'' indicates the Microsoft''s Azure Protection Source environment.

          ''Netapp'' indicates the Netapp Protection Source environment.

          ''Agent'' indicates the Agent Protection Source environment.

          ''GenericNas'' indicates the Generic Network Attached Storage Protection

          Source environment.

          ''Acropolis'' indicates the Acropolis Protection Source environment.

          ''PhsicalFiles'' indicates the Physical Files Protection Source environment.

          ''Isilon'' indicates the Dell EMC''s Isilon Protection Source environment.

          ''GPFS'' indicates IBM''s GPFS Protection Source environment.

          ''KVM'' indicates the KVM Protection Source environment.

          ''AWS'' indicates the AWS Protection Source environment.

          ''Exchange'' indicates the Exchange Protection Source environment.

          ''HyperVVSS'' indicates the HyperV VSS Protection Source

          environment.

          ''Oracle'' indicates the Oracle Protection Source environment.

          ''GCP'' indicates the Google Cloud Platform Protection Source environment.

          ''FlashBlade'' indicates the Flash Blade Protection Source environment.

          ''AWSNative'' indicates the AWS Native Protection Source environment.

          ''O365'' indicates the Office 365 Protection Source environment.

          ''O365Outlook'' indicates Office 365 outlook Protection Source environment.

          ''HyperFlex'' indicates the Hyper Flex Protection Source environment.

          ''GCPNative'' indicates the GCP Native Protection Source environment.

          ''AzureNative'' indicates the Azure Native Protection Source environment.

          ''Kubernetes'' indicates a Kubernetes Protection Source environment.

          ''Elastifile'' indicates Elastifile Protection Source environment.

          ''AD'' indicates Active Directory Protection Source environment.'
        type: string
        enum:
        - kVMware
        - kHyperV
        - kSQL
        - kView
        - kRemoteAdapter
        - kPhysical
        - kPure
        - kAzure
        - kNetapp
        - kGenericNas
        - kAcropolis
        - kIsilon
        - kKVM
        - kAWS
        - kExchange
        - kOracle
        - kGCP
        - kFlashBlade
        - kO365
        - kHyperFlex
        - kAD
        - kGPFS
        - kKubernetes
        - kNimble
        - kElastifile
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        x-nullable: true
        x-order: 2
  ProtectionGroupPriority:
    description: Protection Group Priority type.
    type: object
    title: Protection Group Priority type.
    properties:
      protectionGroupPriority:
        description: Specifies Protection Group priority.
        type: string
        enum:
        - kLow
        - kMedium
        - kHigh
        x-order: 0
  ProtectionGroupRun:
    description: Protection run.
    type: object
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRunResponseParameters'
  ProtectionGroupRuns:
    description: Protection runs.
    type: object
    properties:
      runs:
        description: Specifies the list of Protection Group runs.
        type: array
        items:
          $ref: '#/definitions/ProtectionGroupRun'
        x-nullable: true
        x-order: 0
  ProtectionGroupStateChangeActions:
    description: Protection Group State Change Actions type.
    type: object
    title: Protection Group State Change Actions type.
    properties:
      protectionGroupStateChangeActions:
        description: Specifies Protection Group State Change Actions type.
        type: string
        enum:
        - kPause
        - kResume
        x-order: 0
  ProtectionGroups:
    description: Protection Group  response.
    type: object
    properties:
      protectionGroups:
        description: Specifies the list of Protection Groups which were returned by
          the request.
        type: array
        items:
          x-cohesity-discriminator-ref: CommonProtectionGroupResponseParams
          $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
        x-nullable: true
        x-order: 0
  ProtectionObjectInput:
    description: Specifies an object protected by a Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  ProtectionPolicy:
    description: Specifies common fields required to define Protection Policy.
    type: object
    title: Protection Policy
    required:
    - name
    - backupPolicy
    properties:
      name:
        description: Specifies the name of the Protection Policy.
        type: string
        x-nullable: true
        x-order: 0
      backupPolicy:
        description: Specifies the backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/BackupPolicy'
      description:
        description: Specifies the description of the Protection Policy.
        type: string
        x-nullable: true
        x-order: 2
      blackoutWindow:
        description: List of Blackout Windows. If specified, this field defines blackout
          periods when new Group Runs are not started. If a Group Run has been scheduled
          but not yet executed and the blackout period starts, the behavior depends
          on the policy field AbortInBlackoutPeriod.
        type: array
        title: Blackout Window
        items:
          $ref: '#/definitions/BlackoutWindow'
        x-nullable: true
        x-order: 3
      extendedRetention:
        description: Specifies additional retention policies that should be applied
          to the backup snapshots. A backup snapshot will be retained up to a time
          that is the maximum of all retention policies that are applicable to it.
        type: array
        title: Extended Retention
        items:
          $ref: '#/definitions/ExtendedRetentionPolicy'
        x-nullable: true
        x-order: 4
      remoteTargetPolicy:
        description: Specifies the remote, archival or cloudSpin targets where the
          snapshot is backed up.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/TargetsConfiguration'
      retryOptions:
        description: Specifies the retry options of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/RetryOptions'
      dataLock:
        description: "Specifies WORM retention type for the snapshots. When a WORM\
          \ retention type is specified, the snapshots of the Protection Groups using\
          \ this policy will be kept until the maximum of the snapshot retention time.\
          \ During that time, the snapshots cannot be deleted. \n'Compliance' implies\
          \ WORM retention is set for compliance reason. \n'Administrative' implies\
          \ WORM retention is set for administrative purposes."
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 7
  ProtectionPolicyIdentifier:
    description: Specifies Protection Policy Identifier.
    type: object
    title: Protection Policy Identifier.
    properties:
      protectionPolicyId:
        description: Specifies Protection Policy id.
        type: string
        x-nullable: true
        x-order: 0
      protectionPolicyName:
        description: Specifies Protection Policy name.
        type: string
        x-nullable: true
        x-order: 1
  ProtectionPolicyRequest:
    description: Specifies the request to create a Protection Policy.
    title: Protection Policy Request.
    allOf:
    - $ref: '#/definitions/ProtectionPolicy'
    - type: object
      properties:
        templateId:
          description: Specifies the parent policy template id to which the policy
            is linked to.
          type: string
          x-nullable: true
          x-order: 0
  ProtectionPolicyResponse:
    description: Specifies the details about the Protection Policy.
    title: Protection Policy
    allOf:
    - $ref: '#/definitions/ProtectionPolicy'
    - type: object
      properties:
        id:
          description: Specifies a unique Policy id assigned by the Cohesity Cluster.
          type: string
          x-nullable: true
          x-order: 0
        templateId:
          description: Specifies the parent policy template id to which the policy
            is linked to. This field is set only when policy is created from template.
          type: string
          x-nullable: true
          x-order: 1
        isUsable:
          description: This field is set to true if the linked policy which is internally
            created from a policy templates qualifies as usable to create more policies
            on the cluster. If the linked policy is partially filled and can not create
            a working policy then this field will be set to false. In case of normal
            policy created on the cluster, this field wont be populated.
          type: boolean
          x-nullable: true
          x-order: 2
        isReplicated:
          description: This field is set to true when policy is the replicated policy.
          type: boolean
          x-nullable: true
          x-order: 3
  ProtectionPolicyResponseWithPagination:
    description: Specifies the details about the Protection Policy.
    type: object
    title: Protection Policy Response.
    properties:
      policies:
        description: Specifies a list of protection policies.
        type: array
        items:
          $ref: '#/definitions/ProtectionPolicyResponse'
        x-nullable: true
        x-order: 0
  ProtectionPolicyType:
    description: Protection Policy Type.
    type: object
    title: Protection Policy Type.
    properties:
      type:
        description: Specifies the protection policy type.
        type: string
        enum:
        - Regular
        - Internal
        x-order: 0
  ProtectionRunSummary:
    description: Specifies the summary of a protection run.
    type: object
    properties:
      id:
        description: Specifies the ID of the Protection Group run.
        type: string
        x-nullable: true
        x-order: 0
      protectionGroupId:
        description: ProtectionGroupId to which this run belongs.
        type: string
        x-nullable: true
        x-order: 1
      protectionGroupName:
        description: Name of the Protection Group to which this run belongs.
        type: string
        x-nullable: true
        x-order: 2
      environment:
        description: Specifies the environment type of the Protection Group.
        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-nullable: true
        x-order: 3
      isSlaViolated:
        description: Indicated if SLA has been violated for this run.
        type: boolean
        x-nullable: true
        x-order: 4
      startTimeUsecs:
        description: Specifies the start time of backup run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      endTimeUsecs:
        description: Specifies the end time of backup run in Unix epoch Timestamp(in
          microseconds).
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      status:
        description: Status of the backup run. 'Running' indicates that the run is
          still running. 'Canceled' indicates that the run has been canceled. 'Canceling'
          indicates that the run is in the process of being canceled. 'Failed' indicates
          that the run has failed. 'Missed' indicates that the run was unable to take
          place at the scheduled time because the previous run was still happening.
          'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning'
          indicates that the run finished successfully, but there were some warning
          messages.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 7
      isFullRun:
        description: Specifies if the protection run is a full run.
        type: boolean
        x-nullable: true
        x-order: 8
      totalObjectsCount:
        description: Specifies the total number of objects protected in this run.
        type: integer
        format: int64
        x-nullable: true
        x-order: 9
      successObjectsCount:
        description: Specifies the number of objects which are successfully protected
          in this run.
        type: integer
        format: int64
        x-nullable: true
        x-order: 10
      logicalSizeBytes:
        description: Specifies total logical size of object(s) in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 11
      bytesWritten:
        description: Specifies total size of data in bytes written after taking backup.
        type: integer
        format: int64
        x-nullable: true
        x-order: 12
  ProtectionRunsStats:
    description: Specifies the statistics of protection runs.
    properties:
      protectionRunStatus:
        description: Specifies the status of protection runs.
        type: string
        enum:
        - Running
        - Canceled
        - Failed
        - Succeeded
        - SucceededWithWarning
        x-nullable: true
        x-order: 0
      protectionRunsCount:
        description: Specifies the number of protection runs.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  ProtectionRunsStatsList:
    description: Specifies the statistics of protection runs at the specific time.
    properties:
      timestamp:
        description: Specifies a Unix epoch Timestamp (in microseconds) of this statistics.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      stats:
        description: Specifies the protection runs stats.
        type: array
        items:
          $ref: '#/definitions/ProtectionRunsStats'
        x-nullable: true
        x-order: 1
  ProtectionRunsSummary:
    description: Specifies a list of summaries of protection runs.
    type: object
    properties:
      protectionRunsSummary:
        description: Specifies a list of summaries of protection runs.
        type: array
        items:
          $ref: '#/definitions/ProtectionRunSummary'
        x-nullable: true
        x-order: 0
  ProtectionSummary:
    description: Specifies a summary of an object protection.
    type: object
    properties:
      policyName:
        description: Specifies the policy name for this group.
        type: string
        x-nullable: true
        x-order: 0
      policyId:
        description: Specifies the policy id for this protection.
        type: string
        x-nullable: true
        x-order: 1
      lastBackupRunStatus:
        description: Specifies the status of last local back up run.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 2
      lastArchivalRunStatus:
        description: Specifies the status of last archival run.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 3
      lastReplicationRunStatus:
        description: Specifies the status of last replication run.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 4
      lastRunSlaViolated:
        description: Specifies if the sla is violated in last run.
        type: boolean
        x-nullable: true
        x-order: 5
  ProtectionType:
    description: Protection type.
    type: object
    title: Protection type.
    properties:
      environment:
        description: Specifies Protection type.
        type: string
        enum:
        - kAgent
        - kNative
        - kSnapshotManager
        - kRDSSnapshotManager
        - kAuroraSnapshotManager
        - kFile
        - kVolume
        x-order: 0
  ProtocolAccessLevel:
    description: Protocol access level
    type: object
    title: Protocol access level
    properties:
      protocolAccessLevel:
        description: Specifies the level of access for any protocol.
        type: string
        enum:
        - kDisabled
        - kReadOnly
        - kReadWrite
        x-order: 0
  PublicFolder:
    description: Specifies an PublicFolder item to recover.
    type: object
    required:
    - folderId
    properties:
      folderId:
        description: Specifies the Unique ID of the folder.
        type: string
        x-nullable: true
        x-order: 0
      recoverEntireFolder:
        description: Specifies whether to recover the whole PublicFolder.
        type: boolean
        x-nullable: true
        x-order: 1
      itemIds:
        description: Specifies a list of item ids to recover. This field is applicable
          only if 'recoverEntireFolder' is false.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
  PublicFolderItem:
    description: Specifies an Public folder indexed item.
    title: PublicFolderItem
    allOf:
    - $ref: '#/definitions/CommonIndexedObjectParams'
    - type: object
      properties:
        type:
          description: Specifies the Public folder item type.
          type: string
          x-cohesity-enum: indexed_public_folder_type
          x-nullable: true
          x-order: 0
        id:
          description: Specifies the id of the indexed item.
          type: string
          x-nullable: true
          x-order: 1
        subject:
          description: Specifies the subject of the indexed item.
          type: string
          x-nullable: true
          x-order: 2
        hasAttachments:
          description: Specifies whether the item has any attachments
          type: boolean
          x-nullable: true
          x-order: 3
        itemClass:
          description: Specifies the item class of the indexed item.
          type: string
          x-nullable: true
          x-order: 4
        receivedTimeSecs:
          description: Specifies the Unix timestamp epoch in seconds at which this
            item is received.
          type: integer
          format: int64
          x-nullable: true
          x-order: 5
        itemSize:
          description: Specifies the size in bytes for the indexed item.
          type: integer
          format: int64
          x-nullable: true
          x-order: 6
        parentFolderId:
          description: Specifies the id of parent folder the indexed item.
          type: string
          x-nullable: true
          x-order: 7
  PublicFolderItemType:
    description: Public Folder item types for search.
    type: object
    title: Public Folder item types for search.
    properties:
      type:
        description: Specifies the Public Folder item types for search.
        type: string
        enum:
        - Calendar
        - Contact
        - Post
        - Folder
        - Task
        - Journal
        - Note
        x-order: 0
  PublicTaskStatus:
    description: Public Task Status
    type: object
    title: PublicTaskStatus
    properties:
      publicTaskStatus:
        description: Specifies the public task status.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-order: 0
  PureProtectionGroupObjectParams:
    description: Specifies the object parameters to create Pure Protection Group.
    type: object
    title: Pure Protection Group Object Params.
    required:
    - id
    properties:
      id:
        description: Specifies the id of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  PureProtectionGroupParams:
    description: Specifies the parameters which are specific to Pure related Protection
      Groups.
    type: object
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/PureProtectionGroupObjectParams'
        x-order: 0
      maxSnapshotsOnPrimary:
        description: Specifies the number of snapshots to retain on the primary environment.
          If not specified, then snapshots will not be deleted from the primary environment.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      prePostScript:
        description: Specifies the pre script and post script to run before and after
          the protection group.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/HostBasedBackupScriptParams'
    x-nullable: true
  QoS:
    description: Specifies the Quality of Service (QoS) Policy for the View.
    type: object
    title: QoS.
    properties:
      principalId:
        description: Specifies the name of the QoS Policy used for the View.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      principalName:
        description: 'Specifies the name of the QoS Policy used for the View such
          as

          ''TestAndDev High'', ''Backup Target SSD'', ''Backup Target High''

          ''TestAndDev Low'' and ''Backup Target Low''. For a complete list

          and descriptions, see the ''Create or Edit Views'' topic in the

          documentation. If not specified, the default is ''Backup Target Low''.'
        type: string
        x-nullable: true
        x-order: 1
  QosPolicy:
    description: QOS Policy type.
    type: object
    title: QOS Policy type.
    properties:
      qosPolicy:
        description: Specifies QOS Policy type.
        type: string
        enum:
        - kBackupHDD
        - kBackupSSD
        - kTestAndDevHigh
        - kBackupAll
        x-order: 0
  QuotaPolicy:
    description: 'Specifies a quota limit that can be optionally applied to Views
      and

      Storage Domains.

      At the View level, this quota defines a logical limit for usage on the View.

      At the Storage Domain level, this quota defines a physical limit or

      a default logical View limit.

      If a physical quota is specified for Storage Domain, this quota defines a physical

      limit for the usage on the Storage Domain.

      If a default logical View quota is specified for Storage Domain, this limit

      is inherited by all the Views in that Storage Domain.

      However, this inherited quota can be overwritten at the View level.

      A new write is not allowed if the resource will exceed the specified quota.

      However, it takes time for the Cohesity Cluster to calculate

      the usage across Nodes, so the limit may be exceeded by a small amount.

      In addition, if the limit is increased or data is removed,

      there may be a delay before the Cohesity Cluster allows more data

      to be written to the resource, as the Cluster calculates the usage

      across Nodes.'
    type: object
    title: Quota Policy
    properties:
      alertLimitBytes:
        description: 'Specifies if an alert should be triggered when the usage of
          this

          resource exceeds this quota limit.

          This limit is optional and is specified in bytes.

          If no value is specified, there is no limit.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      alertThresholdPercentage:
        description: 'Supported only for user quota policy.

          Specifies when the usage goes above an alert threshold percentage

          which is:

          HardLimitBytes * AlertThresholdPercentage, eg: 80% of HardLimitBytes

          Can only be set if HardLimitBytes is set.

          Cannot be set if AlertLimitBytes is already set.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      hardLimitBytes:
        description: 'Specifies an optional quota limit on the usage allowed for this

          resource. This limit is specified in bytes. If no value is specified,

          there is no limit.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  Rack:
    description: Specifies information about rack.
    type: object
    title: Rack specific response.
    properties:
      id:
        description: Specifies unique id of the rack.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies name of the rack
        type: string
        x-nullable: true
        x-order: 1
      location:
        description: Specifies location of the rack.
        type: string
        x-nullable: true
        x-order: 2
      chassisIds:
        description: List of chassis ids that are part of the rack.
        type: array
        items:
          type: integer
          format: int64
        x-order: 3
  Racks:
    description: Specifies info about list of racks.
    type: object
    title: List of Racks
    properties:
      racks:
        description: Specifies list of racks
        type: array
        items:
          $ref: '#/definitions/Rack'
        x-nullable: true
        x-order: 0
  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
        format: int32
        x-nullable: true
        x-order: 0
      dbInstanceId:
        description: Specifies the DB instance identifier to use for the restored
          DB.
        type: string
        x-nullable: true
        x-order: 1
      isMultiAzDeployment:
        description: Specifies whether this is a multi-az deployment or not.
        type: boolean
        x-nullable: true
        x-order: 2
      enablePublicAccessibility:
        description: Specifies whether this DB will be publicly accessible or not.
        type: boolean
        x-nullable: true
        x-order: 3
      enableIamDbAuthentication:
        description: Specifies whether to enable IAM authentication for the DB.
        type: boolean
        x-nullable: true
        x-order: 4
      enableCopyTagsToSnapshots:
        description: Specifies whether to enable copying of tags to snapshots of the
          DB.
        type: boolean
        x-nullable: true
        x-order: 5
      enableAutoMinorVersionUpgrade:
        description: Specifies whether to enable auto minor version upgrade in the
          restored DB.
        type: boolean
        x-nullable: true
        x-order: 6
      dbOptionGroup:
        description: Specifies entity representing the RDS option group to use while
          restoring the DB.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 7
      dbParameterGroup:
        description: Specifies the entity representing the RDS parameter group to
          use while restoring the DB.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 8
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/AcropolisTargetParamsForRecoverFileAndFolder'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverAcropolisVmParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover Acropolis files and folders.
        allOf:
        - $ref: '#/definitions/RecoverAcropolisFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      storageContainer:
        description: A storage container where the VM's files should be restored to.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverAcropolisVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverAcropolisVmOriginalSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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
        x-nullable: true
        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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/AcropolisTargetParamsForRecoverVm'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverAcropolisVmNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverAcropolisVmOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      region:
        description: Specifies the AWS region in which to deploy the Aurora instance.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverAwsAuroraNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      subnet:
        description: Specifies the subnet within above VPC.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      availabilityZone:
        description: Specifies the entity representing the availability zone to use
          while restoring the DB.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      securityGroups:
        description: Specifies the network security groups within above VPC.
        type: array
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        x-order: 3
  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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/AwsTargetParamsForRecoverAurora'
        - x-nullable: true
        x-nullable: true
        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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/AwsTargetParamsForRecoverFileAndFolder'
        - x-nullable: true
        x-nullable: true
        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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverAwsVmParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files and folders.
        allOf:
        - $ref: '#/definitions/RecoverAwsFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      recoverRdsParams:
        description: Specifies the parameters to recover AWS RDS.
        allOf:
        - $ref: '#/definitions/RecoverAwsRdsParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      recoverAuroraParams:
        description: Specifies the parameters to recover AWS Aurora.
        allOf:
        - $ref: '#/definitions/RecoverAwsAuroraParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      region:
        description: Specifies the AWS region in which to deploy the RDS instance.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverAwsRdsNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      subnet:
        description: Specifies the subnet within above VPC.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      availabilityZone:
        description: Specifies the entity representing the availability zone to use
          while restoring the DB.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      securityGroups:
        description: Specifies the network security groups within above VPC.
        type: array
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        x-order: 3
  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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/AwsTargetParamsForRecoverRds'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      region:
        description: Specifies the AWS region in which to deploy the VM.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      keyPair:
        description: Specifies the pair of public and private key used to login into
          the VM
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverAwsVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 3
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      subnet:
        description: Specifies the subnet within above VPC.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      securityGroups:
        description: Specifies the network security groups within above VPC.
        type: array
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/AwsTargetParamsForRecoverVm'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/AzureTargetParamsForRecoverFileAndFolder'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverAzureVmParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover Azure files and folders.
        allOf:
        - $ref: '#/definitions/RecoverAzureFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      resourceGroup:
        description: Specifies the Azure resource group.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      storageAccount:
        description: Specifies the storage account that will contain the storage container
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      storageContainer:
        description: Specifies the storage container within the above storage account.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverAzureVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      storageResourceGroup:
        description: Specifies id of the resource group for the selected storage account.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      computeOption:
        description: Specifies the type of VM (e.g. small, medium, large) when cloning/restoring
          the VM in Azure.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      availabilitySet:
        description: Specifies the availability set.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      subnet:
        description: Specifies the subnet within the above virtual network.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      networkResourceGroup:
        description: Specifies id of the resource group for the selected virtual network.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/AzureTargetParamsForRecoverVm'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        x-order: 0
      renameTo:
        description: Specifies the new name to which the object should be renamed
          to after the recovery.
        type: string
        x-nullable: true
        x-order: 1
      objectProperties:
        description: Specifies the properties to be applied to the object at the time
          of recovery.
        type: array
        items:
          $ref: '#/definitions/NoSqlObjectProperty'
        x-nullable: true
        x-order: 2
  RecoverCassandraParams:
    description: Specifies the parameters to recover Cassandra objects.
    title: Recover Cassandra params.
    allOf:
    - $ref: '#/definitions/CommonNoSqlRecoveryOptions'
    - type: object
      required:
      - snapshots
      properties:
        snapshots:
          description: Specifies the local snapshot ids and other details of the Objects
            to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverCassandraSnapshotParams'
          x-nullable: true
          x-order: 0
        suffix:
          description: A suffix that is to be applied to all recovered objects.
          type: string
          x-nullable: true
          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
  RecoverCassandraSnapshotParams:
    description: Specifies the snapshot parameters for a protected Cassandra object.
    title: Recover Cassandra Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        objects:
          description: Specifies details of objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverCassandraNoSqlObjectParams'
          x-nullable: true
          x-order: 0
  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
        x-nullable: true
        x-order: 0
      renameTo:
        description: Specifies the new name to which the object should be renamed,
          at the time of recovery.
        type: string
        x-nullable: true
        x-order: 1
  RecoverCouchbaseParams:
    description: Specifies the parameters to recover Couchbase objects.
    title: Recover Couchbase params.
    allOf:
    - $ref: '#/definitions/CommonNoSqlRecoveryOptions'
    - type: object
      required:
      - snapshots
      - filterDocumentsParams
      properties:
        snapshots:
          description: Specifies the local snapshot ids of the Objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverCouchbaseSnapshotParams'
          x-nullable: true
          x-order: 0
        suffix:
          description: A suffix that is to be applied to all recovered objects.
          type: string
          x-nullable: true
          x-order: 1
        filterDocumentsParams:
          description: Specifies the parameters to filter documents to be restored.
          type: object
          allOf:
          - $ref: '#/definitions/FilterDocumentsParams'
          - x-nullable: true
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/FilterDocumentsParams'
        appendDocuments:
          description: If set to true, docuements from the bucket being recovered
            will be appended into the bucket at the destination.
          type: boolean
          x-nullable: true
          x-order: 3
        ddlOnlyRecovery:
          description: Set to true to recover only the bucket configurations. No documents
            will be recovered.
          type: boolean
          x-nullable: true
          x-order: 4
        overwriteUsers:
          description: If set to true existing users will be replaced with users from
            the bucket being recovered.
          type: boolean
          x-nullable: true
          x-order: 5
  RecoverCouchbaseSnapshotParams:
    description: Specifies the snapshot parameters for a protected Couchbase object.
    title: Recover Couchbase Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        objects:
          description: Specifies details of objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverCouchbaseNoSqlObjectParams'
          x-nullable: true
          x-order: 0
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/RecoverElastifileToElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoverElastifileToElastifileVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      genericNasTargetParams:
        description: Specifies the params for a Generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      viewTargetParams:
        description: Specifies the params for a Cohesity view recovery target.
        allOf:
        - $ref: '#/definitions/RecoverNasVolumeToViewParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverElastifileNasVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files.
        allOf:
        - $ref: '#/definitions/RecoverElastifileFilesParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverOtherNasToElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverOtherNasToElastifileVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalElastifileTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/ExchangeTargetParamsForRecoverExchangeApp'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  RecoverExchangeAppSnapshotParams:
    description: Specifies the snapshot parameters to recover Exchange databases.
    title: Recover Exchange App Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        appObjects:
          description: Specifies the list of params for all the databases which have
            to be recovered.
          type: array
          items:
            $ref: '#/definitions/ExchangeRecoverDatabaseParams'
          x-nullable: true
          x-order: 0
  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: '#/definitions/RecoverExchangeAppParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  RecoverFileAndFolderMethod:
    description: Recover File and Folder Method
    type: object
    title: Recover File and Folder Method
    properties:
      recoverFileAndFolderMethod:
        description: Recover File and Folder Method.
        type: string
        enum:
        - AutoDeploy
        - UseExistingAgent
        - UseHypervisorApis
        x-order: 0
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/RecoverFlashbladeToFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      elastifileTargetParams:
        description: Specifies the params for an Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoverFlashbladeToFlashbladeVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      elastifileTargetParams:
        description: Specifies the params for a Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      genericNasTargetParams:
        description: Specifies the params for a Generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      viewTargetParams:
        description: Specifies the params for a Cohesity view recovery target.
        allOf:
        - $ref: '#/definitions/RecoverNasVolumeToViewParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverFlashbladeNasVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files.
        allOf:
        - $ref: '#/definitions/RecoverFlashbladeFilesParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoverOtherNasToFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverOtherNasToFlashbladeVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalFlashbladeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  RecoverGcpFileAndFolderParams:
    description: Specifies the parameters to recover files and folders.
    type: object
    title: Recover GCP File And Folder Params
    required:
    - filesAndFolders
    - targetEnvironment
    properties:
      filesAndFolders:
        description: Specifies the info about the files and folders to be recovered.
        type: array
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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 parameters to recover to a GCP target.
        allOf:
        - $ref: '#/definitions/GcpTargetParamsForRecoverFileAndFolder'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverGcpVmParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      project:
        description: Specifies the GCP project in which to deploy the VM.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      region:
        description: Specifies the GCP region in which to deploy the VM.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      availabilityZone:
        description: Specifies the GCP zone in which to deploy the VM.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverGcpVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/GcpVpcSubnetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/GcpTargetParamsForRecoverVm'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/RecoverGenericNasToGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      elastifileTargetParams:
        description: Specifies the params for an Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoverGenericNasToGenericNasVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      elastifileTargetParams:
        description: Specifies the params for a Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      viewTargetParams:
        description: Specifies the params for a Cohesity view recovery target.
        allOf:
        - $ref: '#/definitions/RecoverNasVolumeToViewParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverGenericNasNasVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files.
        allOf:
        - $ref: '#/definitions/RecoverGenericNasFilesParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverOtherNasToGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverOtherNasToGenericNasVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalGenericNasTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/RecoverGpfsToGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      elastifileTargetParams:
        description: Specifies the params for an Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      isilonTargetParams:
        description: Specifies the params for a Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoverGpfsToGpfsVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      elastifileTargetParams:
        description: Specifies the params for a Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      viewTargetParams:
        description: Specifies the params for a Cohesity view recovery target.
        allOf:
        - $ref: '#/definitions/RecoverNasVolumeToViewParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverGpfsNasVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files.
        allOf:
        - $ref: '#/definitions/RecoverGpfsFilesParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoverOtherNasToGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverOtherNasToGpfsVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalGpfsTargetParams'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        x-order: 0
      renameTo:
        description: Specifies the new name to which the object should be renamed.
          at the time of recovery.
        type: string
        x-nullable: true
        x-order: 1
  RecoverHbaseParams:
    description: Specifies the parameters to recover Hbase objects.
    title: Recover Hbase params.
    allOf:
    - $ref: '#/definitions/CommonNoSqlRecoveryOptions'
    - type: object
      required:
      - snapshots
      properties:
        snapshots:
          description: Specifies the local snapshot ids of the Objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverHbaseSnapshotParams'
          x-nullable: true
          x-order: 0
        suffix:
          description: A suffix that is to be applied to all recovered objects.
          type: string
          x-nullable: true
          x-order: 1
  RecoverHbaseSnapshotParams:
    description: Specifies the snapshot parameters for a protected Hbase object.
    title: Recover Hbase Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        objects:
          description: Specifies details of objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverHbaseNoSqlObjectParams'
          x-nullable: true
          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
        x-nullable: true
        x-order: 0
  RecoverHdfsParams:
    description: Specifies the parameters to recover HDFS objects.
    title: Recover HDFS params.
    allOf:
    - $ref: '#/definitions/CommonNoSqlRecoveryOptions'
    - type: object
      required:
      - snapshots
      properties:
        snapshots:
          description: Specifies the local snapshot ids of the Objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverHdfsSnapshotParams'
          x-nullable: true
          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
          x-nullable: true
          x-order: 1
  RecoverHdfsSnapshotParams:
    description: Specifies the snapshot parameters for a protected Hdfs object.
    title: Recover Hdfs Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        objects:
          description: Specifies details of objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverHdfsNoSqlObjectParams'
          x-nullable: true
          x-order: 0
  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
        x-nullable: true
        x-order: 0
  RecoverHiveParams:
    description: Specifies the type of recover action to be performed.
    title: Recover Hive params.
    allOf:
    - $ref: '#/definitions/CommonNoSqlRecoveryOptions'
    - type: object
      required:
      - snapshots
      properties:
        snapshots:
          description: Specifies the local snapshot ids of the Objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverHiveSnapshotParams'
          x-nullable: true
          x-order: 0
        suffix:
          description: A suffix that is to be applied to all recovered objects.
          type: string
          x-nullable: true
          x-order: 1
  RecoverHiveSnapshotParams:
    description: Specifies the snapshot parameters for a protected Hive object.
    title: Recover Hive Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        objects:
          description: Specifies details of objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverHiveNoSqlObjectParams'
          x-nullable: true
          x-order: 0
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/HyperVTargetParamsForRecoverFileAndFolder'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverHyperVVmParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      mountVolumeParams:
        description: Specifies the parameters to mount HyperV Volumes.
        allOf:
        - $ref: '#/definitions/MountHyperVVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files and folders.
        allOf:
        - $ref: '#/definitions/RecoverHyperVFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
  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
        enum:
        - kSCVMMServer
        - kStandaloneHost
        - kStandaloneCluster
        x-nullable: true
        x-order: 0
      scvmmServerParams:
        x-order: 1
        $ref: '#/definitions/RecoverHyperVVmSCVMMSourceConfig'
      standaloneHostParams:
        x-order: 2
        $ref: '#/definitions/RecoverHyperVVmStandaloneHostSourceConfig'
      standaloneClusterParams:
        x-order: 3
        $ref: '#/definitions/RecoverHyperVVmStandaloneClusterSourceConfig'
  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
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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: '#/definitions/RecoverHyperVVmOriginalSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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
        x-nullable: true
        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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/HyperVTargetParamsForRecoverVm'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      volume:
        description: Specifies the datastore object where the VMs' files should be
          recovered to.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverHyperVVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 3
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      volume:
        description: Specifies the datastore object where the VMs' files should be
          recovered to.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverHyperVVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 3
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      volume:
        description: Specifies the datastore object where the VMs' files should be
          recovered to.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverHyperVVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/RecoverIsilonToIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      elastifileTargetParams:
        description: Specifies the params for an Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoverIsilonToIsilonVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      elastifileTargetParams:
        description: Specifies the params for an Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      netappTargetParams:
        description: Specifies the params for an Netapp recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToNetappVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      viewTargetParams:
        description: Specifies the params for a Cohesity view recovery target.
        allOf:
        - $ref: '#/definitions/RecoverNasVolumeToViewParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverIsilonNasVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files.
        allOf:
        - $ref: '#/definitions/RecoverIsilonFilesParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoverOtherNasToIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverOtherNasToIsilonVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalIsilonTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/KubernetesTargetParamsForRecoverKubernetesNamespace'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverKubernetesNamespaceParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverKvmVmParams'
        - x-nullable: true
        x-order: 2
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      vnicProfile:
        description: Specifies VNic profile that will be attached to the restored
          object.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 1
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      cluster:
        description: Specifies the resource (KVMH host) to which the restored VM will
          be attached
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 1
      dataCenter:
        description: Specifies the datacenter where the VM's files should be restored
          to.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 2
      storageDomain:
        description: Specifies the Storage Domain where the VM's disk should be restored
          to.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 3
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverKvmVmNewSourceNetworkConfig'
        - x-nullable: true
        x-order: 4
  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
        x-nullable: true
        x-order: 0
      newNetworkConfig:
        description: Specifies the new network configuration of the Kvm recovery.
        allOf:
        - $ref: '#/definitions/RecoverKvmVmNewNetworkConfig'
        - x-nullable: true
        x-order: 1
  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: '#/definitions/RecoverKvmVmOriginalSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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
        x-nullable: true
        x-order: 0
  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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/KvmTargetParamsForRecoverVm'
        - x-nullable: true
        x-nullable: true
        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
        items:
          $ref: '#/definitions/ObjectMailboxParam'
        x-nullable: true
        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: '#/definitions/TargetMailboxParam'
        - x-nullable: true
        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
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        x-order: 0
      renameTo:
        description: Specifies the new name to which the object should be renamed.
          at the time of recovery.
        type: string
        x-nullable: true
        x-order: 1
      objectProperties:
        description: Specifies the properties to be applied to the object at the time
          of recovery.
        type: array
        items:
          $ref: '#/definitions/NoSqlObjectProperty'
        x-nullable: true
        x-order: 2
  RecoverMongodbParams:
    description: Specifies the parameters to recover MongoDB objects.
    title: Recover MongoDB params.
    allOf:
    - $ref: '#/definitions/CommonNoSqlRecoveryOptions'
    - type: object
      required:
      - snapshots
      properties:
        snapshots:
          description: Specifies the local snapshot ids of the Objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverMongodbSnapshotParams'
          x-nullable: true
          x-order: 0
        suffix:
          description: A suffix that is to be applied to all recovered objects.
          type: string
          x-nullable: true
          x-order: 1
  RecoverMongodbSnapshotParams:
    description: Specifies the snapshot parameters for a protected Mongodb object.
    title: Recover MongoDB Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        objects:
          description: Specifies details of objects to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverMongodbNoSqlObjectParams'
          x-nullable: true
          x-order: 0
  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
        items:
          $ref: '#/definitions/MsGroupParam'
        x-nullable: true
        x-order: 0
      restoreToOriginal:
        description: Specifies whether or not all groups are restored to original
          location.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
  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
        items:
          $ref: '#/definitions/ObjectMsTeamParam'
        x-nullable: true
        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: '#/definitions/TargetMsTeamParam'
        - x-nullable: true
        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
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        x-order: 0
      qosPolicy:
        description: Specifies the QoS policy, which defines the principal and priority
          of the NAS recovery.
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/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-nullable: true
        x-order: 2
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/RecoverNetappToNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      elastifileTargetParams:
        description: Specifies the params for an Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoverNetappToNetappVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      elastifileTargetParams:
        description: Specifies the params for an Elastifile recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToElastifileVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      flashbladeTargetParams:
        description: Specifies the params for a Flashblade recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToFlashbladeVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      genericNasTargetParams:
        description: Specifies the params for a generic NAS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGenericNasVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      gpfsTargetParams:
        description: Specifies the params for a GPFS recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToGpfsVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      isilonTargetParams:
        description: Specifies the params for an Isilon recovery target.
        allOf:
        - $ref: '#/definitions/RecoverOtherNasToIsilonVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      viewTargetParams:
        description: Specifies the params for a Cohesity view recovery target.
        allOf:
        - $ref: '#/definitions/RecoverNasVolumeToViewParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverNetappNasVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files.
        allOf:
        - $ref: '#/definitions/RecoverNetappFilesParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoverOtherNasToNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalNetappFilesTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverOtherNasToNetappVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OriginalNetappTargetParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverOneDriveParams'
        - x-nullable: true
        x-order: 2
      recoverMailboxParams:
        description: Specifies the parameters to recover Office 365 Mailbox.
        allOf:
        - $ref: '#/definitions/RecoverMailboxParams'
        - x-nullable: true
        x-order: 3
      recoverPublicFoldersParams:
        description: Specifies the parameters to recover Office 365 Public Folders.
        allOf:
        - $ref: '#/definitions/RecoverPublicFoldersParams'
        - x-nullable: true
        x-order: 4
      recoverMsGroupParams:
        description: Specifies the parameters to recover Microsoft 365 Group.
        allOf:
        - $ref: '#/definitions/RecoverMsGroupParams'
        - x-nullable: true
        x-order: 5
      recoverMsTeamParams:
        description: Specifies the parameters to recover Microsoft 365 Teams.
        allOf:
        - $ref: '#/definitions/RecoverMsTeamParams'
        - x-nullable: true
        x-order: 6
  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
        items:
          $ref: '#/definitions/ObjectOneDriveParam'
        x-nullable: true
        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: '#/definitions/TargetOneDriveParam'
        - x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      recoveryTarget:
        description: Specifies if recovery target is a database or a view.
        type: string
        enum:
        - RecoverDatabase
        - RecoverView
        x-nullable: true
        x-order: 1
      recoverDatabaseParams:
        description: Specifies recovery parameters when recovering to a database
        allOf:
        - $ref: '#/definitions/RecoverOracleNewTargetDatabaseConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverViewParams:
        description: Specifies recovery parameters when recovering to a view.
        allOf:
        - $ref: '#/definitions/RecoverOracleNewTargetViewConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/CommonOracleAppSourceConfig'
  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: '#/definitions/OracleTargetParamsForRecoverOracleApp'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  RecoverOracleDbSnapshotParams:
    description: Specifies the snapshot parameters to recover Oracle databases.
    title: Recover Oracle database Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        instantRecoveryInfo:
          description: Specifies the info about instant recovery. This is only applicable
            for RecoverOracle.
          allOf:
          - $ref: '#/definitions/RecoveryOracleTaskInfo'
          - x-nullable: true
          x-nullable: true
          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
        enum:
        - kPDB
        x-nullable: true
        x-order: 0
      pdbRestoreParams:
        description: Specifies information about the list of pdbs to be restored.
        type: object
        allOf:
        - $ref: '#/definitions/OraclePdbRestoreParams'
        - x-nullable: true
        x-order: 1
  RecoverOracleNewTargetDatabaseConfig:
    description: Specifies recovery parameters when recovering to a database.
    type: object
    title: Recover Oracle App New Database Target Config.
    allOf:
    - $ref: '#/definitions/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
        x-nullable: true
        x-order: 0
      oracleBaseFolder:
        description: Specifies the oracle base folder at selected host.
        type: string
        x-nullable: true
        x-order: 1
      oracleHomeFolder:
        description: Specifies the oracle home folder at selected host.
        type: string
        x-nullable: true
        x-order: 2
      dbFilesDestination:
        description: Specifies the location to restore database files.
        type: string
        x-nullable: true
        x-order: 3
      dbConfigFilePath:
        description: Specifies the config file path on selected host which configures
          the restored database.
        type: string
        x-nullable: true
        x-order: 4
      enableArchiveLogMode:
        description: Specifies archive log mode for oracle restore.
        type: boolean
        x-nullable: true
        x-order: 5
      pfileParameterMap:
        description: Specifies a key value pair for pfile parameters.
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
        x-nullable: true
        x-order: 6
      bctFilePath:
        description: Specifies BCT file path.
        type: string
        x-nullable: true
        x-order: 7
      numTempfiles:
        description: Specifies no. of tempfiles to be used for the recovered database.
        type: integer
        format: int32
        x-nullable: true
        x-order: 8
      redoLogConfig:
        description: Specifies redo log config.
        type: object
        allOf:
        - $ref: '#/definitions/RedoLogGroupConfig'
        - x-nullable: true
        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
        x-nullable: true
        x-order: 10
      oracleUpdateRestoreOptions:
        description: Specifies the parameters that are needed for updating oracle
          restore options.
        allOf:
        - $ref: '#/definitions/MigrateCloneParams'
        - x-nullable: true
        x-nullable: true
        x-order: 11
  RecoverOracleNewTargetViewConfig:
    description: Specifies recovery parameters when recovering to a view.
    type: object
    title: Recover Oracle App New View Target Config.
    allOf:
    - $ref: '#/definitions/CommonOracleAppSourceConfig'
    properties:
      viewMountPath:
        description: Specifies the directory where cohesity view for app recovery
          will be mounted.
        type: string
        x-nullable: true
        x-order: 0
  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
        items:
          $ref: '#/definitions/RecoverOracleDbSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverOracleAppParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      alternatePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/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-nullable: true
        x-order: 8
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      alternatePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/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-nullable: true
        x-order: 8
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      alternatePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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-nullable: true
        x-order: 6
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      alternatePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/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-nullable: true
        x-order: 8
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      alternatePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/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-nullable: true
        x-order: 8
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      alternatePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 2
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 5
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/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-nullable: true
        x-order: 8
        $ref: '#/definitions/RecoveryVlanConfig'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-order: 0
      parentSource:
        description: Specifies the id of the parent source of the recovery target.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        - readOnly: true
        x-order: 1
      overwriteExistingFile:
        description: Specifies whether to overwrite existing file/folder during recovery.
        type: boolean
        x-nullable: true
        x-order: 2
      preserveFileAttributes:
        description: Specifies whether to preserve file/folder attributes during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
      encryptionEnabled:
        description: Specifies whether encryption should be enabled during recovery.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/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-nullable: true
        x-order: 7
        $ref: '#/definitions/RecoveryVlanConfig'
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/PhysicalTargetParamsForRecoverFileAndFolder'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverPhysicalVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      mountVolumeParams:
        description: Specifies the parameters to mount Physical Volumes.
        allOf:
        - $ref: '#/definitions/MountPhysicalVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      recoverFileAndFolderParams:
        description: Specifies the parameters to perform a file and folder recovery.
        allOf:
        - $ref: '#/definitions/RecoverPhysicalFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
  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: '#/definitions/PhysicalTargetParamsForRecoverVolume'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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
        pattern: ^\d+:\d+$
        x-nullable: true
        x-order: 0
      protectionGroupInstanceId:
        description: Specifies the Protection Group Instance id.
        type: integer
        format: int64
        x-nullable: true
        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
        format: int64
        x-nullable: true
        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
        x-nullable: true
        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
        minItems: 1
        items:
          $ref: '#/definitions/RootPublicFolderParam'
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      targetFolderPath:
        description: Specifies the path to the target folder.
        type: string
        x-nullable: true
        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
        x-nullable: true
        x-order: 3
  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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverPureSanVolumeParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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: '#/definitions/RecoverPureVolumeTargetParams'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverPureSanVolumeNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverPureSanVolumeOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      instanceName:
        description: Specifies an instance name of the Sql Server that should be used
          for restoring databases to.
        type: string
        x-nullable: true
        x-order: 1
      dataFileDirectoryLocation:
        description: Specifies the directory where to put the database data files.
          Missing directory will be automatically created.
        type: string
        x-nullable: true
        x-order: 2
      logFileDirectoryLocation:
        description: Specifies the directory where to put the database log files.
          Missing directory will be automatically created.
        type: string
        x-nullable: true
        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
        x-nullable: true
        x-order: 4
  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: '#/definitions/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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 3
  RecoverSqlAppParams:
    description: Specifies the parameters to recover Sql databases.
    type: object
    title: Recover Sql DB params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - $ref: '#/definitions/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
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/SqlTargetParamsForRecoverSqlApp'
  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
        minItems: 1
        items:
          $ref: '#/definitions/RecoverSqlAppParams'
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  RecoverTarget:
    description: Specifies the target entity to recover to.
    title: Recover Target.
    allOf:
    - $ref: '#/definitions/RecoveryObjectIdentifier'
    - type: object
      properties:
        parentSourceId:
          description: Specifies the id of the parent source of the target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
          readOnly: true
        parentSourceName:
          description: Specifies the name of the parent source of the target.
          type: string
          x-nullable: true
          x-order: 1
          readOnly: true
    - x-nullable: true
  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
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      renameTo:
        description: Specifies the new name to which the object should be renamed
          to after the recovery.
        type: string
        x-nullable: true
        x-order: 2
  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
        format: int64
        x-nullable: true
        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
        format: int32
        default: 1
        x-nullable: true
        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
        format: int32
        default: 1
        x-nullable: true
        x-order: 2
      recoveryArgs:
        description: Specifies the arguments for recovery of Universal Data Adapter
          objects.
        type: string
        x-nullable: true
        x-order: 3
      snapshots:
        description: Specifies the local snapshot ids and other details of the objects
          to be recovered.
        type: array
        items:
          $ref: '#/definitions/RecoverUdaSnapshotParams'
        x-nullable: true
        x-order: 4
      warnings:
        description: This field will hold the warnings in cases where the job status
          is SucceededWithWarnings.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 5
        readOnly: true
  RecoverUdaSnapshotParams:
    description: Specifies the snapshot parameters for a protected Universal Data
      Adapter object.
    title: Recover Universal Data Adapter Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        objects:
          description: Specifies the local snapshot ids and other details of the objects
            to be recovered.
          type: array
          items:
            $ref: '#/definitions/RecoverUdaObjectParams'
          x-nullable: true
          x-order: 0
  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
        items:
          $ref: '#/definitions/CommonRecoverFileAndFolderInfo'
        x-nullable: true
        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: '#/definitions/VmwareTargetParamsForRecoverFileAndFolder'
        - x-nullable: true
        x-nullable: true
        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
        items:
          $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        x-nullable: true
        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: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  RecoverVmwareChildSnapshotParams:
    description: Specifies the snapshot parameters for VMware recovery.
    title: Recover VMware Snapshot Params.
    allOf:
    - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
    - type: object
      properties:
        instantRecoveryInfo:
          description: Specifies the info about instant recovery. This is only applicable
            for RecoverVm.
          allOf:
          - $ref: '#/definitions/RecoveryTaskInfo'
          - x-nullable: true
          x-nullable: true
          x-order: 0
          readOnly: true
        datastoreMigrationInfo:
          description: Specifies the info about datastore migration. This is only
            applicable for RecoverVm.
          allOf:
          - $ref: '#/definitions/RecoveryTaskInfo'
          - x-nullable: true
          x-nullable: true
          x-order: 1
          readOnly: true
  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
        allOf:
        - $ref: '#/definitions/VmwareTargetParamsForRecoverDisk'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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
        items:
          $ref: '#/definitions/RecoverVmwareSnapshotParams'
        x-nullable: true
        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: '#/definitions/RecoverVmwareVmParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      recoverVmDiskParams:
        description: Specifies the parameters to recover VMware Disks.
        allOf:
        - $ref: '#/definitions/RecoverVmwareDiskParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      mountVolumeParams:
        description: Specifies the parameters to mount VMware Volumes.
        allOf:
        - $ref: '#/definitions/MountVmwareVolumeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      recoverVAppParams:
        description: Specifies the parameters to recover a VMware vApp.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVAppParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      recoverVAppTemplateParams:
        description: Specifies the parameters to recover a VMware vApp template.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVAppTemplateParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      recoverFileAndFolderParams:
        description: Specifies the parameters to recover files and folders.
        allOf:
        - $ref: '#/definitions/RecoverVMwareFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
      downloadFileAndFolderParams:
        description: Specifies the parameters to download files and folders.
        allOf:
        - $ref: '#/definitions/CommonDownloadFileAndFolderParams'
        - x-nullable: true
        x-nullable: true
        x-order: 8
  RecoverVmwareSnapshotParams:
    description: Specifies the snapshot parameters for VMware recovery.
    title: Recover VMware Parent Snapshot Params.
    allOf:
    - $ref: '#/definitions/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: '#/definitions/RecoverVmwareChildSnapshotParams'
          x-order: 0
  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
        enum:
        - kvCloudDirector
        x-nullable: true
        x-order: 0
      vCloudDirectorParams:
        x-order: 1
        $ref: '#/definitions/RecoverVmwareVAppVCDSourceConfig'
  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: '#/definitions/RecoverVmwareVmOriginalSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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: '#/definitions/VmwareTargetParamsForRecoverVApp'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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
        enum:
        - kvCloudDirector
        x-nullable: true
        x-order: 0
      vCloudDirectorParams:
        x-order: 1
        $ref: '#/definitions/RecoverVmwareVAppTemplateVCDSourceConfig'
  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: '#/definitions/VmwareTargetParamsForRecoverVAppTemplate'
        - x-nullable: true
        x-nullable: true
        x-order: 1
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      vdc:
        description: Specifies the VDC object where the recovered objects will be
          attached.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      catalog:
        description: Specifies the catalog where the vApp template should reside.
        allOf:
        - $ref: '#/definitions/VdcCatalog'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      datastores:
        description: Specifies the datastore objects where the object's files should
          be recovered to.
        type: array
        maxItems: 1
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        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: '#/definitions/VcdStorageProfileParams'
        - x-nullable: true
        x-order: 4
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          vApp templates.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OrgVDCNetwork'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      vdc:
        description: Specifies the VDC object where the recovered objects will be
          attached.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      datastores:
        description: Specifies the datastore objects where the object's files should
          be recovered to.
        type: array
        maxItems: 1
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        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: '#/definitions/VcdStorageProfileParams'
        - x-nullable: true
        x-order: 3
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/OrgVDCNetwork'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      resourcePool:
        description: Specifies the resource pool object where the recovered objects
          will be attached.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      datastores:
        description: Specifies the datastore objects where the object's files should
          be recovered to.
        type: array
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        x-order: 2
      vmFolder:
        description: Folder where the VMs should be created.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      disableNetwork:
        description: Specifies whether the attached network should be left in disabled
          state. Default is false
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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
        enum:
        - kVCenter
        - kStandaloneHost
        - kvCloudDirector
        x-nullable: true
        x-order: 0
      standaloneHostParams:
        x-order: 1
        $ref: '#/definitions/RecoverVmwareVmEsxiSourceConfig'
      vCenterParams:
        x-order: 2
        $ref: '#/definitions/RecoverVmwareVmVCenterSourceConfig'
      vCloudDirectorParams:
        x-order: 3
        $ref: '#/definitions/RecoverVmwareVmVCDSourceConfig'
  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
        x-nullable: true
        x-order: 0
      newNetworkConfig:
        description: Specifies a new network configuration for the VM recovery.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVmNewNetworkConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverVmwareVmOriginalSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 0
  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
        x-nullable: true
        x-order: 0
      disableNetwork:
        description: Specifies whether the attached network should be left in disabled
          state. Default is false.
        type: boolean
        x-nullable: true
        x-order: 1
  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
        items:
          $ref: '#/definitions/RecoverProtectionGroupRunParams'
        x-nullable: true
        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: '#/definitions/VmwareTargetParamsForRecoverVM'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      vdc:
        description: Specifies the VDC object where the recovered objects will be
          attached.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      vApp:
        description: Specifies the vApp object where the recovered objects will be
          attached.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        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
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        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: '#/definitions/VcdStorageProfileParams'
        - x-nullable: true
        x-order: 4
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      orgVdcNetwork:
        description: Specifies the VDC organization network which will be attached
          with recoverd VM.
        type: object
        x-order: 6
        $ref: '#/definitions/OrgVDCNetwork'
  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: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 0
      resourcePool:
        description: Specifies the resource pool object where the recovered objects
          will be attached.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      datastores:
        description: Specifies the datastore objects where the object's files should
          be recovered to.
        type: array
        items:
          $ref: '#/definitions/RecoveryObjectIdentifier'
        x-nullable: true
        x-order: 2
      vmFolder:
        description: Folder where the VMs should be created.
        allOf:
        - $ref: '#/definitions/RecoveryObjectIdentifier'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      networkConfig:
        description: Specifies the networking configuration to be applied to the recovered
          VMs.
        allOf:
        - $ref: '#/definitions/RecoverVmwareVmNewSourceNetworkConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 4
  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
        x-nullable: true
        x-order: 0
      destinationVolumeGuid:
        description: Specifies the guid of the destination volume.
        type: string
        x-nullable: true
        x-order: 1
  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
        x-nullable: true
        x-order: 0
      suffix:
        description: Specifies the suffix string to be added to recovered or cloned
          object names.
        type: string
        x-nullable: true
        x-order: 1
  Recoveries:
    description: Specifies list of Recoveries.
    type: object
    title: List of Recoveries.
    properties:
      recoveries:
        description: Specifies list of Recoveries.
        type: array
        items:
          x-cohesity-discriminator-ref: CommonRecoveryResponseParams
          $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
        x-nullable: true
        x-order: 0
  Recovery:
    description: Specifies a Recovery.
    title: Recovery.
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverVmwareParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/RecoverVmwareParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAwsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/RecoverAwsParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGcpParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/RecoverGcpParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAzureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/RecoverAzureParams'
        kvmParams:
          description: Specifies the parameters which are specific to KVM related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKvmParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/RecoverKvmParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAcropolisParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/RecoverAcropolisParams'
        mssqlParams:
          description: Specifies the parameters which are specific to MsSQL related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverSqlParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/RecoverSqlParams'
        netappParams:
          description: Specifies the parameters which are specific to Netapp related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverNetappParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/RecoverNetappParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic NAS
            related Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGenericNasParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/RecoverGenericNasParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverIsilonParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/RecoverIsilonParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to FlashBlade related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverFlashbladeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/RecoverFlashbladeParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverElastifileParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/RecoverElastifileParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGpfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/RecoverGpfsParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPhysicalParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/RecoverPhysicalParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverHyperVParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/RecoverHyperVParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchange related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverExchangeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/RecoverExchangeParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CassandraParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/CassandraParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/UdaParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/UdaParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CouchbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/CouchbaseParams'
        hbaseParams:
          description: Specifies the parameters which are specific to Hbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHbase
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/HbaseParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HdfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/HdfsParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HiveParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/HiveParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/MongodbParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/MongodbParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/RecoverPureParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverO365Params'
          - x-nullable: true
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/RecoverO365Params'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKubernetesParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/RecoverKubernetesParams'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverOracleParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/RecoverOracleParams'
        viewParams:
          description: Specifies the parameters which are specific to View related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverViewParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kView
          x-nullable: true
          x-order: 27
          $ref: '#/definitions/RecoverViewParams'
  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
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  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
        x-nullable: true
        x-order: 0
        readOnly: true
      status:
        description: Specifies the status of the recovery.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 1
        readOnly: true
      startTimeUsecs:
        description: Specifies the start time in Unix timestamp epoch in microseconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
        readOnly: true
      endTimeUsecs:
        description: Specifies the end time in Unix timestamp epoch in microseconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
        readOnly: true
  RecoveryProcessType:
    description: Recovery Process Type
    type: object
    title: Recovery Process Type
    properties:
      recoveryProcessType:
        description: Specifies the recovery process type.
        type: string
        enum:
        - InstantRecovery
        - CopyRecovery
        x-order: 0
  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
        x-nullable: true
        x-order: 0
        readOnly: true
      status:
        description: Specifies the status of the recovery.
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 1
        readOnly: true
      startTimeUsecs:
        description: Specifies the start time in Unix timestamp epoch in microseconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
        readOnly: true
      endTimeUsecs:
        description: Specifies the end time in Unix timestamp epoch in microseconds.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
        readOnly: true
  RecoveryTimeRangeInfo:
    description: Specifies a valid time range to which this object can be recovered.
    type: object
    title: Time range.
    properties:
      startTimeUsecs:
        description: Specifies the start time of this time range.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      endTimeUsecs:
        description: Specifies the end time of this time range.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      protectionGroupId:
        description: Specifies id of the Protection Group corresponding to this time
          range.
        type: string
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 2
  RecoveryType:
    description: Recovery Type
    type: object
    title: Recovery Type
    properties:
      recoveryType:
        description: Specifies the recovery types.
        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: 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
        format: int32
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      interfaceName:
        description: Interface group to use for Recovery.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
  RedoLogGroupConfig:
    description: Specifies Redo log group configuration
    type: object
    properties:
      numGroups:
        description: Specifies no. of redo log groups.
        type: integer
        format: int32
        x-nullable: true
        x-order: 0
      memberPrefix:
        description: Specifies Log member name prefix.
        type: string
        x-nullable: true
        x-order: 1
      sizeMBytes:
        description: Specifies Size of the member in MB.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
      groupMembers:
        description: Specifies list of members of this redo log group.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 3
  RegisterOrUpdateKerberosProviderRequest:
    description: 'Specifies the request to register or update a Kerberos

      Provider.'
    type: object
    allOf:
    - $ref: '#/definitions/KerberosProvider'
    - $ref: '#/definitions/UnregisterKerberosRequest'
  RegisterSwiftParams:
    description: Specifies the parameters to register a Swift service on Keystone
      server.
    type: object
    required:
    - tenantId
    properties:
      tenantId:
        description: Specifies the tenant Id who's Swift service will be registered.
        type: string
        x-nullable: true
        x-order: 0
      keystoneCredentials:
        description: Specifies the credentials of the Keystone server. Keystone configuration
          associated to the tenant will be used if this field is not specified.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/KeystoneCredentials'
  RegisterTrustedCas:
    description: Specifies the parameters to register a Certificate.
    type: object
    required:
    - certificates
    properties:
      certificates:
        description: Specifies the certificates to be imported.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/TrustedCaRequest'
        x-nullable: true
        x-order: 0
      onlyValidate:
        description: Specifies if the certificates are only to be validated.
        type: boolean
        x-nullable: true
        x-order: 1
  RegisteredRemoteStorageList:
    description: Specifies information about registered remote storage servers which
      are used by cohesity cluster.
    type: object
    title: Registered Remote Storage List
    properties:
      remoteStorages:
        description: Specifies the list of registered remote storage info.
        type: array
        items:
          $ref: '#/definitions/RemoteStorageInfo'
        x-order: 0
  RegularBackupPolicy:
    description: Specifies the Incremental and Full policy settings and also the common
      Retention policy settings."
    type: object
    title: Incremental, Full and Retention Policy.
    required:
    - retention
    properties:
      incremental:
        description: Specifies the Incremental backup schedule and retention of a
          Protection Policy.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/IncrementalBackupPolicy'
      full:
        description: Specifies the Full backup schedule of a Protection Policy.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/FullBackupPolicy'
      retention:
        description: Specifies the Retention period for incremental and full backup
          in days, months or years.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/Retention'
      primaryBackupTarget:
        description: Specifies the primary backup target settings for regular backups.
          Specifying this field shows that instead of local backups on Cohesity cluster,
          primary backup location is different such as Cloud Archives like s3 or azure.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/PrimaryBackupTarget'
  RemoteAdapterHost:
    description: Specifies params of the remote host.
    allOf:
    - $ref: '#/definitions/ScriptHost'
    - type: object
      properties:
        incrementalBackupScript:
          description: Specifies the params of script that will be executed in a 'kRegular'
            type run.
          type: object
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/CommonPreBackupScriptParams'
        fullBackupScript:
          description: Specifies the params of script that will be executed in a 'kFull'
            type run.
          type: object
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/CommonPreBackupScriptParams'
        logBackupScript:
          description: Specifies the params of script that will be executed in a 'kLog'
            type run.
          type: object
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/CommonPreBackupScriptParams'
  RemoteAdapterProtectionGroupParams:
    description: Specifies the parameters which are specific to Remote Adapter related
      Protection Groups.
    type: object
    title: Remote Adapter Protection Group Parameters
    required:
    - hosts
    - viewId
    properties:
      hosts:
        description: Specifies a list of hosts to protected in this protection group.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/RemoteAdapterHost'
        x-nullable: true
        x-order: 0
      viewId:
        description: Specifies the id of the view where we put the script result data.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      remoteViewParams:
        description: Specifies the paramters for view replication.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/RemoteAdapterProtectionGroupReplicationParams'
      indexingPolicy:
        description: Specifies settings for indexing files found in the Remote Adapter
          so these files can be searched and recovered. This also specifies inclusion
          and exclusion rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/IndexingPolicy'
      appConsistentSnapshot:
        description: Specifies whether or not to quiesce apps and the file system
          in order to take app consistent snapshots.
        type: boolean
        x-nullable: true
        x-order: 4
    x-nullable: true
  RemoteAdapterProtectionGroupReplicationParams:
    description: Specifies the parameters for Remote Adapter replication.
    title: Remote Adapter Replication Parameters
    required:
    - createView
    properties:
      createView:
        description: Specifies whether or not to create a remote view on replication
          cluster.
        type: boolean
        x-nullable: true
        x-order: 0
      viewName:
        description: Specifies the name of the remote view. By default the name will
          be same as the protected view. If a view with the specified name already
          exists on the remote cluster, the created name will have a suffix '-1'.
        type: string
        x-nullable: true
        x-order: 1
  RemoteDisk:
    description: Specifies the configuration of a remote disk.
    type: object
    title: Remote disk
    required:
    - mountPath
    - tier
    properties:
      id:
        description: Specifies the disk id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
        readOnly: true
      mountPath:
        description: Specifies the NFS mount path of the remote disk.
        type: string
        x-nullable: true
        x-order: 1
      nodeId:
        description: Specifies the node id of the disk. If not specified, the disk
          will be evenly distributed across all the nodes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      tier:
        description: Specifies the tier of the disk
        type: string
        enum:
        - PCIeSSD
        - SATA-SSD
        - SATA-HDD
        - CLOUD
        x-nullable: true
        x-order: 3
      capacityBytes:
        description: Specifies the logical capacity of the disk in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
        readOnly: true
      usedCapacityBytes:
        description: Specifies the logical used capacity of remote disk in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
        readOnly: true
      status:
        description: Specifies the status of a remote disk.
        type: string
        enum:
        - Active
        - Offline
        - Deleting
        - Deleted
        - DataVipNotReachable
        - FileSystemNotAccessible
        - FileSystemDeleted
        - Mounting
        - Migrating
        - Unknown
        x-nullable: true
        x-order: 6
        readOnly: true
      fileSystemName:
        description: Specifies the name of filesystem on remote storage.
        type: string
        x-nullable: true
        x-order: 7
      dataVip:
        description: Specifies the data vip used to mount the filesystem.
        type: string
        x-nullable: true
        x-order: 8
      nodeIp:
        description: Specifies ip address of the node that this remote disk is mounted
          on.
        type: string
        x-nullable: true
        x-order: 9
      usedCapacityBytesPhysical:
        description: Specifies the physical used capacity of remote disk in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 10
        readOnly: true
      capacityBytesPhysical:
        description: Specifies the physical capacity of the disk in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 11
        readOnly: true
  RemoteDisks:
    description: Specifies a list of remote disks.
    type: object
    title: Remote disks
    properties:
      remoteDisks:
        description: Specifies a list of remote disks.
        type: array
        items:
          $ref: '#/definitions/RemoteDisk'
        x-nullable: true
        x-order: 0
  RemoteStorageInfo:
    description: Specifies the remote storage Registration parameters.
    title: Remote storage Registration parameters.
    allOf:
    - $ref: '#/definitions/CommonRemoteStorageInfo'
    - type: object
      properties:
        flashbladeParams:
          description: Specifies the parameters to register a Pure Storage flashblade
            as remote storage
          type: object
          x-cohesity-discriminator-value: FlashBlade
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/FlashbladeParams'
  RemoteTargetConfig:
    description: Specifies the configuration for adding remote cluster as repilcation
      target
    type: object
    title: Cluster Target Configuration
    required:
    - clusterId
    properties:
      clusterId:
        description: Specifies the cluster id of the target replication cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      clusterName:
        description: Specifies the cluster name of the target replication cluster.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  RemoveDisk:
    description: Specifies details of disk removal response.
    type: object
    title: Disk Removal Response.
    properties:
      markedForRemoval:
        description: If true, Disk is marked for removal.
        type: boolean
        x-nullable: true
        x-order: 0
      id:
        description: Specifies id of the disk.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  RemoveNode:
    description: Specifies details of node removal response.
    type: object
    title: Node Removal Response.
    properties:
      markedForRemoval:
        description: If true, Node is marked for removal.
        type: boolean
        x-nullable: true
        x-order: 0
      id:
        description: Specifies id of the node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  ReplicaFailoverObject:
    description: Specifies the object paring of replicated object and failover object
      created after restore.
    type: object
    properties:
      replicaObjectId:
        description: Specifies the object Id existing on the replciation cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      failoverObjectId:
        description: Specifies the corrosponding object id of the failover object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  ReplicatedViewNameConfig:
    description: Specifies an object protected by a View Protection Group.
    type: object
    required:
    - sourceViewId
    properties:
      sourceViewId:
        description: Specifies the ID of the protected view.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      useSameViewName:
        description: Specifies if the remote view name to be kept is same as the source
          view name. If this field is true, viewName field will be ignored.
        type: boolean
        x-nullable: true
        x-order: 1
      viewName:
        description: Specifies the name of the remote view. This field is only used
          when useSameViewName is false. If useSameViewName is true, this field is
          not used.
        type: string
        x-nullable: true
        x-order: 2
  ReplicationBackupActivation:
    description: Specifies the request parmeters to activate the backup of failover
      entities on replication cluster.
    type: object
    properties:
      objects:
        description: Specifies the list of failover object that need to be protected
          on replication cluster. If the object set that was sent earlier is provided
          again then API will return an error. If this objects list is not specified
          then internally it will be inferred if '/objectLinkage' API has been called
          previously.
        type: array
        items:
          $ref: '#/definitions/FailoverObject'
        x-nullable: true
        x-order: 0
      protectionGroupId:
        description: Specifies the protection group id that will be used for backing
          up the failover entities on replication cluster. This is a optional argument
          and only need to be passed if user wants to use the existing job for the
          backup. If specified then Orchastrator should enusre that protection group
          is compatible to handle all provided failover objects.
        type: string
        x-nullable: true
        x-order: 1
      enableReverseReplication:
        description: If this is specifed as true, then reverse replication of failover
          objects will be enabled from replication cluster to source cluster. If source
          cluster is not reachable, then replications will fail until source cluster
          comes up again. Here orchastrator should also ensure that storage domain
          on replication cluster is correctly mapped to the same storage domain on
          the source cluster.
        type: boolean
        x-nullable: true
        x-order: 2
  ReplicationBackupActivationResult:
    description: Specifies the result returned after creating a protection group for
      backing up failover objects on replication cluster.
    type: object
    properties:
      protectionGroupId:
        description: Specifies the protection group id that will be returned upon
          creation of new group or existing group for backing up failover entities.
        type: string
        x-nullable: true
        x-order: 0
      reverseReplicationResult:
        description: Specifies the reverse replication result.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/ReverseReplicationResult'
      objects:
        description: Specifies the list of failover object that are going to be protected
          on replication cluster.
        type: array
        items:
          $ref: '#/definitions/FailoverObject'
        x-nullable: true
        x-order: 2
  ReplicationConfig:
    description: Specifies settings for copying Snapshots to Remote Clusters. This
      also specifies the retention policy that should be applied to Snapshots after
      they have been copied to the specified target.
    title: Replication Target Configuration
    allOf:
    - $ref: '#/definitions/CommonTargetConfiguration'
    - type: object
      required:
      - targetType
      properties:
        targetType:
          description: Specifies the type of target to which replication need to be
            performed.
          type: string
          enum:
          - RemoteCluster
          - AWS
          - Azure
          x-order: 0
        remoteTargetConfig:
          description: Specifies the required information to add remote cluster as
            replication target.
          type: object
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/RemoteTargetConfig'
        awsTargetConfig:
          description: Specifies the required information to add AWS as replication
            target.
          type: object
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/AWSTargetConfig'
        azureTargetConfig:
          description: Specifies the required information to add Azure as replication
            target.
          type: object
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/AzureTargetConfig'
  ReplicationDataStats:
    description: Specifies statistics about replication data.
    type: object
    title: Replication data statistics.
    properties:
      logicalSizeBytes:
        description: Specifies the total logical size in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      logicalBytesTransferred:
        description: Specifies the total logical bytes transferred.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      physicalBytesTransferred:
        description: Specifies the total physical bytes transferred.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  ReplicationRun:
    description: Specifies information about replication run for an object.
    type: object
    title: Replication run information for an object.
    properties:
      replicationTargetResults:
        description: Replication result for a target.
        type: array
        items:
          $ref: '#/definitions/ReplicationTargetResult'
        x-order: 0
  ReplicationRunSummary:
    description: Specifies summary information about replication run.
    type: object
    title: Summary information for replication run.
    properties:
      replicationTargetResults:
        description: Replication results for each replication target.
        type: array
        items:
          $ref: '#/definitions/ReplicationTargetResult'
        x-order: 0
  ReplicationTargetProgressInfo:
    description: Specifies the progress of a replication run target.
    type: object
    allOf:
    - $ref: '#/definitions/ReplicationTargetSummaryInfo'
    - $ref: '#/definitions/ProgressTaskInfo'
    - type: object
      properties:
        objects:
          description: Specifies progress for objects.
          type: array
          items:
            $ref: '#/definitions/ObjectProgressInfo'
          x-nullable: true
          x-order: 0
  ReplicationTargetResult:
    description: Replication result for a target.
    title: Replication result for a target.
    allOf:
    - $ref: '#/definitions/ReplicationTargetSummaryInfo'
    - type: object
      properties:
        startTimeUsecs:
          description: Specifies the start time of replication in Unix epoch Timestamp(in
            microseconds) for a target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        endTimeUsecs:
          description: Specifies the end time of replication in Unix epoch Timestamp(in
            microseconds) for a target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
        queuedTimeUsecs:
          description: Specifies the time when the replication is queued for schedule
            in Unix epoch Timestamp(in microseconds) for a target.
          type: integer
          format: int64
          x-nullable: true
          x-order: 2
        status:
          description: Status of the replication for a target. 'Running' indicates
            that the run is still running. 'Canceled' indicates that the run has been
            canceled. 'Canceling' indicates that the run is in the process of being
            canceled. 'Failed' indicates that the run has failed. 'Missed' indicates
            that the run was unable to take place at the scheduled time because the
            previous run was still happening. 'Succeeded' indicates that the run has
            finished successfully. 'SucceededWithWarning' indicates that the run finished
            successfully, but there were some warning messages.
          type: string
          enum:
          - Accepted
          - Running
          - Canceled
          - Canceling
          - Failed
          - Missed
          - Succeeded
          - SucceededWithWarning
          - OnHold
          x-nullable: true
          x-order: 3
        message:
          description: Message about the replication run.
          type: string
          x-nullable: true
          x-order: 4
        percentageCompleted:
          description: Specifies the progress in percentage.
          type: integer
          format: int32
          x-nullable: true
          x-order: 5
        stats:
          description: Replication data statistics for a target.
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/ReplicationDataStats'
        isManuallyDeleted:
          description: Specifies whether the snapshot is deleted manually.
          type: boolean
          x-nullable: true
          x-order: 7
        expiryTimeUsecs:
          description: Specifies the expiry time of attempt in Unix epoch Timestamp
            (in microseconds) for an object.
          type: integer
          format: int64
          x-nullable: true
          x-order: 8
        replicationTaskId:
          description: Task UID for a replication protection run. This is for tasks
            that are replicated from another cluster.
          type: string
          x-nullable: true
          x-order: 9
        entriesChanged:
          description: Specifies the number of metadata actions completed during the
            protection run.
          type: integer
          format: int32
          x-nullable: true
          x-order: 10
        isInBound:
          description: Specifies the direction of the replication. If the snapshot
            is replicated to this cluster, then isInBound is true. If the snapshot
            is replicated from this cluster to another cluster, then isInBound is
            false.
          type: boolean
          x-nullable: true
          x-order: 11
  ReplicationTargetSummaryInfo:
    description: Specifies replication target summary information.
    title: Replication target.
    allOf:
    - $ref: '#/definitions/ClusterIdentifier'
    - type: object
      properties:
        awsTargetConfig:
          x-order: 0
          $ref: '#/definitions/AWSTargetConfig'
        azureTargetConfig:
          x-order: 1
          $ref: '#/definitions/AzureTargetConfig'
  ReplicationTargets:
    description: Replication Targets
    type: object
    title: ReplicationTargets
    properties:
      replicationTargets:
        description: Specifies the replication target.
        type: string
        enum:
        - RemoteCluster
        - AWS
        - Azure
        x-order: 0
  ResetOrRestoreNetworking:
    description: Update cluster or node reset state information
    type: object
    title: ResetOrRestoreNetworking
    properties:
      operation:
        description: Cancel reset cluster or node state operation.
        type: string
        enum:
        - network-reset
        - restore
        x-go-name: Operation
        x-nullable: true
        x-order: 0
  ResetStates:
    type: array
    items:
      $ref: '#/definitions/NodeResetState'
  ResourceEndpoint:
    description: Specifies the details about the resource endpoint.
    type: object
    properties:
      fqdn:
        description: Specifies the fqdn of this endpoint.
        type: string
        x-nullable: true
        x-order: 0
      ipv4addr:
        description: Specifies the ipv4 address of this endpoint.
        type: string
        x-nullable: true
        x-order: 1
      ipv6addr:
        description: Specifies the ipv6 address of this endpoint.
        type: string
        x-nullable: true
        x-order: 2
      subnetIp4addr:
        description: Specifies the subnet Ip4 address of this endpoint.
        type: string
        x-nullable: true
        x-order: 3
      preferredAddress:
        description: Specifies the preferred address to use for connecting.
        type: string
        x-nullable: true
        x-order: 4
      isPreferredEndpoint:
        description: Whether to use this endpoint to connect.
        type: boolean
        x-nullable: true
        x-order: 5
  ResumeActionObjectLevelParams:
    description: Specifies the request parameters for Resume action on a Protected
      object.
    type: object
    allOf:
    - $ref: '#/definitions/ProtectionObjectInput'
  ResumeActionObjectLevelResponse:
    description: Specifies the infomration about status of resume action.
    type: object
    properties:
      error:
        description: If the action fails for this object, then error will be return
          here.
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/Error'
  Retention:
    description: Specifies the retention of a backup.
    type: object
    required:
    - unit
    - duration
    properties:
      unit:
        description: 'Specificies the Retention Unit of a backup measured in days,
          months or years. <br> If unit is ''Months'', then number specified in duration
          is multiplied to 30. <br> Example: If duration is 4 and unit is ''Months''
          then number of retention days will be 30 * 4 = 120 days. <br> If unit is
          ''Years'', then number specified in duration is multiplied to 365. <br>
          If duration is 2 and unit is ''Months'' then number of retention days will
          be 365 * 2 = 730 days.'
        type: string
        enum:
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 0
      duration:
        description: Specifies the duration for a backup retention. <br> Example.
          If duration is 7 and unit is Months, the retention of a backup is 7 * 30
          = 210 days.
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 1
  RetentionUnits:
    description: Retention Units.
    type: object
    title: RetentionUnits
    properties:
      retentionUnits:
        description: Specifies the retention unit.
        type: string
        enum:
        - Days
        - Weeks
        - Months
        - Years
        x-order: 0
  RetryOptions:
    description: Retry Options of a Protection Policy when a Protection Group run
      fails.
    type: object
    properties:
      retries:
        description: 'Specifies the number of times to retry capturing Snapshots before

          the Protection Group Run fails.'
        type: integer
        format: int32
        minimum: 0
        x-nullable: true
        x-order: 0
      retryIntervalMins:
        description: Specifies the number of minutes before retrying a failed Protection
          Group.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  ReverseReplicationResult:
    description: Specifies the request parameters to create a view failover task.
    type: object
    properties:
      isReverseReplicationEnabled:
        description: Specifies whether the reverse replication was enabled or not
          during group creation. It can be false, if source cluster is not reachable
          for reverse replication.
        type: boolean
        x-nullable: true
        x-order: 0
      errorReason:
        description: Specifies the reason of not enabling reverse replication.
        type: string
        x-nullable: true
        x-order: 1
  RevertPatchesRequest:
    description: Specifies the request to revert a patch. An optional patch level
      can be specified. When a patch level is specified, system keeps reverting patches
      until the given patch level is reverted. If no patch level is specified, just
      the last applied patch is reverted.
    type: object
    title: Revert patch.
    required:
    - service
    properties:
      service:
        description: Specifies the name of the service whose patch should be reverted.
        type: string
        x-order: 0
      patchLevel:
        description: Specifies optional patch level upto which the patches should
          be reverted. If given, it should be between 1 and the current patch level
          inclusive.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  RigelClaimInfo:
    description: Specifies the Rigel registration info.
    type: object
    title: Rigel Claim Info.
    properties:
      status:
        description: Specifies the registration status.
        type: string
        enum:
        - NotDone
        - InProgress
        - Success
        - Failed
        x-nullable: true
        x-order: 0
      message:
        description: Specifies possible error message during registration.
        type: string
        x-nullable: true
        x-order: 1
  RigelClaimLog:
    description: Specifies an event during Rigel claim..
    type: object
    title: Rigel Claim Log.
    properties:
      timeStamp:
        description: Specifies the time stamp in microseconds of the event.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      message:
        description: Specifies the message of this event.
        type: string
        x-nullable: true
        x-order: 1
      type:
        description: Specifies the severity of the event.
        type: string
        x-cohesity-enum: rigel_claim_log_type
        x-nullable: true
        x-order: 2
  RigelClaimLogs:
    description: Specifies the Rigel claim logs.
    type: object
    title: Rigel Claim Logs.
    properties:
      rigelClaimLogs:
        description: Specifies Rigel claim logs.
        type: array
        items:
          $ref: '#/definitions/RigelClaimLog'
        x-nullable: true
        x-order: 0
  RigelClusterConfigParams:
    description: Params for Rigel Cluster Creation
    title: Rigel Cluster Params.
    properties:
      nodes:
        description: Specifies the Nodes present in this Cluster.
        type: array
        items:
          $ref: '#/definitions/RigelClusterNode'
        x-nullable: true
        x-order: 0
      claimToken:
        description: Specifies the token which is used to claim this Cluster to Helios.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
    x-nullable: true
  RigelClusterNode:
    description: Params for a Rigel Cluster Node
    title: Rigel Cluster Node
    required:
    - nodeIp
    properties:
      nodeIp:
        description: Specifies the IP address of the Node.
        type: string
        x-nullable: true
        x-order: 0
      nodeId:
        description: Specifies the ID of the Node.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  RigelConnection:
    description: Specify a connection of Rigel.
    type: object
    title: Rigel connection.
    properties:
      id:
        description: Specifies the id of the connection.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the connection.
        type: string
        x-nullable: true
        x-order: 1
  RigelConnectionInfo:
    description: Specifies the Rigel connection info.
    type: object
    title: Rigel Connection Info.
    properties:
      isActive:
        description: Specifies if the connection is active.
        type: boolean
        x-nullable: true
        x-order: 0
      message:
        description: Specifies possible error message when rigel is not able to connect.
        type: string
        x-nullable: true
        x-order: 1
      lastConnectedTimestampMsecs:
        description: Specifies last timestamp for which connection status was known.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  RigelConnections:
    description: Specify a list of connection of Rigel.
    type: object
    title: Rigel connections.
    properties:
      RigelConnections:
        description: Specifies a list of connection of Rigel.
        type: array
        items:
          $ref: '#/definitions/RigelConnection'
        x-nullable: true
        x-order: 0
  RigelConnector:
    description: Specify a Rigel connector.
    type: object
    title: Rigel Connector.
    properties:
      id:
        description: Specifies the id of the connector.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the connector.
        type: string
        x-nullable: true
        x-order: 1
      connectionId:
        description: Specifies the Id of the connection which this connector belongs
          to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      certificateVersion:
        description: Specifies the version of the connector's certificate. The version
          is used to revoke/renew connector's certificates.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      connectionStatus:
        description: Specifies the connection status.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/ConnectorConnectionInfo'
  RigelConnectors:
    description: Specify a list of Rigel connectors.
    type: object
    title: Rigel Connectors.
    properties:
      RigelConnectors:
        description: Specifies a list of Rigel Connectors.
        type: array
        items:
          $ref: '#/definitions/RigelConnector'
        x-nullable: true
        x-order: 0
  RigelEntityType:
    description: Entity type.
    type: object
    title: Entity type.
    properties:
      type:
        description: Entity type.
        type: string
        enum:
        - OnPrem
        - Cloud
        x-order: 0
  RigelRegConfig:
    description: Specifies the Rigel Registration Config.
    type: object
    title: Rigel Registration Config.
    properties:
      regInfo:
        description: Specifies the registration status.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/RigelClaimInfo'
      controlPlaneConnectionInfo:
        description: Specifies the connection status between rigel and control plane(helios).
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RigelConnectionInfo'
      dataPlaneConnectionInfo:
        description: Specifies the connection status between rigel and data plane.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/RigelConnectionInfo'
  RootPublicFolderParam:
    description: Specifies parameters to recover a RootPublicFolder.
    type: object
    required:
    - recoverObject
    properties:
      recoverObject:
        description: Specifies the RootPublicFolder recover Object info.
        allOf:
        - $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
        - x-nullable: true
        x-order: 0
      recoverEntireRootPublicFolder:
        description: Specifies whether to recover the whole RootPublicFolder.
        type: boolean
        x-nullable: true
        x-order: 1
      recoverFolders:
        description: Specifies a list of Public Folders to recover. This field is
          applicable only if 'recoverEntireRootPublicFolder' is false.
        type: array
        items:
          $ref: '#/definitions/PublicFolder'
        x-nullable: true
        x-order: 2
  RunArchivalConfig:
    description: Specifies settings for copying Snapshots External Targets (such as
      AWS or Tape). This also specifies the retention policy that should be applied
      to Snapshots after they have been copied to the specified target.
    type: object
    title: Archival Target Configuration
    required:
    - id
    - archivalTargetType
    properties:
      id:
        description: Specifies the Archival target to copy the Snapshots to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      archivalTargetType:
        description: Specifies the snapshot's archival target type from which recovery
          has been performed.
        type: string
        enum:
        - Tape
        - Cloud
        - Nas
        x-nullable: true
        x-order: 1
      retention:
        description: Specifies the Retention period of snapshot in days, months or
          years to retain copied Snapshots on the target.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/Retention'
  RunFilterValues:
    description: Run Filter Values.
    type: object
    title: Run Filter Values.
    properties:
      runFilterValues:
        description: Specifies Run Filter Value.
        type: string
        enum:
        - kAll
        - kLog
        - kSystem
        - kIncremental
        - kFull
        x-order: 0
  RunNowActionObjectLevelParams:
    description: Specifies the request parameters for RunNow action on a Protected
      object.
    type: object
    allOf:
    - $ref: '#/definitions/ProtectionObjectInput'
    - type: object
      properties:
        takeLocalSnapshotOnly:
          description: If sepcified as true then runNow will only take local snapshot
            ignoring all other targets such as replication, archivals etc. If not
            sepcified or specified as false then runNow will follow the policy settings.
          type: boolean
          x-nullable: true
          x-order: 0
        backupType:
          description: Specifies the backup type should be used for RunNow action.
          type: string
          enum:
          - kRegular
          - kFull
          - kLog
          - kSystem
          - kHydrateCDP
          x-order: 1
  RunNowActionObjectLevelResponse:
    description: Specifies the infomration about status of run now action.
    type: object
    properties:
      error:
        description: If the action fails for this object, then error will be return
          here.
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/Error'
  RunObject:
    description: Specifies the object details to create a protection run.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the id of object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      appIds:
        description: Specifies a list of ids of applications.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      physicalParams:
        description: Specifies physical parameters for this run.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/RunObjectPhysicalParams'
  RunObjectPhysicalParams:
    description: Specifies physical parameters for this run.
    type: object
    properties:
      metadataFilePath:
        description: Specifies metadata file path during run-now requests for physical
          file based backups for some specific source. If specified, it will override
          any default metadata/directive file path set at the object level for the
          source. Also note that if the job default does not specify a metadata/directive
          file path for the source, then specifying this field for that source during
          run-now request will be rejected.
        type: string
        x-nullable: true
        x-order: 0
  RunReplicationConfig:
    description: Specifies settings for copying Snapshots to Remote Clusters. This
      also specifies the retention policy that should be applied to Snapshots after
      they have been copied to the specified target.
    type: object
    title: Replication Target Configuration
    required:
    - id
    properties:
      id:
        description: Specifies id of Remote Cluster to copy the Snapshots to.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      retention:
        description: Specifies the Retention period of snapshot in days, months or
          years to retain copied Snapshots on the target.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/Retention'
  RunTargetsConfiguration:
    description: Specifies the replication and archival targets.
    type: object
    title: Target Configuration
    properties:
      replications:
        description: Specifies a list of replication targets configurations.
        type: array
        items:
          $ref: '#/definitions/RunReplicationConfig'
        x-nullable: true
        x-order: 0
      archivals:
        description: Specifies a list of archival targets configurations.
        type: array
        items:
          $ref: '#/definitions/RunArchivalConfig'
        x-nullable: true
        x-order: 1
  S3Config:
    description: Specifies the S3 config settings for this View.
    type: object
    properties:
      s3AccessPath:
        description: Specifies the path to access this View as an S3 share.
        type: string
        x-nullable: true
        x-order: 0
        readOnly: true
  SQLServer:
    description: Specifies the details of a SQL server.
    type: object
    properties:
      id:
        description: Specifies the unique identifier of the SQL server host.
        type: string
        x-nullable: true
        x-order: 0
      resourceInfo:
        description: Specifies the resource information about the SQL server host.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/AppResource'
      agentInfo:
        description: Specifies the information related to agent running on the SQL
          server.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/AgentInformation'
      error:
        description: Specifies the error information if any associated with SQL server
          host.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/Error'
      isPrimary:
        description: Indicates whether this is a active node of a FCI cluster or hosts
          primary replica of a AAG group.
        type: boolean
        x-nullable: true
        x-order: 4
      instances:
        description: Specifies the list of all sql instances running inside the current
          SQL host.
        type: array
        items:
          $ref: '#/definitions/SQLServerInstance'
        x-nullable: true
        x-order: 5
      isSelectedByDefault:
        description: Indicates to the UI whether this server should be selected by
          default
        type: boolean
        x-nullable: true
        x-order: 6
  SQLServerInstance:
    description: Specifies the details of a SQL server.
    type: object
    properties:
      id:
        description: Specifies the unique id of the SQL server instance.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the SQL server instance.
        type: string
        x-nullable: true
        x-order: 1
      isOnline:
        description: Specifies the wehther the SQL server instance is online or not.
        type: string
        x-nullable: true
        x-order: 2
      endpoints:
        description: Specifies the information about endpoint associated with this
          SQL server instance.
        type: array
        items:
          $ref: '#/definitions/ResourceEndpoint'
        x-nullable: true
        x-order: 3
      isPartofFCI:
        description: Specifies whether this SQL server instance is a part of Failover
          cluster or not.
        type: boolean
        x-nullable: true
        x-order: 4
  ScheduleUnit:
    description: Schedule Units
    type: object
    title: ScheduleUnit
    properties:
      scheduleUnit:
        description: Specifies the schedule unit.
        type: string
        enum:
        - Runs
        - Hours
        - Days
        - Weeks
        - Months
        - Years
        x-order: 0
  ScheduledBackup:
    description: Scheduled Backup type.
    type: object
    title: Scheduled Backup type.
    properties:
      scheduledBackup:
        description: Specifies Scheduled Backup type.
        type: string
        enum:
        - kRegular
        - kFull
        - kLog
        - kSystem
        - kHydrateCDP
        x-order: 0
  ScriptHost:
    description: Specifies the params for the host of a pre / post script.
    type: object
    title: Pre/Post Script Host
    properties:
      hostname:
        description: Specifies the Hostname or IP address of the host where the pre
          and post script will be run.
        type: string
        x-nullable: true
        x-order: 0
      username:
        description: Specifies the username for the host.
        type: string
        x-nullable: true
        x-order: 1
      hostType:
        description: Specifies the Operating system type of the host.
        type: string
        enum:
        - kLinux
        - kWindows
        - kAix
        - kSolaris
        - kSapHana
        - kOther
        x-nullable: true
        x-order: 2
  ScriptHostType:
    description: Script Host Type
    type: object
    title: ScriptHostType
    properties:
      scriptHostType:
        description: Specifies the host type of the pre/post script.
        type: string
        enum:
        - kLinux
        - kWindows
        - kAix
        - kSolaris
        - kSapHana
        - kOther
        x-order: 0
  SearchEmailRequestParams:
    description: Specifies the request parameters to search for emails and email folders.
    type: object
    title: Search emails request params.
    properties:
      hasAttachment:
        description: Filters the emails which have attachment.
        type: boolean
        x-nullable: true
        x-order: 0
      senderAddress:
        description: Filters the emails which are received from specified User's email
          address.
        type: string
        x-nullable: true
        x-order: 1
      recipientAddresses:
        description: Filters the emails which are sent to specified email addresses.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
      ccRecipientAddresses:
        description: Filters the emails which are sent to specified email addresses
          in CC.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 3
      bccRecipientAddresses:
        description: Filters the emails which are sent to specified email addresses
          in BCC.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 4
      receivedStartTimeSecs:
        description: Specifies the start time in Unix timestamp epoch in seconds where
          the received time of the email is more than specified value.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      receivedEndTimeSecs:
        description: Specifies the end time in Unix timestamp epoch in seconds where
          the received time of the email is less than specified value.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      emailSubject:
        description: Filters the emails which have the specified text in its subject.
        type: string
        x-nullable: true
        x-order: 7
      folderName:
        description: Filters the emails which are categorized to specified folder.
        type: string
        x-nullable: true
        x-order: 8
      includeOnlyEmailFolders:
        description: Specifies whether to only include email folders in the response.
          Default is false.
        type: boolean
        default: false
        x-nullable: true
        x-order: 9
      sourceEnvironment:
        description: Specifies the source environment.
        type: string
        enum:
        - kO365
        x-nullable: true
        x-order: 10
      o365Params:
        description: Specifies the O365 specific params to search emails.
        type: object
        x-nullable: true
        x-order: 11
        $ref: '#/definitions/O365SearchEmailsRequestParams'
  SearchFileRequestParams:
    description: Specifies the request parameters to search for files and file folders.
    type: object
    title: Search files request params.
    properties:
      searchString:
        description: Specifies the search string to filter the files. User can specify
          a wildcard character '*' as a suffix to a string where all files name are
          matched with the prefix string.
        type: string
        x-nullable: true
        x-order: 0
      types:
        description: Specifies a list of file types. Only files within the given types
          will be returned.
        type: array
        uniqueItems: true
        items:
          type: string
          enum:
          - File
          - Directory
          - Symlink
        x-nullable: true
        x-order: 1
      sourceEnvironments:
        description: Specifies a list of the source environments. Only files from
          these types of source will be returned.
        type: array
        items:
          type: string
          enum:
          - kVMware
          - kHyperV
          - kSQL
          - kView
          - kRemoteAdapter
          - kPhysical
          - kPhysicalFiles
          - kPure
          - kAzure
          - kNetapp
          - kGenericNas
          - kAcropolis
          - kIsilon
          - kGPFS
          - kKVM
          - kAWS
          - kExchange
          - kOracle
          - kGCP
          - kFlashBlade
          - kO365
          - kHyperFlex
          - kKubernetes
          - kElastifile
          - kUDA
        x-nullable: true
        x-order: 2
      sourceIds:
        description: Specifies a list of source ids. Only files found in these sources
          will be returned.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 3
      objectIds:
        description: Specifies a list of object ids. Only files found in these objects
          will be returned.
        type: array
        uniqueItems: true
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 4
  SearchIndexedObjectsRequest:
    description: Specifies the request parameters to search for indexed objects.
    title: Search indexed objects request params.
    allOf:
    - $ref: '#/definitions/CommonSearchIndexedObjectsRequestParams'
    - type: object
      properties:
        emailParams:
          description: Specifies the parameters which are specific for searching emails
            and email folders.
          type: object
          allOf:
          - $ref: '#/definitions/SearchEmailRequestParams'
          - x-nullable: true
          x-cohesity-discriminator-value: Emails
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/SearchEmailRequestParams'
        fileParams:
          description: Specifies the parameters which are specific for searching files
            and file folders.
          type: object
          allOf:
          - $ref: '#/definitions/SearchFileRequestParams'
          - x-nullable: true
          x-cohesity-discriminator-value: Files
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/SearchFileRequestParams'
        cassandraParams:
          description: Specifies the parameters which are specific for searching Cassandra
            objects.
          type: object
          required:
          - searchString
          - cassandraObjectTypes
          properties:
            cassandraObjectTypes:
              description: Specifies one or more Cassandra object types to be searched.
              type: array
              items:
                type: string
                enum:
                - CassandraKeyspaces
                - CassandraTables
              x-order: 1
            searchString:
              description: Specifies the search string to search the Cassandra Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 2
        couchbaseParams:
          description: Specifies the parameters which are specific for searching Couchbase
            objects.
          type: object
          required:
          - searchString
          - couchbaseObjectTypes
          properties:
            couchbaseObjectTypes:
              description: Specifies Couchbase object types be searched. For Couchbase
                it can only be set to 'CouchbaseBuckets'.
              type: array
              items:
                type: string
                enum:
                - CouchbaseBuckets
              x-order: 1
            searchString:
              description: Specifies the search string to search the Couchbase Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 3
        hbaseParams:
          description: Specifies the parameters which are specific for searching Hbase
            objects.
          type: object
          required:
          - searchString
          - hbaseObjectTypes
          properties:
            hbaseObjectTypes:
              description: Specifies one or more Hbase object types be searched.
              type: array
              items:
                type: string
                enum:
                - HbaseNamespaces
                - HbaseTables
              x-order: 1
            searchString:
              description: Specifies the search string to search the Hbase Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 4
        hiveParams:
          description: Specifies the parameters which are specific for searching Hive
            objects.
          type: object
          required:
          - searchString
          - hiveObjectTypes
          properties:
            hiveObjectTypes:
              description: Specifies one or more Hive object types be searched.
              type: array
              items:
                type: string
                enum:
                - HiveDatabases
                - HiveTables
                - HivePartitions
              x-order: 1
            searchString:
              description: Specifies the search string to search the Hive Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 5
        mongodbParams:
          description: Specifies the parameters which are specific for searching MongoDB
            objects.
          type: object
          required:
          - searchString
          - mongodbObjectTypes
          properties:
            mongoDBObjectTypes:
              description: Specifies one or more MongoDB object types be searched.
              type: array
              items:
                type: string
                enum:
                - MongoDatabases
                - MongoCollections
              x-order: 1
            searchString:
              description: Specifies the search string to search the MongoDB Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 6
        hdfsParams:
          description: Specifies the parameters for searching HDFS Folders and Files.
          type: object
          required:
          - searchString
          - HDFSTypes
          properties:
            hdfsTypes:
              description: Specifies types as Folders or Files or both to be searched.
              type: array
              items:
                type: string
                enum:
                - HDFSFolders
                - HDFSFiles
              x-order: 1
            searchString:
              description: Specifies the search string to search the HDFS Folders
                and Files.
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 7
        exchangeParams:
          description: Specifies the parameters which are specific for searching Exchange
            mailboxes.
          type: object
          required:
          - searchString
          properties:
            searchString:
              description: Specifies the search string to search the Exchange Objects
              type: string
              x-nullable: true
              x-order: 0
          x-order: 8
        publicFolderParams:
          description: Specifies the parameters which are specific for searching Public
            folder items.
          type: object
          allOf:
          - $ref: '#/definitions/SearchPublicFolderRequestParams'
          - x-nullable: true
          x-cohesity-discriminator-value: PublicFolders
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/SearchPublicFolderRequestParams'
  SearchIndexedObjectsResponseBody:
    description: Specifies the search indexed objects response body.
    title: Search Indexed objects response body.
    allOf:
    - $ref: '#/definitions/CommonSearchIndexedObjectsResponseParams'
    - type: object
      properties:
        emails:
          description: Specifies the indexed emails and email folders.
          type: array
          items:
            $ref: '#/definitions/Email'
          x-cohesity-discriminator-value: Emails
          x-nullable: true
          x-order: 0
        files:
          description: Specifies the indexed files and file folders.
          type: array
          items:
            $ref: '#/definitions/File'
          x-cohesity-discriminator-value: Files
          x-nullable: true
          x-order: 1
        cassandraObjects:
          description: Specifies the indexed Cassandra objects.
          type: array
          items:
            $ref: '#/definitions/CassandraIndexedObject'
          x-cohesity-discriminator-value: CassandraObjects
          x-nullable: true
          x-order: 2
        couchbaseObjects:
          description: Specifies the indexed Couchbase objects.
          type: array
          items:
            $ref: '#/definitions/CouchbaseIndexedObject'
          x-cohesity-discriminator-value: CouchbaseObjects
          x-nullable: true
          x-order: 3
        hbaseObjects:
          description: Specifies the indexed Hbase objects.
          type: array
          items:
            $ref: '#/definitions/HbaseIndexedObject'
          x-cohesity-discriminator-value: HbaseObjects
          x-nullable: true
          x-order: 4
        hiveObjects:
          description: Specifies the indexed Hive objects.
          type: array
          items:
            $ref: '#/definitions/HiveIndexedObject'
          x-cohesity-discriminator-value: HiveObjects
          x-nullable: true
          x-order: 5
        mongoObjects:
          description: Specifies the indexed Mongo objects.
          type: array
          items:
            $ref: '#/definitions/MongoIndexedObject'
          x-cohesity-discriminator-value: MongoObjects
          x-nullable: true
          x-order: 6
        hdfsObjects:
          description: Specifies the indexed HDFS objects.
          type: array
          items:
            $ref: '#/definitions/HDFSIndexedObject'
          x-cohesity-discriminator-value: HDFSObjects
          x-nullable: true
          x-order: 7
        exchangeObjects:
          description: Specifies the indexed HDFS objects.
          type: array
          items:
            $ref: '#/definitions/ExchangeIndexedObject'
          x-cohesity-discriminator-value: ExchangeObjects
          x-nullable: true
          x-order: 8
        publicFolderItems:
          description: Specifies the indexed Public folder items.
          type: array
          items:
            $ref: '#/definitions/PublicFolderItem'
          x-cohesity-discriminator-value: PublicFolderItems
          x-nullable: true
          x-order: 9
  SearchObject:
    description: Specifies an object.
    allOf:
    - $ref: '#/definitions/Object'
    - $ref: '#/definitions/TagObject'
    - type: object
      properties:
        sourceInfo:
          description: Specifies the Source Object information.
          allOf:
          - $ref: '#/definitions/Object'
          - x-nullable: true
          x-order: 0
        objectProtectionInfos:
          description: Specifies the object info on each cluster.
          type: array
          items:
            $ref: '#/definitions/ObjectProtectionInfo'
          x-nullable: true
          x-order: 1
  SearchPublicFolderRequestParams:
    description: Specifies the request parameters to search for Public Folder items.
    type: object
    title: Search Public Folder request params.
    properties:
      searchString:
        description: Specifies the search string to filter the items. User can specify
          a wildcard character '*' as a suffix to a string where all item names are
          matched with the prefix string.
        type: string
        x-nullable: true
        x-order: 0
      types:
        description: Specifies a list of public folder item types. Only items within
          the given types will be returned.
        type: array
        uniqueItems: true
        items:
          type: string
          enum:
          - Calendar
          - Contact
          - Post
          - Folder
          - Task
          - Journal
          - Note
        x-nullable: true
        x-order: 1
      hasAttachment:
        description: Filters the public folder items which have attachment.
        type: boolean
        x-nullable: true
        x-order: 2
      senderAddress:
        description: Filters the public folder items which are received from specified
          user's email address.
        type: string
        pattern: ^\S+@\S+.\S+$
        x-nullable: true
        x-order: 3
      recipientAddresses:
        description: Filters the public folder items which are sent to specified email
          addresses.
        type: array
        items:
          type: string
          pattern: ^\S+@\S+.\S+$
        x-nullable: true
        x-order: 4
      ccRecipientAddresses:
        description: Filters the public folder items which are sent to specified email
          addresses in CC.
        type: array
        items:
          type: string
          pattern: ^\S+@\S+.\S+$
        x-nullable: true
        x-order: 5
      bccRecipientAddresses:
        description: Filters the public folder items which are sent to specified email
          addresses in BCC.
        type: array
        items:
          type: string
          pattern: ^\S+@\S+.\S+$
        x-nullable: true
        x-order: 6
      receivedStartTimeSecs:
        description: Specifies the start time in Unix timestamp epoch in seconds where
          the received time of the public folder item is more than specified value.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      receivedEndTimeSecs:
        description: Specifies the end time in Unix timestamp epoch in seconds where
          the received time of the public folder items is less than specified value.
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
  SecurityConfig:
    description: Specifies the fields of security settings.
    type: object
    properties:
      passwordStrength:
        description: Specifies security settings related to password strength.
        type: object
        x-order: 0
        $ref: '#/definitions/SecurityConfigPasswordStrength'
      passwordReuse:
        description: Specifies security settings related to password reuse.
        type: object
        x-order: 1
        $ref: '#/definitions/SecurityConfigPasswordReuse'
      passwordLifetime:
        description: Specifies security settings related to password lifetime.
        type: object
        x-order: 2
        $ref: '#/definitions/SecurityConfigPasswordLifetime'
      accountLockout:
        description: Specifies security settings related to account lockout.
        type: object
        x-order: 3
        $ref: '#/definitions/SecurityConfigAccountLockout'
      dataClassification:
        description: Specifies security settings related to data classification.
        type: object
        x-order: 4
        $ref: '#/definitions/SecurityConfigDataClassification'
      sessionConfiguration:
        description: Specifies security settings related to user sessions. Applies
          only when session management is enabled.
        type: object
        x-order: 5
        $ref: '#/definitions/SecurityConfigSessionConfiguration'
      certificateBasedAuth:
        description: '"Specifies security settings related to certificate based

          authentication."'
        type: object
        x-order: 6
        $ref: '#/definitions/SecurityConfigCertificateBasedAuth'
  SecurityConfigAccountLockout:
    description: Specifies security config for account lockout.
    type: object
    properties:
      maxFailedLoginAttempts:
        description: Specifies the maximum number of consecutive fail login attempts.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 0
      failedLoginLockTimeDurationMins:
        description: Specifies the time duration within which the consecutive failed
          login attempts causes a local user account to be locked and the lockout
          duration time due to that.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
      inactivityTimeDays:
        description: Specifies the lockout inactivity time range in days.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 2
  SecurityConfigCertificateBasedAuth:
    description: Specifies security config for certificate based authentication.
    type: object
    properties:
      enableMappingBasedAuthentication:
        description: 'If true, certfication based authentication is done via configured

          mapping. Else it will proceed based on legacy serial number match.'
        type: boolean
        x-nullable: true
        x-order: 0
      certificateMapping:
        description: Specifies the field to be used in certificate for authentication.
        type: string
        enum:
        - CommonName
        - EmailAddress
        - UserPrincipalName
        x-nullable: true
        x-order: 1
      adMapping:
        description: Specifies the field to be used in AD user for authentication.
        type: string
        enum:
        - SamAccountName
        - UserPrincipalName
        x-nullable: true
        x-order: 2
  SecurityConfigDataClassification:
    description: Specifies security config for data classification.
    type: object
    properties:
      isDataClassified:
        description: Specifies whether to mark the web page data classified/unclassified.
        type: boolean
        x-nullable: true
        x-order: 0
      classifiedDataMessage:
        description: Specifies the classified data message.
        type: string
        x-nullable: true
        x-order: 1
      unclassifiedDataMessage:
        description: Specifies the unclassified data message.
        type: string
        x-nullable: true
        x-order: 2
  SecurityConfigPasswordLifetime:
    description: Specifies security config for password lifetime.
    type: object
    properties:
      minLifetimeDays:
        description: Specifies the minimum password lifetime in days.
        type: integer
        format: int32
        minimum: 0
        x-nullable: true
        x-order: 0
      maxLifetimeDays:
        description: Specifies the maximum password lifetime in days.
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  SecurityConfigPasswordReuse:
    description: Specifies security config for password reuse.
    type: object
    properties:
      numDisallowedOldPasswords:
        description: Specifies the minimum number of old passwords that are not allowed
          for changing the password.
        type: integer
        format: int32
        minimum: 0
        x-nullable: true
        x-order: 0
      numDifferentChars:
        description: Specifies the number of characters in the new password that needs
          to be different from the old password (only applicable when changing the
          user's own password).
        type: integer
        format: int32
        minimum: 0
        x-nullable: true
        x-order: 1
  SecurityConfigPasswordStrength:
    description: Specifies security config for password strength.
    type: object
    properties:
      minLength:
        description: Specifies the password minimum length.
        type: integer
        format: int32
        minimum: 0
        x-nullable: true
        x-order: 0
      includeUpperLetter:
        description: Specifies if the password needs to have at least one uppercase
          letter.
        type: boolean
        x-nullable: true
        x-order: 1
      includeLowerLetter:
        description: Specifies if the password needs to have at least one lowercase
          letter.
        type: boolean
        x-nullable: true
        x-order: 2
      includeNumber:
        description: Specifies if the password needs to have at least one number.
        type: boolean
        x-nullable: true
        x-order: 3
      includeSpecialChar:
        description: Specifies if the password needs to have at least one special
          character.
        type: boolean
        x-nullable: true
        x-order: 4
  SecurityConfigResponse:
    description: Specifies the detail response the security config.
    title: Security Config Response
    allOf:
    - $ref: '#/definitions/SecurityConfig'
  SecurityConfigSessionConfiguration:
    description: Specifies configuration for user sessions.
    type: object
    properties:
      absoluteTimeout:
        description: Specifies absolute session expiration time in seconds.
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 0
      inactivityTimeout:
        description: Specifies inactivity session expiration time in seconds.
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 1
      limitSessions:
        description: Specifies if limitations on number of active sessions is enabled
          or not.
        type: boolean
        x-nullable: true
        x-order: 2
      sessionLimitPerUser:
        description: Specifies maximum number of active sessions allowed per user.
          This applies only when limitSessions is enabled.
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 3
      sessionLimitSystemWide:
        description: Specifies maximum number of active sessions allowed system wide.
          This applies only when limitSessions is enabled.
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 4
  SecurityPrincipal:
    description: Specifies a security principal.
    type: object
    properties:
      domainName:
        description: Specifies the domain name where the security principal account
          is maintained.
        type: string
        x-nullable: true
        x-order: 0
      fullName:
        description: Specifies the full name (first and last name) of the security
          principal.
        type: string
        x-nullable: true
        x-order: 1
      principalName:
        description: Specifies the name of the security principal.
        type: string
        x-nullable: true
        x-order: 2
      objectClass:
        description: Specifies the object class of the security principal.
        type: string
        enum:
        - User
        - Group
        - Computer
        - WellKnownPrincipal
        x-nullable: true
        x-order: 3
      sid:
        description: Specifies the SID of the security principal.
        type: string
        x-nullable: true
        x-order: 4
  SecurityPrincipals:
    description: Specifies a list of security principals.
    type: object
    properties:
      securityPrincipals:
        description: Specifies a list of security principals.
        type: array
        items:
          $ref: '#/definitions/SecurityPrincipal'
        x-nullable: true
        x-order: 0
  SelfServiceSnapshotConfig:
    description: Specifies the self service snapshot config of a view.
    type: object
    properties:
      enabled:
        description: Specifies if self service snapshot feature is enabled. If this
          is set to true, the feature will also be enabled for NFS protocol. This
          field is deprecated.
        type: boolean
        x-nullable: true
        x-order: 0
      previousVersionsEnabled:
        description: Specifies if previouse versions feature is enabled with SMB protocol.
        type: boolean
        x-nullable: true
        x-order: 1
      nfsAccessEnabled:
        description: Specifies if self service snapshot feature is enabled for NFS
          protocol.
        type: boolean
        x-nullable: true
        x-order: 2
      smbAccessEnabled:
        description: Specifies if self service snapshot feature is enabled for SMB
          protocol.
        type: boolean
        x-nullable: true
        x-order: 3
      snapshotDirectoryName:
        description: Specifies the directory name for the snapshots.
        type: string
        x-nullable: true
        x-order: 4
      alternateSnapshotDirectoryName:
        description: Specifies the alternate directory name for the snapshots. If
          it is not set, this feature for SMB protocol will not work.
        type: string
        x-nullable: true
        x-order: 5
      allowAccessSids:
        description: Specifies a list of sids who has access to the snapshots.
        type: array
        items:
          type: string
        x-omitempty: true
        x-order: 6
      denyAccessSids:
        description: Specifies a list of sids who does not have access to the snapshots.
          This field overrides 'allowAccessSids'.
        type: array
        items:
          type: string
        x-omitempty: true
        x-order: 7
  ServicePatchLevel:
    description: Patch level of a service. It is the number of patches applied for
      the service on the cluster. If a service is never patched the patch level is
      0. If two patches were applied, patch level is 2.
    properties:
      service:
        description: Specifies the name of the service.
        type: string
        x-nullable: true
        x-order: 0
      patchLevel:
        description: Specifies patch level of the service after the patch operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      patchVersion:
        description: Specifies the version of the service patch after the patch operation.
        type: string
        x-nullable: true
        x-order: 2
      startLevel:
        description: Specifies patch level of the service before the patch operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      startVersion:
        description: Specifies the version of the service running on the cluster before
          the patch operation.
        type: string
        x-nullable: true
        x-order: 4
  ServicePatchLevels:
    description: Patch levels of a service and its dependencies.
    type: array
    items:
      $ref: '#/definitions/ServicePatchLevel'
  ServiceUnitProgress:
    description: Specifies the progress of one patch operation for one service at
      one patch level.
    title: Patch Operation Service Unit Progress.
    properties:
      service:
        description: Specifies the service which is patched.
        type: string
        x-nullable: true
        x-order: 0
      inProgress:
        description: Specifies whether a operation is in progress for the service.
        type: boolean
        x-nullable: true
        x-order: 1
      percentage:
        description: Specifies the percentage of completion of the patch unit operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      timeRemainingSeconds:
        description: Specifies the time remaining to complete the patch operation
          for the service.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      timeTakenSeconds:
        description: Specifies the time taken so far in this patch unit operation
          for the service.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      nodesProgress:
        description: Specifies the details of patch operation for each service at
          each patch level.
        type: array
        items:
          $ref: '#/definitions/NodeUnitProgress'
        x-nullable: true
        x-order: 5
      serviceMessage:
        description: Specifies a message about the patch unit operation.
        type: string
        x-nullable: true
        x-order: 6
  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
        x-nullable: true
        x-order: 0
      value:
        description: Specifies the value of the shell environment variable.
        type: string
        x-nullable: true
        x-order: 1
  SlaRule:
    description: Specifies an SLA rule for a specific Protection Group run type.
    type: object
    properties:
      backupRunType:
        description: Specifies the type of run this rule should apply to.
        type: string
        enum:
        - kIncremental
        - kFull
        x-nullable: true
        x-order: 0
      slaMinutes:
        description: Specifies the number of minutes allotted to a run of the specified
          type before SLA is considered violated.
        type: integer
        format: int64
        minimum: 1
        x-nullable: true
        x-order: 1
  SmbConfig:
    description: Specifies the SMB config settings for this View.
    type: object
    properties:
      enableSmbViewDiscovery:
        description: If set, it enables discovery of view for SMB.
        type: boolean
        x-nullable: true
        x-order: 0
      enableSmbAccessBasedEnumeration:
        description: 'Specifies if access-based enumeration should be enabled.

          If ''true'', only files and folders that the user has permissions to

          access are visible on the SMB share for that user.'
        type: boolean
        x-nullable: true
        x-order: 1
      enableSmbEncryption:
        description: 'Specifies the SMB encryption for the View. If set, it enables
          the SMB

          encryption for the View. Encryption is supported only by SMB 3.x dialects.

          Dialects that do not support would still access data in unencrypted

          format.'
        type: boolean
        x-nullable: true
        x-order: 2
      enforceSmbEncryption:
        description: 'Specifies the SMB encryption for all the sessions for the View.

          If set, encryption is enforced for all the sessions for the View. When

          enabled all future and existing unencrypted sessions are disallowed.'
        type: boolean
        x-nullable: true
        x-order: 3
      enableFastDurableHandle:
        description: 'Specifies whether fast durable handle is enabled. If enabled,
          view open

          handle will be kept in memory, which results in a higher performance. But

          the handles cannot be recovered if node or service crashes.'
        type: boolean
        x-nullable: true
        x-order: 4
      enableSmbOplock:
        description: Specifies whether SMB opportunistic lock is enabled.
        type: boolean
        x-nullable: true
        x-order: 5
      smbPermissionsInfo:
        description: Specifies the SMB permissions for the View.
        allOf:
        - $ref: '#/definitions/SmbPermissionsInfo'
        - x-nullable: true
        x-order: 6
      sharePermissions:
        description: Specifies share level permissions of the view.
        type: object
        allOf:
        - $ref: '#/definitions/ViewSharePermissions'
        - x-nullable: true
        x-order: 7
    x-nullable: true
  SmbMountCredentials:
    description: Specifies the credentials to mount a view.
    title: SMB Mount Credentials.
    allOf:
    - $ref: '#/definitions/Credentials'
    - type: object
  SmbPermission:
    description: Specifies information about a single SMB permission.
    type: object
    title: SMB Permission.
    properties:
      type:
        description: 'Specifies the type of permission.

          ''Allow'' indicates access is allowed.

          ''Deny'' indicates access is denied.

          ''SpecialType'' indicates a type defined in the Access Control Entry (ACE)

          does not map to ''Allow'' or ''Deny''.'
        type: string
        enum:
        - Allow
        - Deny
        - SpecialType
        x-nullable: true
        x-order: 0
      mode:
        description: 'Specifies how the permission should be applied to folders and/or
          files.

          ''FolderSubFoldersAndFiles'' indicates that permissions are applied to a
          Folder

          and it''s sub folders and files.

          ''FolderAndSubFolders'' indicates that permissions are applied to a Folder
          and it''s sub folders.

          ''FolderAndSubFiles'' indicates that permissions are applied to a Folder
          and it''s sub files.

          ''FolderOnly'' indicates that permsission are applied to folder only.

          ''SubFoldersAndFilesOnly'' indicates that permissions are applied to sub
          folders and files only.

          ''SubFoldersOnly'' indicates that permissiona are applied to sub folders
          only.

          ''FilesOnly'' indicates that permissions are applied to files only.'
        type: string
        enum:
        - FolderSubFoldersAndFiles
        - FolderAndSubFolders
        - FolderAndFiles
        - FolderOnly
        - SubFoldersAndFilesOnly
        - SubFoldersOnly
        - FilesOnly
        x-nullable: true
        x-order: 1
      access:
        description: "Specifies the read/write access to the SMB share.\n'ReadyOnly'\
          \ indicates read only access to the SMB share.\n'ReadWrite' indicates read\
          \ and write access to the SMB share.\n'FullControl' indicates full administrative\
          \ control of the SMB share.\n'SpecialAccess' indicates custom permissions\
          \ to the SMB share using\n access masks structures.\n'SuperUser' indicates\
          \ root permissions ignoring all SMB ACLs."
        type: string
        enum:
        - ReadOnly
        - ReadWrite
        - Modify
        - FullControl
        - SpecialAccess
        x-nullable: true
        x-order: 2
      sid:
        description: Specifies the security identifier (SID) of the principal.
        type: string
        x-nullable: true
        x-order: 3
      specialType:
        description: 'Specifies a custom type.

          When the type from the Access Control Entry (ACE) cannot be mapped

          to one of the enums in ''type'', this field is populated with the custom

          type derived from the ACE and ''type'' is set to kSpecialType.

          This is a placeholder for storing an unmapped type and should

          not be set when creating and editing a View.'
        type: integer
        format: int32
        x-nullable: true
        x-order: 4
      specialAccessMask:
        description: 'Specifies custom access permissions.

          When the access mask from the Access Control Entry (ACE) cannot be mapped

          to one of the enums in ''access'', this field is populated

          with the custom mask derived from the ACE and ''access'' is set

          to kSpecialAccess.

          This is a placeholder for storing an unmapped access permission and should

          not be set when creating and editing a View.'
        type: integer
        format: uint32
        x-nullable: true
        x-order: 5
  SmbPermissionsInfo:
    description: Specifies information about SMB permissions.
    type: object
    title: SMB Permissions Information.
    properties:
      ownerSid:
        description: 'Specifies the security identifier (SID) of the owner of the
          SMB

          share.'
        type: string
        x-nullable: true
        x-order: 0
      permissions:
        description: 'Array of SMB Permissions.

          Specifies a list of SMB permissions.'
        type: array
        items:
          $ref: '#/definitions/SmbPermission'
        x-nullable: true
        x-order: 1
  SnapshotActions:
    description: Snapshot Actions
    type: object
    title: Snapshot Actions
    properties:
      snapshotActions:
        description: Snapshot Actions
        type: string
        enum:
        - RecoverVMs
        - RecoverFiles
        - InstantVolumeMount
        - RecoverVmDisks
        - MountVolumes
        - RecoverVApps
        - RecoverRDS
        - RecoverAurora
        - RecoverApps
        - RecoverNasVolume
        - RecoverPhysicalVolumes
        - RecoverSystem
        - RecoverSanVolumes
        - RecoverNamespaces
        - RecoverObjects
        - DownloadFilesAndFolders
        - RecoverPublicFolders
        - RecoverVAppTemplates
        - RecoverMailbox
        - RecoverOneDrive
        - RecoverMsTeam
        - RecoverMsGroup
        x-order: 0
  SnapshotInfo:
    description: Snapshot info for an object.
    type: object
    title: Snapshot information for an object.
    properties:
      snapshotId:
        description: Snapshot id for a successful snapshot. This field will not be
          set if the Protection Group Run has no successful attempt.
        type: string
        x-nullable: true
        x-order: 0
      status:
        description: Status of snapshot.
        type: string
        enum:
        - kInProgress
        - kSuccessful
        - kFailed
        - kWaitingForNextAttempt
        - kWarning
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the start time of attempt in Unix epoch Timestamp(in
          microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      endTimeUsecs:
        description: Specifies the end time of attempt in Unix epoch Timestamp(in
          microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      admittedTimeUsecs:
        description: Specifies the time at which the backup task was admitted to run
          in Unix epoch Timestamp(in microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      permitGrantTimeUsecs:
        description: Specifies the time when gatekeeper permit is granted to the backup
          task. If the backup task is rescheduled due to errors, the field is updated
          to the time when permit is granted again.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
      queueDurationUsecs:
        description: Specifies the duration between the startTime and when gatekeeper
          permit is granted to the backup task. If the backup task is rescheduled
          due to errors, the field is updated considering the time when permit is
          granted again. Queue duration = PermitGrantTimeUsecs - StartTimeUsecs
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      snapshotCreationTimeUsecs:
        description: Specifies the time at which the source snapshot was taken in
          Unix epoch Timestamp(in microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      stats:
        description: Statistics about backup data for an object.
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/BackupDataStats'
      progressTaskId:
        description: Progress monitor task for an object.
        type: string
        x-nullable: true
        x-order: 9
      warnings:
        description: Specifies a list of warning messages.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 10
      isManuallyDeleted:
        description: Specifies whether the snapshot is deleted manually.
        type: boolean
        x-nullable: true
        x-order: 11
      expiryTimeUsecs:
        description: Specifies the expiry time of attempt in Unix epoch Timestamp
          (in microseconds) for an object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 12
      totalFileCount:
        description: The total number of file and directory entities visited in this
          backup. Only applicable to file based backups.
        type: integer
        format: int64
        x-nullable: true
        x-order: 13
      backupFileCount:
        description: The total number of file and directory entities that are backed
          up in this run. Only applicable to file based backups.
        type: integer
        format: int64
        x-nullable: true
        x-order: 14
  SnapshotLabel:
    description: Specifies the snapshot label for incremental and full backup of Secondary
      Netapp volumes (Data-Protect Volumes).
    type: object
    title: Snapshot Label
    properties:
      incrementalLabel:
        description: Specifies the incremental snapshot label value
        type: string
        x-nullable: true
        x-order: 0
      fullLabel:
        description: Specifies the full snapshot label value
        type: string
        x-nullable: true
        x-order: 1
  SnapshotRecoveryTargetType:
    description: Snapshot Recovery Target Type
    type: object
    title: Snapshot Recovery Target Type
    properties:
      snapshotRecoveryTargetType:
        description: Specifies the snapshot recovery target type.
        type: string
        x-cohesity-enum: snapshot_recovery_target_type
        x-order: 0
  SnapshotTagInfo:
    description: Specifies the snapshot tag info for an object.
    allOf:
    - $ref: '#/definitions/TagInfo'
    - type: object
      properties:
        runIds:
          description: Specifies runs the tags are applied to.
          type: array
          items:
            type: string
          x-nullable: true
          x-order: 0
  SnapshotTargetType:
    description: Snapshot Target Type
    type: object
    title: Snapshot Target Type
    properties:
      snapshotTargetType:
        description: Specifies the snapshot target type.
        type: string
        enum:
        - Local
        - Archival
        x-order: 0
  SnapshotsSummary:
    description: Specifies a summary of the object snapshots.
    type: object
    properties:
      snapshotTargetType:
        description: Specifies the target type where the Object's snapshot resides.
        type: string
        enum:
        - Local
        - Archival
        x-nullable: true
        x-order: 0
      externalTargetInfo:
        description: Specifies the external target information if this is an archival
          snapshot.
        allOf:
        - $ref: '#/definitions/ArchivalTargetSummaryInfo'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      snapshotCount:
        description: Specifies the number of snapshots of this type and target.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      latestSnapshotTimestampUsecs:
        description: Specifies the timestamp in Unix time epoch in microseconds when
          the latest snapshot is taken.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  Source:
    description: Specifies the Protection Source.
    title: Protection Source.
    allOf:
    - $ref: '#/definitions/Object'
    - type: object
      properties:
        lastRefreshedTime:
          description: Time at which the data about this protection source was last
            refreshed.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        registrationId:
          description: Id of the registration as part of which this source was discovered.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
  SourceAttributeFilter:
    description: Specifies a pair of source filter attribute and its possible values.
    type: object
    properties:
      filterAttribute:
        description: Specifies the filter attribute for the source.
        type: string
        x-nullable: true
        x-order: 0
      attributeValues:
        description: Specifies the list of attribute values for above filter.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 1
  SourceAttributeFiltersResponseParams:
    description: Protection Source attribute filters
    type: object
    properties:
      sourceAttributeFilters:
        description: Specifies the list of protection source filters.
        type: array
        items:
          $ref: '#/definitions/SourceAttributeFilter'
        x-order: 0
  SourceBackupDeactivation:
    description: Specifies the request parmeters to deactivate the backup of failover
      entities on source cluster.
    type: object
    properties:
      replicationClusterId:
        description: Specifies the replication cluster Id involved in failover operation.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      viewId:
        description: If failover is initiated by view based orchastrator, then this
          field specifies the local view id of source cluster which is being failed
          over. Backup will be deactivated for view object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      objects:
        description: Specifies the list of all local entity ids of all the objects
          being failed from the source cluster. Backup will be deactiaved for all
          given objects.
        type: array
        items:
          $ref: '#/definitions/FailoverObject'
        x-nullable: true
        x-order: 2
      protectionGroupId:
        description: Specifies the protection group id of the source cluster from
          where the objects being failed over. If this is not specified then it will
          be infer from the list of objects being failed over.
        type: string
        x-nullable: true
        x-order: 3
      keepFailoverObjects:
        description: If this is set to true then objects will not be removed from
          protection group. If this is set to false, then all objects which are being
          failed over will be removed from the protection group. If protection group
          left with zero entities then it will be paused automatically.
        type: boolean
        x-nullable: true
        x-order: 4
  SourceConnectionRequestParams:
    description: Specifies the parameters to test connectivity with a source.
    type: object
    title: Test connection request parameters.
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Protection Source.
        type: string
        enum:
        - kCassandra
        - kHive
        - kHBase
        - kHdfs
        - kSQL
        x-nullable: true
        x-order: 0
      cassandraConnectionParams:
        description: Specifies the parameters to connect to a Cassandra seed node
          and fetch information from its cassandra config file.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/CassandraConnectionParams'
      hiveConnectionParams:
        description: Specifies the parameters to connect to a hive seed node and fetch
          information from its config file.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/HadoopConnectionParams'
      hbaseConnectionParams:
        description: Specifies the parameters to connect to a HBase seed node and
          fetch information from its config file.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/HadoopConnectionParams'
      hdfsConnectionParams:
        description: Specifies the parameters to connect to a HDFS seed node and fetch
          information from its config file.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/HadoopConnectionParams'
      mssqlConnectionParams:
        description: Specifies the parameters to connect to a SQL node/cluster and
          fetch connection status information of all nodes.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/MssqlConnectionParams'
      vmwareConnectionParams:
        description: Specifies the parameters to connect to a HDFS seed node and fetch
          information from its config file.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/VmwareConnectionParams'
  SourceConnectionResponseParams:
    description: Specifies the response from a test connection request.
    type: object
    title: Test Connection response parameters.
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Protection Source.
        type: string
        enum:
        - kCassandra
        - kHive
        - kHBase
        - kHdfs
        - kSQL
        x-nullable: true
        x-order: 0
      cassandraConnectionResponseParams:
        description: Specifies the parameters fetched by reading cassandra configuration
          on the seed node.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/CassandraSourceConfigParams'
      hiveConnectionResponseParams:
        description: Specifies the parameters fetched by reading Hive configuration
          on the seed node.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/HiveAdditionalParams'
      hbaseConnectionResponseParams:
        description: Specifies the parameters fetched by reading HBase configuration
          on the seed node.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/HBaseAdditionalParams'
      hdfsConnectionResponseParams:
        description: Specifies the parameters fetched by reading Hdfs configuration
          on the seed node.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/HdfsAdditionalParams'
      mssqlConnectionResponseParams:
        description: Specifies the response parameters after connecting to a SQL node/cluster
          using given IP or hostname FQDN.
        type: object
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/MssqlConnectionResponseParams'
      vmwareConnectionResponseParams:
        description: Specifies the parameters fetched by reading VMware configuration
          on the seed node.
        type: object
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/VmwareAdditionalParams'
  SourceHierarchyObjectSummaries:
    description: Specifies a list of Source Hierarchy Object Summaries.
    type: object
    title: ObjectSummaries
    properties:
      objects:
        description: Specifies a list of Source Hierarchy Object summaries.
        type: array
        items:
          $ref: '#/definitions/SourceHierarchyObjectSummary'
        x-nullable: true
        x-order: 0
  SourceHierarchyObjectSummary:
    description: Specifies the list of Object Summaries for Objects under a given
      Source.
    type: object
    title: SourceHierarchyObjectSummaries
    allOf:
    - $ref: '#/definitions/ObjectSummary'
    - type: object
      properties:
        parentId:
          description: Specifies the ID of the direct parent of this object in the
            source hierarchy.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
  SourceRegistration:
    description: Specifies the Source Registration.
    title: Source Registration.
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters to register a VMware Protection Source.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareSourceRegistrationParams'
        physicalParams:
          description: Specifies the parameters to register a Physical Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
        genericNasParams:
          description: Specifies the parameters to register a Generic Nas Source.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/GenericNasRegistrationParams'
        isilonParams:
          description: Specifies the parameters to register an Isilon Source.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/IsilonRegistrationParams'
        netappParams:
          description: Specifies the parameters to register an Netapp Source.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/NetappRegistrationParams'
        elastifileParams:
          description: Specifies the parameters to register an Elastifile Source.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ElastifileRegistrationParams'
        flashbladeParams:
          description: Specifies the parameters to register an Flashblade Source.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/FlashbladeRegistrationParams'
        gpfsParams:
          description: Specifies the parameters to register an GPFS Source.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/GpfsRegistrationParams'
        cassandraParams:
          description: Specifies the parameters to register a Cassandra Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/CassandraSourceRegistrationParams'
        mongodbParams:
          description: Specifies the parameters to register a MongoDB Protection Source.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
        couchbaseParams:
          description: Specifies the parameters to register a Couchbase Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
        hdfsParams:
          description: Specifies the parameters to register an HDFS Protection Source.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/HdfsSourceRegistrationParams'
        hbaseParams:
          description: Specifies the parameters to register an HBase Protection Source.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/HbaseSourceRegistrationParams'
        hiveParams:
          description: Specifies the parameters to register a Hive Protection Source.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/HiveSourceRegistrationParams'
        udaParams:
          description: Specifies the parameters to register a Universal Data Adapter
            Protection Source.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/UdaSourceRegistrationParams'
  SourceRegistrationRequestParams:
    description: Specifies the Source Registration parameters.
    title: Source Registration parameters.
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters to register a VMware Protection Source.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareSourceRegistrationParams'
        physicalParams:
          description: Specifies the parameters to register a Physical Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
        genericNasParams:
          description: Specifies the parameters to register a Generic Nas Source.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/GenericNasRegistrationParams'
        isilonParams:
          description: Specifies the parameters to register an Isilon Source.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/IsilonRegistrationParams'
        netappParams:
          description: Specifies the parameters to register an Netapp Source.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/NetappRegistrationParams'
        elastifileParams:
          description: Specifies the parameters to register an Elastifile Source.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ElastifileRegistrationParams'
        flashbladeParams:
          description: Specifies the parameters to register an Flashblade Source.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/FlashbladeRegistrationParams'
        gpfsParams:
          description: Specifies the parameters to register an GPFS Source.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/GpfsRegistrationParams'
        cassandraParams:
          description: Specifies the parameters to register a Cassandra Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/CassandraSourceRegistrationParams'
        mongodbParams:
          description: Specifies the parameters to register a MongoDB Protection Source.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
        couchbaseParams:
          description: Specifies the parameters to register a Couchbase Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
        hdfsParams:
          description: Specifies the parameters to register an HDFS Protection Source.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/HdfsSourceRegistrationParams'
        hbaseParams:
          description: Specifies the parameters to register an HBase Protection Source.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/HbaseSourceRegistrationParams'
        hiveParams:
          description: Specifies the parameters to register a Hive Protection Source.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/HiveSourceRegistrationParams'
        udaParams:
          description: Specifies the parameters to register a Universal Data Adapter
            Protection Source.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/UdaSourceRegistrationParams'
  SourceRegistrationUpdateRequestParams:
    description: Specifies the Source registration Update request parameters.
    title: Source Registration update parameters.
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters to register a VMware Protection Source.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareSourceRegistrationParams'
        physicalParams:
          description: Specifies the parameters to register a Physical Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
        genericNasParams:
          description: Specifies the parameters to register a Generic Nas Source.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/GenericNasRegistrationParams'
        isilonParams:
          description: Specifies the parameters to register an Isilon Source.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/IsilonRegistrationParams'
        netappParams:
          description: Specifies the parameters to register an Netapp Source.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/NetappRegistrationParams'
        elastifileParams:
          description: Specifies the parameters to register an Elastifile Source.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ElastifileRegistrationParams'
        flashbladeParams:
          description: Specifies the parameters to register an Flashblade Source.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/FlashbladeRegistrationParams'
        gpfsParams:
          description: Specifies the parameters to register an GPFS Source.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/GpfsRegistrationParams'
        cassandraParams:
          description: Specifies the parameters to update the registration of a Cassandra
            Protection Source.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/CassandraSourceRegistrationParams'
        mongodbParams:
          description: Specifies the parameters to register a MongoDB Protection Source.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
        couchbaseParams:
          description: Specifies the parameters to register a Couchbase Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
        hdfsParams:
          description: Specifies the parameters to update registration of an HDFS
            Protection Source. Update for HDFS supports two operations - Reconfigure
            and Update Kerberos. For the Reconfigure operation you have to specify
            host, config directory and either SSHCredentials or SSHPrivateKey. All
            other fields in the request will be ignored. For the Update Kerberos operation
            you should set only the Kerberos field and not set any other field.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/HdfsSourceRegistrationParams'
        hbaseParams:
          description: Specifies the parameters to update registration of an Hbase
            Protection Source. Update Hbase supports two operations - Reconfigure
            and Update Kerberos. For the Reconfigure operation you have to specify
            host, config directory and either SSHCredentials or SSHPrivateKey. All
            other fields in the request will be ignored. For the Update Kerberos operation
            you should set only the Kerberos field and not set any other field.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/HbaseSourceRegistrationParams'
        hiveParams:
          description: Specifies the parameters to update registration of an Hive
            Protection Source. Update Hive supports two operations - Reconfigure and
            Update Kerberos. For the Reconfigure operation you have to specify host,
            config directory and either SSHCredentials or SSHPrivateKey. All other
            fields in the request will be ignored. For the Update Kerberos operation
            you should set only the Kerberos field and not set any other field.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/HiveSourceRegistrationParams'
        udaParams:
          description: Specifies the parameters to update the registration of a Universal
            Data Adapter Protection Source.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/UdaSourceRegistrationParams'
  SourceRegistrations:
    description: Protection Source Registrations.
    type: object
    properties:
      registrations:
        description: Specifies the list of Protection Source Registrations.
        type: array
        items:
          x-cohesity-discriminator-ref: CommonSourceRegistrationReponseParams
          $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
        x-nullable: true
        x-order: 0
  SourceReplicaObject:
    description: Specifies the response after succesfully initiating the failover
      request.
    type: object
    properties:
      replicaObjectId:
        description: Specifies the object Id existing on the replciation cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      sourceObjectId:
        description: Specifies the corrosponding object id existing on the source
          cluster.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  Sources:
    description: Protection Sources.
    type: object
    properties:
      sources:
        description: Specifies the list of Protection Sources.
        type: array
        items:
          $ref: '#/definitions/Source'
        x-nullable: true
        x-order: 0
  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: '#/definitions/CommonRecoverSqlAppTargetParams'
  StoragePolicyOverride:
    description: 'Specifies if inline deduplication and compression settings inherited
      from

      Storage Domain (View Box) should be disabled for this View.'
    type: object
    title: Storage Policy Override.
    properties:
      disableInlineDedupAndCompression:
        description: 'If false, the inline deduplication and compression settings
          inherited

          from the Storage Domain (View Box) apply to this View.

          If true, both inline deduplication and compression are disabled for this

          View. This can only be set to true if inline deduplication is set for

          the Storage Domain (View Box).'
        type: boolean
        x-nullable: true
        x-order: 0
      disableDedup:
        description: 'If it is set to true, we would disable dedup for writes made
          in this

          view irrespective of the view box''s storage policy.'
        type: boolean
        x-nullable: true
        x-order: 1
    x-nullable: true
  Subnet:
    description: 'Defines a Subnet (Subnetwork).

      The netmask can be specified by setting netmaskBits or netmaskIp4.

      The netmask can only be set using netmaskIp4 if the IP address

      is an IPv4 address.'
    type: object
    title: Subnet
    properties:
      component:
        description: Component that has reserved the subnet.
        type: string
        x-nullable: true
        x-order: 0
      description:
        description: Description of the subnet.
        type: string
        x-nullable: true
        x-order: 1
      gateway:
        description: Gateway for the subnet.
        type: string
        x-nullable: true
        x-order: 2
      id:
        description: ID of the subnet.
        type: integer
        format: int32
        x-nullable: true
        x-order: 3
      ip:
        description: Specifies either an IPv6 address or an IPv4 address.
        type: string
        x-nullable: true
        x-order: 4
      netmaskBits:
        description: Specifies the netmask using bits.
        type: integer
        format: int32
        x-nullable: true
        x-order: 5
      netmaskIp4:
        description: 'Specifies the netmask using an IP4 address.

          The netmask can only be set using netmaskIp4 if the IP address

          is an IPv4 address.'
        type: string
        x-nullable: true
        x-order: 6
      nfsAccess:
        description: 'Specifies whether clients from this subnet can mount using NFS
          protocol.

          Protocol access level.

          ''kDisabled'' indicates Protocol access level ''Disabled''

          ''kReadOnly'' indicates Protocol access level ''ReadOnly''

          ''kReadWrite'' indicates Protocol access level ''ReadWrite'''
        type: string
        enum:
        - kDisabled
        - kReadOnly
        - kReadWrite
        x-nullable: true
        x-order: 7
      nfsSquash:
        description: 'Specifies which nfsSquash Mounted.

          ''kNone'' mounts none.

          ''kRootSquash'' mounts nfsRootSquash. Whether clients from this subnet can

          mount as root on NFS.

          ''kAllSquash'' mounts nfsAllSquash. Whether all clients from this subnet
          can

          map view with view_all_squash_uid/view_all_squash_gid configured in

          the view.'
        type: string
        enum:
        - kNone
        - kRootSquash
        - kAllSquash
        x-nullable: true
        x-order: 8
      smbAccess:
        description: 'Specifies whether clients from this subnet can mount using SMB
          protocol.

          Protocol access level.

          ''kDisabled'' indicates Protocol access level ''Disabled''

          ''kReadOnly'' indicates Protocol access level ''ReadOnly''

          ''kReadWrite'' indicates Protocol access level ''ReadWrite'''
        type: string
        enum:
        - kDisabled
        - kReadOnly
        - kReadWrite
        x-nullable: true
        x-order: 9
      s3Access:
        description: 'Specifies whether clients from this subnet can access using
          S3 protocol.

          Protocol access level.

          ''kDisabled'' indicates Protocol access level ''Disabled''

          ''kReadOnly'' indicates Protocol access level ''ReadOnly''

          ''kReadWrite'' indicates Protocol access level ''ReadWrite'''
        type: string
        enum:
        - kDisabled
        - kReadOnly
        - kReadWrite
        x-nullable: true
        x-order: 10
  SubnetInfo:
    description: Subnet information.
    type: object
    title: SubnetInfo
    properties:
      subnetIp:
        description: Subnet IP.
        type: string
        x-nullable: true
        x-order: 0
      netmaskBits:
        description: Subnet netmask bits.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
      gateway:
        description: Gateway.
        type: string
        x-nullable: true
        x-order: 2
  SupportChannelConfig:
    description: Specifies the support channel configuration.
    type: object
    title: Support channel configuration.
    required:
    - isEnabled
    - endTimeUsecs
    properties:
      isEnabled:
        description: Specifies id the support channel is enabled.
        type: boolean
        x-nullable: true
        x-order: 0
      endTimeUsecs:
        description: Specifies the support channel expiry time.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  SupportedHadoopDistributions:
    description: Enumeration of all the supported Hadoop distributions.
    type: object
    title: Enumeration of all the supported Hadoop distributions.
    properties:
      SupportedHadoopDistributions:
        description: Enumeration of all the supported Hadoop distributions.
        type: string
        enum:
        - CDH
        - HDP
        x-order: 0
  SwiftConfig:
    description: Specifies the Swift config settings for this View.
    type: object
    properties:
      swiftProjectDomain:
        description: Specifies the Keystone project domain.
        type: string
        x-nullable: true
        x-order: 0
      swiftProjectName:
        description: Specifies the Keystone project name.
        type: string
        x-nullable: true
        x-order: 1
      swiftUserDomain:
        description: Specifies the Keystone user domain.
        type: string
        x-nullable: true
        x-order: 2
      swiftUsername:
        description: Specifies the Keystone username.
        type: string
        x-nullable: true
        x-order: 3
  SwiftParams:
    description: Specifies the parameters to update a Swift configuration.
    type: object
    required:
    - tenantId
    properties:
      tenantId:
        description: Specifies the tenant Id who will use this Swift configuration.
        type: string
        x-nullable: true
        x-order: 0
      keystoneId:
        description: Specifies the associated Keystone configuration Id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      operatorRoles:
        description: Specifies a list of roles that can operate on Cohesity Swift
          service.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: string
        x-order: 2
  SyslogAuditTag:
    description: Cohesity audit tag name.
    type: object
    title: SyslogAuditTag
    properties:
      clusterAudit:
        description: Cluster audit tagging name.
        type: string
        x-nullable: true
        x-order: 0
      filerAudit:
        description: Filer audit tagging name.
        type: string
        x-nullable: true
        x-order: 1
      dataProtectionEventsAudit:
        description: Data protection events audit tagging name.
        type: string
        x-nullable: true
        x-order: 2
      alertAudit:
        description: Alert audit tagging name.
        type: string
        x-nullable: true
        x-order: 3
  SyslogServer:
    description: Specifies information about syslog server.
    type: object
    title: Syslog Server.
    properties:
      id:
        description: The id of the syslog server.
        type: integer
        format: int32
        x-nullable: true
        x-order: 0
      ip:
        description: Specifies the IP address or hostname of the syslog server.
        type: string
        x-nullable: true
        x-order: 1
      port:
        description: Specifies the port where the syslog server listens.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
      protocol:
        description: Specifies the protocol used to send the logs.
        type: string
        x-nullable: true
        x-order: 3
      name:
        description: Specifies a unique name for the syslog server on the Cluster.
        type: string
        x-nullable: true
        x-order: 4
      enabled:
        description: Specifies whether to enable the syslog server on the Cluster.
        type: boolean
        x-nullable: true
        x-order: 5
      facilityList:
        description: Send enabled syslog facilities related logs to logging server.
        type: array
        items:
          type: string
        x-order: 6
      programNameList:
        description: Send programes related logs to logging server.
        type: array
        items:
          type: string
        x-order: 7
      msgPatternList:
        description: Send logs including the msg patterns to logging server.
        type: array
        items:
          type: string
        x-order: 8
      rawMsgPatternList:
        description: Send logs including the msg patterns to logging server.
        type: array
        items:
          type: string
        x-order: 9
      isTlsEnabled:
        description: Specify whether to enable tls support.
        type: boolean
        x-nullable: true
        x-order: 10
      caCertificate:
        description: Syslog server CA certificate.
        type: string
        x-nullable: true
        x-order: 11
  SyslogServerStatus:
    description: Remote system logging server.
    type: object
    title: SyslogServerStatus
    properties:
      id:
        description: The id of the syslog server.
        type: integer
        format: int32
        x-nullable: true
        x-order: 0
      isReachable:
        description: Specify if the syslog server is reachable or not.
        type: boolean
        x-nullable: true
        x-order: 1
      message:
        description: Description for current status.
        type: string
        x-nullable: true
        x-order: 2
  SyslogServers:
    description: Specifies the list of syslog servers.
    type: object
    title: List of syslog servers
    properties:
      syslogServers:
        description: Specifies the list of syslog servers.
        type: array
        items:
          $ref: '#/definitions/SyslogServer'
        x-nullable: true
        x-order: 0
  Tag:
    description: Tag details
    type: object
    title: Tag.
    required:
    - name
    - namespace
    properties:
      id:
        description: Specifies unique id of the Tag.
        type: string
        pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 0
        readOnly: true
      name:
        description: Name of the Tag. Name has to be unique under Namespace.
        type: string
        x-nullable: true
        x-order: 1
      namespace:
        description: 'Namespace of the Tag. This is used to filter tags based on

          application or usecase. For example all tags related to vcenter can

          be put under one namespace or different departments could have their

          own namespaces e.g. finance/tag1 or operations/tag2 etc.'
        type: string
        x-nullable: true
        x-order: 2
      tenantId:
        description: Tenant Id to whom the Tag belongs.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      description:
        description: Description of the Tag.
        type: string
        x-nullable: true
        x-order: 4
      createdTimeUsecs:
        description: 'Specifies the timestamp in microseconds since the epoch

          when this Tag was created.'
        type: integer
        format: uint64
        x-nullable: true
        x-order: 5
        readOnly: true
      lastUpdatedTimeUsecs:
        description: 'Specifies the timestamp in microseconds since the epoch

          when this Tag was last updated.'
        type: integer
        format: uint64
        x-nullable: true
        x-order: 6
        readOnly: true
      markedForDeletion:
        description: If true, Tag is marked for deletion.
        type: boolean
        x-nullable: true
        x-order: 7
        readOnly: true
      uiColor:
        description: Color of the tag in UI.
        type: string
        x-nullable: true
        x-order: 8
      uiPathElements:
        description: Path of the tag for UI nesting purposes.
        type: array
        items:
          type: string
        x-nullable: true
        x-omitempty: true
        x-order: 9
  TagInfo:
    description: Specifies the tag info for an object.
    type: object
    required:
    - tagId
    properties:
      tagId:
        description: Specifies Id of tag applied to the object.
        type: string
        x-nullable: true
        x-order: 0
  TagObject:
    description: Specifies all the tag related info for an object.
    type: object
    properties:
      tags:
        description: Specifies tag applied to the object.
        type: array
        items:
          $ref: '#/definitions/TagInfo'
        x-nullable: true
        x-order: 0
      snapshotTags:
        description: Specifies snapshot tags applied to the object.
        type: array
        items:
          $ref: '#/definitions/SnapshotTagInfo'
        x-nullable: true
        x-order: 1
  TargetMailboxParam:
    description: Specifies the target Mailbox to recover to.
    allOf:
    - $ref: '#/definitions/RecoveryObjectIdentifier'
    - type: object
      required:
      - targetFolderPath
      properties:
        targetFolderPath:
          description: Specifies the path to the target folder.
          type: string
          x-nullable: true
          x-order: 0
  TargetMsTeamParam:
    description: Specifies the target Microsoft 365 Team to recover to.
    allOf:
    - $ref: '#/definitions/RecoveryObjectIdentifier'
    - type: object
  TargetOneDriveParam:
    description: Specifies the target OneDrive to recover to.
    allOf:
    - $ref: '#/definitions/RecoveryObjectIdentifier'
    - type: object
      required:
      - targetFolderPath
      properties:
        targetFolderPath:
          description: Specifies the path to the target folder.
          type: string
          x-nullable: true
          x-order: 0
  TargetSchedule:
    description: Specifies a schedule frequency and schedule unit for copying Snapshots
      to backup targets.
    type: object
    title: Schedule
    required:
    - unit
    properties:
      unit:
        description: Specifies the frequency that Snapshots should be copied to the
          specified target. Used in combination with multiplier. <br>'Runs' means
          that the Snapshot copy occurs after the number of Protection Group Runs
          equals the number specified in the frequency. <br>'Hours' means that the
          Snapshot copy occurs hourly at the frequency set in the frequency, for example
          if scheduleFrequency is 2, the copy occurs every 2 hours. <br>'Days' means
          that the Snapshot copy occurs daily at the frequency set in the frequency.
          <br>'Weeks' means that the Snapshot copy occurs weekly at the frequency
          set in the frequency. <br>'Months' means that the Snapshot copy occurs monthly
          at the frequency set in the Frequency. <br>'Years' means that the Snapshot
          copy occurs yearly at the frequency set in the scheduleFrequency.
        type: string
        enum:
        - Runs
        - Hours
        - Days
        - Weeks
        - Months
        - Years
        x-nullable: true
        x-order: 0
      frequency:
        description: 'Specifies a factor to multiply the unit by, to determine the
          copy schedule.

          For example if set to 2 and the unit is hourly, then Snapshots from the
          first eligible Job Run for every 2 hour period is copied.'
        type: integer
        format: int32
        minimum: 1
        x-nullable: true
        x-order: 1
  TargetsConfiguration:
    description: Specifies the replication, archival and cloud spin targets of Protection
      Policy.
    type: object
    properties:
      replicationTargets:
        type: array
        items:
          $ref: '#/definitions/ReplicationConfig'
        x-order: 0
      archivalTargets:
        type: array
        items:
          $ref: '#/definitions/ArchivalConfig'
        x-order: 1
      cloudSpinTargets:
        type: array
        items:
          $ref: '#/definitions/CloudSpinConfig'
        x-order: 2
  TdmAction:
    description: Supported actions in TDM.
    type: object
    title: TdmAction
    properties:
      type:
        description: Specifies the TDM action type.
        type: string
        enum:
        - clone
        - teardown
        - refresh
        - snapshot
        - rewind
        x-order: 0
  TdmCloneTaskRequestParams:
    description: Specifies the request parameters to create a clone task.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmCloneTaskRequestParams'
    - type: object
      properties:
        oracleParams:
          x-order: 0
          $ref: '#/definitions/OracleCloneTask'
  TdmCloneTaskResponseParams:
    description: Specifies the response parameters for a clone task.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmCloneTaskResponseParams'
    - type: object
      properties:
        oracleParams:
          x-order: 0
          $ref: '#/definitions/OracleCloneTask'
  TdmEnvironment:
    description: Supported environments in TDM.
    type: object
    title: TdmEnvironment
    properties:
      type:
        description: Specifies the TDM environment type.
        type: string
        enum:
        - kSQL
        - kOracle
        x-order: 0
  TdmObject:
    description: Specifies a TDM object.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmObjectResponseParams'
    - type: object
      properties:
        oracleParams:
          x-cohesity-discriminator-value: oracle
          x-order: 0
          $ref: '#/definitions/OracleCloneObject'
  TdmObjectTimelineEvent:
    description: Specifies a TDM object timeline event.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmObjectTimelineEventsResponseParams'
    - type: object
      properties:
        cloneParams:
          x-cohesity-discriminator-value: clone
          x-order: 0
          $ref: '#/definitions/TdmCloneTaskResponseParams'
        snapshotParams:
          x-cohesity-discriminator-value: snapshot
          x-order: 1
          $ref: '#/definitions/TdmSnapshot'
  TdmObjectTimelineEvents:
    description: Specifies a collection of TDM object's timeline events.
    type: object
    properties:
      events:
        description: Specifies the collection of the timeline events, filtered by
          the specified criteria.
        type: array
        items:
          x-cohesity-discriminator-ref: CommonTdmObjectTimelineEventsResponseParams
          $ref: '#/definitions/CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89b'
        x-nullable: true
        x-order: 0
  TdmObjects:
    description: Specifies a collection of TDM objects.
    type: object
    properties:
      objects:
        description: Specifies the collection of TDM objects, filtered by the specified
          criteria.
        type: array
        items:
          x-cohesity-discriminator-ref: CommonTdmObjectResponseParams
          $ref: '#/definitions/CommonTdmObjectResponseParamsa153f0a0-cd89-4b59-836b-6ec803e6e173'
        x-order: 0
      paginationInfo:
        x-order: 1
        $ref: '#/definitions/PaginationInfo'
  TdmRefreshTaskRequestParams:
    description: Specifies the parameters to refresh a clone with new data.
    type: object
    required:
    - cloneId
    - snapshotId
    properties:
      cloneId:
        description: Specifies the ID of the clone, which needs to be refreshed.
        type: string
        x-nullable: true
        x-order: 0
      snapshotId:
        description: Specifies the snapshot ID, using which the clone is to be refreshed.
        type: string
        x-nullable: true
        x-order: 1
      description:
        description: Specifies the description of the clone refresh task.
        type: string
        x-nullable: true
        x-order: 2
  TdmRefreshTaskResponseParams:
    description: Specifies the response parameters for a refresh task.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmRefreshTaskResponseParams'
    - type: object
      properties:
        oracleParams:
          x-cohesity-discriminator-value: kOracle
          x-order: 0
          $ref: '#/definitions/OracleCloneRefreshTask'
  TdmSnapshot:
    description: Specifies the response params for a TDM snapshot.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmCloneSnapshotParams'
    - type: object
      required:
      - id
      properties:
        id:
          description: Specifies the ID of the snapshot.
          type: string
          x-nullable: true
          x-order: 0
        isAutomated:
          description: Specifies whether the snapshot was taken automatically by the
            scheduler.
          type: boolean
          x-nullable: true
          x-order: 1
        createdAt:
          description: Specifies the time (in usecs from epoch) when the snapshot
            was created.
          type: integer
          format: int64
          x-nullable: true
          x-order: 2
        updatedAt:
          description: Specifies the time (in usecs from epoch) when the snapshot
            was last updated.
          type: integer
          format: int64
          x-nullable: true
          x-order: 3
        createdByUser:
          description: Specifies the details of the user, who created the snapshot.
            This will be null for snapshots, that are taken by system, such as a scheduler.
          allOf:
          - $ref: '#/definitions/User'
          x-nullable: true
          x-order: 4
        updatedByUser:
          description: Specifies the details of the user, who last updated the snapshot.
          allOf:
          - $ref: '#/definitions/User'
          x-nullable: true
          x-order: 5
  TdmSnapshotTaskParams:
    description: Specifies the parameters to create a snapshot of an existing clone.
    type: object
    allOf:
    - type: object
      required:
      - cloneId
      properties:
        cloneId:
          description: Specifies the ID of the clone.
          type: string
          x-nullable: true
          x-order: 0
    - $ref: '#/definitions/CommonTdmCloneSnapshotParams'
  TdmStatus:
    description: Possible status of a TDM resource (task/object).
    type: object
    title: TdmStatus
    properties:
      type:
        description: Specifies the status of the resource.
        type: string
        enum:
        - scheduled
        - inProgress
        - succeeded
        - failed
        - canceled
        x-order: 0
  TdmTask:
    description: Specifies a TDM task.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmTaskResponseParams'
    - type: object
      properties:
        cloneParams:
          x-cohesity-discriminator-value: clone
          x-order: 0
          $ref: '#/definitions/TdmCloneTaskResponseParams'
        refreshParams:
          x-cohesity-discriminator-value: refresh
          x-order: 1
          $ref: '#/definitions/TdmRefreshTaskResponseParams'
  TdmTasks:
    description: Specifies a collection of TDM tasks.
    type: object
    properties:
      tasks:
        description: Specifies the collection of TDM tasks, filtered by the specified
          criteria.
        type: array
        items:
          x-cohesity-discriminator-ref: CommonTdmTaskResponseParams
          $ref: '#/definitions/CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37'
        x-nullable: true
        x-order: 0
      paginationInfo:
        x-order: 1
        $ref: '#/definitions/PaginationInfo'
  TdmTeardownTaskRequestParams:
    description: Specifies the parameters to teardown a clone.
    type: object
    required:
    - cloneId
    properties:
      cloneId:
        description: Specifies the ID of the clone to teardown.
        type: string
        x-nullable: true
        x-order: 0
  TearDownStatus:
    description: Tear Down Status
    title: TearDownStatus
    properties:
      tearDownStatus:
        description: Specifies the tear down status.
        type: string
        enum:
        - DestroyScheduled
        - Destroying
        - Destroyed
        - DestroyError
        x-order: 0
  Template:
    description: Description of the view template.
    type: object
    title: Template.
    properties:
      id:
        description: Specifies an id of the view template.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
        readOnly: true
      name:
        description: Specifies the name of the view template.
        type: string
        x-nullable: true
        x-order: 1
      dedup:
        description: Specifies whether to enable dedup in storage domain.
        type: boolean
        x-nullable: true
        x-order: 2
      compress:
        description: Specifies whether to enable compression in storage domain.
        type: boolean
        x-nullable: true
        x-order: 3
      isDefault:
        description: Specifies if the tempate is custom or static.
        type: boolean
        x-nullable: true
        x-order: 4
        readOnly: true
      defaultTemplateName:
        description: Used for uniquely indentifying a default template.
        type: string
        enum:
        - Unknown
        - BackupGeneral
        - BackupCommvault
        - BackupVeeam
        - FileServiceVideos
        - FileServiceMultimedia
        - FileServiceArchive
        - ObjectServiceContainer
        x-nullable: true
        x-order: 5
        readOnly: true
      viewParams:
        description: 'Specifies the parameters which is used to create the view.

          No field is required.'
        allOf:
        - $ref: '#/definitions/CreateView'
        - x-nullable: true
        x-order: 6
  Tenant:
    description: Specifies a tenant object.
    type: object
    title: Tenant
    properties:
      id:
        description: Specifies the id of the tenant.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the tenant.
        type: string
        x-nullable: true
        x-order: 1
  TenantDmaasCert:
    description: Specifies the parameters to of a tenant certificate.
    type: object
    title: Tenant Dmaas Certificate.
    properties:
      tenantId:
        description: The id of the tenant.
        type: string
        x-nullable: true
        x-order: 0
      certificate:
        description: Specifies the tenant certificate.
        type: string
        x-nullable: true
        x-order: 1
      privateKey:
        description: Specifies the tenant private key.
        type: string
        x-nullable: true
        x-order: 2
      connectorCaChain:
        description: Specifies the CA chain that is used to sign the connector certificate.
        type: string
        x-nullable: true
        x-order: 3
      passphrase:
        description: Specifies the passphrase used to encode the private key.
        type: string
        x-nullable: true
        x-order: 4
  TenantDmaasCerts:
    description: Specifies a list of tenant certificates.
    type: object
    title: Tenant Dmaas Certificates.
    properties:
      certificates:
        description: Specifies a list of tenant certificates.
        type: array
        items:
          $ref: '#/definitions/TenantDmaasCert'
        x-nullable: true
        x-order: 0
  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
        enum:
        - AWS
        - Azure
        - Oracle
        - Google
        x-nullable: true
        x-order: 0
      awsTiering:
        description: Specifies the settings for AWS Tiers.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/AWSTiers'
      azureTiering:
        description: Specifies the settings for Azure Tiers.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/AzureTiers'
      googleTiering:
        description: Specifies the settings for Google Tiers.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/GoogleTiers'
      oracleTiering:
        description: Specifies the settings for Oracle Tiers.
        type: object
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/OracleTiers'
  TieringCloudPlatforms:
    description: Tiering Cloud Platforms.
    type: object
    title: Tiering Cloud Platforms.
    properties:
      type:
        description: Tiering Cloud Platforms.
        type: string
        enum:
        - AWS
        - Azure
        - Oracle
        - Google
        x-order: 0
  TieringInfo:
    description: Specifies the data tiering task details.
    type: object
    properties:
      progress:
        description: Specifies the progress of data tiering task.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/ProgressSummary'
      status:
        description: "Status of the analysis run.\n'Running' indicates that the run\
          \ is still running.\n'Canceled' indicates that the run has been canceled.\n\
          'Canceling' indicates that the run is in the process of being\n canceled.\n\
          'Failed' indicates that the run has failed.\n'Missed' indicates that the\
          \ run was unable to take place at the\n scheduled time because the previous\
          \ run was still happening.\n'Succeeded' indicates that the run has finished\
          \ successfully.\n'SucceededWithWarning' indicates that the run finished\n\
          \ successfully, but there were some warning messages.\n'OnHold' indicates\
          \ that the run has On hold."
        type: string
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 1
      stats:
        description: Specifies the stats of data tiering task.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/DataTieringTaskStats'
  TieringLevels:
    description: Tiering Levels
    type: object
    title: Tiering Levels.
    properties:
      type:
        description: Tiering Levels
        type: string
        enum:
        - kAmazonS3Standard
        - kAmazonS3StandardIA
        - kAmazonS3OneZoneIA
        - kAmazonS3IntelligentTiering
        - kAmazonS3Glacier
        - kAmazonS3GlacierDeepArchive
        - kAzureTierHot
        - kAzureTierCool
        - kAzureTierArchive
        - kGoogleStandard
        - kGoogleRegional
        - kGoogleMultiRegional
        - kGoogleNearline
        - kGoogleColdline
        - kOracleTierStandard
        - kOracleTierArchive
        x-order: 0
  TieringType:
    description: Data tiering task type.
    type: object
    title: Data tiering task type.
    properties:
      type:
        description: Specifies the data tiering task type.
        type: string
        enum:
        - Downtier
        - Uptier
        x-order: 0
  TimeOfDay:
    description: Specifies the time of day. Used for scheduling purposes.
    type: object
    required:
    - hour
    - minute
    properties:
      hour:
        description: Specifies the hour of the day (0-23).
        type: integer
        format: int32
        maximum: 23
        minimum: 0
        x-nullable: true
        x-order: 0
      minute:
        description: Specifies the minute of the hour (0-59).
        type: integer
        format: int32
        maximum: 59
        minimum: 0
        x-nullable: true
        x-order: 1
      timeZone:
        description: Specifies the time zone of the user. If not specified, default
          value is assumed as America/Los_Angeles.
        type: string
        default: America/Los_Angeles
        x-nullable: true
        x-order: 2
  TimeUnits:
    description: Time Units type.
    type: object
    title: Time Units type.
    properties:
      timeUnits:
        description: Specifies Time Units type.
        type: string
        enum:
        - Minutes
        - Hours
        - Days
        - Weeks
        - Months
        x-order: 0
  TrustedCa:
    description: Specifies the basic info about CA Root Certificate.
    type: object
    properties:
      id:
        description: Unique id for the certificate.
        type: string
        x-nullable: true
        x-order: 0
        readOnly: true
      name:
        description: Unique name for the certificate.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      issuedBy:
        description: Specifies the issuer.
        type: string
        x-nullable: true
        x-order: 2
        readOnly: true
      issuedTo:
        description: Specifies whom it was issued to.
        type: string
        x-nullable: true
        x-order: 3
        readOnly: true
      issuedTimeUsecs:
        description: 'Specifies the timestamp epoch in microseconds when this certificate

          will start being valid.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
        readOnly: true
      expirationTimeUsecs:
        description: 'Specifies the timestamp epoch in microseconds when this certificate

          will no longer be valid.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
        readOnly: true
      description:
        description: description of the certificate.
        type: string
        x-nullable: true
        x-order: 6
        readOnly: true
      registrationTimeUsecs:
        description: 'Specifies the timestamp epoch in microseconds when this certificate

          was registered on the cluster.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
        readOnly: true
      lastValidatedTimeUsecs:
        description: 'Specifies the timestamp epoch in microseconds when this certificate

          was last validated.'
        type: integer
        format: int64
        x-nullable: true
        x-order: 8
        readOnly: true
      status:
        description: Validation Status of the certificate.
        type: string
        enum:
        - Valid
        - Expired
        - Revoked
        - Unknown
        x-nullable: true
        x-order: 9
        readOnly: true
  TrustedCaRequest:
    description: Specifies the basic info about CA Root Certificate.
    type: object
    required:
    - name
    - certificate
    properties:
      certificate:
        description: 'Specifies the certificate to be imported. Certificate should
          be in

          PEM format.'
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Descriptive name of the certificate.
        type: string
        x-nullable: true
        x-order: 1
      description:
        description: Description of the certificate.
        type: string
        x-nullable: true
        x-order: 2
  TrustedDomain:
    description: Specifies the details of a trusted domain.
    type: object
    properties:
      domainName:
        description: Specifies a domain name.
        type: string
        x-nullable: true
        x-order: 0
      preferredDomainControllers:
        description: Specifies a list of preferred domain controllers for this domain.
        type: array
        items:
          type: object
          x-nullable: true
          $ref: '#/definitions/DomainController'
        x-order: 1
  TrustedDomainParams:
    description: Specifies the params related to trusted domains.
    type: object
    required:
    - enabled
    properties:
      enabled:
        description: Specifies if trusted domain discovery is enabled.
        type: boolean
        x-nullable: true
        x-order: 0
      trustedDomains:
        description: Specifies a list of trusted domains.
        type: array
        items:
          x-nullable: true
          $ref: '#/definitions/TrustedDomain'
        x-nullable: true
        x-order: 1
      blacklistedDomains:
        description: Specifies a list of domains to add to blacklist. These domains
          will be blacklisted in trusted domain discorvery.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 2
  UdaOSType:
    description: Enumeration of all the supported OS types for the Universal Data
      Adapter.
    type: object
    title: Enumeration of all the supported OS types for the Universal Data Adapter.
    properties:
      type:
        description: Enumeration of all the supported OS types for the Universal Data
          Adapter.
        type: string
        enum:
        - kLinux
        x-order: 0
  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
        allOf:
        - $ref: '#/definitions/RecoverUdaParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/RecoverUdaParams'
  UdaProtectionGroupObjectParams:
    description: Specifies the Universal Data Adapter object details.
    type: object
    required:
    - name
    properties:
      name:
        description: Specifies the fully qualified name of the object.
        type: string
        x-order: 0
  UdaProtectionGroupParams:
    description: Specifies parameters related to the Universal Data Adapter Protection
      job.
    type: object
    required:
    - sourceId
    - objects
    properties:
      sourceId:
        description: Specifies the source Id of the objects to be protected.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      objects:
        description: Specifies a list of fully qualified names of the objects to be
          protected.
        type: array
        items:
          $ref: '#/definitions/UdaProtectionGroupObjectParams'
        x-order: 1
      fullBackupArgs:
        description: Specifies the custom arguments to be supplied to the full backup
          script when a full backup is enabled in the policy.
        type: string
        x-nullable: true
        x-order: 2
      incrBackupArgs:
        description: Specifies the custom arguments to be supplied to the incremental
          backup script when an incremental backup is enabled in the policy.
        type: string
        x-nullable: true
        x-order: 3
      logBackupArgs:
        description: Specifies the custom arguments to be supplied to the log backup
          script when a log backup is enabled in the policy.
        type: string
        x-nullable: true
        x-order: 4
      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
        format: int32
        default: 1
        x-nullable: true
        x-order: 5
      mounts:
        description: Specifies the maximum number of view mounts per host. If not
          specified, the default value is taken as 1.
        type: integer
        format: int32
        default: 1
        x-nullable: true
        x-order: 6
  UdaSourceRegistrationParams:
    description: Specifies parameters to register a Universal Data Adapter source.
    type: object
    title: Register Universal Data Adapter source registration request parameters.
    required:
    - sourceType
    - osType
    - hosts
    - scriptDir
    properties:
      sourceType:
        description: Specifies the source type for Universal Data Adapter source.
        type: string
        enum:
        - kSapHana
        - kSapOracle
        - kCockroachDB
        - kOther
        x-order: 0
      osType:
        description: Specifies the operating system type of the object. Currently
          only Linux is supported.
        type: string
        enum:
        - kLinux
        x-order: 1
      hosts:
        description: Specifies the IPs/hostnames for the nodes forming the Universal
          Data Adapter source cluster.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: string
        x-order: 2
      credentials:
        description: 'Specifies credentials to access the Universal Data Adapter source.
          For e.g.: To perform backup and recovery tasks with Oracle Recovery Manager
          (RMAN), specify credentials for a user having ''SYSDBA'' or ''SYSBACKUP''
          administrative privilege.'
        type: object
        properties:
          password:
            description: Specifies the password to access target entity.
            type: string
            x-nullable: true
            x-order: 0
          username:
            description: Specifies the username to access target entity.
            type: string
            x-nullable: true
            x-order: 1
        x-order: 3
      scriptDir:
        description: Specifies the absolute path of scripts used to interact with
          the Universal Data Adapter source.
        type: string
        x-order: 4
      mountView:
        description: Specifies if SMB/NFS view mounting should be enabled. If set
          to true, configuration for the mounted view can be optionally specified
          inside the viewParams. Default value is false.
        type: boolean
        x-nullable: true
        x-order: 5
      viewParams:
        description: Specifies optional configuration parameters for the mounted view.
        type: object
        properties:
          mountDir:
            description: Specifes the absolute path on the host where the view will
              be mounted.
            type: string
            x-nullable: true
            x-order: 0
        x-nullable: true
        x-order: 6
      sourceRegistrationArgs:
        description: Specifies custom arguments to be supplied to the source registration
          scripts.
        type: string
        x-nullable: true
        x-order: 7
  UdaSourceType:
    description: Enumeration of all the supported source types for the Universal Data
      Adapter.
    type: object
    title: Enumeration of all the supported source types for the Universal Data Adapter.
    properties:
      type:
        description: Enumeration of all the supported source types for the Universal
          Data Adapter.
        type: string
        enum:
        - kSapHana
        - kSapOracle
        - kCockroachDB
        - kOther
        x-order: 0
  UnplannedFailoverParams:
    description: Specifies parameters of an unplanned failover.
    type: object
    properties:
      reverseReplication:
        description: Specifies whether a reverse replication needs to be set for the
          view on target cluster after failover.
        type: boolean
        x-nullable: true
        x-order: 0
  UnprotectActionObjectLevelParams:
    description: Specifies the request parameters for Unprotect action on a Protected
      object.
    type: object
    allOf:
    - $ref: '#/definitions/ProtectionObjectInput'
    - type: object
      properties:
        deleteAllSnapshots:
          description: Specifies whether to delete all snapshots along with unprotecting
            object protection. If set to true, all snapshots will be deleted and no
            more recoverable.
          type: boolean
          x-nullable: true
          x-order: 0
        forceUnprotect:
          description: If specified as true then it will cancel the ongoing runs and
            immediatly unprotect.
          type: boolean
          x-nullable: true
          x-order: 1
  UnprotectActionObjectLevelResponse:
    description: Specifies the infomration about status of Unprotect action.
    type: object
    properties:
      error:
        description: If the action fails for this object, then error will be return
          here.
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/Error'
  UnregisterKerberosProvider:
    description: Response of Unregister Kerberos Provider.
    type: object
    properties:
      message:
        description: A status message returned upon unregistering.
        type: string
        x-order: 0
  UnregisterKerberosRequest:
    description: Specifies the request to unregister a Kerberos Provider.
    type: object
    required:
    - adminPassword
    properties:
      adminPassword:
        description: Specifies the password
        type: string
        x-nullable: true
        x-order: 0
  UnregisterSwiftParams:
    description: Specifies the parameters to unregister a Swift service from Keystone
      server.
    type: object
    required:
    - tenantId
    properties:
      tenantId:
        description: Specifies the tenant Id who's Swift service will be unregistered.
        type: string
        x-nullable: true
        x-order: 0
      keystoneCredentials:
        description: Specifies the credentials of the Keystone server. Keystone configuration
          associated to the tenant will be used if this field is not specified.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/KeystoneCredentials'
  UpTieringFileSelectionType:
    description: Data up-tiering file selection type.
    type: object
    title: Data up-tiering file selection type.
    properties:
      type:
        description: Specifies the data up-tiering file selection type.
        type: string
        enum:
        - LastAccessed
        - LastModified
        x-order: 0
  UpdateActiveDirectoryRequest:
    description: Specifies the request to create an Active Directory.
    type: object
    allOf:
    - $ref: '#/definitions/CommonActiveDirectoryParams'
    - type: object
      required:
      - workGroupName
      properties:
        activeDirectoryAdminParams:
          description: Specifies the params of a user with administrative privilege
            of this Active Directory. This field is mandatory if machine accounts
            are updated.
          type: object
          allOf:
          - $ref: '#/definitions/ActiveDirectoryAdminParams'
          - x-nullable: true
          x-nullable: true
          x-order: 0
        overwriteMachineAccounts:
          description: Specifies if specified machine accounts should overwrite existing
            machine accounts.
          type: boolean
          x-nullable: true
          x-order: 1
        idMappingParams:
          description: Specifies the params of the user id mapping info of an Active
            Directory.
          type: object
          allOf:
          - $ref: '#/definitions/IdMappingParams'
          - x-nullable: true
          x-nullable: true
          x-order: 2
        transitiveAdTrustLevelLimit:
          description: Specifies level of transitive Active Directory trust domains
            to be used.
          type: integer
          format: int32
          x-nullable: true
          x-order: 3
  UpdateArchivalSnapshotConfig:
    description: Specifies the params to perform actions on archival snapshots taken
      by a Protection Group Run.
    type: object
    title: Archival Snapshot Config.
    properties:
      newSnapshotConfig:
        description: Specifies the new configuration about adding Archival Snapshot
          to existing Protection Group Run.
        type: array
        items:
          $ref: '#/definitions/RunArchivalConfig'
        x-nullable: true
        x-order: 0
      updateExistingSnapshotConfig:
        description: Specifies the configuration about updating an existing Archival
          Snapshot Run.
        type: array
        items:
          $ref: '#/definitions/UpdateExistingArchivalSnapshotConfig'
        x-nullable: true
        x-order: 1
  UpdateCertificateByCsrRequest:
    description: Specifies the request to update a certificate.
    type: object
    required:
    - certificate
    - csrId
    properties:
      certificate:
        description: Specifies the certificate to be imported.
        type: string
        x-nullable: true
        x-order: 0
      csrId:
        description: Specifies the id of the csr corresponding to the certificate.
        type: string
        x-nullable: true
        x-order: 1
  UpdateCertificateByCsrResponseBody:
    description: Specifies the response to update a certificate.
    type: object
    title: Update Certificate Response
    properties:
      certificate:
        description: Specifies the certificate.
        type: string
        x-nullable: true
        x-order: 0
  UpdateDataTieringState:
    type: object
    title: 'Specifies the summary of the state updation for the multiple data

      tiering groups.'
    properties:
      failedIds:
        description: 'Specifies a list of data tiering groups ids for which

          updation of state failed.'
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      successfulIds:
        description: 'Specifies a list of data tiering groups ids for which updation
          of

          state was successful.'
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 1
  UpdateDataTieringStateRequest:
    description: 'Specifies the parameters to perform an action on the data tiering

      groups for the specified Sources.'
    type: object
    title: Update state of the data tiering groups.
    required:
    - action
    - ids
    properties:
      action:
        description: 'Specifies the action to be performed on all the specified data

          tiering groups.

          ''Pause''  specifies to pause.

          ''Resume'' specifies to resume.'
        type: string
        enum:
        - Pause
        - Resume
        x-nullable: true
        x-order: 0
      ids:
        description: 'Specifies a list of data tiering groups ids for

          which the state should change.'
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: string
        x-nullable: true
        x-order: 1
  UpdateExistingArchivalSnapshotConfig:
    description: Specifies the configuration about updating an existing Archival Snapshot
      Run.
    type: object
    title: Update Archival Snapshot Config.
    required:
    - id
    - archivalTargetType
    properties:
      id:
        description: Specifies the id of the archival target.
        type: integer
        format: int64
        x-order: 0
      archivalTargetType:
        description: Specifies the snapshot's archival target type from which recovery
          has been performed.
        type: string
        enum:
        - Tape
        - Cloud
        - Nas
        x-nullable: true
        x-order: 1
      enableLegalHold:
        description: Specifies whether to retain the snapshot for legal purpose. If
          set to true, the snapshots cannot be deleted until the retention period.
          Note that using this option may cause the Cluster to run out of space. If
          set to false explicitly, the hold is removed, and the snapshots will expire
          as specified in the policy of the Protection Group. If this field is not
          specified, there is no change to the hold of the run. This field can be
          set only by a User having Data Security Role.
        type: boolean
        x-nullable: true
        x-order: 2
      deleteSnapshot:
        description: Specifies whether to delete the snapshot. When this is set to
          true, all other params will be ignored.
        type: boolean
        x-nullable: true
        x-order: 3
      resync:
        description: Specifies whether to retry the archival operation in case if
          earlier attempt failed. If not specified or set to false, archival is not
          retried.
        type: boolean
        x-nullable: true
        x-order: 4
      dataLock:
        description: "Specifies WORM retention type for the snapshots. When a WORM\
          \ retention type is specified, the snapshots of the Protection Groups using\
          \ this policy will be kept until the maximum of the snapshot retention time.\
          \ During that time, the snapshots cannot be deleted. \n'Compliance' implies\
          \ WORM retention is set for compliance reason. \n'Administrative' implies\
          \ WORM retention is set for administrative purposes."
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 5
      daysToKeep:
        description: Specifies number of days to retain the snapshots. If positive,
          then this value is added to exisiting expiry time thereby increasing  the
          retention period of the snapshot. Conversly, if this value is negative,
          then value is subtracted to existing expiry time thereby decreasing the
          retention period of the snaphot. Here, by this operation if expiry time
          goes below current time then snapshot is immediately deleted.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
  UpdateExistingReplicationSnapshotConfig:
    description: Specifies the configuration about updating an existing Replication
      Snapshot Run.
    type: object
    title: Update Replication Snapshot Config.
    required:
    - id
    properties:
      id:
        description: Specifies the cluster id of the replication cluster.
        type: integer
        format: int64
        x-order: 0
      enableLegalHold:
        description: Specifies whether to retain the snapshot for legal purpose. If
          set to true, the snapshots cannot be deleted until the retention period.
          Note that using this option may cause the Cluster to run out of space. If
          set to false explicitly, the hold is removed, and the snapshots will expire
          as specified in the policy of the Protection Group. If this field is not
          specified, there is no change to the hold of the run. This field can be
          set only by a User having Data Security Role.
        type: boolean
        x-nullable: true
        x-order: 1
      deleteSnapshot:
        description: Specifies whether to delete the snapshot. When this is set to
          true, all other params will be ignored.
        type: boolean
        x-nullable: true
        x-order: 2
      resync:
        description: Specifies whether to retry the replication operation in case
          if earlier attempt failed. If not specified or set to false, replication
          is not retried.
        type: boolean
        x-nullable: true
        x-order: 3
      dataLock:
        description: "Specifies WORM retention type for the snapshots. When a WORM\
          \ retention type is specified, the snapshots of the Protection Groups using\
          \ this policy will be kept until the maximum of the snapshot retention time.\
          \ During that time, the snapshots cannot be deleted. \n'Compliance' implies\
          \ WORM retention is set for compliance reason. \n'Administrative' implies\
          \ WORM retention is set for administrative purposes."
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 4
      daysToKeep:
        description: Specifies number of days to retain the snapshots. If positive,
          then this value is added to exisiting expiry time thereby increasing  the
          retention period of the snapshot. Conversly, if this value is negative,
          then value is subtracted to existing expiry time thereby decreasing the
          retention period of the snaphot. Here, by this operation if expiry time
          goes below current time then snapshot is immediately deleted.
        type: integer
        format: int64
        x-nullable: true
        x-order: 5
  UpdateFleetEnvInfoRequest:
    description: Specifies the params to add fleet env info.
    type: object
    title: Update Fleet Env Info Request.
    required:
    - iamRole
    - region
    - vpcId
    - subnetId
    - securityGroupId
    properties:
      iamRole:
        description: Specifies the IAM role used to create instances.
        type: string
        x-nullable: true
        x-order: 0
      region:
        description: Specifies the Region of the CE cluster.
        type: string
        x-nullable: true
        x-order: 1
      vpcId:
        description: Specifies the VPC of the CE cluster.
        type: string
        x-nullable: true
        x-order: 2
      subnetId:
        description: Specifies the Subnet of the CE cluster.
        type: string
        x-nullable: true
        x-order: 3
      securityGroupId:
        description: Specifies the security group Id.
        type: string
        x-nullable: true
        x-order: 4
  UpdateKeystoneRequest:
    description: Specifies the parameters to update a Keystone configuration.
    type: object
    allOf:
    - $ref: '#/definitions/Keystone'
  UpdateLocalSnapshotConfig:
    description: Specifies the params to perform actions on local snapshot taken by
      a Protection Group Run.
    type: object
    title: Local Snapshot Config.
    properties:
      enableLegalHold:
        description: Specifies whether to retain the snapshot for legal purpose. If
          set to true, the snapshots cannot be deleted until the retention period.
          Note that using this option may cause the Cluster to run out of space. If
          set to false explicitly, the hold is removed, and the snapshots will expire
          as specified in the policy of the Protection Group. If this field is not
          specified, there is no change to the hold of the run. This field can be
          set only by a User having Data Security Role.
        type: boolean
        x-nullable: true
        x-order: 0
      deleteSnapshot:
        description: Specifies whether to delete the snapshot. When this is set to
          true, all other params will be ignored.
        type: boolean
        x-nullable: true
        x-order: 1
      dataLock:
        description: "Specifies WORM retention type for the snapshots. When a WORM\
          \ retention type is specified, the snapshots of the Protection Groups using\
          \ this policy will be kept until the maximum of the snapshot retention time.\
          \ During that time, the snapshots cannot be deleted. \n'Compliance' implies\
          \ WORM retention is set for compliance reason. \n'Administrative' implies\
          \ WORM retention is set for administrative purposes."
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 2
      daysToKeep:
        description: Specifies number of days to retain the snapshots. If positive,
          then this value is added to exisiting expiry time thereby increasing  the
          retention period of the snapshot. Conversly, if this value is negative,
          then value is subtracted to existing expiry time thereby decreasing the
          retention period of the snaphot. Here, by this operation if expiry time
          goes below current time then snapshot is immediately deleted.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  UpdateObjectSnapshotRequest:
    description: Specifies the parameters to update an object snapshot.
    type: object
    title: Update Object Snapshot Request.
    properties:
      setLegalHold:
        description: Whether to set the snapshot on legal hold. If set to true, the
          run cannot be deleted during the retention period.
        type: boolean
        x-nullable: true
        x-order: 0
      dataLockType:
        description: Specifies the snapshot data lock type.
        type: string
        enum:
        - Compliance
        - Administrative
        x-nullable: true
        x-order: 1
      expiryTimeSecs:
        description: Specifies the expiry time of the snapshot in Unix timestamp epoch
          in seconds.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
  UpdateProtectedObjectsRequest:
    description: Specifies the request to update an object backup configuration.
    type: object
    allOf:
    - $ref: '#/definitions/CommonObjectProtectParams'
    - $ref: '#/definitions/EnvSpecificObjectProtectionUpdateRequestParams'
  UpdateProtectionGroupRunParams:
    description: Specifies the params to update a Protection Group Run.
    type: object
    title: Update Protection Group Run Request Params.
    required:
    - runId
    properties:
      runId:
        description: Specifies a unique Protection Group Run id.
        type: string
        pattern: ^\d+:\d+$
        x-nullable: true
        x-order: 0
      localSnapshotConfig:
        description: Specifies the params to perform actions on local snapshot taken
          by this Protection Group Run.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/UpdateLocalSnapshotConfig'
      replicationSnapshotConfig:
        description: Specifies the params to perform actions on replication snapshots
          taken by this Protection Group Run. A user can configure new replication
          targets here.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/UpdateReplicationSnapshotConfig'
      archivalSnapshotConfig:
        description: Specifies the params to perform actions on archival snapshots
          taken by this Protection Group Run. A user can configure new archival targets
          here.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/UpdateArchivalSnapshotConfig'
  UpdateProtectionGroupRunRequestBody:
    description: Specifies the params to update a list of Protection Group Runs.
    type: object
    title: Update Protection Group Run Request Body.
    required:
    - updateProtectionGroupRunParams
    properties:
      updateProtectionGroupRunParams:
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/UpdateProtectionGroupRunParams'
        x-nullable: true
        x-order: 0
  UpdateProtectionGroupRunResponseBody:
    description: Specifies the response of update Protection Group Runs request.
    type: object
    title: Update Protection Group Run Response Body.
    properties:
      successfulRunIds:
        description: Specifies a list of ids of Protection Group Runs that are successfully
          updated.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      failedRuns:
        description: Specifies a list of ids of Protection Group Runs that failed
          to update along with error details.
        type: array
        items:
          $ref: '#/definitions/FailedRunDetails'
        x-nullable: true
        x-order: 1
  UpdateProtectionGroupsState:
    type: object
    title: Specifies the response of updation of state of multiple Protection Groups.
    properties:
      failedProtectionGroups:
        description: Specifies a list of Protection Group ids along with details for
          which updation of state was failed.
        type: array
        items:
          $ref: '#/definitions/FailedProtectionGroupDetails'
        x-nullable: true
        x-order: 0
      successfulProtectionGroupIds:
        description: Specifies a list of Protection Group ids for which updation of
          state was successful.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 1
  UpdateProtectionGroupsStateRequest:
    description: Specifies the parameters to perform an action of list of Protection
      Groups.
    type: object
    title: Update state of Protection Groups.
    required:
    - action
    - ids
    properties:
      action:
        description: Specifies the action to be performed on all the specfied Protection
          Groups. 'kActivate' specifies that Protection Group should be activated.
          'kDeactivate' sepcifies that Protection Group should be deactivated. 'kPause'
          specifies that Protection Group should be paused. 'kResume' specifies that
          Protection Group should be resumed.
        type: string
        enum:
        - kPause
        - kResume
        x-nullable: true
        x-order: 0
      ids:
        description: Specifies a list of Protection Group ids for which the state
          should change.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          type: string
        x-nullable: true
        x-order: 1
  UpdateReplicationSnapshotConfig:
    description: Specifies the params to perform actions on replication snapshots
      taken by a Protection Group Run.
    type: object
    title: Replication Snapshot Config.
    properties:
      newSnapshotConfig:
        description: Specifies the new configuration about adding Replication Snapshot
          to existing Protection Group Run.
        type: array
        items:
          $ref: '#/definitions/RunReplicationConfig'
        x-nullable: true
        x-order: 0
      updateExistingSnapshotConfig:
        description: Specifies the configuration about updating an existing Replication
          Snapshot Run.
        type: array
        items:
          $ref: '#/definitions/UpdateExistingReplicationSnapshotConfig'
        x-nullable: true
        x-order: 1
  UpdateRigelConnectionRequest:
    description: Specify the params to update a connection of Rigel.
    type: object
    title: Update Rigel Connection Request.
    allOf:
    - $ref: '#/definitions/CommonCreateOrUpdateRigelConnectionRequest'
  UpdateRigelConnectorRequest:
    description: Specify the params to update a Rigel connector.
    type: object
    title: Update Rigel connector Request.
    allOf:
    - $ref: '#/definitions/CommonCreateOrUpdateRigelConnectorRequest'
  UpdateSecurityConfigRequest:
    description: Specifies the request params for updating the security config.
    title: Update Security Config Request
    allOf:
    - $ref: '#/definitions/SecurityConfig'
  UpdateTdmSnapshotRequest:
    description: Specifies the request parameters to update a TDM snapshot.
    type: object
    allOf:
    - $ref: '#/definitions/CommonTdmCloneSnapshotParams'
  UpdateViewParam:
    description: 'Specifies the settings that define a View. Common fields between
      create,

      edit and response struct.'
    type: object
    allOf:
    - type: object
      properties:
        name:
          description: Specifies the name of the View.
          type: string
          x-nullable: true
          x-order: 0
        category:
          description: Specifies the category of the View.
          type: string
          enum:
          - BackupTarget
          - FileServices
          - ObjectServices
          x-nullable: true
          x-order: 1
        protocolAccess:
          description: Specifies the supported Protocols for the View.
          type: array
          items:
            $ref: '#/definitions/ViewProtocol'
          x-nullable: true
          x-order: 2
        qos:
          description: Specifies the Quality of Service (QoS) Policy for the View.
          allOf:
          - $ref: '#/definitions/QoS'
          - x-nullable: true
          x-order: 3
        overrideGlobalSubnetWhitelist:
          description: 'Specifies whether view level client subnet whitelist overrides
            cluster and

            global setting.'
          type: boolean
          x-nullable: true
          x-order: 4
        subnetWhitelist:
          description: 'Array of Subnets.

            Specifies a list of Subnets with IP addresses that have permissions to

            access the View. (Overrides or extends the Subnets specified at the global

            Cohesity Cluster level.)'
          type: array
          items:
            $ref: '#/definitions/Subnet'
          x-nullable: true
          x-order: 5
        overrideGlobalNetgroupWhitelist:
          description: 'Specifies whether view level client netgroup whitelist overrides
            cluster and

            global setting.'
          type: boolean
          x-nullable: true
          x-order: 6
        netgroupWhitelist:
          description: 'Array of Netgroups.

            Specifies a list of netgroups with domains that have permissions to

            access the View. (Overrides or extends the Netgroup specified at the global

            Cohesity Cluster level.)'
          allOf:
          - $ref: '#/definitions/NisNetgroups'
          - x-nullable: true
          x-order: 7
        securityMode:
          description: 'Specifies the security mode used for this view.

            Currently we support the following modes: Native, Unified and NTFS style.

            ''NativeMode'' indicates a native security mode.

            ''UnifiedMode'' indicates a unified security mode.

            ''NtfsMode'' indicates a NTFS style security mode.'
          type: string
          enum:
          - NativeMode
          - UnifiedMode
          - NtfsMode
          x-nullable: true
          x-order: 8
        storagePolicyOverride:
          description: 'Specifies if inline deduplication and compression settings
            inherited from

            the Storage Domain (View Box) should be disabled for this View.'
          allOf:
          - $ref: '#/definitions/StoragePolicyOverride'
          - x-nullable: true
          x-order: 9
        logicalQuota:
          description: 'Specifies an optional logical quota limit (in bytes) for the
            usage allowed

            on this View.

            (Logical data is when the data is fully hydrated and expanded.)

            This limit overrides the limit inherited from the Storage Domain

            (View Box) (if set).

            If logicalQuota is nil, the limit is inherited from the

            Storage Domain (View Box) (if set).

            A new write is not allowed if the Storage Domain (View Box) will exceed
            the

            specified quota.

            However, it takes time for the Cohesity Cluster to calculate

            the usage across Nodes, so the limit may be exceeded by a small amount.

            In addition, if the limit is increased or data is removed,

            there may be a delay before the Cohesity Cluster allows more data

            to be written to the View, as the Cluster is calculating the usage

            across Nodes.'
          allOf:
          - $ref: '#/definitions/QuotaPolicy'
          - x-nullable: true
          x-order: 10
        fileLockConfig:
          description: 'Optional config that enables file locking for this view. It
            cannot be

            disabled during the edit of a view, if it has been enabled during the

            creation of the view. Also, it cannot be enabled if it was disabled

            during the creation of the view.'
          allOf:
          - $ref: '#/definitions/FileLevelDataLockConfig'
          - x-nullable: true
          x-order: 11
        fileExtensionFilter:
          description: 'Optional filtering criteria that should be satisfied by all
            the files

            created in this view. It does not affect existing files.'
          allOf:
          - $ref: '#/definitions/FileExtensionFilter'
          - x-nullable: true
          x-order: 12
        antivirusScanConfig:
          description: Specifies the antivirus scan config settings for this View.
          allOf:
          - $ref: '#/definitions/AntivirusScanConfig'
          - x-nullable: true
          x-order: 13
        description:
          description: Specifies an optional text description about the View.
          type: string
          x-nullable: true
          x-order: 14
        allowMountOnWindows:
          description: 'Specifies if this View can be mounted using the NFS protocol

            on Windows systems. If true, this View can be NFS mounted on Windows

            systems.'
          type: boolean
          x-nullable: true
          x-order: 15
        enableMinion:
          description: 'Specifies if this view should allow minion or not. If true,
            this will

            allow minion.'
          type: boolean
          x-nullable: true
          x-order: 16
        enableFilerAuditLogging:
          description: Specifies if Filer Audit Logging is enabled for this view.
          type: boolean
          x-nullable: true
          x-order: 17
        tenantId:
          description: Optional tenant id who has access to this View.
          type: string
          x-nullable: true
          x-order: 18
        enableLiveIndexing:
          description: Specifies whether to enable live indexing for the view.
          type: boolean
          x-nullable: true
          x-order: 19
        enableOfflineCaching:
          description: Specifies whether to enable offline file caching of the view.
          type: boolean
          x-nullable: true
          x-order: 20
        accessSids:
          description: 'Array of Security Identifiers (SIDs)

            Specifies the list of security identifiers (SIDs) for the restricted

            Principals who have access to this View.'
          type: array
          items:
            type: string
          x-nullable: true
          x-order: 21
        viewLockEnabled:
          description: 'Specifies whether view lock is enabled. If enabled the view
            cannot be

            modified or deleted until unlock. By default it is disabled.'
          type: boolean
          x-nullable: true
          x-order: 22
        isReadOnly:
          description: Specifies if the view is a read only view. User will no longer
            be able to write to this view if this is set to true.
          type: boolean
          x-nullable: true
          x-order: 23
        viewPinningConfig:
          description: Specifies the pinning config of this view.
          allOf:
          - $ref: '#/definitions/ViewPinningConfig'
          - x-nullable: true
          x-order: 24
        selfServiceSnapshotConfig:
          description: Specifies self service config of this view.
          type: object
          allOf:
          - $ref: '#/definitions/SelfServiceSnapshotConfig'
          - x-nullable: true
          x-order: 25
    - $ref: '#/definitions/NfsConfig'
    - $ref: '#/definitions/SmbConfig'
    - $ref: '#/definitions/S3Config'
    - $ref: '#/definitions/SwiftConfig'
  UptieringFileAgePolicy:
    description: 'Specifies the file''s selection rule by file age for up tiering
      data

      tiering task eg.

      1. select files last accessed 2 weeks ago.

      2. select files last modified 1 month ago.'
    type: object
    properties:
      condition:
        description: Specifies the condition for the file age.
        type: string
        enum:
        - LastAccessed
        - LastModified
        x-nullable: true
        x-order: 0
      ageMsecs:
        description: Specifies the number of msecs used for file selection.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      numFileAccess:
        description: Specifies number of file access in last ageMsecs.
        type: integer
        format: uint32
        x-nullable: true
        x-order: 2
  UptieringPolicy:
    description: Specifies the data uptiering policy.
    type: object
    allOf:
    - type: object
      properties:
        fileAge:
          x-order: 0
          $ref: '#/definitions/UptieringFileAgePolicy'
        includeAllFiles:
          description: 'If set, all files in the view will be uptiered regardless
            of

            file_select_policy, num_file_access, hot_file_window, file_size

            constraints.'
          type: boolean
          default: false
          x-nullable: true
          x-order: 1
    - $ref: '#/definitions/CommonTieringPolicy'
  User:
    description: Specifies a user object.
    type: object
    title: User
    properties:
      name:
        description: Specifies the name of the user.
        type: string
        x-nullable: true
        x-order: 0
      sid:
        description: Specifies the sid of the user.
        type: string
        x-nullable: true
        x-order: 1
      domain:
        description: Specifies the domain of the user.
        type: string
        x-nullable: true
        x-order: 2
  UserDbBackupPreference:
    description: Specifies User Database Backup Preference Type.
    type: object
    title: User Database Backup Preference Type.
    properties:
      userDbBackupPreference:
        description: Specifies User Database Backup Preference Type.
        type: string
        enum:
        - kBackupAllDatabases
        - kBackupAllExceptAAGDatabases
        - kBackupOnlyAAGDatabases
        x-order: 0
  UserIdMappingParams:
    description: Specifies how the Unix and Windows users are mapped in an Active
      Directory.
    type: object
    required:
    - type
    properties:
      type:
        description: Specifies the type of the mapping.
        type: string
        enum:
        - Rfc2307
        - Sfu30
        - Centrify
        - CustomAttributes
        - LdapProvider
        - NisProvider
        - Rid
        - Fixed
        x-order: 0
      rfc2307TypeParams:
        description: Specifies the params for Rfc2307 mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdRfc2307TypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      sfu30TypeParams:
        description: Specifies the params for Sfu30 mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdSfu30TypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      ldapProviderTypeParams:
        description: Specifies the params for LdapProvider mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdLdapProviderTypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 3
      nisProviderTypeParams:
        description: Specifies the params for NisProvider mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdNisProviderTypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 4
      centrifyTypeParams:
        description: Specifies the params for Centrify mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdCentrifyTypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 5
      fixedTypeParams:
        description: Specifies the params for Fixed mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdFixedTypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 6
      customAttributesTypeParams:
        description: Specifies the params for CustomAttributes mapping type mapping.
        type: object
        allOf:
        - $ref: '#/definitions/AdCustomAttributesTypeParams'
        - x-nullable: true
        x-nullable: true
        x-order: 7
  UserSession:
    description: User session response
    type: object
    properties:
      sessionId:
        description: Specifies the session id
        type: string
        x-order: 0
  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
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/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
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 3
  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
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  VcdAdditionalParams:
    description: Additional params for VCD protection source.
    type: object
    title: VCD Additional Params.
    properties:
      vcenterInfoList:
        description: Specifies the list of vCenters associated with this VCD protection
          source.
        type: array
        items:
          $ref: '#/definitions/VcdVcenterInfo'
        x-order: 0
  VcdConnectionParams:
    description: Specifies the parameters to connect to a seed node and fetch information
      from its config file.
    title: Parameters to connect and query VMware config file.
    allOf:
    - type: object
      required:
      - host
      properties:
        host:
          description: IP or hostname of the source.
          type: string
          x-nullable: true
          x-order: 0
    - $ref: '#/definitions/Credentials'
  VcdRegistrationParams:
    description: Specifies parameters to register VMware vCloud director.
    title: Register VMware vCloud director request parameters.
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationParams'
    - type: object
      required:
      - vcenterCredentialInfoList
      properties:
        vcenterCredentialInfoList:
          description: Specifies the credentials information for all the vcenters
            in vcloud director.
          type: array
          minItems: 1
          items:
            $ref: '#/definitions/VcenterCredentialInfo'
          x-nullable: true
          x-order: 0
  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
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the storage profile.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  VcdVcenterInfo:
    description: Specifies information about a vCetner.
    type: object
    title: VCD vCenter Info
    properties:
      name:
        description: Specifies the name of the vCenter.
        type: string
        x-nullable: true
        x-order: 0
      endpoint:
        description: Specifies the endpoint of the vCenter.
        type: string
        x-nullable: true
        x-order: 1
  VcenterCredentialInfo:
    description: Specifies the credential information for a specific vcenter.
    type: object
    title: VMware vCenter Credential Info
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationParams'
    - type: object
      properties:
        name:
          description: Specifies the name of the vCenter.
          type: string
          x-nullable: true
          x-order: 0
  VcenterRegistrationParams:
    description: Specifies parameters to register VMware vCenter.
    title: Register VMware vCenter request parameters.
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationParams'
    - type: object
      properties:
        caCert:
          description: Specifies the CA certificate to enable SSL communication between
            host and cluster.
          type: string
          x-nullable: true
          x-order: 0
        useVmBiosUuid:
          description: Specifies to use VM BIOS UUID to track virtual machines in
            the host.
          type: boolean
          x-nullable: true
          x-order: 1
        minFreeDatastoreSpaceForBackupGb:
          description: Specifies the minimum free space (in GB) expected to be available
            in the datastore where the virtual disks of the VM being backed up reside.
            If the space available is lower than the specified value, backup will
            be aborted.
          type: integer
          format: int64
          x-nullable: true
          x-order: 2
        throttlingParams:
          description: Specifies the throttling params.
          type: object
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/VmwareThrottlingParams'
        dataStoreParams:
          description: Specifies datastore specific parameters.
          type: array
          items:
            $ref: '#/definitions/DatastoreParams'
          x-nullable: true
          x-order: 4
  VdcCatalog:
    description: Specifies a VDC Catalog.
    type: object
    title: VDC Catalog
    required:
    - uuid
    properties:
      uuid:
        description: Specifies the UUID of the catalog.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the catalog.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  VdcCatalogs:
    description: Specifies a list of VDC Catalogs.
    type: object
    title: VDC Catalogs
    properties:
      catalogs:
        description: Specifies a list of VDC Catalogs.
        type: array
        items:
          $ref: '#/definitions/VdcCatalog'
        x-order: 0
  VdcObject:
    description: Specifies the details about VMware Virtual datacenter.
    type: object
    properties:
      catalogs:
        description: Specifies a list of VDC Catalogs.
        type: array
        items:
          $ref: '#/definitions/VdcCatalog'
        x-order: 0
      orgNetworks:
        description: Specifies a list of Organization VDC Networks.
        type: array
        items:
          $ref: '#/definitions/OrgVDCNetwork'
        x-order: 1
  View:
    description: 'Specifies settings for defining a storage location (called a View)

      with NFS and SMB mount paths in a Storage Domain (View Box) on the Cohesity

      Cluster.'
    type: object
    title: View.
    allOf:
    - type: object
      required:
      - protocolAccess
      - qos
      properties:
        viewId:
          description: Specifies an id of the View assigned by the Cohesity Cluster.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
          readOnly: true
        isCategoryInferred:
          description: "If True, category in response is not set by user but inferred\
            \ by\nIris because none is set. Category can only be none when view was\n\
            created by v1 API or cloned from a view created by v1 API.\n\nInference\
            \ Logic is as follows:\n1. Object Services if only S3 or Swift protocol\
            \ is selected.\n2. Backup Target only if one read-write protocol is selected\
            \ and\n   QoS is \"Backup Target Commvault\" or \"Backup Target SSD\"\
            .\n3. File Services if there are more than 1 read-write protocol or\n\
            \   it doesn't fit any other category."
          type: boolean
          x-nullable: true
          x-order: 1
          readOnly: true
        dataLockExpiryUsecs:
          description: 'DataLock (Write Once Read Many) lock expiry epoch time in
            microseconds. If

            a view is marked as a DataLock view, only a Data Security Officer (a user

            having Data Security Privilege) can delete the view until the lock expiry

            time.'
          type: integer
          format: int64
          x-nullable: true
          x-order: 2
        objectServicesMappingConfig:
          description: 'Specifies the Object Services key mapping config of the view.
            This parameter can only

            be set during create and cannot be changed.

            Configuration of Object Services key mapping.

            Specifies the type of Object Services key mapping config.'
          type: string
          enum:
          - Random
          - Short
          - Long
          - Hierarchical
          x-nullable: true
          x-order: 3
          readOnly: true
        storageDomainId:
          description: 'Specifies the id of the Storage Domain (View Box) where the
            View is

            stored.'
          type: integer
          format: int64
          x-nullable: true
          x-order: 4
          readOnly: true
        storageDomainName:
          description: 'Specifies the name of the Storage Domain (View Box) where
            the View is

            stored.'
          type: string
          x-nullable: true
          x-order: 5
          readOnly: true
        caseInsensitiveNamesEnabled:
          description: 'Specifies whether to support case insensitive file/folder
            names. This

            parameter can only be set during create and cannot be changed.'
          type: boolean
          x-nullable: true
          x-order: 6
          readOnly: true
        createTimeMsecs:
          description: Specifies the time that the View was created in milliseconds.
          type: integer
          format: int64
          x-nullable: true
          x-order: 7
          readOnly: true
        basicMountPath:
          description: 'Specifies the NFS mount path of the View (without the hostname

            information).

            This path is used to support NFS mounting of the paths specified in the

            nfsExportPathList on Windows systems.'
          type: string
          x-nullable: true
          x-order: 8
          readOnly: true
        nfsMountPath:
          description: 'This field is currently deprecated. Please use NFS MountPaths

            which would be an array of strings.'
          type: string
          x-nullable: true
          x-order: 9
          readOnly: true
        nfsMountPaths:
          description: "Array of NFS Paths.\nSpecifies the path for mounting this\
            \ View as an NFS share. If\nKerberos Provider has multiple hostaliases,\
            \ each host alias has\n its own path."
          type: array
          items:
            type: string
          x-nullable: true
          x-order: 10
          readOnly: true
        smbMountPaths:
          description: 'Array of SMB Paths.

            Specifies the possible paths that can be used to mount this View

            as a SMB share. If Active Directory has multiple account names;

            each machine account has its own path.'
          type: array
          items:
            type: string
          x-nullable: true
          x-order: 11
          readOnly: true
        viewProtection:
          allOf:
          - $ref: '#/definitions/ViewProtection'
          - x-nullable: true
          x-order: 12
          readOnly: true
        aliases:
          description: 'Aliases created for the view. A view alias allows a directory
            path inside

            a view to be mounted using the alias name.'
          type: array
          items:
            $ref: '#/definitions/ViewAliasInfo'
          x-nullable: true
          x-order: 13
          readOnly: true
        isTargetForMigratedData:
          description: Specifies if a view contains migrated data.
          type: boolean
          x-nullable: true
          x-order: 14
          readOnly: true
        viewFailover:
          description: 'Specifies the information about the failover of the

            view.'
          allOf:
          - $ref: '#/definitions/ViewFailover'
          - x-nullable: true
          x-order: 15
          readOnly: true
        stats:
          description: Specifies statistics about the View.
          allOf:
          - $ref: '#/definitions/ViewStats'
          - x-nullable: true
          x-order: 16
          readOnly: true
    - $ref: '#/definitions/UpdateViewParam'
  ViewAliasInfo:
    description: View Alias Info is returned as part of list views.
    type: object
    title: View Alias Information.
    properties:
      aliasName:
        description: Alias name.
        type: string
        x-nullable: true
        x-order: 0
      viewPath:
        description: View path for the alias.
        type: string
        x-nullable: true
        x-order: 1
      smbConfig:
        description: SMB config for the alias (share).
        allOf:
        - $ref: '#/definitions/AliasSmbConfig'
        - x-nullable: true
        x-order: 2
      clientSubnetWhitelist:
        description: List of external client subnet IPs that are allowed to access
          the share.
        type: array
        items:
          $ref: '#/definitions/Subnet'
        x-nullable: true
        x-order: 3
  ViewCategory:
    description: Specifies category for view.
    type: object
    title: View Category.
    properties:
      type:
        description: Specifies category for view.
        type: string
        enum:
        - BackupTarget
        - FileServices
        - ObjectServices
        x-order: 0
  ViewFailover:
    description: Specifies the failover status of a view.
    type: object
    properties:
      isFailoverReady:
        description: Specifies if the view is ready for failover.
        type: boolean
        x-nullable: true
        x-order: 0
      remoteViewId:
        description: Specifies the remote view id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      remoteClusterId:
        description: Specifies the remote cluster id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      remoteClusterIncarnationId:
        description: Specifies the remote cluster incarnation id.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
  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
        x-nullable: true
        x-order: 0
      viewName:
        description: The name of the view.
        type: string
        x-nullable: true
        x-order: 1
      mountPoint:
        description: The path of the SMB share.
        type: string
        x-nullable: true
        x-order: 2
  ViewParams:
    description: Specifies the details about a view.
    type: object
    title: View
    properties:
      id:
        description: Specifies the ID of the view.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the view.
        type: string
        x-nullable: true
        x-order: 1
  ViewPinningConfig:
    description: Specifies the pinning config of a view.
    type: object
    required:
    - enabled
    properties:
      enabled:
        description: Specifies if view pinning is enabled. If set to true, view will
          be pinned to SSD and view data will be stored there.
        type: boolean
        x-nullable: true
        x-order: 0
      pinnedTimeSecs:
        description: Specifies the time to pin files after last access.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      lastUpdatedTimestampSecs:
        description: Specifies the timestamp when view pinning config is last updated.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
        readOnly: true
  ViewProtection:
    description: 'Specifies information about the Protection Groups that are protecting
      the

      View.'
    type: object
    title: View Protection.
    properties:
      magnetoEntityId:
        description: Specifies the id of the Protection Source that is using this
          View.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      protectionGroups:
        description: 'Array of Protection Group.

          Specifies the Protection Group that are protecting the View.'
        type: array
        items:
          $ref: '#/definitions/ProtectionGroupInfo'
        x-nullable: true
        x-order: 1
      inactive:
        description: 'Specifies if this View is an inactive View that was created
          on this

          Remote Cluster to store the Snapshots created by replication.

          This inactive View cannot be NFS or SMB mounted.'
        type: boolean
        x-nullable: true
        x-order: 2
    readOnly: true
  ViewProtectionConfig:
    description: Specifies the View protection config.
    type: object
    required:
    - protectionGroupType
    properties:
      protectionGroupType:
        description: Specifies the View protection group type.
        type: string
        enum:
        - ExistingGroup
        - NewGroup
        x-nullable: true
        x-order: 0
      existingGroupParam:
        description: Specifies the parameters used for existing protection group.
        allOf:
        - $ref: '#/definitions/ExistingGroupParam'
        - x-nullable: true
        x-order: 1
      newGroupParam:
        description: Specifies the parameters used for new protection group.
        allOf:
        - $ref: '#/definitions/NewGroupParam'
        - x-nullable: true
        x-order: 2
  ViewProtectionGroupObjectParams:
    description: Specifies an object protected by a View Protection Group.
    type: object
    required:
    - id
    properties:
      id:
        description: Specifies the ID of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
  ViewProtectionGroupParams:
    description: Specifies the parameters which are specific to view related Protection
      Groups.
    type: object
    title: View Protection Group Parameters
    required:
    - objects
    properties:
      objects:
        description: Specifies the objects to be included in the Protection Group.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ViewProtectionGroupObjectParams'
        x-order: 0
      replicationParams:
        description: Specifies the paramters for view replication.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/ViewProtectionGroupReplicationParams'
      indexingPolicy:
        description: Specifies settings for indexing files found in the View so these
          files can be searched and recovered. This also specifies inclusion and exclusion
          rules that determine the directories to index.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/IndexingPolicy'
    x-nullable: true
  ViewProtectionGroupReplicationParams:
    description: Specifies the parameters for view replication.
    title: Replication Parameters
    properties:
      viewNameConfigList:
        description: Specifies the list of remote view names for the protected views
          in the Protection Group. By default the names will be the same as the name
          of the protected view.
        type: array
        minItems: 1
        uniqueItems: true
        items:
          $ref: '#/definitions/ReplicatedViewNameConfig'
        x-order: 0
    x-nullable: true
  ViewProtocol:
    description: Specifies the protocol options for view.
    type: object
    title: Protocol Option
    properties:
      type:
        description: "Type of protocol.\nSpecifies the supported Protocols for the\
          \ View.\n  'NFS' enables protocol access to NFS v3.\n  'NFS4' enables protocol\
          \ access to NFS v4.1.\n  'SMB' enables protocol access to SMB.\n  'S3' enables\
          \ protocol access to S3.\n  'Swift' enables protocol access to Swift."
        type: string
        enum:
        - NFS
        - NFS4
        - SMB
        - S3
        - Swift
        x-order: 0
      mode:
        description: "Mode of protocol access.\n  'ReadOnly'\n  'ReadWrite'"
        type: string
        enum:
        - ReadOnly
        - ReadWrite
        x-order: 1
  ViewProtocolAccess:
    description: Specifies protocol access for view.
    type: object
    title: View Protocol Access.
    properties:
      type:
        description: Specifies protocol access for view.
        type: string
        enum:
        - NFS
        - NFS4
        - SMB
        - S3
        - Swift
        x-order: 0
  ViewProtocolAccessMode:
    description: Specifies protocol access mode for view.
    type: object
    title: View Protocol Access Mode
    properties:
      type:
        description: Specifies protocol access mode for view.
        type: string
        enum:
        - ReadOnly
        - ReadWrite
        x-order: 0
  ViewSecurityMode:
    description: Specifies Security Mode for view.
    type: object
    title: View Security Mode.
    properties:
      type:
        description: Specifies Security Mode for view.
        type: string
        enum:
        - NativeMode
        - UnifiedMode
        - NtfsMode
        x-order: 0
  ViewSharePermissions:
    description: Specifies share permissions of the view.
    type: object
    properties:
      superUserSids:
        description: Specifies a list of super user sids.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      permissions:
        description: Specifies a list of share permissions.
        type: array
        items:
          $ref: '#/definitions/SmbPermission'
        x-nullable: true
        x-order: 1
  ViewStats:
    description: Provides statistics about the View.
    type: object
    title: View Stats.
    properties:
      id:
        description: Specifies the id of the View.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      dataUsageStats:
        description: Specifies the data usage metric of the data stored in this View.
        allOf:
        - $ref: '#/definitions/DataUsageStats'
        - x-nullable: true
        x-order: 1
    readOnly: true
  VlanParams:
    description: Specifies VLAN params associated with the backup/restore operation.
    type: object
    title: Vlan Params for backup/restore operation.
    properties:
      vlanId:
        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
        format: int32
        x-nullable: true
        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 restore.
        type: boolean
        x-nullable: true
        x-order: 1
      interfaceName:
        description: Interface group to use for backup/restore. If this is not specified,
          primary interface group for the cluster will be used.
        type: string
        x-nullable: true
        x-order: 2
  VmwareAdditionalParams:
    description: Additional params for VMware protection source.
    type: object
    title: VMware Additional Params.
    properties:
      vcdParams:
        description: Specifies the VCD additional params.
        type: object
        x-nullable: true
        x-order: 0
        $ref: '#/definitions/VcdAdditionalParams'
  VmwareCdpObject:
    description: Specifies the VMware specific CDP object details.
    type: object
    allOf:
    - $ref: '#/definitions/CdpObjectInfo'
    - type: object
      properties:
        ioFilterStatus:
          description: Specifies the state of CDP IO filter. CDP IO filter is an agent
            which will be installed on the object for performing continuous backup.
            <br> 1. 'kNotInstalled' specifies that CDP is enabled on this object but
            filter is not installed. <br> 2. 'kInstallFilterInProgress' specifies
            that IO filter installation is triggered and in progress. <br> 3. 'kFilterInstalledIOInactive'
            specifies that IO filter is installed but IO streaming is disabled due
            to missing backup or explicitly disabled by the user. <br> 4. 'kIOActivationInProgress'
            specifies that IO filter is activated to start streaming. <br> 5. 'kIOActive'
            specifies that filter is attached to the object and started streaming.
            <br> 6. 'kIODeactivationInProgress' specifies that deactivation has been
            initiated to stop the IO streaming. <br> 7. 'kUninstallFilterInProgress'
            specifies that uninstallation of IO filter is in progress.
          type: string
          enum:
          - NotInstalled
          - InstallFilterInProgress
          - FilterInstalledIOInactive
          - FilterInstalled
          - IOInactive
          - IOActivationInProgress
          - IOActive
          - IODeactivationInProgress
          - UninstallFilterInProgress
          - UpgradeFilterInProgress
          - UpgradeFilterFailed
          x-nullable: true
          x-order: 0
        ioFilterErrorMessage:
          description: Specifies the error message related to IO filter if there is
            any.
          type: string
          x-nullable: true
          x-order: 1
  VmwareConnectionParams:
    description: Specifies the parameters to connect to a seed node and fetch information
      from its config file.
    type: object
    title: Parameters to connect and query VMware config file.
    required:
    - type
    properties:
      type:
        description: Specifies the VMware Source type.
        type: string
        enum:
        - kVCenter
        - kStandaloneHost
        - kvCloudDirector
        x-nullable: true
        x-order: 0
      vcdParams:
        description: Specifies the parameters to register a VCD.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VcdConnectionParams'
  VmwareDiskControllerType:
    description: Vmware disk controller type.
    type: object
    title: VMware disk controller type.
    properties:
      vmwareDiskControllerType:
        description: Specifies VMware disk controller type.
        type: string
        enum:
        - kScsi
        - kIde
        - kSata
        x-order: 0
  VmwareObjectAction:
    description: Actions on VMware objects.
    type: object
    title: Actions on VMware objects.
    properties:
      vmwareObjectAction:
        description: Specifies the actions on vmware objects.
        type: string
        enum:
        - enableAppProtection
        - disableAppProtection
        - upgradeCdpIoFilter
        - uninstallCdpIoFilter
        x-order: 0
  VmwareObjectActionParams:
    description: Specifies the parameters to perform an action on VMware Objects.
    title: Actions on VMware Objects
    required:
    - action
    properties:
      action:
        description: Specifies the action on the Object.
        type: string
        enum:
        - enableAppProtection
        - disableAppProtection
        - upgradeCdpIoFilter
        - uninstallCdpIoFilter
        x-nullable: true
        x-order: 0
      enableAppProtectionParams:
        description: Specifies the parameters to enable App Protection on VMware Object.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VmwareObjectEnableAppProtectionParams'
  VmwareObjectEnableAppProtectionParams:
    description: Specifies the parameters to enable app protection on VMware.
    title: VMware app protection parameters.
    required:
    - appType
    properties:
      appType:
        description: Specifies the app from which protection must be enabled.
        type: string
        enum:
        - kSQL
        - kOracle
        - kAD
        - kExchange
        x-nullable: true
        x-order: 0
      enableSqlProtectionParams:
        description: Specifies the parameters to enable protection for SQL app on
          this VM.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VmwareObjectEnableSqlProtectionParams'
  VmwareObjectEnableSqlProtectionParams:
    description: Specifies the parameters for enabling SQL protection.
    title: Enable SQL protection parameters.
    properties:
      useInstalledAgent:
        description: Specifies if agent is already installed.
        type: boolean
        x-nullable: true
        x-order: 0
      credentials:
        description: Specifies the credentials to connect to SQL. This is needed only
          if agent is not installed.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VmwareSQLCredentialParams'
  VmwareObjectEntityParams:
    description: Object details for Vmware.
    type: object
    properties:
      type:
        description: VMware Object type.
        type: string
        enum:
        - kVCenter
        - kStandaloneHost
        - kvCloudDirector
        - kFolder
        - kDatacenter
        - kComputeResource
        - kClusterComputeResource
        - kResourcePool
        - kDatastore
        - kHostSystem
        - kVirtualMachine
        - kVirtualApp
        - kStoragePod
        - kNetwork
        - kDistributedVirtualPortgroup
        - kTagCategory
        - kTag
        - kOpaqueNetwork
        - kOrganization
        - kVirtualDatacenter
        - kCatalog
        - kOrgMetadata
        - kStoragePolicy
        - kVirtualAppTemplate
        x-nullable: true
        x-order: 0
      cdpInfo:
        description: Specifies the Continuous Data Protection (CDP) details about
          this object. This is only available if this object if protected by a CDP
          enabled policy.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VmwareCdpObject'
      isTemplate:
        description: Specifies if the object is a VM template.
        type: boolean
        x-nullable: true
        x-order: 2
  VmwareObjectProtectionRequest:
    description: Specifies the VMware object level settings for object protection.
    type: object
    allOf:
    - type: object
      required:
      - id
      properties:
        id:
          description: Specifies the id of the object being protected. This can be
            a leaf level or non leaf level object.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        excludeObjectIds:
          description: Specifies the list of IDs of the objects to not be protected
            in this backup. This field only applies if provided object id is non leaf
            entity such as Tag or a folder. This can be used to ignore specific objects
            under a parent object which has been included for protection.
          type: array
          items:
            type: integer
            format: int64
            x-nullable: true
          x-order: 1
    - $ref: '#/definitions/CommonVmwareObjectParams'
  VmwareObjectProtectionRequestParams:
    description: Specifies the parameters which are specific to VMware object protection.
    type: object
    allOf:
    - type: object
      required:
      - objects
      properties:
        objects:
          description: Specifies the objects to include in the backup.
          type: array
          items:
            $ref: '#/definitions/VmwareObjectProtectionRequest'
          x-order: 0
        globalExcludeDisks:
          description: Specifies a list of disks to exclude from the backup.
          type: array
          items:
            $ref: '#/definitions/DiskInfo'
          x-nullable: true
          x-order: 1
    - $ref: '#/definitions/CommonVmwareProtectionParams'
  VmwareObjectProtectionResponse:
    description: Specifies the input for a protection object in the VMware environment.
    type: object
    allOf:
    - $ref: '#/definitions/CommonVmwareObjectParams'
    - type: object
      properties:
        excludeObjectIds:
          description: Specifies the list of IDs of the objects to not be protected
            in this backup. This field only applies if provided object id is non leaf
            entity such as Tag or a folder. This can be used to ignore specific objects
            under a parent object which has been included for protection.
          type: array
          items:
            type: integer
            format: int64
            x-nullable: true
          x-order: 0
        cdpInfo:
          description: Specifies the CDP related information for a given object. This
            field will only be populated when protection group is configured with
            policy having CDP retnetion settings.
          type: object
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/VmwareCdpObject'
  VmwareObjectProtectionResponseParams:
    description: Specifies the parameters which are specific to VMware object protection.
    type: object
    allOf:
    - $ref: '#/definitions/VmwareObjectProtectionResponse'
    - $ref: '#/definitions/CommonVmwareProtectionParams'
  VmwareObjectProtectionUpdateRequestParams:
    description: Specifies the parameters which are specific to VMware object protection.
    type: object
    allOf:
    - $ref: '#/definitions/CommonVmwareProtectionParams'
    - $ref: '#/definitions/CommonVmwareObjectParams'
    - type: object
      properties:
        excludeObjectIds:
          description: Specifies the list of IDs of the objects to not be protected
            in this backup. This field only applies if provided object id is non leaf
            entity such as Tag or a folder. This can be used to ignore specific objects
            under a parent object which has been included for protection.
          type: array
          items:
            type: integer
            format: int64
            x-nullable: true
          x-order: 0
  VmwareProtectionGroupExtraParams:
    description: Specifies the extra parameters which are specific to VMware object
      protection Group.
    type: object
    properties:
      sourceId:
        description: Specifies the id of the parent of the objects.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
        readOnly: true
      sourceName:
        description: Specifies the name of the parent of the objects.
        type: string
        x-nullable: true
        x-order: 1
        readOnly: true
      excludeObjectIds:
        description: Specifies the list of IDs of the objects to not be protected
          in this backup. This field only applies if provided object id is non leaf
          entity such as Tag or a folder. This can be used to ignore specific objects
          under a parent object which has been included for protection.
        type: array
        items:
          type: integer
          format: int64
          x-nullable: true
        x-order: 2
      vmTagIds:
        description: 'Array of Array of VM Tag Ids that Specify VMs to Protect. Optionally
          specify a list of VMs to protect by listing Protection Source ids of VM
          Tags in this two dimensional array. Using this two dimensional array of
          Tag ids, the Cluster generates a list of VMs to protect which are derived
          from intersections of the inner arrays and union of the outer array, as
          shown by the following example. To protect only ''Eng'' VMs in the East
          and all the VMs in the West, specify the following tag id array: [ [1101,
          2221], [3031] ], where 1101 is the ''Eng'' VM Tag id, 2221 is the ''East''
          VM Tag id and 3031 is the ''West'' VM Tag id. The inner array [1101, 2221]
          produces a list of VMs that are both tagged with ''Eng'' and ''East'' (an
          intersection). The outer array combines the list from the inner array with
          list of VMs tagged with ''West'' (a union). The list of resulting VMs are
          protected by this Protection Group.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-nullable: true
        x-order: 3
      excludeVmTagIds:
        description: 'Array of Arrays of VM Tag Ids that Specify VMs to Exclude. Optionally
          specify a list of VMs to exclude from protecting by listing Protection Source
          ids of VM Tags in this two dimensional array. Using this two dimensional
          array of Tag ids, the Cluster generates a list of VMs to exclude from protecting,
          which are derived from intersections of the inner arrays and union of the
          outer array, as shown by the following example. For example a Datacenter
          is selected to be protected but you want to exclude all the ''Former Employees''
          VMs in the East and West but keep all the VMs for ''Former Employees'' in
          the South which are also stored in this Datacenter, by specifying the following
          tag id array: [ [1000, 2221], [1000, 3031] ], where 1000 is the ''Former
          Employee'' VM Tag id, 2221 is the ''East'' VM Tag id and 3031 is the ''West''
          VM Tag id. The first inner array [1000, 2221] produces a list of VMs that
          are both tagged with ''Former Employees'' and ''East'' (an intersection).
          The second inner array [1000, 3031] produces a list of VMs that are both
          tagged with ''Former Employees'' and ''West'' (an intersection). The outer
          array combines the list of VMs from the two inner arrays. The list of resulting
          VMs are excluded from being protected this Job.'
        type: array
        items:
          type: array
          items:
            type: integer
            format: int64
        x-order: 4
      excludeFilters:
        description: Specifies the list of exclusion filters applied during the group
          creation or edit. These exclusion filters can be wildcard supported strings
          or regular expressions. Objects satisfying these filters will be excluded
          during backup and also auto protected objects will be ignored if filtered
          by any of the filters.
        type: array
        items:
          $ref: '#/definitions/Filter'
        x-nullable: true
        x-order: 5
      leverageStorageSnapshots:
        description: Whether to leverage the storage array based snapshots for this
          backup. To leverage storage snapshots, the storage array has to be registered
          as a source. If storage based snapshots can not be taken, backup will fallback
          to the default backup method.
        type: boolean
        x-nullable: true
        x-order: 6
      leverageHyperflexSnapshots:
        description: Whether to leverage the hyperflex based snapshots for this backup.
          To leverage hyperflex snapshots, it has to first be registered. If hyperflex
          based snapshots cannot be taken, backup will fallback to the default backup
          method.
        type: boolean
        x-nullable: true
        x-order: 7
      leverageNutanixSnapshots:
        description: Whether to leverage the nutanix based snapshots for this backup.
          To leverage nutanix snapshots, it has to first be registered. If nutanix
          based snapshots cannot be taken, backup will fallback to the default backup
          method.
        type: boolean
        x-nullable: true
        x-order: 8
      cloudMigration:
        description: Specifies whether or not to move the workload to the cloud.
        type: boolean
        x-nullable: true
        x-order: 9
  VmwareProtectionGroupObjectParams:
    description: Specifies the input for a protection object in the VMware environment.
    type: object
    allOf:
    - type: object
      required:
      - id
      properties:
        id:
          description: Specifies the id of the object being protected. This can be
            a leaf level or non leaf level object.
          type: integer
          format: int64
          x-nullable: true
          x-order: 0
        name:
          description: Specifies the name of the virtual machine.
          type: string
          x-nullable: true
          x-order: 1
          readOnly: true
        isAutoprotected:
          description: Specifies whether the vm is part of an Autoprotection. True
            implies that the vm or its parent directory is autoprotected and will
            remain part of the autoprotection with additional settings specified here.
            False implies the object is not part of an Autoprotection and will remain
            protected and its individual settings here even if a parent directory's
            Autoprotection setting is altered. Default is false.
          type: boolean
          x-nullable: true
          x-order: 2
        cdpInfo:
          description: Specifies the CDP related information for a given object. This
            field will only be populated when protection group is configured with
            policy having CDP retnetion settings.
          allOf:
          - $ref: '#/definitions/VmwareCdpObject'
          - x-nullable: true
          x-order: 3
          readOnly: true
    - $ref: '#/definitions/CommonVmwareObjectParams'
  VmwareProtectionGroupParams:
    description: Specifies the parameters which are specific to VMware related Protection
      Groups.
    type: object
    allOf:
    - type: object
      properties:
        objects:
          description: Specifies the objects to include in the backup.
          type: array
          items:
            $ref: '#/definitions/VmwareProtectionGroupObjectParams'
          x-order: 0
        globalExcludeDisks:
          description: Specifies a list of disks to exclude from the backup.
          type: array
          items:
            $ref: '#/definitions/DiskInfo'
          x-nullable: true
          x-order: 1
        standbyResourceObjects:
          description: Specifies the standby resource objects for this backup.
          type: array
          items:
            $ref: '#/definitions/VmwareProtectionGroupStandbyResourceParams'
          x-nullable: true
          x-order: 2
    - $ref: '#/definitions/CommonVmwareProtectionParams'
    - $ref: '#/definitions/VmwareProtectionGroupExtraParams'
    - $ref: '#/definitions/CommonCdpParams'
  VmwareProtectionGroupStandbyResourceParams:
    description: VMware protection group standby resource params which will be used
      to create standby VM entity for backup entity.
    allOf:
    - $ref: '#/definitions/CommonStandbyResourceParams'
    - type: object
      properties:
        renameRestoredObjectParams:
          description: Specifies params to rename the standby resource.
          allOf:
          - $ref: '#/definitions/RecoveredOrClonedVmsRenameConfig'
          - x-nullable: true
          x-nullable: true
          x-order: 0
        parentObjectId:
          description: Specifies the object id for parent vCenter source where this
            standby resource should be created.
          type: integer
          format: int64
          x-nullable: true
          x-order: 1
        targetFolderObjectId:
          description: Specifies the object id for target vm folder where this standby
            resource should be created.
          type: integer
          format: int64
          x-nullable: true
          x-order: 2
        targetDatastoreFolderObjectId:
          description: Specifies the object id for target datastore folder where disks
            for this standby resource should be placed.
          type: integer
          format: int64
          x-nullable: true
          x-order: 3
        resourcePoolObjectId:
          description: Specifies the object id for resource pool where this standby
            resource should be created.
          type: integer
          format: int64
          x-nullable: true
          x-order: 4
        datastoreObjectIds:
          description: Specifies the list of IDs of the datastore objects where this
            standby resource should be created.
          type: array
          items:
            type: integer
            format: int64
            x-nullable: true
          x-order: 5
        networkConfig:
          description: Specifies the networking configuration to be applied to this
            standby resource.
          allOf:
          - $ref: '#/definitions/RecoverVmwareVmNewSourceNetworkConfig'
          - x-nullable: true
          x-nullable: true
          x-order: 6
  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: '#/definitions/VmwareRecoverOriginalSourceDiskParams'
        x-order: 0
  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
        format: int64
        x-nullable: true
        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: '#/definitions/VmwareRecoverTargetSourceDiskParams'
        x-order: 1
  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: '#/definitions/RecoverTarget'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      absolutePath:
        description: Specifies the path location to recover files to.
        type: string
        x-nullable: true
        x-order: 3
  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: '#/definitions/Credentials'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        x-order: 2
      alternatePath:
        description: Specifies the alternate path location to recover files to.
        type: string
        x-nullable: true
        x-order: 3
  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
        x-nullable: true
        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
        x-nullable: true
        x-order: 1
      datastoreId:
        description: Specifies the ID of the datastore on which the specified disk
          will be spun up.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
  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
        x-nullable: true
        x-order: 0
      datastoreId:
        description: Specifies the ID of the datastore on which the specified disk
          will be spun up.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
  VmwareSQLCredentialParams:
    description: Specifies the credentials to connect to SQL.
    title: Credentials to connect to SQL.
    properties:
      username:
        description: ' username for when agent is not installed'
        type: string
        x-nullable: true
        x-order: 0
      password:
        description: ' password for when agent is not installed'
        type: string
        x-nullable: true
        x-order: 1
  VmwareSourceRegistrationParams:
    description: Specifies the paramaters to register a VMware source.
    type: object
    required:
    - type
    properties:
      type:
        description: Specifies the VMware Source type.
        type: string
        enum:
        - kVCenter
        - kStandaloneHost
        - kvCloudDirector
        x-nullable: true
        x-order: 0
      vCenterParams:
        description: Specifies the parameters to register a VMware vCenter.
        type: object
        x-nullable: true
        x-order: 1
        $ref: '#/definitions/VcenterRegistrationParams'
      esxiParams:
        description: Specifies the parameters to register a ESXi.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/EsxiRegistrationParams'
      vcdParams:
        description: Specifies the parameters to register a VCD.
        type: object
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/VcdRegistrationParams'
  VmwareSourceType:
    description: VMware Source Type
    type: object
    title: VMware Source Type
    properties:
      vmwareSourceType:
        description: Specifies the VMware Source types.
        type: string
        enum:
        - kVCenter
        - kStandaloneHost
        - kvCloudDirector
        x-order: 0
  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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for mounting to the original target.
        allOf:
        - $ref: '#/definitions/VMwareMountVolumesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for mounting to a new target.
        allOf:
        - $ref: '#/definitions/VMwareMountVolumesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      readOnlyMount:
        description: Specifies whether to perform a read-only mount. Default is false.
        type: boolean
        x-nullable: true
        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
        items:
          type: string
        x-nullable: true
        x-order: 4
      mountedVolumeMapping:
        description: Specifies the mapping of original volumes and mounted volumes
        type: array
        items:
          $ref: '#/definitions/MountedVolumeMapping'
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/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: '#/definitions/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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      powerOffVms:
        description: Specifies whether or not to power off VMs before performing the
          recovery.
        type: boolean
        x-nullable: true
        x-order: 3
      powerOnVms:
        description: Specifies whether or not to power on VMs after performing the
          recovery.
        type: boolean
        x-nullable: true
        x-order: 4
      continueOnError:
        description: Specifies whether or not to continue performing the recovery
          in the event that an error is encountered.
        type: boolean
        x-nullable: true
        x-order: 5
  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
        x-nullable: true
        x-order: 0
      originalTargetConfig:
        description: Specifies the configuration for recovering to the original target.
        allOf:
        - $ref: '#/definitions/VmwareRecoverFilesOriginalTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 1
      newTargetConfig:
        description: Specifies the configuration for recovering to a new target.
        allOf:
        - $ref: '#/definitions/VmwareRecoverFilesNewTargetConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
      overwriteExisting:
        description: Specifies whether to overwrite the existing files. Default is
          true.
        type: boolean
        x-nullable: true
        x-order: 3
      preserveAttributes:
        description: Specifies whether to preserve original attributes. Default is
          true.
        type: boolean
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/VmwareVAppRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 7
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/VmwareVAppTemplateRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 6
  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: '#/definitions/RecoveredOrClonedVmsRenameConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/VmwareVmRecoveryTargetConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoveryVlanConfig'
        - x-nullable: true
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        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
        x-nullable: true
        x-order: 8
  VmwareThrottlingParams:
    description: Specifies throttling params.
    type: object
    title: Throttling Params.
    properties:
      newTaskLatencyThresholdMsecs:
        description: If the latency of a datastore is above this value, then a new
          backup task that uses the datastore won't be started.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
      activeTaskLatencyThresholdMsecs:
        description: If the latency of a datastore is above this value, then an existing
          backup task that uses the datastore will start getting throttled.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      maxConcurrentStreams:
        description: If this value is > 0 and the number of streams concurrently active
          on a datastore is equal to it, then any further requests to access the datastore
          would be denied until the number of active streams reduces. This applies
          for all the datastores in the specified host.
        type: integer
        format: int32
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverVmwareVAppNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverVmwareVAppOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverVmwareVAppTemplateNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverVmwareVAppOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  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: '#/definitions/RecoverVmwareVmNewSourceConfig'
        - x-nullable: true
        x-nullable: true
        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: '#/definitions/RecoverVmwareVmOriginalSourceConfig'
        - x-nullable: true
        x-nullable: true
        x-order: 2
  VolumeInfo:
    description: Specifies info of logical volume (filesystem).
    type: object
    properties:
      name:
        description: Specifies the volume name.
        type: string
        x-nullable: true
        x-order: 0
      isSupported:
        description: Specifies if this volume is supported.
        type: boolean
        x-nullable: true
        x-order: 1
      volumeType:
        description: Specifies the volume type.
        type: string
        enum:
        - SimpleVolume
        - LVM
        - LDM
        x-nullable: true
        x-order: 2
      filesystemType:
        description: Specifies the filesystem type.
        type: string
        x-nullable: true
        x-order: 3
      filesystemUuid:
        description: Specifies the filesystem uuid.
        type: string
        x-nullable: true
        x-order: 4
      volumeGuid:
        description: Specifies the volume guid.
        type: string
        x-nullable: true
        x-order: 5
      volumeSizeInBytes:
        description: Specifies volume size in bytes.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      logicalVolumeInfo:
        description: Specifies the logical volume info. This fields is for 'LVM' and
          'LDM' volume type only.
        allOf:
        - $ref: '#/definitions/LogicalVolumeInfo'
        - x-nullable: true
        x-order: 7
  WeekDays:
    description: Week Days type.
    type: object
    title: Week Days type.
    properties:
      weekDays:
        description: Specifies Week Days type.
        type: string
        enum:
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        x-order: 0
  WeekSchedule:
    description: Specifies settings that define a schedule for a Protection Group
      runs to start on certain days of week.
    title: Week Schedule
    required:
    - dayOfWeek
    properties:
      dayOfWeek:
        description: 'Specifies a list of days of the week when to start Protection
          Group Runs. <br> Example: To run a Protection Group on every Monday and
          Tuesday, set the schedule with following values: <br>  unit: ''Weeks'' <br>  dayOfWeek:
          [''Monday'',''Tuesday'']'
        type: array
        items:
          type: string
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
        x-nullable: true
        x-order: 0
  WormRetention:
    description: Worm Retention type.
    type: object
    title: Worm Retention type.
    properties:
      wormRetention:
        description: Specifies Worm Retention type.
        type: string
        enum:
        - Compliance
        - Administrative
        x-order: 0
  ObjectActionRequest86c52dc1-d691-4745-b532-0b5ea13ae817:
    description: Specifies the request to peform an action on an Object.
    title: Peform an action on an Object.
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the actions for VMware Objects.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareObjectActionParams'
  CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014:
    description: Specifies the common request parameters for performing an action
      on Object.
    type: object
    title: Common Object Action Request.
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Object.
        type: string
        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-nullable: true
        x-order: 0
    x-cohesity-discriminator-details:
      propertyName: environment
    x-discriminator:
      mapping:
        kVMware: '#/definitions/CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014VmwareObjectActionParamsWrapper'
      propertyName: environment
  CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014VmwareObjectActionParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014'
    - properties:
        vmwareParams:
          $ref: '#/definitions/VmwareObjectActionParams'
      type: object
  CreateOrUpdateProtectionGroupRequest3f69a8d7-07cd-4281-9b17-de6f73423a2c:
    description: Specifies the request to create or update a Protection Group.
    title: Create Or Update Protection Group Request.
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareProtectionGroupParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/AcropolisProtectionGroupParams'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/KubernetesProtectionGroupParams'
        mssqlParams:
          description: Specifies the parameters specific to MSSQL Protection Group.
          type: object
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/MSSQLProtectionGroupParams'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle Protection
            Group.
          type: object
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/OracleProtectionGroupParams'
        viewParams:
          description: Specifies the parameters which are specific to View related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kView
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ViewProtectionGroupParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/PureProtectionGroupParams'
        nimbleParams:
          description: Specifies the parameters which are specific to Nimble related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNimble
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/NimbleProtectionGroupParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/HyperVProtectionGroupParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/AwsProtectionGroupParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/AzureProtectionGroupParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/GcpProtectionGroupParams'
        kvmParams:
          description: Specifies the parameters which are specific to Kvm related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/KvmProtectionGroupParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/PhysicalProtectionGroupParams'
        adParams:
          description: Specifies the parameters which are specific to Active Directory
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAD
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/ADProtectionGroupParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/Office365ProtectionGroupParams'
        netappParams:
          description: Specifies the parameters which are specific to NetApp related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/NetappProtectionGroupParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic Nas
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/GenericNasProtectionGroupParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/IsilonProtectionGroupParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to Flashblade related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/FlashbladeProtectionGroupParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/GpfsProtectionGroupParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Protection
            Groups
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/ElastifileProtectionGroupParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/CassandraProtectionGroupParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/MongoDBProtectionGroupParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/HdfsProtectionGroupParams'
        hbaseParams:
          description: Specifies the parameters which are specific to HBase Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 27
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        remoteAdapterParams:
          description: Specifies the parameters which are specific to Remote Adapter
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kRemoteAdapter
          x-nullable: true
          x-order: 28
          $ref: '#/definitions/RemoteAdapterProtectionGroupParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchangee related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 29
          $ref: '#/definitions/ExchangeProtectionGroupParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 30
          $ref: '#/definitions/UdaProtectionGroupParams'
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659:
    description: Specifies the parameters which are common between all Protection
      Group requests.
    type: object
    required:
    - name
    - policyId
    - environment
    properties:
      name:
        description: Specifies the name of the Protection Group.
        type: string
        x-nullable: true
        x-order: 0
      policyId:
        description: Specifies the unique id of the Protection Policy associated with
          the Protection Group. The Policy provides retry settings Protection Schedules,
          Priority, SLA, etc.
        type: string
        x-nullable: true
        x-order: 1
      priority:
        description: Specifies the priority of the Protection Group.
        type: string
        enum:
        - kLow
        - kMedium
        - kHigh
        x-nullable: true
        x-order: 2
      storageDomainId:
        description: Specifies the Storage Domain (View Box) ID where this Protection
          Group writes data.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      description:
        description: Specifies a description of the Protection Group.
        type: string
        x-nullable: true
        x-order: 4
      startTime:
        description: Specifies the start time for this Protection Group. If no start
          time is specified, the start time will default to 2am. This field is only
          used if the policy has a daily or monthly schedule.
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/TimeOfDay'
      endTimeUsecs:
        description: Specifies the end time in micro seconds for this Protection Group.
          If this is not specified, the Protection Group won't be ended.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      alertPolicy:
        description: Specifies the alerting policy for this Protection Group.
        x-nullable: true
        x-order: 7
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      sla:
        description: Specifies the SLA parameters for this Protection Group.
        type: array
        items:
          $ref: '#/definitions/SlaRule'
        x-nullable: true
        x-order: 8
      qosPolicy:
        description: Specifies whether the Protection Group will be written to HDD
          or SSD.
        type: string
        enum:
        - kBackupHDD
        - kBackupSSD
        - kTestAndDevHigh
        - kBackupAll
        x-nullable: true
        x-order: 9
      abortInBlackouts:
        description: Specifies whether currently executing jobs should abort if a
          blackout period specified by a policy starts. Available only if the selected
          policy has at least one blackout period. Default value is false.
        type: boolean
        x-nullable: true
        x-order: 10
      environment:
        description: Specifies the environment type of the Protection Group.
        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-nullable: true
        x-order: 11
      isPaused:
        description: Specifies if the the Protection Group is paused. New runs are
          not scheduled for the paused Protection Groups. Active run if any is not
          impacted.
        type: boolean
        x-nullable: true
        x-order: 12
    x-cohesity-discriminator-details:
      propertyName: environment
    x-discriminator:
      mapping:
        kVMware: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659VmwareProtectionGroupParamsWrapper'
        kAcropolis: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659AcropolisProtectionGroupParamsWrapper'
        kKubernetes: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659KubernetesProtectionGroupParamsWrapper'
        kSQL: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659MSSQLProtectionGroupParamsWrapper'
        kOracle: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659OracleProtectionGroupParamsWrapper'
        kView: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ViewProtectionGroupParamsWrapper'
        kPure: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659PureProtectionGroupParamsWrapper'
        kNimble: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NimbleProtectionGroupParamsWrapper'
        kHyperV: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659HyperVProtectionGroupParamsWrapper'
        kAWS: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659AwsProtectionGroupParamsWrapper'
        kAzure: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659AzureProtectionGroupParamsWrapper'
        kGCP: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659GcpProtectionGroupParamsWrapper'
        kKVM: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659KvmProtectionGroupParamsWrapper'
        kPhysical: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659PhysicalProtectionGroupParamsWrapper'
        kAD: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ADProtectionGroupParamsWrapper'
        kO365: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659Office365ProtectionGroupParamsWrapper'
        kNetapp: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NetappProtectionGroupParamsWrapper'
        kGenericNas: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659GenericNasProtectionGroupParamsWrapper'
        kIsilon: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659IsilonProtectionGroupParamsWrapper'
        kFlashBlade: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659FlashbladeProtectionGroupParamsWrapper'
        kGPFS: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659GpfsProtectionGroupParamsWrapper'
        kCouchbase: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NoSqlProtectionGroupParamsWrapper'
        kElastifile: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ElastifileProtectionGroupParamsWrapper'
        kCassandra: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659CassandraProtectionGroupParamsWrapper'
        kMongoDB: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659MongoDBProtectionGroupParamsWrapper'
        kHive: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NoSqlProtectionGroupParamsWrapper'
        kHdfs: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659HdfsProtectionGroupParamsWrapper'
        kHBase: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NoSqlProtectionGroupParamsWrapper'
        kRemoteAdapter: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659RemoteAdapterProtectionGroupParamsWrapper'
        kExchange: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ExchangeProtectionGroupParamsWrapper'
        kUDA: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659UdaProtectionGroupParamsWrapper'
      propertyName: environment
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659VmwareProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        vmwareParams:
          $ref: '#/definitions/VmwareProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659AcropolisProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        acropolisParams:
          $ref: '#/definitions/AcropolisProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659KubernetesProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        kubernetesParams:
          $ref: '#/definitions/KubernetesProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659MSSQLProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        mssqlParams:
          $ref: '#/definitions/MSSQLProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659OracleProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        oracleParams:
          $ref: '#/definitions/OracleProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ViewProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        viewParams:
          $ref: '#/definitions/ViewProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659PureProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        pureParams:
          $ref: '#/definitions/PureProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NimbleProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        nimbleParams:
          $ref: '#/definitions/NimbleProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659HyperVProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        hypervParams:
          $ref: '#/definitions/HyperVProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659AwsProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        awsParams:
          $ref: '#/definitions/AwsProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659AzureProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        azureParams:
          $ref: '#/definitions/AzureProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659GcpProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        gcpParams:
          $ref: '#/definitions/GcpProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659KvmProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        kvmParams:
          $ref: '#/definitions/KvmProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659PhysicalProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        physicalParams:
          $ref: '#/definitions/PhysicalProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ADProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        adParams:
          $ref: '#/definitions/ADProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659Office365ProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        office365Params:
          $ref: '#/definitions/Office365ProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NetappProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        netappParams:
          $ref: '#/definitions/NetappProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659GenericNasProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        genericNasParams:
          $ref: '#/definitions/GenericNasProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659IsilonProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        isilonParams:
          $ref: '#/definitions/IsilonProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659FlashbladeProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        flashbladeParams:
          $ref: '#/definitions/FlashbladeProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659GpfsProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        gpfsParams:
          $ref: '#/definitions/GpfsProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659NoSqlProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        hbaseParams:
          $ref: '#/definitions/NoSqlProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ElastifileProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        elastifileParams:
          $ref: '#/definitions/ElastifileProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659CassandraProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        cassandraParams:
          $ref: '#/definitions/CassandraProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659MongoDBProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        mongodbParams:
          $ref: '#/definitions/MongoDBProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659HdfsProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        hdfsParams:
          $ref: '#/definitions/HdfsProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659RemoteAdapterProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        remoteAdapterParams:
          $ref: '#/definitions/RemoteAdapterProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659ExchangeProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        exchangeParams:
          $ref: '#/definitions/ExchangeProtectionGroupParams'
      type: object
  CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659UdaProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupRequestParamse9ef605d-4350-4f91-93ca-9e8a25d0f659'
    - properties:
        udaParams:
          $ref: '#/definitions/UdaProtectionGroupParams'
      type: object
  CreateRecoveryRequesteb6f3c7e-90d7-4ef7-b727-9e71c344ee73:
    description: Specifies the request parameters to create a Recovery.
    title: Create Recovery request params.
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverVmwareParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/RecoverVmwareParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAwsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/RecoverAwsParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGcpParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/RecoverGcpParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAzureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/RecoverAzureParams'
        kvmParams:
          description: Specifies the parameters which are specific to KVM related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKvmParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/RecoverKvmParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAcropolisParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/RecoverAcropolisParams'
        mssqlParams:
          description: Specifies the parameters which are specific to MsSQL related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverSqlParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/RecoverSqlParams'
        netappParams:
          description: Specifies the parameters which are specific to Netapp related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverNetappParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/RecoverNetappParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic NAS
            related Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGenericNasParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/RecoverGenericNasParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverIsilonParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/RecoverIsilonParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to FlashBlade related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverFlashbladeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/RecoverFlashbladeParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverElastifileParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/RecoverElastifileParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGpfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/RecoverGpfsParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPhysicalParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/RecoverPhysicalParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverHyperVParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/RecoverHyperVParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchange related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverExchangeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/RecoverExchangeParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CassandraParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/CassandraParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/UdaParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/UdaParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CouchbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/CouchbaseParams'
        hbaseParams:
          description: Specifies the parameters which are specific to Hbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHbase
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/HbaseParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HdfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/HdfsParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HiveParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/HiveParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/MongodbParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/MongodbParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/RecoverPureParams'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKubernetesParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/RecoverKubernetesParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverO365Params'
          - x-nullable: true
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/RecoverO365Params'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverOracleParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/RecoverOracleParams'
  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
        x-nullable: true
        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
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverVmwareParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        vmwareParams:
          $ref: '#/definitions/RecoverVmwareParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverAwsParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        awsParams:
          $ref: '#/definitions/RecoverAwsParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverGcpParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        gcpParams:
          $ref: '#/definitions/RecoverGcpParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverAzureParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        azureParams:
          $ref: '#/definitions/RecoverAzureParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverKvmParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        kvmParams:
          $ref: '#/definitions/RecoverKvmParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverAcropolisParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        acropolisParams:
          $ref: '#/definitions/RecoverAcropolisParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverSqlParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        mssqlParams:
          $ref: '#/definitions/RecoverSqlParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverNetappParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        netappParams:
          $ref: '#/definitions/RecoverNetappParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverGenericNasParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        genericNasParams:
          $ref: '#/definitions/RecoverGenericNasParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverIsilonParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        isilonParams:
          $ref: '#/definitions/RecoverIsilonParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverFlashbladeParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        flashbladeParams:
          $ref: '#/definitions/RecoverFlashbladeParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverElastifileParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        elastifileParams:
          $ref: '#/definitions/RecoverElastifileParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverGpfsParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        gpfsParams:
          $ref: '#/definitions/RecoverGpfsParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverPhysicalParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        physicalParams:
          $ref: '#/definitions/RecoverPhysicalParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverHyperVParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        hypervParams:
          $ref: '#/definitions/RecoverHyperVParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverExchangeParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        exchangeParams:
          $ref: '#/definitions/RecoverExchangeParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eCassandraParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        cassandraParams:
          $ref: '#/definitions/CassandraParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eUdaParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        udaParams:
          $ref: '#/definitions/UdaParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eCouchbaseParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        couchbaseParams:
          $ref: '#/definitions/CouchbaseParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eHbaseParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        hbaseParams:
          $ref: '#/definitions/HbaseParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eHdfsParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        hdfsParams:
          $ref: '#/definitions/HdfsParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eHiveParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        hiveParams:
          $ref: '#/definitions/HiveParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eMongodbParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        mongodbParams:
          $ref: '#/definitions/MongodbParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverPureParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        pureParams:
          $ref: '#/definitions/RecoverPureParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverKubernetesParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        kubernetesParams:
          $ref: '#/definitions/RecoverKubernetesParams'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverO365ParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        office365Params:
          $ref: '#/definitions/RecoverO365Params'
      type: object
  CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265eRecoverOracleParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryRequestParams35493c9a-e370-4716-8cfd-4d811134265e'
    - properties:
        oracleParams:
          $ref: '#/definitions/RecoverOracleParams'
      type: object
  SearchIndexedObjectsRequestb60c3076-8a0d-42b4-884c-d5d699790467:
    description: Specifies the request parameters to search for indexed objects.
    title: Search indexed objects request params.
    allOf:
    - {}
    - type: object
      properties:
        emailParams:
          description: Specifies the parameters which are specific for searching emails
            and email folders.
          type: object
          allOf:
          - $ref: '#/definitions/SearchEmailRequestParams'
          - x-nullable: true
          x-cohesity-discriminator-value: Emails
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/SearchEmailRequestParams'
        fileParams:
          description: Specifies the parameters which are specific for searching files
            and file folders.
          type: object
          allOf:
          - $ref: '#/definitions/SearchFileRequestParams'
          - x-nullable: true
          x-cohesity-discriminator-value: Files
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/SearchFileRequestParams'
        cassandraParams:
          description: Specifies the parameters which are specific for searching Cassandra
            objects.
          type: object
          required:
          - searchString
          - cassandraObjectTypes
          properties:
            cassandraObjectTypes:
              description: Specifies one or more Cassandra object types to be searched.
              type: array
              items:
                type: string
                enum:
                - CassandraKeyspaces
                - CassandraTables
              x-order: 1
            searchString:
              description: Specifies the search string to search the Cassandra Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 2
        couchbaseParams:
          description: Specifies the parameters which are specific for searching Couchbase
            objects.
          type: object
          required:
          - searchString
          - couchbaseObjectTypes
          properties:
            couchbaseObjectTypes:
              description: Specifies Couchbase object types be searched. For Couchbase
                it can only be set to 'CouchbaseBuckets'.
              type: array
              items:
                type: string
                enum:
                - CouchbaseBuckets
              x-order: 1
            searchString:
              description: Specifies the search string to search the Couchbase Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 3
        hbaseParams:
          description: Specifies the parameters which are specific for searching Hbase
            objects.
          type: object
          required:
          - searchString
          - hbaseObjectTypes
          properties:
            hbaseObjectTypes:
              description: Specifies one or more Hbase object types be searched.
              type: array
              items:
                type: string
                enum:
                - HbaseNamespaces
                - HbaseTables
              x-order: 1
            searchString:
              description: Specifies the search string to search the Hbase Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 4
        hiveParams:
          description: Specifies the parameters which are specific for searching Hive
            objects.
          type: object
          required:
          - searchString
          - hiveObjectTypes
          properties:
            hiveObjectTypes:
              description: Specifies one or more Hive object types be searched.
              type: array
              items:
                type: string
                enum:
                - HiveDatabases
                - HiveTables
                - HivePartitions
              x-order: 1
            searchString:
              description: Specifies the search string to search the Hive Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 5
        mongodbParams:
          description: Specifies the parameters which are specific for searching MongoDB
            objects.
          type: object
          required:
          - searchString
          - mongodbObjectTypes
          properties:
            mongoDBObjectTypes:
              description: Specifies one or more MongoDB object types be searched.
              type: array
              items:
                type: string
                enum:
                - MongoDatabases
                - MongoCollections
              x-order: 1
            searchString:
              description: Specifies the search string to search the MongoDB Objects
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 6
        hdfsParams:
          description: Specifies the parameters for searching HDFS Folders and Files.
          type: object
          required:
          - searchString
          - HDFSTypes
          properties:
            hdfsTypes:
              description: Specifies types as Folders or Files or both to be searched.
              type: array
              items:
                type: string
                enum:
                - HDFSFolders
                - HDFSFiles
              x-order: 1
            searchString:
              description: Specifies the search string to search the HDFS Folders
                and Files.
              type: string
              x-nullable: true
              x-order: 0
            sourceIds:
              description: Specifies a list of source ids. Only objects found in these
                sources will be returned.
              type: array
              uniqueItems: true
              items:
                type: integer
                format: int64
              x-nullable: true
              x-order: 2
          x-order: 7
        exchangeParams:
          description: Specifies the parameters which are specific for searching Exchange
            mailboxes.
          type: object
          required:
          - searchString
          properties:
            searchString:
              description: Specifies the search string to search the Exchange Objects
              type: string
              x-nullable: true
              x-order: 0
          x-order: 8
        publicFolderParams:
          description: Specifies the parameters which are specific for searching Public
            folder items.
          type: object
          allOf:
          - $ref: '#/definitions/SearchPublicFolderRequestParams'
          - x-nullable: true
          x-cohesity-discriminator-value: PublicFolders
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/SearchPublicFolderRequestParams'
  CommonSearchIndexedObjectsRequestParams63f295a7-5815-41d3-ba77-8be105cc8153:
    description: Specifies the common params to search for indexed objects.
    type: object
    title: Common Search Indexed Objects Params
    required:
    - objectType
    properties:
      protectionGroupIds:
        description: Specifies a list of Protection Group ids to filter the indexed
          objects. If specified, the objects indexed by specified Protection Group
          ids will be returned.
        type: array
        items:
          type: string
        x-nullable: true
        x-order: 0
      storageDomainIds:
        description: Specifies the Storage Domain ids to filter indexed objects for
          which Protection Groups are writing data to Cohesity Views on the specified
          Storage Domains.
        type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        x-order: 1
      tenantId:
        description: TenantId contains id of the tenant for which objects are to be
          returned.
        type: string
        x-nullable: true
        x-order: 2
      includeTenants:
        description: If true, the response will include objects which belongs to all
          tenants which the current user has permission to see. Default value is false.
        type: boolean
        default: false
        x-nullable: true
        x-order: 3
      tags:
        description: '"This field is deprecated. Please use mightHaveTagIds."'
        type: array
        uniqueItems: true
        items:
          type: string
        x-nullable: true
        x-order: 4
      snapshotTags:
        description: '"This field is deprecated. Please use mightHaveSnapshotTagIds."'
        type: array
        items:
          type: string
        x-order: 5
      mustHaveTagIds:
        description: Specifies tags which must be all present in the document.
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 6
      mightHaveTagIds:
        description: 'Specifies list of tags, one or more of which might be present
          in the

          document. These are OR''ed together and the resulting criteria AND''ed

          with the rest of the query.'
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 7
      mustHaveSnapshotTagIds:
        description: Specifies snapshot tags which must be all present in the document.
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 8
      mightHaveSnapshotTagIds:
        description: 'Specifies list of snapshot tags, one or more of which might
          be

          present in the document. These are OR''ed together and the resulting

          criteria AND''ed with the rest of the query.'
        type: array
        uniqueItems: true
        items:
          type: string
          pattern: ^\d+:\d+:[A-Z0-9-]+$
        x-nullable: true
        x-order: 9
      paginationCookie:
        description: Specifies the pagination cookie with which subsequent parts of
          the response can be fetched.
        type: string
        x-nullable: true
        x-order: 10
      count:
        description: Specifies the number of indexed objects to be fetched for the
          specified pagination cookie.
        type: integer
        format: int32
        x-nullable: true
        x-order: 11
      objectType:
        description: Specifies the object type to be searched for.
        type: string
        enum:
        - Emails
        - Files
        - CassandraObjects
        - CouchbaseObjects
        - HbaseObjects
        - HiveObjects
        - MongoObjects
        - HDFSObjects
        - ExchangeObjects
        - PublicFolders
        x-order: 12
  CommonSearchIndexedObjectsRequestParams63f295a7-5815-41d3-ba77-8be105cc8153SearchEmailRequestParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSearchIndexedObjectsRequestParams63f295a7-5815-41d3-ba77-8be105cc8153'
    - properties:
        emailParams:
          $ref: '#/definitions/SearchEmailRequestParams'
      type: object
  CommonSearchIndexedObjectsRequestParams63f295a7-5815-41d3-ba77-8be105cc8153SearchFileRequestParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSearchIndexedObjectsRequestParams63f295a7-5815-41d3-ba77-8be105cc8153'
    - properties:
        fileParams:
          $ref: '#/definitions/SearchFileRequestParams'
      type: object
  CommonSearchIndexedObjectsRequestParams63f295a7-5815-41d3-ba77-8be105cc8153SearchPublicFolderRequestParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSearchIndexedObjectsRequestParams63f295a7-5815-41d3-ba77-8be105cc8153'
    - properties:
        publicFolderParams:
          $ref: '#/definitions/SearchPublicFolderRequestParams'
      type: object
  SourceRegistrationRequestParams9c89a679-9d21-45c9-89c0-55f40b1f0790:
    description: Specifies the Source Registration parameters.
    title: Source Registration parameters.
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters to register a VMware Protection Source.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareSourceRegistrationParams'
        physicalParams:
          description: Specifies the parameters to register a Physical Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
        genericNasParams:
          description: Specifies the parameters to register a Generic Nas Source.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/GenericNasRegistrationParams'
        isilonParams:
          description: Specifies the parameters to register an Isilon Source.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/IsilonRegistrationParams'
        netappParams:
          description: Specifies the parameters to register an Netapp Source.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/NetappRegistrationParams'
        elastifileParams:
          description: Specifies the parameters to register an Elastifile Source.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ElastifileRegistrationParams'
        flashbladeParams:
          description: Specifies the parameters to register an Flashblade Source.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/FlashbladeRegistrationParams'
        gpfsParams:
          description: Specifies the parameters to register an GPFS Source.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/GpfsRegistrationParams'
        cassandraParams:
          description: Specifies the parameters to register a Cassandra Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/CassandraSourceRegistrationParams'
        mongodbParams:
          description: Specifies the parameters to register a MongoDB Protection Source.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
        couchbaseParams:
          description: Specifies the parameters to register a Couchbase Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
        hdfsParams:
          description: Specifies the parameters to register an HDFS Protection Source.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/HdfsSourceRegistrationParams'
        hbaseParams:
          description: Specifies the parameters to register an HBase Protection Source.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/HbaseSourceRegistrationParams'
        hiveParams:
          description: Specifies the parameters to register a Hive Protection Source.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/HiveSourceRegistrationParams'
        udaParams:
          description: Specifies the parameters to register a Universal Data Adapter
            Protection Source.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/UdaSourceRegistrationParams'
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a:
    description: Specifies the parameters which are common between all Protection
      Source registrations.
    type: object
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Protection Source.
        type: string
        enum:
        - kVMware
        - kHyperV
        - kAcropolis
        - kKVM
        - kAWS
        - kGCP
        - kAzure
        - kPhysical
        - kPure
        - kNimble
        - kNetapp
        - kGenericNas
        - kIsilon
        - kFlashBlade
        - kGPFS
        - kElastifile
        - kO365
        - kHyperFlex
        - kKubernetes
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        x-nullable: true
        x-order: 0
      isInternalEncrypted:
        description: Specifies if credentials are encrypted by internal key.
        type: boolean
        x-nullable: true
        x-order: 1
      encryptionKey:
        description: Specifies the key that user has encrypted the credential with.
        type: string
        x-nullable: true
        x-order: 2
      connectionId:
        description: Specifies the id of the connection from where this source is
          reachable. This should only be set for a source being registered by a tenant
          user.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
    x-cohesity-discriminator-details:
      propertyName: environment
    x-discriminator:
      mapping:
        kVMware: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aVmwareSourceRegistrationParamsWrapper'
        kPhysical: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aPhysicalSourceRegistrationParamsWrapper'
        kGenericNas: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aGenericNasRegistrationParamsWrapper'
        kIsilon: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aIsilonRegistrationParamsWrapper'
        kNetapp: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aNetappRegistrationParamsWrapper'
        kElastifile: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aElastifileRegistrationParamsWrapper'
        kFlashBlade: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aFlashbladeRegistrationParamsWrapper'
        kGPFS: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aGpfsRegistrationParamsWrapper'
        kCassandra: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aCassandraSourceRegistrationParamsWrapper'
        kMongoDB: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aMongoDBSourceRegistrationParamsWrapper'
        kCouchbase: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aCouchbaseSourceRegistrationParamsWrapper'
        kHdfs: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aHdfsSourceRegistrationParamsWrapper'
        kHBase: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aHbaseSourceRegistrationParamsWrapper'
        kHive: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aHiveSourceRegistrationParamsWrapper'
        kUDA: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aUdaSourceRegistrationParamsWrapper'
      propertyName: environment
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aVmwareSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        vmwareParams:
          $ref: '#/definitions/VmwareSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aPhysicalSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        physicalParams:
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aGenericNasRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        genericNasParams:
          $ref: '#/definitions/GenericNasRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aIsilonRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        isilonParams:
          $ref: '#/definitions/IsilonRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aNetappRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        netappParams:
          $ref: '#/definitions/NetappRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aElastifileRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        elastifileParams:
          $ref: '#/definitions/ElastifileRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aFlashbladeRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        flashbladeParams:
          $ref: '#/definitions/FlashbladeRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aGpfsRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        gpfsParams:
          $ref: '#/definitions/GpfsRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aCassandraSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        cassandraParams:
          $ref: '#/definitions/CassandraSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aMongoDBSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        mongodbParams:
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aCouchbaseSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        couchbaseParams:
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aHdfsSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        hdfsParams:
          $ref: '#/definitions/HdfsSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aHbaseSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        hbaseParams:
          $ref: '#/definitions/HbaseSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aHiveSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        hiveParams:
          $ref: '#/definitions/HiveSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87aUdaSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParamsb9726d9f-8d6d-4c74-a31c-ad36a91fc87a'
    - properties:
        udaParams:
          $ref: '#/definitions/UdaSourceRegistrationParams'
      type: object
  SourceRegistrationUpdateRequestParams3d4c8358-b0ad-4ec5-9070-dca4c6cb7305:
    description: Specifies the Source registration Update request parameters.
    title: Source Registration update parameters.
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters to register a VMware Protection Source.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareSourceRegistrationParams'
        physicalParams:
          description: Specifies the parameters to register a Physical Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
        genericNasParams:
          description: Specifies the parameters to register a Generic Nas Source.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/GenericNasRegistrationParams'
        isilonParams:
          description: Specifies the parameters to register an Isilon Source.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/IsilonRegistrationParams'
        netappParams:
          description: Specifies the parameters to register an Netapp Source.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/NetappRegistrationParams'
        elastifileParams:
          description: Specifies the parameters to register an Elastifile Source.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ElastifileRegistrationParams'
        flashbladeParams:
          description: Specifies the parameters to register an Flashblade Source.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/FlashbladeRegistrationParams'
        gpfsParams:
          description: Specifies the parameters to register an GPFS Source.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/GpfsRegistrationParams'
        cassandraParams:
          description: Specifies the parameters to update the registration of a Cassandra
            Protection Source.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/CassandraSourceRegistrationParams'
        mongodbParams:
          description: Specifies the parameters to register a MongoDB Protection Source.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
        couchbaseParams:
          description: Specifies the parameters to register a Couchbase Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
        hdfsParams:
          description: Specifies the parameters to update registration of an HDFS
            Protection Source. Update for HDFS supports two operations - Reconfigure
            and Update Kerberos. For the Reconfigure operation you have to specify
            host, config directory and either SSHCredentials or SSHPrivateKey. All
            other fields in the request will be ignored. For the Update Kerberos operation
            you should set only the Kerberos field and not set any other field.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/HdfsSourceRegistrationParams'
        hbaseParams:
          description: Specifies the parameters to update registration of an Hbase
            Protection Source. Update Hbase supports two operations - Reconfigure
            and Update Kerberos. For the Reconfigure operation you have to specify
            host, config directory and either SSHCredentials or SSHPrivateKey. All
            other fields in the request will be ignored. For the Update Kerberos operation
            you should set only the Kerberos field and not set any other field.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/HbaseSourceRegistrationParams'
        hiveParams:
          description: Specifies the parameters to update registration of an Hive
            Protection Source. Update Hive supports two operations - Reconfigure and
            Update Kerberos. For the Reconfigure operation you have to specify host,
            config directory and either SSHCredentials or SSHPrivateKey. All other
            fields in the request will be ignored. For the Update Kerberos operation
            you should set only the Kerberos field and not set any other field.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/HiveSourceRegistrationParams'
        udaParams:
          description: Specifies the parameters to update the registration of a Universal
            Data Adapter Protection Source.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/UdaSourceRegistrationParams'
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4:
    description: Specifies the parameters which are common between all Protection
      Source registrations.
    type: object
    required:
    - environment
    properties:
      environment:
        description: Specifies the environment type of the Protection Source.
        type: string
        enum:
        - kVMware
        - kHyperV
        - kAcropolis
        - kKVM
        - kAWS
        - kGCP
        - kAzure
        - kPhysical
        - kPure
        - kNimble
        - kNetapp
        - kGenericNas
        - kIsilon
        - kFlashBlade
        - kGPFS
        - kElastifile
        - kO365
        - kHyperFlex
        - kKubernetes
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        x-nullable: true
        x-order: 0
      isInternalEncrypted:
        description: Specifies if credentials are encrypted by internal key.
        type: boolean
        x-nullable: true
        x-order: 1
      encryptionKey:
        description: Specifies the key that user has encrypted the credential with.
        type: string
        x-nullable: true
        x-order: 2
      connectionId:
        description: Specifies the id of the connection from where this source is
          reachable. This should only be set for a source being registered by a tenant
          user.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
    x-cohesity-discriminator-details:
      propertyName: environment
    x-discriminator:
      mapping:
        kVMware: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4VmwareSourceRegistrationParamsWrapper'
        kPhysical: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4PhysicalSourceRegistrationParamsWrapper'
        kGenericNas: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4GenericNasRegistrationParamsWrapper'
        kIsilon: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4IsilonRegistrationParamsWrapper'
        kNetapp: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4NetappRegistrationParamsWrapper'
        kElastifile: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4ElastifileRegistrationParamsWrapper'
        kFlashBlade: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4FlashbladeRegistrationParamsWrapper'
        kGPFS: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4GpfsRegistrationParamsWrapper'
        kCassandra: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4CassandraSourceRegistrationParamsWrapper'
        kMongoDB: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4MongoDBSourceRegistrationParamsWrapper'
        kCouchbase: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4CouchbaseSourceRegistrationParamsWrapper'
        kHdfs: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HdfsSourceRegistrationParamsWrapper'
        kHBase: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HbaseSourceRegistrationParamsWrapper'
        kHive: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HiveSourceRegistrationParamsWrapper'
        kUDA: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4UdaSourceRegistrationParamsWrapper'
      propertyName: environment
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4VmwareSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        vmwareParams:
          $ref: '#/definitions/VmwareSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4PhysicalSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        physicalParams:
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4GenericNasRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        genericNasParams:
          $ref: '#/definitions/GenericNasRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4IsilonRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        isilonParams:
          $ref: '#/definitions/IsilonRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4NetappRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        netappParams:
          $ref: '#/definitions/NetappRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4ElastifileRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        elastifileParams:
          $ref: '#/definitions/ElastifileRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4FlashbladeRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        flashbladeParams:
          $ref: '#/definitions/FlashbladeRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4GpfsRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        gpfsParams:
          $ref: '#/definitions/GpfsRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4CassandraSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        cassandraParams:
          $ref: '#/definitions/CassandraSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4MongoDBSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        mongodbParams:
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4CouchbaseSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        couchbaseParams:
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HdfsSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        hdfsParams:
          $ref: '#/definitions/HdfsSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HbaseSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        hbaseParams:
          $ref: '#/definitions/HbaseSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HiveSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        hiveParams:
          $ref: '#/definitions/HiveSourceRegistrationParams'
      type: object
  CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4UdaSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4'
    - properties:
        udaParams:
          $ref: '#/definitions/UdaSourceRegistrationParams'
      type: object
  CreateOrUpdateDataTieringTaskRequest6b283162-c0fd-4057-8c86-6b1ac74dfae3:
    description: Specifies the request to create or update a data tiering task.
    title: Create Or Update data tiering task Request.
    allOf:
    - {}
    - type: object
      properties:
        downtieringPolicy:
          description: Specifies downtiering policy for Data Tiering
          type: object
          x-cohesity-discriminator-value: Downtier
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/DowntieringPolicy'
        uptieringPolicy:
          description: Specifies uptiering policy for Data Tiering
          type: object
          x-cohesity-discriminator-value: Uptier
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/UptieringPolicy'
  CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396e:
    description: Specifies the data tiering task details.
    type: object
    required:
    - name
    - type
    properties:
      name:
        description: Specifies the name of the data tiering task.
        type: string
        x-nullable: true
        x-order: 0
      description:
        description: Specifies a description of the data tiering task.
        type: string
        x-nullable: true
        x-order: 1
      alertPolicy:
        description: Specifies the alerting policy for the data tiering task.
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      source:
        description: Specifies source for data tiering.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/DataTieringSource'
      target:
        description: Specifies target for data tiering
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/DataTieringTarget'
      schedule:
        description: Specifies schedule for data tiering
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/DataTieringSchedule'
      type:
        description: 'Type of data tiering task.

          ''Downtier'' indicates downtiering task.

          ''Uptier'' indicates uptiering task.'
        type: string
        enum:
        - Downtier
        - Uptier
        x-nullable: true
        x-order: 6
    x-cohesity-discriminator-details:
      propertyName: type
    x-discriminator:
      mapping:
        Downtier: '#/definitions/CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396eDowntieringPolicyWrapper'
        Uptier: '#/definitions/CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396eUptieringPolicyWrapper'
      propertyName: type
  CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396eDowntieringPolicyWrapper:
    allOf:
    - $ref: '#/definitions/CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396e'
    - properties:
        downtieringPolicy:
          $ref: '#/definitions/DowntieringPolicy'
      type: object
  CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396eUptieringPolicyWrapper:
    allOf:
    - $ref: '#/definitions/CommonDataTieringTaskParams5edf51bd-907d-4ee5-a931-bf9b9e2e396e'
    - properties:
        uptieringPolicy:
          $ref: '#/definitions/UptieringPolicy'
      type: object
  CreateTdmTaskRequestb73b543c-beaa-4a65-972c-de46d88e905f:
    description: Specifies the request parameters to create a TDM task.
    type: object
    allOf:
    - {}
    - type: object
      properties:
        cloneParams:
          x-cohesity-discriminator-value: clone
          x-order: 0
          $ref: '#/definitions/TdmCloneTaskRequestParams'
        snapshotParams:
          x-cohesity-discriminator-value: snapshot
          x-order: 1
          $ref: '#/definitions/TdmSnapshotTaskParams'
        refreshParams:
          x-cohesity-discriminator-value: refresh
          x-order: 2
          $ref: '#/definitions/TdmRefreshTaskRequestParams'
        teardownParams:
          x-cohesity-discriminator-value: teardown
          x-order: 3
          $ref: '#/definitions/TdmTeardownTaskRequestParams'
  CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1:
    description: Specifies the common parameters used in TDM Task Creation.
    type: object
    required:
    - action
    properties:
      name:
        description: Specifies the name of the task.
        type: string
        x-nullable: true
        x-order: 0
      action:
        description: Specifies the TDM Task action.
        type: string
        enum:
        - clone
        - teardown
        - refresh
        - snapshot
        - rewind
        x-nullable: true
        x-order: 1
    x-cohesity-discriminator-details:
      propertyName: action
    x-discriminator:
      mapping:
        clone: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmCloneTaskRequestParamsWrapper'
        snapshot: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmSnapshotTaskParamsWrapper'
        refresh: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmRefreshTaskRequestParamsWrapper'
        teardown: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmTeardownTaskRequestParamsWrapper'
      propertyName: action
  CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmCloneTaskRequestParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1'
    - properties:
        cloneParams:
          $ref: '#/definitions/TdmCloneTaskRequestParams'
      type: object
  CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmSnapshotTaskParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1'
    - properties:
        snapshotParams:
          $ref: '#/definitions/TdmSnapshotTaskParams'
      type: object
  CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmRefreshTaskRequestParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1'
    - properties:
        refreshParams:
          $ref: '#/definitions/TdmRefreshTaskRequestParams'
      type: object
  CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1TdmTeardownTaskRequestParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmTaskRequestParams4b65913c-05f2-4bdd-b9d7-66a297c749d1'
    - properties:
        teardownParams:
          $ref: '#/definitions/TdmTeardownTaskRequestParams'
      type: object
  Recovery62c065af-935c-465c-8afd-4a6ad210b8d4:
    description: Specifies a Recovery.
    title: Recovery.
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams'
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverVmwareParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/RecoverVmwareParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAwsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/RecoverAwsParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGcpParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/RecoverGcpParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAzureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/RecoverAzureParams'
        kvmParams:
          description: Specifies the parameters which are specific to KVM related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKvmParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/RecoverKvmParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAcropolisParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/RecoverAcropolisParams'
        mssqlParams:
          description: Specifies the parameters which are specific to MsSQL related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverSqlParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/RecoverSqlParams'
        netappParams:
          description: Specifies the parameters which are specific to Netapp related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverNetappParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/RecoverNetappParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic NAS
            related Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGenericNasParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/RecoverGenericNasParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverIsilonParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/RecoverIsilonParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to FlashBlade related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverFlashbladeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/RecoverFlashbladeParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverElastifileParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/RecoverElastifileParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGpfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/RecoverGpfsParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPhysicalParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/RecoverPhysicalParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverHyperVParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/RecoverHyperVParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchange related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverExchangeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/RecoverExchangeParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CassandraParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/CassandraParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/UdaParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/UdaParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CouchbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/CouchbaseParams'
        hbaseParams:
          description: Specifies the parameters which are specific to Hbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHbase
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/HbaseParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HdfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/HdfsParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HiveParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/HiveParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/MongodbParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/MongodbParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/RecoverPureParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverO365Params'
          - x-nullable: true
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/RecoverO365Params'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKubernetesParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/RecoverKubernetesParams'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverOracleParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/RecoverOracleParams'
        viewParams:
          description: Specifies the parameters which are specific to View related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverViewParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kView
          x-nullable: true
          x-order: 27
          $ref: '#/definitions/RecoverViewParams'
  DownloadFilesAndFoldersResponseParamsfee4eb61-b964-4ead-9a9b-8c5c004a1104:
    description: Specifies the parameters to create a download files and folders Recovery.
    type: object
    title: Download Files And Folders Recovery Params.
    properties:
      id:
        description: Specifies the id of the Recovery.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the recovery task. This field must be set
          and must be a unique name.
        type: string
        x-nullable: true
        x-order: 1
      object:
        description: Specifies the snapshot object from which to download files and
          folders.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/CommonRecoverObjectSnapshotParams'
      filesAndFolders:
        description: Specifies the list of files and folders to download.
        type: array
        minItems: 1
        items:
          $ref: '#/definitions/FilesAndFoldersObject'
        x-nullable: true
        x-order: 3
  ProtectionGroupe6b49627-cebf-46ba-9106-033cdc32c2c3:
    description: Protection Group  response.
    type: object
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareProtectionGroupParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/AcropolisProtectionGroupParams'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/KubernetesProtectionGroupParams'
        mssqlParams:
          description: Specifies the parameters specific to MSSQL Protection Group.
          type: object
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/MSSQLProtectionGroupParams'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle Protection
            Group.
          type: object
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/OracleProtectionGroupParams'
        viewParams:
          description: Specifies the parameters which are specific to View related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kView
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ViewProtectionGroupParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/PureProtectionGroupParams'
        nimbleParams:
          description: Specifies the parameters which are specific to Nimble related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNimble
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/NimbleProtectionGroupParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/HyperVProtectionGroupParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/AwsProtectionGroupParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Protection Group.
          type: object
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/AzureProtectionGroupParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/GcpProtectionGroupParams'
        kvmParams:
          description: Specifies the parameters which are specific to Kvm related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/KvmProtectionGroupParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/PhysicalProtectionGroupParams'
        adParams:
          description: Specifies the parameters which are specific to Active Directory
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kAD
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/ADProtectionGroupParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/Office365ProtectionGroupParams'
        netappParams:
          description: Specifies the parameters which are specific to NetApp related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/NetappProtectionGroupParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic Nas
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/GenericNasProtectionGroupParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/IsilonProtectionGroupParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to Flashblade related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/FlashbladeProtectionGroupParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/GpfsProtectionGroupParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/ElastifileProtectionGroupParams'
        remoteAdapterParams:
          description: Specifies the parameters which are specific to Remote Adapter
            related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kRemoteAdapter
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/RemoteAdapterProtectionGroupParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchangee related
            Protection Groups.
          type: object
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/ExchangeProtectionGroupParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/CassandraProtectionGroupParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/MongoDBProtectionGroupParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 27
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 28
          $ref: '#/definitions/HdfsProtectionGroupParams'
        hbaseParams:
          description: Specifies the parameters which are specific to HBase Protection
            Groups.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 29
          $ref: '#/definitions/NoSqlProtectionGroupParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter related Protection Groups.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 30
          $ref: '#/definitions/UdaProtectionGroupParams'
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801:
    description: Specifies the parameters which are common between all Protection
      Group responses.
    type: object
    properties:
      id:
        description: Specifies the ID of the Protection Group.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the Protection Group.
        type: string
        x-nullable: true
        x-order: 1
      policyId:
        description: Specifies the unique id of the Protection Policy associated with
          the Protection Group. The Policy provides retry settings Protection Schedules,
          Priority, SLA, etc.
        type: string
        x-nullable: true
        x-order: 2
      priority:
        description: Specifies the priority of the Protection Group.
        type: string
        enum:
        - kLow
        - kMedium
        - kHigh
        x-nullable: true
        x-order: 3
      storageDomainId:
        description: Specifies the Storage Domain (View Box) ID where this Protection
          Group writes data.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
      description:
        description: Specifies a description of the Protection Group.
        type: string
        x-nullable: true
        x-order: 5
      startTime:
        description: Specifies the start time for this Protection Group. If no start
          time is specified, the start time will default to 2am. This field is only
          used if the policy has a daily or monthly schedule.
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/TimeOfDay'
      endTimeUsecs:
        description: Specifies the end time in micro seconds for this Protection Group.
          If this is not specified, the Protection Group won't be ended.
        type: integer
        format: int64
        x-nullable: true
        x-order: 7
      alertPolicy:
        description: Specifies the alerting policy for this Protection Group.
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      sla:
        description: Specifies the SLA parameters for this Protection Group.
        type: array
        items:
          $ref: '#/definitions/SlaRule'
        x-nullable: true
        x-order: 9
      qosPolicy:
        description: Specifies whether the Protection Group will be written to HDD
          or SSD.
        type: string
        enum:
        - kBackupHDD
        - kBackupSSD
        - kTestAndDevHigh
        - kBackupAll
        x-nullable: true
        x-order: 10
      abortInBlackouts:
        description: Specifies whether currently executing jobs should abort if a
          blackout period specified by a policy starts. Available only if the selected
          policy has at least one blackout period. Default value is false.
        type: boolean
        x-nullable: true
        x-order: 11
      isActive:
        description: Specifies if the Protection Group is active or not.
        type: boolean
        x-nullable: true
        x-order: 12
      isDeleted:
        description: Specifies if the Protection Group has been deleted.
        type: boolean
        x-nullable: true
        x-order: 13
      isPaused:
        description: Specifies if the the Protection Group is paused. New runs are
          not scheduled for the paused Protection Groups. Active run if any is not
          impacted.
        type: boolean
        x-nullable: true
        x-order: 14
      environment:
        description: Specifies the environment of the Protection Group.
        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-nullable: true
        x-order: 15
      lastRun:
        description: Specifies information about the last run for this Protection
          Group.
        x-nullable: true
        x-order: 16
        $ref: '#/definitions/ProtectionGroupRun'
      permissions:
        description: Specifies the list of tenants that have permissions for this
          protection group.
        type: array
        items:
          $ref: '#/definitions/Tenant'
        x-nullable: true
        x-order: 17
      isProtectOnce:
        description: Specifies if the the Protection Group is using a protect once
          type of policy. This field is helpful to identify run happen for this group.
        type: boolean
        x-nullable: true
        x-order: 18
    x-cohesity-discriminator-details:
      propertyName: environment
    x-discriminator:
      mapping:
        kVMware: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801VmwareProtectionGroupParamsWrapper'
        kAcropolis: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801AcropolisProtectionGroupParamsWrapper'
        kKubernetes: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801KubernetesProtectionGroupParamsWrapper'
        kSQL: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801MSSQLProtectionGroupParamsWrapper'
        kOracle: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801OracleProtectionGroupParamsWrapper'
        kView: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ViewProtectionGroupParamsWrapper'
        kPure: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801PureProtectionGroupParamsWrapper'
        kNimble: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NimbleProtectionGroupParamsWrapper'
        kHyperV: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801HyperVProtectionGroupParamsWrapper'
        kAWS: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801AwsProtectionGroupParamsWrapper'
        kAzure: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801AzureProtectionGroupParamsWrapper'
        kGCP: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801GcpProtectionGroupParamsWrapper'
        kKVM: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801KvmProtectionGroupParamsWrapper'
        kPhysical: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801PhysicalProtectionGroupParamsWrapper'
        kAD: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ADProtectionGroupParamsWrapper'
        kO365: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801Office365ProtectionGroupParamsWrapper'
        kNetapp: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NetappProtectionGroupParamsWrapper'
        kGenericNas: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801GenericNasProtectionGroupParamsWrapper'
        kIsilon: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801IsilonProtectionGroupParamsWrapper'
        kFlashBlade: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801FlashbladeProtectionGroupParamsWrapper'
        kGPFS: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801GpfsProtectionGroupParamsWrapper'
        kElastifile: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ElastifileProtectionGroupParamsWrapper'
        kRemoteAdapter: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801RemoteAdapterProtectionGroupParamsWrapper'
        kExchange: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ExchangeProtectionGroupParamsWrapper'
        kCassandra: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801CassandraProtectionGroupParamsWrapper'
        kCouchbase: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NoSqlProtectionGroupParamsWrapper'
        kMongoDB: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801MongoDBProtectionGroupParamsWrapper'
        kHive: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NoSqlProtectionGroupParamsWrapper'
        kHdfs: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801HdfsProtectionGroupParamsWrapper'
        kHBase: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NoSqlProtectionGroupParamsWrapper'
        kUDA: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801UdaProtectionGroupParamsWrapper'
      propertyName: environment
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801VmwareProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        vmwareParams:
          $ref: '#/definitions/VmwareProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801AcropolisProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        acropolisParams:
          $ref: '#/definitions/AcropolisProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801KubernetesProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        kubernetesParams:
          $ref: '#/definitions/KubernetesProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801MSSQLProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        mssqlParams:
          $ref: '#/definitions/MSSQLProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801OracleProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        oracleParams:
          $ref: '#/definitions/OracleProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ViewProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        viewParams:
          $ref: '#/definitions/ViewProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801PureProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        pureParams:
          $ref: '#/definitions/PureProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NimbleProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        nimbleParams:
          $ref: '#/definitions/NimbleProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801HyperVProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        hypervParams:
          $ref: '#/definitions/HyperVProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801AwsProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        awsParams:
          $ref: '#/definitions/AwsProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801AzureProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        azureParams:
          $ref: '#/definitions/AzureProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801GcpProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        gcpParams:
          $ref: '#/definitions/GcpProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801KvmProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        kvmParams:
          $ref: '#/definitions/KvmProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801PhysicalProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        physicalParams:
          $ref: '#/definitions/PhysicalProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ADProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        adParams:
          $ref: '#/definitions/ADProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801Office365ProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        office365Params:
          $ref: '#/definitions/Office365ProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NetappProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        netappParams:
          $ref: '#/definitions/NetappProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801GenericNasProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        genericNasParams:
          $ref: '#/definitions/GenericNasProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801IsilonProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        isilonParams:
          $ref: '#/definitions/IsilonProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801FlashbladeProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        flashbladeParams:
          $ref: '#/definitions/FlashbladeProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801GpfsProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        gpfsParams:
          $ref: '#/definitions/GpfsProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ElastifileProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        elastifileParams:
          $ref: '#/definitions/ElastifileProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801RemoteAdapterProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        remoteAdapterParams:
          $ref: '#/definitions/RemoteAdapterProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801ExchangeProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        exchangeParams:
          $ref: '#/definitions/ExchangeProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801CassandraProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        cassandraParams:
          $ref: '#/definitions/CassandraProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801NoSqlProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        hbaseParams:
          $ref: '#/definitions/NoSqlProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801MongoDBProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        mongodbParams:
          $ref: '#/definitions/MongoDBProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801HdfsProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        hdfsParams:
          $ref: '#/definitions/HdfsProtectionGroupParams'
      type: object
  CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801UdaProtectionGroupParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonProtectionGroupResponseParamsfd9f614e-2c28-46ff-a431-2430d1548801'
    - properties:
        udaParams:
          $ref: '#/definitions/UdaProtectionGroupParams'
      type: object
  Recovery65dc707a-59b2-458c-8df1-93f41136db6a:
    description: Specifies a Recovery.
    title: Recovery.
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverVmwareParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/RecoverVmwareParams'
        awsParams:
          description: Specifies the parameters which are specific to AWS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAwsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAWS
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/RecoverAwsParams'
        gcpParams:
          description: Specifies the parameters which are specific to GCP related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGcpParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGCP
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/RecoverGcpParams'
        azureParams:
          description: Specifies the parameters which are specific to Azure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAzureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAzure
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/RecoverAzureParams'
        kvmParams:
          description: Specifies the parameters which are specific to KVM related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKvmParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKVM
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/RecoverKvmParams'
        acropolisParams:
          description: Specifies the parameters which are specific to Acropolis related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverAcropolisParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kAcropolis
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/RecoverAcropolisParams'
        mssqlParams:
          description: Specifies the parameters which are specific to MsSQL related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverSqlParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kSQL
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/RecoverSqlParams'
        netappParams:
          description: Specifies the parameters which are specific to Netapp related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverNetappParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/RecoverNetappParams'
        genericNasParams:
          description: Specifies the parameters which are specific to Generic NAS
            related Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGenericNasParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/RecoverGenericNasParams'
        isilonParams:
          description: Specifies the parameters which are specific to Isilon related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverIsilonParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/RecoverIsilonParams'
        flashbladeParams:
          description: Specifies the parameters which are specific to FlashBlade related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverFlashbladeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/RecoverFlashbladeParams'
        elastifileParams:
          description: Specifies the parameters which are specific to Elastifile related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverElastifileParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/RecoverElastifileParams'
        gpfsParams:
          description: Specifies the parameters which are specific to GPFS related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverGpfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/RecoverGpfsParams'
        physicalParams:
          description: Specifies the parameters which are specific to Physical related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPhysicalParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/RecoverPhysicalParams'
        hypervParams:
          description: Specifies the parameters which are specific to HyperV related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverHyperVParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHyperV
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/RecoverHyperVParams'
        exchangeParams:
          description: Specifies the parameters which are specific to Exchange related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverExchangeParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kExchange
          x-nullable: true
          x-order: 15
          $ref: '#/definitions/RecoverExchangeParams'
        cassandraParams:
          description: Specifies the parameters which are specific to Cassandra Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CassandraParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 16
          $ref: '#/definitions/CassandraParams'
        udaParams:
          description: Specifies the parameters which are specific to Universal Data
            Adapter Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/UdaParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 17
          $ref: '#/definitions/UdaParams'
        couchbaseParams:
          description: Specifies the parameters which are specific to Couchbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/CouchbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 18
          $ref: '#/definitions/CouchbaseParams'
        hbaseParams:
          description: Specifies the parameters which are specific to Hbase Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HbaseParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHbase
          x-nullable: true
          x-order: 19
          $ref: '#/definitions/HbaseParams'
        hdfsParams:
          description: Specifies the parameters which are specific to HDFS Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HdfsParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 20
          $ref: '#/definitions/HdfsParams'
        hiveParams:
          description: Specifies the parameters which are specific to Hive Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/HiveParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 21
          $ref: '#/definitions/HiveParams'
        mongodbParams:
          description: Specifies the parameters which are specific to MongoDB Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/MongodbParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 22
          $ref: '#/definitions/MongodbParams'
        pureParams:
          description: Specifies the parameters which are specific to Pure related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverPureParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kPure
          x-nullable: true
          x-order: 23
          $ref: '#/definitions/RecoverPureParams'
        office365Params:
          description: Specifies the parameters which are specific to Office 365 related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverO365Params'
          - x-nullable: true
          x-cohesity-discriminator-value: kO365
          x-nullable: true
          x-order: 24
          $ref: '#/definitions/RecoverO365Params'
        kubernetesParams:
          description: Specifies the parameters which are specific to Kubernetes related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverKubernetesParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kKubernetes
          x-nullable: true
          x-order: 25
          $ref: '#/definitions/RecoverKubernetesParams'
        oracleParams:
          description: Specifies the parameters which are specific to Oracle related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverOracleParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kOracle
          x-nullable: true
          x-order: 26
          $ref: '#/definitions/RecoverOracleParams'
        viewParams:
          description: Specifies the parameters which are specific to View related
            Recovery.
          type: object
          allOf:
          - $ref: '#/definitions/RecoverViewParams'
          - x-nullable: true
          x-cohesity-discriminator-value: kView
          x-nullable: true
          x-order: 27
          $ref: '#/definitions/RecoverViewParams'
  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
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the Recovery.
        type: string
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the start time of the Recovery in Unix timestamp epoch
          in microseconds.
        type: integer
        format: int64
        x-nullable: true
        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
        format: int64
        x-nullable: true
        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
        enum:
        - Accepted
        - Running
        - Canceled
        - Canceling
        - Failed
        - Missed
        - Succeeded
        - SucceededWithWarning
        - OnHold
        x-nullable: true
        x-order: 4
      progressTaskId:
        description: Progress monitor task id for Recovery.
        type: string
        x-nullable: true
        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
        items:
          $ref: '#/definitions/Tenant'
        x-nullable: true
        x-order: 8
      creationInfo:
        description: Specifies the information about the creation of the recovery.
        type: object
        x-nullable: true
        x-order: 9
        $ref: '#/definitions/CreationInfo'
      canTearDown:
        description: Specifies whether it's possible to tear down the objects created
          by the recovery.
        type: boolean
        x-nullable: true
        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
        enum:
        - DestroyScheduled
        - Destroying
        - Destroyed
        - DestroyError
        x-nullable: true
        x-order: 11
      tearDownMessage:
        description: Specifies the error message about the tear down operation if
          it fails.
        type: string
        x-nullable: true
        x-order: 12
      messages:
        description: Specifies messages about the recovery.
        type: array
        items:
          type: string
        x-nullable: true
        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
        x-nullable: true
        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
        pattern: ^\d+:\d+:\d+$
        x-nullable: true
        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
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverVmwareParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        vmwareParams:
          $ref: '#/definitions/RecoverVmwareParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverAwsParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        awsParams:
          $ref: '#/definitions/RecoverAwsParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverGcpParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        gcpParams:
          $ref: '#/definitions/RecoverGcpParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverAzureParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        azureParams:
          $ref: '#/definitions/RecoverAzureParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverKvmParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        kvmParams:
          $ref: '#/definitions/RecoverKvmParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverAcropolisParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        acropolisParams:
          $ref: '#/definitions/RecoverAcropolisParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverSqlParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        mssqlParams:
          $ref: '#/definitions/RecoverSqlParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverNetappParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        netappParams:
          $ref: '#/definitions/RecoverNetappParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverGenericNasParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        genericNasParams:
          $ref: '#/definitions/RecoverGenericNasParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverIsilonParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        isilonParams:
          $ref: '#/definitions/RecoverIsilonParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverFlashbladeParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        flashbladeParams:
          $ref: '#/definitions/RecoverFlashbladeParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverElastifileParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        elastifileParams:
          $ref: '#/definitions/RecoverElastifileParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverGpfsParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        gpfsParams:
          $ref: '#/definitions/RecoverGpfsParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverPhysicalParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        physicalParams:
          $ref: '#/definitions/RecoverPhysicalParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverHyperVParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        hypervParams:
          $ref: '#/definitions/RecoverHyperVParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverExchangeParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        exchangeParams:
          $ref: '#/definitions/RecoverExchangeParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093CassandraParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        cassandraParams:
          $ref: '#/definitions/CassandraParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093UdaParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        udaParams:
          $ref: '#/definitions/UdaParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093CouchbaseParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        couchbaseParams:
          $ref: '#/definitions/CouchbaseParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093HbaseParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        hbaseParams:
          $ref: '#/definitions/HbaseParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093HdfsParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        hdfsParams:
          $ref: '#/definitions/HdfsParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093HiveParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        hiveParams:
          $ref: '#/definitions/HiveParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093MongodbParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        mongodbParams:
          $ref: '#/definitions/MongodbParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverPureParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        pureParams:
          $ref: '#/definitions/RecoverPureParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverO365ParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        office365Params:
          $ref: '#/definitions/RecoverO365Params'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverKubernetesParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        kubernetesParams:
          $ref: '#/definitions/RecoverKubernetesParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverOracleParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        oracleParams:
          $ref: '#/definitions/RecoverOracleParams'
      type: object
  CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093RecoverViewParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonRecoveryResponseParams335b0a6c-58b8-45e8-b7c1-9a65fb375093'
    - properties:
        viewParams:
          $ref: '#/definitions/RecoverViewParams'
      type: object
  TdmTask544ac02a-1f25-4a93-b2e2-3c5d311526a8:
    description: Specifies a TDM task.
    type: object
    allOf:
    - {}
    - type: object
      properties:
        cloneParams:
          x-cohesity-discriminator-value: clone
          x-order: 0
          $ref: '#/definitions/TdmCloneTaskResponseParams'
        refreshParams:
          x-cohesity-discriminator-value: refresh
          x-order: 1
          $ref: '#/definitions/TdmRefreshTaskResponseParams'
  CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37:
    description: Specifies the common parameters for a TDM task response.
    type: object
    required:
    - id
    - action
    properties:
      id:
        description: Specifies the unique ID of the task.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the task.
        type: string
        x-nullable: true
        x-order: 1
      startTimeUsecs:
        description: Specifies the time (in usecs from epoch) when the task was started.
        type: integer
        format: int64
        x-nullable: true
        x-order: 2
      endTimeUsecs:
        description: Specifies the time (in usecs from epoch) when the task was completed.
        type: integer
        format: int64
        x-nullable: true
        x-order: 3
      status:
        description: Specifies the current status of the task.
        type: string
        enum:
        - scheduled
        - inProgress
        - succeeded
        - failed
        - canceled
        x-nullable: true
        x-order: 4
      action:
        description: Specifies the TDM Task action.
        type: string
        enum:
        - clone
        - teardown
        - refresh
        - snapshot
        - rewind
        x-nullable: true
        x-order: 5
      createdByUser:
        description: Specifies the user, who created this task.
        allOf:
        - $ref: '#/definitions/User'
        x-order: 6
      progressTaskId:
        description: Specifies the ID for tracking progress of this task.
        type: string
        x-nullable: true
        x-order: 7
    x-cohesity-discriminator-details:
      propertyName: action
    x-discriminator:
      mapping:
        clone: '#/definitions/CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37TdmCloneTaskResponseParamsWrapper'
        refresh: '#/definitions/CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37TdmRefreshTaskResponseParamsWrapper'
      propertyName: action
  CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37TdmCloneTaskResponseParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37'
    - properties:
        cloneParams:
          $ref: '#/definitions/TdmCloneTaskResponseParams'
      type: object
  CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37TdmRefreshTaskResponseParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmTaskResponseParams81bccdc8-f441-4a25-a03e-85698b230b37'
    - properties:
        refreshParams:
          $ref: '#/definitions/TdmRefreshTaskResponseParams'
      type: object
  DataTieringTaske4757ef7-f196-45ac-8af6-3c87a236876c:
    description: Specifies the data tiering task details.
    type: object
    allOf:
    - {}
    - type: object
      properties:
        downtieringPolicy:
          description: Specifies downtiering policy for data tiering task.
          type: object
          x-cohesity-discriminator-value: Downtier
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/DowntieringPolicy'
        uptieringPolicy:
          description: Specifies uptiering policy for data tiering task.
          type: object
          x-cohesity-discriminator-value: Uptier
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/UptieringPolicy'
  CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2f:
    description: Specifies the data tiering task details.
    type: object
    required:
    - name
    - type
    properties:
      id:
        description: Specifies the id of the data tiering task.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the data tiering task.
        type: string
        x-nullable: true
        x-order: 1
      description:
        description: Specifies a description of the data tiering task.
        type: string
        x-nullable: true
        x-order: 2
      alertPolicy:
        description: Specifies the alerting policy for the data tiering task.
        x-nullable: true
        x-order: 3
        $ref: '#/definitions/ProtectionGroupAlertingPolicy'
      source:
        description: Specifies source for data tiering.
        x-nullable: true
        x-order: 4
        $ref: '#/definitions/DataTieringSource'
      target:
        description: Specifies target for data tiering
        x-nullable: true
        x-order: 5
        $ref: '#/definitions/DataTieringTarget'
      schedule:
        description: Specifies schedule for data tiering
        x-nullable: true
        x-order: 6
        $ref: '#/definitions/DataTieringSchedule'
      type:
        description: 'Type of data tiering task.

          ''Downtier'' indicates downtiering task.

          ''Uptier'' indicates uptiering task.'
        type: string
        enum:
        - Downtier
        - Uptier
        x-nullable: true
        x-order: 7
      lastRun:
        description: Specifies last run details for data tiering task.
        type: object
        x-nullable: true
        x-order: 8
        $ref: '#/definitions/DataTieringTaskRun'
        readOnly: true
      isActive:
        description: Whether the data tiering task is active or not.
        type: boolean
        default: true
        x-nullable: true
        x-order: 9
      isPaused:
        description: 'Whether the data tiering task is paused. New runs are not scheduled

          for the paused tasks. Active run of the task (if any) is not

          impacted.'
        type: boolean
        default: true
        x-nullable: true
        x-order: 10
      isDeleted:
        description: Tracks whether the backup job has actually been deleted.
        type: boolean
        default: true
        x-nullable: true
        x-order: 11
    x-cohesity-discriminator-details:
      propertyName: type
    x-discriminator:
      mapping:
        Downtier: '#/definitions/CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2fDowntieringPolicyWrapper'
        Uptier: '#/definitions/CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2fUptieringPolicyWrapper'
      propertyName: type
  CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2fDowntieringPolicyWrapper:
    allOf:
    - $ref: '#/definitions/CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2f'
    - properties:
        downtieringPolicy:
          $ref: '#/definitions/DowntieringPolicy'
      type: object
  CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2fUptieringPolicyWrapper:
    allOf:
    - $ref: '#/definitions/CommonDataTieringTaskResponse568f444b-bc54-43a1-acf2-ec3f8b0d9f2f'
    - properties:
        uptieringPolicy:
          $ref: '#/definitions/UptieringPolicy'
      type: object
  Object7ffd1f22-6125-44ac-b697-c93683f472a2:
    description: Specifies information about an object.
    title: Object information
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters which are specific to VMware objects.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareObjectEntityParams'
        isilonParams:
          description: Specifies the parameters for Isilon object.
          allOf:
          - $ref: '#/definitions/IsilonObjectParams'
          - x-nullable: true
          x-order: 1
        netappParams:
          description: Specifies the parameters for NetApp object.
          allOf:
          - $ref: '#/definitions/NetappObjectParams'
          - x-nullable: true
          x-order: 2
        genericNasParams:
          description: Specifies the parameters for GenericNas object.
          allOf:
          - $ref: '#/definitions/CommonNasObjectParams'
          - x-nullable: true
          x-order: 3
        flashbladeParams:
          description: Specifies the parameters for Flashblade object.
          allOf:
          - $ref: '#/definitions/FlashbladeObjectParams'
          - x-nullable: true
          x-order: 4
        elastifileParams:
          description: Specifies the parameters for Elastifile object.
          allOf:
          - $ref: '#/definitions/CommonNasObjectParams'
          - x-nullable: true
          x-order: 5
        gpfsParams:
          description: Specifies the parameters for GPFS object.
          allOf:
          - $ref: '#/definitions/CommonNasObjectParams'
          - x-nullable: true
          x-order: 6
        mssqlParams:
          description: Specifies the parameters for Msssql object.
          allOf:
          - $ref: '#/definitions/MssqlObjectEntityParams'
          - x-nullable: true
          x-order: 7
        oracleParams:
          description: Specifies the parameters for Oracle object.
          allOf:
          - $ref: '#/definitions/OracleObjectEntityParams'
          - x-nullable: true
          x-order: 8
  CommonObjectSummaryf0e8a175-a9e2-409b-8c0e-4b53b0423501:
    description: Specifies an Common summary properties for an object.
    type: object
    title: Common Object Entity Summary.
    x-cohesity-discriminator-details:
      propertyName: environment
    properties:
      id: *id002
      name: *id003
      sourceId: *id004
      sourceName: *id005
      environment: *id006
      objectHash: *id007
      objectType: *id008
      logicalSizeBytes: *id009
      uuid: *id010
      protectionType: *id011
      osType: *id012
      vCenterSummary: *id013
      protectionStats:
        description: Specifies the count and size of protected and unprotected objects
          for the size.
        type: array
        items:
          $ref: '#/definitions/ObjectProtectionStatsSummary'
        x-nullable: true
        x-order: 0
      permissions:
        description: Specifies the list of users, groups and tenants that have permissions
          for this object.
        type: object
        x-order: 1
        $ref: '#/definitions/PermissionInfo'
    x-discriminator:
      mapping:
        kVMware: '#/definitions/CommonObjectSummaryf0e8a175-a9e2-409b-8c0e-4b53b0423501VmwareObjectEntityParamsWrapper'
      propertyName: environment
  CommonObjectSummaryf0e8a175-a9e2-409b-8c0e-4b53b0423501VmwareObjectEntityParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonObjectSummaryf0e8a175-a9e2-409b-8c0e-4b53b0423501'
    - properties:
        vmwareParams:
          $ref: '#/definitions/VmwareObjectEntityParams'
      type: object
  SearchIndexedObjectsResponseBody07843731-d8d4-47fe-b207-b6f5341d1b57:
    description: Specifies the search indexed objects response body.
    title: Search Indexed objects response body.
    allOf:
    - {}
    - type: object
      properties:
        emails:
          description: Specifies the indexed emails and email folders.
          type: array
          items:
            $ref: '#/definitions/Email'
          x-cohesity-discriminator-value: Emails
          x-nullable: true
          x-order: 0
        files:
          description: Specifies the indexed files and file folders.
          type: array
          items:
            $ref: '#/definitions/File'
          x-cohesity-discriminator-value: Files
          x-nullable: true
          x-order: 1
        cassandraObjects:
          description: Specifies the indexed Cassandra objects.
          type: array
          items:
            $ref: '#/definitions/CassandraIndexedObject'
          x-cohesity-discriminator-value: CassandraObjects
          x-nullable: true
          x-order: 2
        couchbaseObjects:
          description: Specifies the indexed Couchbase objects.
          type: array
          items:
            $ref: '#/definitions/CouchbaseIndexedObject'
          x-cohesity-discriminator-value: CouchbaseObjects
          x-nullable: true
          x-order: 3
        hbaseObjects:
          description: Specifies the indexed Hbase objects.
          type: array
          items:
            $ref: '#/definitions/HbaseIndexedObject'
          x-cohesity-discriminator-value: HbaseObjects
          x-nullable: true
          x-order: 4
        hiveObjects:
          description: Specifies the indexed Hive objects.
          type: array
          items:
            $ref: '#/definitions/HiveIndexedObject'
          x-cohesity-discriminator-value: HiveObjects
          x-nullable: true
          x-order: 5
        mongoObjects:
          description: Specifies the indexed Mongo objects.
          type: array
          items:
            $ref: '#/definitions/MongoIndexedObject'
          x-cohesity-discriminator-value: MongoObjects
          x-nullable: true
          x-order: 6
        hdfsObjects:
          description: Specifies the indexed HDFS objects.
          type: array
          items:
            $ref: '#/definitions/HDFSIndexedObject'
          x-cohesity-discriminator-value: HDFSObjects
          x-nullable: true
          x-order: 7
        exchangeObjects:
          description: Specifies the indexed HDFS objects.
          type: array
          items:
            $ref: '#/definitions/ExchangeIndexedObject'
          x-cohesity-discriminator-value: ExchangeObjects
          x-nullable: true
          x-order: 8
        publicFolderItems:
          description: Specifies the indexed Public folder items.
          type: array
          items:
            $ref: '#/definitions/PublicFolderItem'
          x-cohesity-discriminator-value: PublicFolderItems
          x-nullable: true
          x-order: 9
  CommonSearchIndexedObjectsResponseParams0d08f346-9154-4a0c-bff6-28b35e1f53dc:
    description: Specifies the common search indexed objects response params.
    type: object
    title: Common Search Indexed Objects Response Params.
    properties:
      objectType:
        description: Specifies the object type.
        type: string
        enum:
        - Emails
        - Files
        - CassandraObjects
        - CouchbaseObjects
        - HbaseObjects
        - HiveObjects
        - MongoObjects
        - HDFSObjects
        - ExchangeObjects
        - PublicFolders
        x-order: 0
      count:
        description: Specifies the total number of indexed objects that match the
          filter and search criteria. Use this value to determine how many additional
          requests are required to get the full result.
        type: integer
        format: int32
        x-nullable: true
        x-order: 1
      paginationCookie:
        description: Specifies cookie for resuming search if pagination is being used.
        type: string
        x-nullable: true
        x-order: 2
  SourceRegistratione9f00395-6310-4d6b-9fa0-57c9b0d298c0:
    description: Specifies the Source Registration.
    title: Source Registration.
    allOf:
    - {}
    - type: object
      properties:
        vmwareParams:
          description: Specifies the parameters to register a VMware Protection Source.
          type: object
          x-cohesity-discriminator-value: kVMware
          x-nullable: true
          x-order: 0
          $ref: '#/definitions/VmwareSourceRegistrationParams'
        physicalParams:
          description: Specifies the parameters to register a Physical Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kPhysical
          x-nullable: true
          x-order: 1
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
        genericNasParams:
          description: Specifies the parameters to register a Generic Nas Source.
          type: object
          x-cohesity-discriminator-value: kGenericNas
          x-nullable: true
          x-order: 2
          $ref: '#/definitions/GenericNasRegistrationParams'
        isilonParams:
          description: Specifies the parameters to register an Isilon Source.
          type: object
          x-cohesity-discriminator-value: kIsilon
          x-nullable: true
          x-order: 3
          $ref: '#/definitions/IsilonRegistrationParams'
        netappParams:
          description: Specifies the parameters to register an Netapp Source.
          type: object
          x-cohesity-discriminator-value: kNetapp
          x-nullable: true
          x-order: 4
          $ref: '#/definitions/NetappRegistrationParams'
        elastifileParams:
          description: Specifies the parameters to register an Elastifile Source.
          type: object
          x-cohesity-discriminator-value: kElastifile
          x-nullable: true
          x-order: 5
          $ref: '#/definitions/ElastifileRegistrationParams'
        flashbladeParams:
          description: Specifies the parameters to register an Flashblade Source.
          type: object
          x-cohesity-discriminator-value: kFlashBlade
          x-nullable: true
          x-order: 6
          $ref: '#/definitions/FlashbladeRegistrationParams'
        gpfsParams:
          description: Specifies the parameters to register an GPFS Source.
          type: object
          x-cohesity-discriminator-value: kGPFS
          x-nullable: true
          x-order: 7
          $ref: '#/definitions/GpfsRegistrationParams'
        cassandraParams:
          description: Specifies the parameters to register a Cassandra Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCassandra
          x-nullable: true
          x-order: 8
          $ref: '#/definitions/CassandraSourceRegistrationParams'
        mongodbParams:
          description: Specifies the parameters to register a MongoDB Protection Source.
          type: object
          x-cohesity-discriminator-value: kMongoDB
          x-nullable: true
          x-order: 9
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
        couchbaseParams:
          description: Specifies the parameters to register a Couchbase Protection
            Source.
          type: object
          x-cohesity-discriminator-value: kCouchbase
          x-nullable: true
          x-order: 10
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
        hdfsParams:
          description: Specifies the parameters to register an HDFS Protection Source.
          type: object
          x-cohesity-discriminator-value: kHdfs
          x-nullable: true
          x-order: 11
          $ref: '#/definitions/HdfsSourceRegistrationParams'
        hbaseParams:
          description: Specifies the parameters to register an HBase Protection Source.
          type: object
          x-cohesity-discriminator-value: kHBase
          x-nullable: true
          x-order: 12
          $ref: '#/definitions/HbaseSourceRegistrationParams'
        hiveParams:
          description: Specifies the parameters to register a Hive Protection Source.
          type: object
          x-cohesity-discriminator-value: kHive
          x-nullable: true
          x-order: 13
          $ref: '#/definitions/HiveSourceRegistrationParams'
        udaParams:
          description: Specifies the parameters to register a Universal Data Adapter
            Protection Source.
          type: object
          x-cohesity-discriminator-value: kUDA
          x-nullable: true
          x-order: 14
          $ref: '#/definitions/UdaSourceRegistrationParams'
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0:
    description: Specifies the parameters which are common between all Protection
      Source registrations.
    type: object
    properties:
      id:
        description: Source Registration ID. This can be used to retrieve, edit or
          delete the source registration.
        type: integer
        format: int64
        x-nullable: true
        x-order: 0
        readOnly: true
      sourceId:
        description: ID of top level source object discovered after the registration.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
        readOnly: true
      sourceInfo:
        description: Specifies detailed info about the source.
        type: object
        x-nullable: true
        x-order: 2
        $ref: '#/definitions/Object'
      environment:
        description: Specifies the environment type of the Protection Source.
        type: string
        enum:
        - kVMware
        - kHyperV
        - kAcropolis
        - kKVM
        - kAWS
        - kGCP
        - kAzure
        - kPhysical
        - kPure
        - kNimble
        - kNetapp
        - kGenericNas
        - kIsilon
        - kFlashBlade
        - kGPFS
        - kElastifile
        - kO365
        - kHyperFlex
        - kKubernetes
        - kCassandra
        - kMongoDB
        - kCouchbase
        - kHdfs
        - kHive
        - kHBase
        - kUDA
        x-nullable: true
        x-order: 3
      connectionId:
        description: Specifies the id of the connection from where this source is
          reachable. This should only be set for a source being registered by a tenant
          user.
        type: integer
        format: int64
        x-nullable: true
        x-order: 4
    x-cohesity-discriminator-details:
      propertyName: environment
    x-discriminator:
      mapping:
        kVMware: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0VmwareSourceRegistrationParamsWrapper'
        kPhysical: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0PhysicalSourceRegistrationParamsWrapper'
        kGenericNas: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0GenericNasRegistrationParamsWrapper'
        kIsilon: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0IsilonRegistrationParamsWrapper'
        kNetapp: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0NetappRegistrationParamsWrapper'
        kElastifile: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0ElastifileRegistrationParamsWrapper'
        kFlashBlade: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0FlashbladeRegistrationParamsWrapper'
        kGPFS: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0GpfsRegistrationParamsWrapper'
        kCassandra: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0CassandraSourceRegistrationParamsWrapper'
        kMongoDB: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0MongoDBSourceRegistrationParamsWrapper'
        kCouchbase: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0CouchbaseSourceRegistrationParamsWrapper'
        kHdfs: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HdfsSourceRegistrationParamsWrapper'
        kHBase: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HbaseSourceRegistrationParamsWrapper'
        kHive: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HiveSourceRegistrationParamsWrapper'
        kUDA: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0UdaSourceRegistrationParamsWrapper'
      propertyName: environment
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0VmwareSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        vmwareParams:
          $ref: '#/definitions/VmwareSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0PhysicalSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        physicalParams:
          $ref: '#/definitions/PhysicalSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0GenericNasRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        genericNasParams:
          $ref: '#/definitions/GenericNasRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0IsilonRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        isilonParams:
          $ref: '#/definitions/IsilonRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0NetappRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        netappParams:
          $ref: '#/definitions/NetappRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0ElastifileRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        elastifileParams:
          $ref: '#/definitions/ElastifileRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0FlashbladeRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        flashbladeParams:
          $ref: '#/definitions/FlashbladeRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0GpfsRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        gpfsParams:
          $ref: '#/definitions/GpfsRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0CassandraSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        cassandraParams:
          $ref: '#/definitions/CassandraSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0MongoDBSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        mongodbParams:
          $ref: '#/definitions/MongoDBSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0CouchbaseSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        couchbaseParams:
          $ref: '#/definitions/CouchbaseSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HdfsSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        hdfsParams:
          $ref: '#/definitions/HdfsSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HbaseSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        hbaseParams:
          $ref: '#/definitions/HbaseSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HiveSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        hiveParams:
          $ref: '#/definitions/HiveSourceRegistrationParams'
      type: object
  CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0UdaSourceRegistrationParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0'
    - properties:
        udaParams:
          $ref: '#/definitions/UdaSourceRegistrationParams'
      type: object
  TdmObjectTimelineEventc178908e-3930-4945-a22c-3204a4e67c54:
    description: Specifies a TDM object timeline event.
    type: object
    allOf:
    - {}
    - type: object
      properties:
        cloneParams:
          x-cohesity-discriminator-value: clone
          x-order: 0
          $ref: '#/definitions/TdmCloneTaskResponseParams'
        snapshotParams:
          x-cohesity-discriminator-value: snapshot
          x-order: 1
          $ref: '#/definitions/TdmSnapshot'
  CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89b:
    description: Specifies the common parameters for the TDM object timeline events
      response.
    type: object
    required:
    - id
    - action
    properties:
      id:
        description: Specifies the unique ID of the event.
        type: string
        x-nullable: true
        x-order: 0
      createdAt:
        description: Specifies the time (in usecs from epoch) at which the event was
          created.
        type: integer
        format: int64
        x-nullable: true
        x-order: 1
      createdByUser:
        description: Specifies the user, who triggered the event.
        allOf:
        - $ref: '#/definitions/User'
        x-nullable: true
        x-order: 2
      status:
        description: Specifies the current status of the event.
        type: string
        enum:
        - scheduled
        - inProgress
        - succeeded
        - failed
        - canceled
        x-nullable: true
        x-order: 3
      errorMessage:
        description: Specifies the error message if the event is in failed state.
        type: string
        x-nullable: true
        x-order: 4
      description:
        description: Specifies the description of the event, as provided by the user.
        type: string
        x-nullable: true
        x-order: 5
      eventGroupId:
        description: Specifies the ID of the group this event belongs to. Events with
          same group ID are considered to be a single timeline for the TDM object.
          Different group IDs mean different timelines for the TDM object.
        type: string
        x-nullable: true
        x-order: 6
      action:
        description: Specifies the action for the event.
        type: string
        enum:
        - clone
        - teardown
        - refresh
        - snapshot
        - rewind
        x-nullable: true
        x-order: 7
    x-cohesity-discriminator-details:
      propertyName: action
    x-discriminator:
      mapping:
        clone: '#/definitions/CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89bTdmCloneTaskResponseParamsWrapper'
        snapshot: '#/definitions/CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89bTdmSnapshotWrapper'
      propertyName: action
  CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89bTdmCloneTaskResponseParamsWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89b'
    - properties:
        cloneParams:
          $ref: '#/definitions/TdmCloneTaskResponseParams'
      type: object
  CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89bTdmSnapshotWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmObjectTimelineEventsResponseParams5c6067d0-8782-441a-b331-2583cdaaf89b'
    - properties:
        snapshotParams:
          $ref: '#/definitions/TdmSnapshot'
      type: object
  TdmObject6ac64942-fa7d-4997-9fff-5fb6d89459db:
    description: Specifies a TDM object.
    type: object
    allOf:
    - {}
    - type: object
      properties:
        oracleParams:
          x-cohesity-discriminator-value: oracle
          x-order: 0
          $ref: '#/definitions/OracleCloneObject'
  CommonTdmObjectResponseParamsa153f0a0-cd89-4b59-836b-6ec803e6e173:
    description: Specifies the common parameters for a TDM object response.
    type: object
    required:
    - id
    - environment
    properties:
      id:
        description: Specifies the unique ID of the object.
        type: string
        x-nullable: true
        x-order: 0
      name:
        description: Specifies the name of the object.
        type: string
        x-nullable: true
        x-order: 1
      status:
        description: Specifies the current status of the object.
        type: string
        enum:
        - scheduled
        - inProgress
        - succeeded
        - failed
        - canceled
        x-nullable: true
        x-order: 2
      environment:
        description: Specifies the environment of the object.
        type: string
        enum:
        - kSQL
        - kOracle
        x-nullable: true
        x-order: 3
      createdByUser:
        description: Specifies the user, who created the object.
        allOf:
        - $ref: '#/definitions/User'
        x-order: 4
      lastAction:
        description: Specifies the details of the last action performed on this object.
        allOf:
        - $ref: '#/definitions/TdmObjectTimelineEvent'
        x-order: 5
      sizeBytes:
        description: Specifies the size (in bytes) of the object.
        type: integer
        format: int64
        x-nullable: true
        x-order: 6
      parent:
        description: Specifies the parent of the object.
        allOf:
        - $ref: '#/definitions/ObjectSummary'
        x-order: 7
    x-cohesity-discriminator-details:
      propertyName: environment
    x-discriminator:
      mapping:
        oracle: '#/definitions/CommonTdmObjectResponseParamsa153f0a0-cd89-4b59-836b-6ec803e6e173OracleCloneObjectWrapper'
      propertyName: environment
  CommonTdmObjectResponseParamsa153f0a0-cd89-4b59-836b-6ec803e6e173OracleCloneObjectWrapper:
    allOf:
    - $ref: '#/definitions/CommonTdmObjectResponseParamsa153f0a0-cd89-4b59-836b-6ec803e6e173'
    - properties:
        oracleParams:
          $ref: '#/definitions/OracleCloneObject'
      type: object
securityDefinitions:
  APIKeyHeader:
    in: header
    name: apiKey
    type: apiKey