opdb.yaml

x-generated: Automatically generated by CDP protoc plugin. Do not edit manually.
swagger: '2.0'
x-endpoint-name: opdb
x-products: CDP
x-form-factors: public
x-cdp-releases: PUBLIC
info:
  version: 0.9.135 (BETA)
  title: Operational Database service
  license:
    name: Apache 2.0
  description: Interact with the Cloudera Operational Database service
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v1/opdb/addCoprocessor:
    post:
      summary: Add a coprocessor for a specific table
      description: Adds a coprocessor for a specific table.
      operationId: addCoprocessor
      x-entitlement: COD_COPROCESSORS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/AddCoprocessorRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AddCoprocessorResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/collectDiagnostics:
    post:
      summary: Collect diagnostic data bundles from the database
      description: returns details of running command
      operationId: collectDiagnostics
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CollectDiagnosticsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CollectDiagnosticsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/createDatabase:
    post:
      summary: Create opDb
      description: Create a operational database in a environment
      operationId: createDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/createSnapshot:
    post:
      summary: Creates a snapshot for a specific table.
      description: Returns id state and creation time.
      operationId: createSnapshot
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateSnapshotRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateSnapshotResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/deleteSnapshot:
    post:
      summary: Deletes a snapshot.
      description: Returns the snapshot that is deleted.
      operationId: deleteSnapshot
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteSnapshotRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteSnapshotResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/describeClientConnectivity:
    post:
      summary: Returns client connectivity details
      description: Returns details to enable programmatic client connectivity for a database
      operationId: describeClientConnectivity
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeClientConnectivityRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeClientConnectivityResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/describeDatabase:
    post:
      summary: Describe a opDb
      description: Details about the operational database
      operationId: describeDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/describeHbaseConfiguration:
    post:
      summary: Describes the configuration of HBase.
      description: Describes the selected configuration of the HBase cluster of an operational database in the environment.
      operationId: describeHbaseConfiguration
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeHbaseConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeHbaseConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/describeUpgradeDatabase:
    post:
      summary: Describes the upgrade availability.
      description: Describes the upgrade availability for an operational database.
      operationId: describeUpgradeDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeUpgradeDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeUpgradeDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/dropDatabase:
    post:
      summary: drop a opDb
      description: drop the operational database
      operationId: dropDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DropDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DropDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/listCertificates:
    post:
      summary: List certificates
      description: List SHA-1 fingerprints of certificates in Global Trust Store
      operationId: listCertificates
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListCertificatesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListCertificatesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listCoprocessors:
    post:
      summary: Lists coprocessors in a database
      description: Lists coprocessors in a database.
      operationId: listCoprocessors
      x-entitlement: COD_COPROCESSORS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListCoprocessorsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListCoprocessorsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listDatabases:
    post:
      summary: List all opDbs in an environment
      description: Fetch a list of all operational databases in an environment
      operationId: listDatabases
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDatabasesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDatabasesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listDiagnostics:
    post:
      summary: List all diagnostics associated to the database
      description: returns list of diagnostics collections
      operationId: listDiagnostics
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDiagnosticsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDiagnosticsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listEdgeNodes:
    post:
      summary: Lists edge nodes in a database
      description: Lists edge nodes in a database.
      operationId: listEdgeNodes
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListEdgeNodesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListEdgeNodesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listEvents:
    post:
      summary: Lists events
      description: Lists events in reverse chronological order for an operational database.
      operationId: listEvents
      x-entitlement: COD_PROACTIVE_SUPPORT
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListEventsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListEventsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listRestoreSnapshots:
    post:
      summary: Lists instances when a snapshot was restored to a database.
      description: Returns a list of snapshots restored into a database.
      operationId: listRestoreSnapshots
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListRestoreSnapshotsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListRestoreSnapshotsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listScalingEvents:
    post:
      summary: Lists scaling events
      description: Lists scaling events in reverse chronological order for an operational database.
      operationId: listScalingEvents
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListScalingEventsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListScalingEventsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listSnapshots:
    post:
      summary: Shows snapshot for a table name in a specific location.
      description: Returns list of snapshot names.
      operationId: listSnapshots
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListSnapshotsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListSnapshotsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listSupportedEnvironments:
    post:
      summary: List of environments available for the database creation
      description: Fetches a list of environments available for the database creation
      operationId: listSupportedEnvironments
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListSupportedEnvironmentsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListSupportedEnvironmentsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/listSupportedInstanceTypes:
    post:
      summary: Lists instance types supported by COD
      description: Lists instance types supported by COD.
      operationId: listSupportedInstanceTypes
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListSupportedInstanceTypesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListSupportedInstanceTypesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/opdb/prepareUpgradeDatabase:
    post:
      summary: Prepare database upgrade.
      description: Running upgrade related validations and prepares the required parcels for the upgrade.
      operationId: prepareUpgradeDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/PrepareUpgradeDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/PrepareUpgradeDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/removeCoprocessor:
    post:
      summary: Removes a coprocessor for a specific table
      description: Removes a coprocessor for a specific table.
      operationId: removeCoprocessor
      x-entitlement: COD_COPROCESSORS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RemoveCoprocessorRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RemoveCoprocessorResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/restoreSnapshot:
    post:
      summary: Restores a snapshot.
      description: Returns the snapshot that was restored.
      operationId: restoreSnapshot
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RestoreSnapshotRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RestoreSnapshotResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/startDatabase:
    post:
      summary: Starts the database
      description: Starts a previously stopped database
      operationId: startDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/StartDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/StartDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/stopDatabase:
    post:
      summary: Stops the database
      description: Stops a running database
      operationId: stopDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/StopDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/StopDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/updateDatabase:
    post:
      summary: Updates the database
      description: Update an operational database in an environment
      operationId: updateDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/updateEdgeNodes:
    post:
      summary: Update edge nodes in a database
      description: Update edge nodes in a database.
      operationId: updateEdgeNodes
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateEdgeNodesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateEdgeNodesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/updateHbaseConfiguration:
    post:
      summary: Updates the configuration of HBase.
      description: Updates the selected configuration of the HBase cluster of an operational database in the environment.
      operationId: updateHbaseConfiguration
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateHbaseConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateHbaseConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/upgradeDatabase:
    post:
      summary: Upgrades the database.
      description: Upgrades an operational database in an environment to a given runtime.
      operationId: upgradeDatabase
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpgradeDatabaseRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpgradeDatabaseResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/opdb/uploadCertificate:
    post:
      summary: Upload custom certificate
      description: Upload a custom certificate to Global Trust Store
      operationId: uploadCertificate
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UploadCertificateRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UploadCertificateResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
definitions:
  Error:
    type: object
    description: An object returned on an error.
    properties:
      code:
        type: string
        description: The error code.
      message:
        type: string
        description: The error message.
  DiagnosticsBundle:
    type: object
    description: Describe a diagnostics bundle
    properties:
      id:
        type: string
        description: Identifier for each bundle collection
      crn:
        type: string
        description: The object on which diagnostics was collected
      startTime:
        type: string
        format: date-time
        description: Start time
      endTime:
        type: string
        format: date-time
        description: The end time, if the command is finished.
      status:
        type: string
        description: A status of the diagnostics collection process
      result:
        type: string
        description: If this is a download, a link to the download location of the bundle
  CollectDiagnosticsRequest:
    type: object
    description: Enables starting collection of the diagnostics. This is an asynchronous API and not expected to block.
    required:
      - environmentName
      - databaseName
      - endTime
    properties:
      environmentName:
        type: string
        description: The name of the environment
      databaseName:
        type: string
        description: The name of the database
      endTime:
        type: string
        description: The end time (in ISO 8601 format) of the period to collection statistics for.
      startTime:
        type: string
        description: The start time (in ISO 8601 format) of the period to collection statistics for.
  CollectDiagnosticsResponse:
    type: object
    description: Information about diagnostic bundle generation
    properties:
      diagnosticsBundle:
        description: Details of requested diagnostic bundle collection
        $ref: '#/definitions/DiagnosticsBundle'
  ListDiagnosticsRequest:
    type: object
    description: Lists the in-progress diagnostic bundle operations.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment
      databaseName:
        type: string
        description: The name of the database
  ListDiagnosticsResponse:
    type: object
    description: The list of in-progress diagnostic bundle operations
    properties:
      diagnosticsBundles:
        type: array
        items:
          $ref: '#/definitions/DiagnosticsBundle'
        description: List of diagnostics operations
  KeyValuePair:
    type: object
    description: Generic key-value type, because map<> is not supported
    properties:
      key:
        type: string
        description: Key
      value:
        type: string
        description: Value
  InstanceGroupType:
    type: string
    description: "InstanceGroup Type.\n `WORKER` - WORKER value of the InstanceGroup name. `LEADER` - LEADER value of the InstanceGroup name. `MASTER` - MASTER value of the InstanceGroup name. `GATEWAY` - GATEWAY value of the InstanceGroup name. `STRONGMETA` - STRONGMETA value of the InstanceGroup name. `EDGE` - EDGE value of the InstanceGroup name. `COMPUTE` - COMPUTE value of the InstanceGroup name. `RESTWORKER` - RESTWORKER value of the InstanceGroup name."
    enum:
      - WORKER
      - LEADER
      - MASTER
      - GATEWAY
      - STRONGMETA
      - EDGE
  CustomRecipe:
    type: object
    description: Describe a custom recipe.
    required:
      - names
      - instanceGroup
    properties:
      names:
        type: array
        items:
          type: string
        description: Name of the recipe.
      instanceGroup:
        description: Instance group to apply the recipe to.
        $ref: '#/definitions/InstanceGroupType'
  VolumeEncryption:
    type: object
    description: Specify volume encryption key for instance group.
    required:
      - encryptionKey
      - instanceGroup
    properties:
      encryptionKey:
        type: string
        description: Encryption key.
      instanceGroup:
        description: Instance group to apply the encryption key to.
        $ref: '#/definitions/InstanceGroupType'
  CreateDatabaseRequest:
    type: object
    description: A request to create the database
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: environment name
      databaseName:
        type: string
        description: database name
      autoScalingParameters:
        description: Parameters to configure the AutoScaling
        $ref: '#/definitions/AutoScalingParameters'
      disableExternalDB:
        type: boolean
        description: Skips external database creation to avoid DB creation time.
      subnetId:
        type: string
        description: Override subnet where the database will be deployed. Disables Multi-AZ if set [only for AWS].
      customUserTags:
        type: array
        items:
          $ref: '#/definitions/KeyValuePair'
        description: Optional tags to apply to launched infrastructure resources
      disableMultiAz:
        type: boolean
        description: Disable deployment into multiple availability-zones (the database will be deployed into one subnet).
      attachedStorageForWorkers:
        description: Attached storage for the worker nodes for AWS, Azure, and GCP cloud providers.
        $ref: '#/definitions/AttachedStorageForWorkers'
      disableKerberos:
        type: boolean
        description: Disable Kerberos authentication.
      numEdgeNodes:
        type: integer
        format: int32
        description: Number of edge nodes to be created for the database. A positive, non-zero number is required. The default value is 0.
      image:
        description: Image details for the database.
        $ref: '#/definitions/Image'
      disableJwtAuth:
        type: boolean
        description: Disable OAuth Bearer (JWT) authentication scheme.
      enableRegionCanary:
        type: boolean
        description: To enable the region canary for the database.
      scaleType:
        description: Optional tags to choose one of the predefined cluster sizes.
        $ref: '#/definitions/ScaleType'
      storageType:
        description: Optional tag to choose the storage types.
        $ref: '#/definitions/StorageType'
      recipes:
        type: array
        items:
          $ref: '#/definitions/CustomRecipe'
        description: Custom recipes for the database.
      enableGrafana:
        type: boolean
        description: To enable grafana server for the database.
      javaVersion:
        type: integer
        format: int32
        description: Optional tag to configure the major version of Java on the cluster.
      computeClusterId:
        type: string
        description: Uses provided compute cluster for Kubernetes clusters instead of creating a new one. Deprecated, use `computeClusterCrn` instead.
        x-deprecated: true
      storageLocation:
        type: string
        description: Provide an optional external storage location for a non-CDP managed bucket as the HBase root.
      rootVolumeSize:
        type: integer
        format: int32
        description: Root volume size in GiB.
      volumeEncryptions:
        type: array
        items:
          $ref: '#/definitions/VolumeEncryption'
        description: Specifies encryption key to encrypt volume for instance group. It is currently supported for AWS cloud provider only.
      gatewayNodesCount:
        type: integer
        format: int32
        description: Number of gateway nodes to be created for the database. When multiple gateway nodes are present Knox works in HA mode. A positive, non-zero number is required. The default value is 1. Requires the COD_RESTWORKERS entitlement.
      restworkerNodesCount:
        type: integer
        format: int32
        description: Number of REST Worker nodes to be created for the database. A positive, non-zero number is required. The default value is 0. Requires the COD_RESTWORKERS entitlement.
      computeClusterCrn:
        type: string
        description: Utilizes the existing compute cluster with the provided CRN instead of creating a new one.
      architecture:
        description: Specifies the Architecture of the cluster nodes.
        $ref: '#/definitions/ArchitectureType'
      customInstanceTypes:
        description: Provide custom VM instance types for master, worker, gateway, leader, edge and compute groups.
        $ref: '#/definitions/CustomInstanceTypes'
      securityRequest:
        description: Specifies the Security related configuration of the cluster.
        $ref: '#/definitions/SecurityRequest'
  CustomInstanceTypes:
    type: object
    description: Custom VM Instance Types.
    properties:
      masterType:
        type: string
        description: Master VM Instance Type.
      workerType:
        type: string
        description: Worker VM Instance Type.
      gatewayType:
        type: string
        description: Gateway VM Instance Type.
      leaderType:
        type: string
        description: Leader VM Instance Type.
      edgeType:
        type: string
        description: Edge VM Instance Type.
      computeType:
        type: string
        description: Compute VM Instance Type.
  VolumeType:
    type: string
    description: "Volume Type.\n `HDD` - Hard disk drives (HDD) volume type. Default is HDD. `SSD` - Solid disk drives (SSD) volume type. `LOCAL_SSD` - Local SSD volume type."
    enum:
      - HDD
      - SSD
      - LOCAL_SSD
  AttachedStorageForWorkers:
    type: object
    description: Attached storage for the worker nodes for AWS, Azure, and GCP cloud providers.
    properties:
      volumeCount:
        type: integer
        format: int32
        minimum: 1
        maximum: 8
        description: 'The number of Volumes. Default is 4. Valid Range: Minimum value of 1, maximum value 8.'
      volumeSize:
        type: integer
        format: int32
        description: The target size of the volume, in GiB. Default is 2048.
      volumeType:
        description: The volume type. This parameter can be HDD or SSD. Default is HDD.
        $ref: '#/definitions/VolumeType'
  ScaleType:
    type: string
    description: "Scale type.\n `MICRO` - Create a 2-node cluster (1 gateway and 1 worker) with high availability disabled. `LIGHT` - Create a multi-node cluster with a light master and gateway instance type. `HEAVY` - Create a multi-node cluster with heavy master and gateway instance type."
    enum:
      - MICRO
      - LIGHT
      - HEAVY
  StorageType:
    type: string
    description: "Storage type for clusters.\n `CLOUD_WITH_EPHEMERAL` - Cloud with ephemeral storage. `CLOUD` - Cloud storage without ephemeral storage. `HDFS` - HDFS storage."
    enum:
      - CLOUD_WITH_EPHEMERAL
      - CLOUD
      - HDFS
  ArchitectureType:
    type: string
    description: "Architecture type for cluster.\n `X86_64` - X64 CPU Architecture is used for the cluster. `ARM64` - ARM64 CPU Architecture is used for the cluster."
    enum:
      - X86_64
      - ARM64
  SecurityRequest:
    type: object
    description: Security related configurations for the clusters.
    properties:
      seLinux:
        description: SELinux enforcement policy, can be PERMISSIVE or ENFORCING
        $ref: '#/definitions/SELinux'
  SecurityResponse:
    type: object
    description: Security related configurations for the clusters.
    properties:
      seLinux:
        description: SELinux enforcement policy, can be PERMISSIVE or ENFORCING
        $ref: '#/definitions/SELinux'
  SELinux:
    type: string
    description: "SELinux configurations for the cluster\n `PERMISSIVE` - PERMISSIVE policy is used for the cluster. `ENFORCING` - ENFORCING policy is used for the cluster."
    enum:
      - PERMISSIVE
      - ENFORCING
  UpdateDatabaseRequest:
    type: object
    description: A request to update the database
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: environment name
      databaseName:
        type: string
        description: database name
      autoScalingParameters:
        description: Parameters to configure the scaling policy
        $ref: '#/definitions/AutoScalingParameters'
      numDesiredStrongMetaServers:
        type: integer
        format: int32
        description: The desired number of strong meta servers for this database. A positive, non-zero number is required. Use removeStrongMetaServers to remove strong meta servers entirely. Requires the COD_STRONG_META_SERVERS entitlement.
      removeStrongMetaServers:
        type: boolean
        description: Removes any strong meta servers provisioned for this database. Requires the COD_STRONG_META_SERVERS entitlement.
      catalog:
        type: string
        description: Catalog name for the image.
      verticalScale:
        description: Vertical Scale request for database.
        $ref: '#/definitions/GroupType'
      numDesiredRestworkerNodes:
        type: integer
        format: int32
        description: Sets the desired number of REST Worker nodes for the database. A positive, non-zero number is required. Requires the COD_RESTWORKERS entitlement.
      removeRestworkerNodes:
        type: boolean
        description: Removes any REST Worker nodes provisioned for this database. Requires the COD_RESTWORKERS entitlement.
      switchInstanceType:
        description: Provide custom VM instance types to switch instance types for instance groups. Requires COD_USE_CUSTOM_INSTANCE_TYPES entitlement.
        $ref: '#/definitions/CustomInstanceType'
  CustomInstanceType:
    type: object
    description: Parameters to configure custom VM Instance Types.
    properties:
      instanceGroup:
        description: The Instance Group Type.
        $ref: '#/definitions/InstanceGroupType'
      instanceType:
        type: string
        description: The Custom VM Instance Type.
  AutoScalingParameters:
    type: object
    description: A Parameters to configure AutoScaling
    properties:
      targetedValueForMetric:
        type: integer
        format: int64
        description: The target value of the metric a user expect to maintain for the cluster
      maxWorkersForDatabase:
        type: integer
        format: int32
        description: Maximum number of worker nodes as per this metrics can be scaled up to.
      maxWorkersPerBatch:
        type: integer
        format: int32
        description: Maximum number of worker nodes as per this metrics can be scaled up to in one batch.
      minWorkersForDatabase:
        type: integer
        format: int32
        description: Minimum number of worker nodes as per this metrics can be scaled down to.
      evaluationPeriod:
        type: integer
        format: int64
        description: Period of metrics(in seconds) needs to be considered.
      minimumBlockCacheGb:
        type: integer
        format: int32
        description: The amount of block cache, in Gigabytes, which the database should have.
      maxHdfsUsagePercentage:
        type: integer
        format: int32
        description: The maximum percentage of HDFS utilization for the database before we trigger the scaling.
      maxRegionsPerRegionServer:
        type: integer
        format: int32
        description: The maximum number of regions per region server.
      maxCpuUtilization:
        type: integer
        format: int32
        description: This configuration is effective when compute nodes are enabled. The maximum percentage threshold for the CPU utilization of nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker and compute nodes. Set 100 or more to disable the CPU metrics.
      maxComputeNodesForDatabase:
        type: integer
        format: int32
        description: The maximum number of compute nodes, as per these metrics, that can be scaled up to.
        default: -1
      minComputeNodesForDatabase:
        type: integer
        format: int32
        description: The minimum number of compute nodes, as per these metrics, that can be scaled down to.
        default: -1
  AutoScalingConfig:
    type: object
    description: A config for Autoscaling
    properties:
      targetedValueForMetric:
        type: integer
        format: int64
        description: The target value of the metric a user expect to maintain for the cluster
      maxWorkersForDatabase:
        type: integer
        format: int32
        description: Maximum number of worker nodes as per this metrics can be scaled up to.
      maxWorkersPerBatch:
        type: integer
        format: int32
        description: Maximum number of worker nodes as per this metrics can be scaled up to in one batch.
      minWorkersForDatabase:
        type: integer
        format: int32
        description: Minimum number of worker nodes as per this metrics can be scaled down to.
      evaluationPeriod:
        type: integer
        format: int64
        description: Period of metrics(in seconds) needs to be considered.
      minimumBlockCacheGb:
        type: integer
        format: int32
        description: The amount of block cache, in Gigabytes, which the database should have.
      maxHdfsUsagePercentage:
        type: integer
        format: int32
        description: The maximum percentage of HDFS utilization for the database before the scaling is triggered.
      maxRegionsPerRegionServer:
        type: integer
        format: int32
        description: The maximum number of regions per region server.
      maxCpuUtilization:
        type: integer
        format: int32
        description: The maximum percentage threshold for the CPU utilization of the worker nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker nodes. Set 100 or more to disable the CPU metrics.
      maxComputeNodesForDatabase:
        type: integer
        format: int32
        description: The maximum number of compute nodes, as per these metrics can be scaled up to.
        default: -1
      minComputeNodesForDatabase:
        type: integer
        format: int32
        description: The minimum number of compute nodes as per these metrics can be scaled down to.
        default: -1
  CreateDatabaseResponse:
    type: object
    description: A response which gives status of the database creation
    required:
      - databaseDetails
    properties:
      databaseDetails:
        description: Details of the Database created
        $ref: '#/definitions/DatabaseDetails'
  UpdateDatabaseResponse:
    type: object
    description: A response to database update request
    properties:
      status:
        type: string
        description: Status of whether the update was successful or not.
  ConfigurationType:
    type: string
    description: "Type of an HBase configuration.\n `SERVICE` - Service level configuration. `MASTER` - Configuration for the Master nodes. `REGIONSERVER` - Configuration for the RegionServer nodes. `STRONGMETA` - Configuration for the StrongMeta RegionServer nodes. `GATEWAY` - Configuration for the Gateway nodes."
    enum:
      - SERVICE
      - MASTER
      - REGIONSERVER
      - STRONGMETA
      - GATEWAY
  UpdateHbaseConfigurationRequest:
    type: object
    description: A request to update the HBase configuration.
    required:
      - environment
      - database
      - configurationType
      - configurationName
      - configurationValue
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      configurationType:
        description: The type of the configuration being updated.
        $ref: '#/definitions/ConfigurationType'
      configurationName:
        type: string
        description: The name of the configuration in Cloudera Manager being updated.
      configurationValue:
        type: string
        description: The new value of the configuration being updated.
  UpdateHbaseConfigurationResponse:
    type: object
    description: A response to update the HBase configuration request.
    properties:
      configuration:
        description: The details of the configuration.
        $ref: '#/definitions/HBaseConfiguration'
  DescribeHbaseConfigurationRequest:
    type: object
    description: A request to describe the HBase configuration.
    required:
      - environment
      - database
      - configurationType
      - configurationName
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      configurationType:
        description: The type of the configuration.
        $ref: '#/definitions/ConfigurationType'
      configurationName:
        type: string
        description: The name of the configuration used in Cloudera Manager.
  DescribeHbaseConfigurationResponse:
    type: object
    description: A response to describe the HBase configuration request.
    properties:
      configuration:
        description: The details of the configuration.
        $ref: '#/definitions/HBaseConfiguration'
  HBaseConfiguration:
    type: object
    description: The details of the HBase configuration.
    required:
      - name
    properties:
      name:
        type: string
        description: The name of the configuration.
      value:
        type: string
        description: The value of the configuration.
  DropDatabaseRequest:
    type: object
    description: A request to drop the database
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: environment name
      databaseName:
        type: string
        description: database name
  DropDatabaseResponse:
    type: object
    description: A response which gives status of the database deletion
    properties:
      status:
        description: status of delete database request
        $ref: '#/definitions/StatusType'
  ListSupportedEnvironmentsRequest:
    type: object
    description: A request to get a list of available environments
  Environment:
    type: object
    description: Details of the environment
    required:
      - crn
      - name
    properties:
      crn:
        type: string
        description: The crn of the environment
      name:
        type: string
        description: The name of the environment
  ListSupportedEnvironmentsResponse:
    type: object
    description: A response which contains a list of available environments
    properties:
      environments:
        type: array
        items:
          $ref: '#/definitions/Environment'
        description: The crn of the environment
  StatusType:
    type: string
    description: status of the database
    enum:
      - REQUESTED
      - CREATE_IN_PROGRESS
      - AVAILABLE
      - UPDATE_IN_PROGRESS
      - UPDATE_REQUESTED
      - UPDATE_FAILED
      - CREATE_FAILED
      - ENABLE_SECURITY_FAILED
      - PRE_DELETE_IN_PROGRESS
      - DELETE_IN_PROGRESS
      - DELETE_FAILED
      - DELETE_COMPLETED
      - STOPPED
      - STOP_REQUESTED
      - START_REQUESTED
      - STOP_IN_PROGRESS
      - START_IN_PROGRESS
      - START_FAILED
      - STOP_FAILED
      - WAIT_FOR_SYNC
      - MAINTENANCE_MODE_ENABLED
      - REQUESTING
      - MISSING
      - BACKUP_IN_PROGRESS
      - BACKUP_FAILED
      - BACKUP_FINISHED
      - RESTORE_IN_PROGRESS
      - RESTORE_FAILED
      - RESTORE_FINISHED
      - DELETED_ON_PROVIDER_SIDE
      - AMBIGUOUS
      - EXTERNAL_DATABASE_CREATION_IN_PROGRESS
      - EXTERNAL_DATABASE_CREATION_FAILED
      - EXTERNAL_DATABASE_DELETION_IN_PROGRESS
      - EXTERNAL_DATABASE_DELETION_FINISHED
      - EXTERNAL_DATABASE_DELETION_FAILED
      - UNKNOWN
      - EXTERNAL_DATABASE_START_IN_PROGRESS
      - EXTERNAL_DATABASE_START_FINISHED
      - EXTERNAL_DATABASE_START_FAILED
      - EXTERNAL_DATABASE_STOP_IN_PROGRESS
      - EXTERNAL_DATABASE_STOP_FINISHED
      - EXTERNAL_DATABASE_STOP_FAILED
      - LOAD_BALANCER_UPDATE_IN_PROGRESS
      - LOAD_BALANCER_UPDATE_FINISHED
      - LOAD_BALANCER_UPDATE_FAILED
      - UNREACHABLE
      - NODE_FAILURE
      - RECOVERY_IN_PROGRESS
      - RECOVERY_REQUESTED
      - RECOVERY_FAILED
  ListDatabasesRequest:
    type: object
    description: A request to list databases
    properties:
      environmentName:
        type: string
        description: name of the environment
  ListDatabasesResponse:
    type: object
    description: A list of databases in response
    required:
      - databases
    properties:
      databases:
        type: array
        items:
          $ref: '#/definitions/DatabaseDetails'
        description: The details of the database
  DatabaseDetails:
    type: object
    description: Details of the databases.
    required:
      - databaseName
      - environmentCrn
      - crn
      - creationDate
    properties:
      databaseName:
        type: string
        description: The name of the database.
      environmentCrn:
        type: string
        description: environment crn
      crn:
        type: string
        description: database crn
      creationDate:
        type: string
        format: date-time
        description: The creation time of the database
      status:
        description: Status of the database creation
        $ref: '#/definitions/StatusType'
      creatorCrn:
        type: string
        description: Crn of the creator
      dbVersion:
        type: string
        description: Database version
      hueEndpoint:
        type: string
        description: Hue endpoint
      environmentName:
        type: string
        description: Environment name
      storageLocation:
        type: string
        description: HBase cloud storage location
      internalName:
        type: string
        description: Internal cluster name for this database
      autoScalingConfig:
        description: The autoscaling config
        $ref: '#/definitions/AutoScalingConfig'
      numStrongMetaServers:
        type: integer
        format: int32
        description: The number of strong meta servers for this database. Requires the COD_STRONG_META_SERVERS entitlement.
      storageDetailsForWorkers:
        type: array
        items:
          $ref: '#/definitions/StorageDetailsForWorker'
        description: The list of storage details for the worker nodes for AWS, Azure, and GCP cloud providers.
      dbEdgeNodeCount:
        type: integer
        format: int32
        description: The number of edge nodes for this database.
      scaleType:
        description: The predetermined size of the cluster.
        $ref: '#/definitions/ScaleType'
      computeNodesCount:
        type: integer
        format: int32
        description: Number of active compute nodes in the database (does not include the stopped nodes).
      totalComputeNodesCount:
        type: integer
        format: int32
        description: Total number of compute nodes in the database (including stopped nodes).
      javaVersion:
        type: string
        description: The version of java on the cluster.
      gatewayNodesCount:
        type: integer
        format: int32
        description: Number of gateway nodes for the database.
      restworkerNodesCount:
        type: integer
        format: int32
        description: Number of REST Worker nodes for the database.
      architecture:
        description: Specifies the architecture of the cluster nodes.
        $ref: '#/definitions/ArchitectureType'
      securityResponse:
        description: Specifies the Security related configuration of the cluster nodes.
        $ref: '#/definitions/SecurityResponse'
  StorageDetailsForWorker:
    type: object
    description: Storage details for the worker node for AWS, Azure, and GCP cloud providers.
    properties:
      volumeCount:
        type: integer
        format: int32
        description: The number of volumes.
      volumeSize:
        type: integer
        format: int32
        description: The target size of the volume, in GiB.
      volumeType:
        description: The volume type.
        $ref: '#/definitions/VolumeType'
  CloudPlatform:
    type: string
    description: "Cloud Provider that cluster is exhibited on.\n `AWS` - AWS `AZURE` - Azure `GCP` - GCP"
    enum:
      - AWS
      - AZURE
      - GCP
  DescribeDatabaseRequest:
    type: object
    description: request to get details of the database in a particular environment
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
  DescribeDatabaseResponse:
    type: object
    description: Details of the database.
    properties:
      databaseDetails:
        description: The details of the database.
        $ref: '#/definitions/DatabaseDetails'
  SnapshotStatusType:
    type: string
    description: "Snapshot Status Type.\n `NEW` - Expected when a snapshot request was just requested. `IN_PROGRESS` - When a snapshot request is in progress. `FAILED` - If for any reason a snapshot request has failed. `SUCCESSFUL` - A snapshot request has completed successfully. `LOCKED` - A snapshot exists, but can't be restored or read. `DELETED` - A snapshot existed but was just deleted. `CORRUPT` - A snapshot got corrupted. `DELETING` - A snapshot is being deleted."
    enum:
      - NEW
      - IN_PROGRESS
      - FAILED
      - SUCCESSFUL
      - LOCKED
      - DELETED
      - CORRUPT
      - DELETING
      - UNKNOWN
  CreateSnapshotRequest:
    type: object
    description: Create Snapshot Request.
    required:
      - environmentName
      - databaseName
      - tableName
      - snapshotName
      - snapshotLocation
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      tableName:
        type: string
        description: The fully qualified table name.
      snapshotName:
        type: string
        description: Snapshot name unique per database.
      snapshotLocation:
        type: string
        description: The snapshot location URL on object store.
  CreateSnapshotResponse:
    type: object
    description: Create Snapshot Response.
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      status:
        description: The status of the create snapshot.
        $ref: '#/definitions/SnapshotStatusType'
      creationTime:
        type: integer
        format: int64
        description: When the snapshot was created.
      commandID:
        type: integer
        format: int64
        description: The submitted Command ID of the create snapshot.
      statusReason:
        type: string
        description: Reason for the status.
  RestoreSnapshotRequest:
    type: object
    description: Restore Snapshot Request.
    required:
      - environmentName
      - databaseName
      - snapshotName
      - targetEnvironmentName
      - targetDatabaseName
    properties:
      environmentName:
        type: string
        description: The name of the original environment.
      databaseName:
        type: string
        description: The name of the original database.
      snapshotName:
        type: string
        description: The name of the snapshot.
      targetEnvironmentName:
        type: string
        description: The name of the target environment where the snapshot should be restored.
      targetDatabaseName:
        type: string
        description: The name of the target database where the snapshot should be restored.
  RestoreSnapshotResponse:
    type: object
    description: Response object for the RestoreSnapshot method.
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      snapshotName:
        type: string
        description: The name of the snapshot.
      targetEnvironmentName:
        type: string
        description: The name of the target environment.
      targetDatabaseName:
        type: string
        description: The name of the target database.
      status:
        description: The status of the restore snapshot.
        $ref: '#/definitions/SnapshotStatusType'
      restoreTime:
        type: integer
        format: int64
        description: The time when the snapshot restore was started.
      commandID:
        type: integer
        format: int64
        description: The submitted Command ID of the restore snapshot.
      statusReason:
        type: string
        description: Reason for the status.
  DeleteSnapshotRequest:
    type: object
    description: Request object for the DeleteSnapshot method.
    required:
      - environmentName
      - databaseName
      - snapshotName
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      snapshotName:
        type: string
        description: The name of the snapshot.
  DeleteSnapshotResponse:
    type: object
    description: Response object of the DeleteSnapshot method.
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      status:
        description: The status of the delete snapshot.
        $ref: '#/definitions/SnapshotStatusType'
      commandID:
        type: integer
        format: int64
        description: The submitted Command ID of the delete snapshot.
      statusReason:
        type: string
        description: Reason for the status.
      snapshotName:
        type: string
        description: The name of the snapshot.
  Snapshot:
    type: object
    description: An instance of a table's snapshot.
    required:
      - snapshotId
      - tableName
      - snapshotName
    properties:
      snapshotId:
        type: integer
        format: int64
        description: The id of the snapshot.
      tableName:
        type: string
        description: The table name.
      snapshotName:
        type: string
        description: The name of the snapshot.
      creationTime:
        type: integer
        format: int64
        description: The creation time of the snapshot.
      status:
        description: The status of the snapshot.
        $ref: '#/definitions/SnapshotStatusType'
      commandID:
        type: integer
        format: int64
        description: The submitted Command ID of the snapshot.
      snapshotLocation:
        type: string
        description: The location of the snapshot.
      failureReason:
        type: string
        description: Reason for the failure in case of snapshot creation failed.
  ListSnapshotsRequest:
    type: object
    description: Show Snapshots Request.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      tableName:
        type: string
        description: The table name.
      commandId:
        type: integer
        format: int64
        description: The submitted Command ID of the snapshots.
      fromCreationTime:
        type: string
        format: date-time
        description: The creation time of the snapshots to search (inclusive).
      toCreationTime:
        type: string
        format: date-time
        description: The ending time of the snapshot creation to search (inclusive).
  ListSnapshotsResponse:
    type: object
    description: Show Snapshots Response.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      snapshots:
        type: array
        items:
          $ref: '#/definitions/Snapshot'
        description: List of snapshots.
      status:
        description: The status of the list snapshots.
        $ref: '#/definitions/SnapshotStatusType'
      statusReason:
        type: string
        description: Reason for the status.
  ListRestoreSnapshotsRequest:
    type: object
    description: Show Restore Snapshots Request.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      snapshotName:
        type: string
        description: The name of the snapshot.
      targetEnvironmentName:
        type: string
        description: The name of the target environment.
      targetDatabaseName:
        type: string
        description: The name of the target database.
      commandId:
        type: integer
        format: int64
        description: The submitted Command ID of the snapshot.
      fromRestoreTime:
        type: string
        format: date-time
        description: The starting snapshot restore time to search restore snapshots (inclusive).
      toRestoreTime:
        type: string
        format: date-time
        description: The ending snapshot restore time to search restore snapshots (inclusive).
  RestoreSnapshot:
    type: object
    description: An instance of restoring a snapshot to a database.
    required:
      - restoreId
      - snapshotId
    properties:
      restoreId:
        type: integer
        format: int64
        description: The id of the restore snapshot.
      snapshotId:
        type: integer
        format: int64
        description: The id of the snapshot.
      snapshotName:
        type: string
        description: The name of the snapshot.
      targetEnvironmentName:
        type: string
        description: The name of the target environment.
      targetDatabaseName:
        type: string
        description: The name of the target database.
      status:
        description: The status of the restore snapshot.
        $ref: '#/definitions/SnapshotStatusType'
      restoreTime:
        type: integer
        format: int64
        description: The time when the snapshot restore was started.
      commandID:
        type: integer
        format: int64
        description: The submitted Command ID of the restore snapshot.
      failureReason:
        type: string
        description: Reason for the failure in case of restore snapshot failed.
  ListRestoreSnapshotsResponse:
    type: object
    description: Show Restore Snapshots Response.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment.
      databaseName:
        type: string
        description: The name of the database.
      restoreSnapshots:
        type: array
        items:
          $ref: '#/definitions/RestoreSnapshot'
        description: List of snapshots which have been restored against the database.
  StartDatabaseRequest:
    type: object
    description: Start the database.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment
      databaseName:
        type: string
        description: The name of the database.
  StartDatabaseResponse:
    type: object
    description: A response from starting the database.
    properties:
      wasStarted:
        type: boolean
        description: True if the database start request accepted
      previousStatus:
        description: The status of the database prior to the start request.
        $ref: '#/definitions/StatusType'
  StopDatabaseRequest:
    type: object
    description: Stop the database.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment
      databaseName:
        type: string
        description: The name of the database.
  StopDatabaseResponse:
    type: object
    description: A response from stopping the database.
    properties:
      wasStopped:
        type: boolean
        description: True if the database stop request accepted
      previousStatus:
        description: The status of the database prior to the stop request.
        $ref: '#/definitions/StatusType'
  DescribeClientConnectivityRequest:
    type: object
    description: A request for client API connectivity to a database.
    required:
      - environmentName
      - databaseName
    properties:
      environmentName:
        type: string
        description: The name of the environment
      databaseName:
        type: string
        description: The name of the database
  KerberosConfiguration:
    type: object
    description: Configuration information to enable Kerberos authentication
    properties:
      kdcHost:
        type: string
        description: The hostname of the KDC
      realm:
        type: string
        description: The Kerberos realm
      krb5Conf:
        type: string
        description: A base64-encoded krb5.conf file
  Kind:
    type: string
    description: "A categorization of a connector to describe how it is broadly used.\n `LIBRARY` - A client library or API which user's code invokes `JDBC` - A JDBC driver `SERVICE` - A Service URL `ENVIRONMENT` - An environment to use to run other commands and tools `ODBC` - An ODBC driver"
    enum:
      - LIBRARY
      - JDBC
      - SERVICE
      - ENVIRONMENT
  DependencyManagement:
    type: object
    description: Information about dependencies necessary to use a connector.
    properties:
      mavenUrl:
        type: string
        description: The URL of a Maven repository containing the client JARs.
  ClientConfigurationDetails:
    type: object
    description: A URL which holds information necessary to configure a Connector.
    properties:
      name:
        type: string
        description: The name of this configuration
      url:
        type: string
        description: The URL from which to fetch the configuration
  ConnectorConfiguration:
    type: object
    description: Runtime details necessary to use a connector.
    properties:
      clientConfigurationDetails:
        type: array
        items:
          $ref: '#/definitions/ClientConfigurationDetails'
        description: Configuration information required to use a Connector
      jdbcUrl:
        type: string
        description: A base JDBC URL if the connector is a JDBC driver.
      serviceUrl:
        type: string
        description: A base service URL
  Connector:
    type: object
    description: Information to use to connect to a database via some mechanism.
    properties:
      name:
        type: string
        description: The name of the API/Library this connector represents.
      version:
        type: string
        description: The version of the connector.
      kind:
        description: A categorization of this connector.
        $ref: '#/definitions/Kind'
      dependencies:
        description: Software dependency information necessary to use the connector.
        $ref: '#/definitions/DependencyManagement'
      configuration:
        description: Runtime details required to use the connector.
        $ref: '#/definitions/ConnectorConfiguration'
      requiresKerberos:
        type: boolean
        description: True if the connector requires Kerberos to authenticate.
  DescribeClientConnectivityResponse:
    type: object
    description: A response with client API connectivity to a database.
    properties:
      connectors:
        type: array
        items:
          $ref: '#/definitions/Connector'
        description: Available connectors for this database
      kerberosConfiguration:
        description: Kerberos configuration information
        $ref: '#/definitions/KerberosConfiguration'
  UpgradeDatabaseRequest:
    type: object
    description: Asynchronous request to upgrade the CDP Runtime for a database.
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      runtime:
        type: string
        description: The CDP Runtime version to upgrade to.
      osUpgradeOnly:
        type: boolean
        description: Only perform an Operating System upgrade.
      imageId:
        type: string
        description: ID of a database image to upgrade to. If this is empty, the default image is used.
      workerBatchSize:
        type: integer
        format: int32
        description: Batch size of worker nodes for restart.
      nonWorkerBatchSize:
        type: integer
        format: int32
        description: Batch size of non-worker nodes for restart.
      rollingUpgrade:
        type: boolean
        description: Perform upgrade in a rolling fashion.
      edgeUpgradeStrategy:
        description: Upgrade strategy for edge nodes.
        $ref: '#/definitions/EdgeUpgradeStrategy'
  PrepareUpgradeDatabaseRequest:
    type: object
    description: Asynchronous request to prepare cluster upgrade.
    required:
      - environment
      - database
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      runtime:
        type: string
        description: The CDP Runtime version to upgrade to.
      imageId:
        type: string
        description: ID of a database image to upgrade to.
  EdgeUpgradeStrategy:
    type: string
    description: "Edge node upgrade strategy.\n `ALL` - Upgrade edge nodes together. `ONE_BY_ONE` - Upgrade edge nodes one by one."
    enum:
      - ALL
      - ONE_BY_ONE
  UpgradeDatabaseResponse:
    type: object
    description: Response with the reason whether upgrade request is accepted or why it is not possible.
    properties:
      statusReason:
        type: string
        description: The reason whether upgrade request is accepted or why it is not possible.
  PrepareUpgradeDatabaseResponse:
    type: object
    description: Response with the reason whether prepare upgrade request is accepted or why it is not possible.
    properties:
      statusReason:
        type: string
        description: The reason whether upgrade request is accepted or why it is not possible.
  DescribeUpgradeDatabaseRequest:
    type: object
    description: Request to describe the upgrade availability of CDP Runtime and Operating System for a database.
    required:
      - environment
      - database
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
  DescribeUpgradeDatabaseResponse:
    type: object
    description: Response with upgrade availability of CDP Runtime and Operating System for a database.
    properties:
      statusReason:
        type: string
        description: The reason whether upgrade request is accepted or why it is not possible.
      currentComponentVersion:
        description: Versions of currently deployed CDP runtime and operating system.
        $ref: '#/definitions/ComponentsVersion'
      availableComponentVersions:
        type: array
        items:
          $ref: '#/definitions/ComponentsVersion'
        description: List of available versions for upgrade.
      isOSUpgradeAvailable:
        type: boolean
        description: Is an OS upgrade available.
      isRuntimeUpgradeAvailable:
        type: boolean
        description: Is a CDP Runtime upgrade available.
  ComponentsVersion:
    type: object
    description: Versions of the CDP runtime and Operating system components.
    properties:
      cm:
        type: string
        description: Version of Cloudera Manager.
      cdp:
        type: string
        description: CDP Runtime version.
      os:
        type: string
        description: Operation System name and version.
      osPatchLevel:
        type: string
        description: Operation System patch level.
  CoprocessorStatusType:
    type: string
    description: "Coprocessor status type.\n `ADD_NEW` - When an add coprocessor request was just requested. `ADD_IN_PROGRESS` - When an add coprocessor request is in progress. `ADD_FAILED` - When an add coprocessor request has failed. `ADD_SUCCESSFUL` - Add coprocessor request has been completed successfully. `REMOVE_NEW` - When a remove coprocessor request was just requested. `REMOVE_IN_PROGRESS` - When a remove coprocessor is in progress. `REMOVE_FAILED` - When a remove coprocessor request has failed. `REMOVE_SUCCESSFUL` - Remove coprocessor request has been completed successfully."
    enum:
      - ADD_NEW
      - ADD_IN_PROGRESS
      - ADD_FAILED
      - ADD_SUCCESSFUL
      - REMOVE_NEW
      - REMOVE_IN_PROGRESS
      - REMOVE_FAILED
      - REMOVE_SUCCESSFUL
      - UNKNOWN
  AddCoprocessorRequest:
    type: object
    description: The request for adding a coprocessor of a table in a database.
    required:
      - tableName
      - coprocessorCanonicalName
    properties:
      tableName:
        type: string
        description: Fully qualified table name.
      coprocessorCanonicalName:
        type: string
        description: The coprocessor canonical name. It is unique per database.
      coprocessorLocationUrl:
        type: string
        description: The coprocessor location URL. This URL could be an object store path, or it could be an HDFS path if it's a built-in coprocessor.
      coprocessorArgs:
        type: string
        description: The optional coprocessor arguments in comma-separated list.
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
  AddCoprocessorResponse:
    type: object
    description: The response for adding a coprocessor of a table in a database.
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      status:
        description: The current status when submitting the add coprocessor request.
        $ref: '#/definitions/CoprocessorStatusType'
      creationTime:
        type: integer
        format: int64
        description: When the coprocessor request was submitted.
      commandId:
        type: integer
        format: int64
        description: The command ID of the submitted request.
      statusReason:
        type: string
        description: Reason for the response if any.
  Coprocessor:
    type: object
    description: An instance of a coprocessor.
    properties:
      tableName:
        type: string
        description: Fully qualified table name.
      coprocessorCanonicalName:
        type: string
        description: The coprocessor canonical name. It is unique per database.
      coprocessorLocationUrl:
        type: string
        description: The coprocessor location URL.
      coprocessorArgs:
        type: string
        description: The optional coprocessor arguments in comma-separated list.
      status:
        description: The current status when listing coprocessors.
        $ref: '#/definitions/CoprocessorStatusType'
      commandId:
        type: integer
        format: int64
        description: The last committed command ID of the coprocessor.
      statusReason:
        type: string
        description: The reason of the current status.
  ListCoprocessorsRequest:
    type: object
    description: The request for listing coprocessors in a database.
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      tableName:
        type: string
        description: Fully qualified table name.
      commandId:
        type: integer
        format: int64
        description: The command ID for the requested coprocessor.
  ListCoprocessorsResponse:
    type: object
    description: The response for listing coprocessors in a database.
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      coprocessors:
        type: array
        items:
          $ref: '#/definitions/Coprocessor'
        description: The list of coprocessors.
  RemoveCoprocessorRequest:
    type: object
    description: The request for removing a coprocessor of a table in a database.
    required:
      - tableName
      - coprocessorCanonicalName
    properties:
      tableName:
        type: string
        description: Fully qualified table name.
      coprocessorCanonicalName:
        type: string
        description: The coprocessor canonical name. It is unique per database.
      force:
        type: boolean
        description: Forcefully remove the coprocessor.
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
  RemoveCoprocessorResponse:
    type: object
    description: The response for removing a coprocessor of a table in a database.
    properties:
      status:
        description: The current status when submitting the remove coprocessor request.
        $ref: '#/definitions/CoprocessorStatusType'
      commandId:
        type: integer
        format: int64
        description: The command ID of the submitted request.
  ListScalingEventsRequest:
    type: object
    description: List scaling events request.
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      fromTimestamp:
        type: string
        format: date-time
        description: The beginning timestamp for the search range (inclusive).
      toTimestamp:
        type: string
        format: date-time
        description: The ending timestamp for the search range (exclusive).
      pageSize:
        type: integer
        format: int32
        minimum: 5
        maximum: 20
        x-paging-page-size: true
        description: The page size.
      pageToken:
        type: string
        x-paging-input-token: true
        description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
  ListScalingEventsResponse:
    type: object
    description: List scaling events response.
    properties:
      scalingEvents:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/ScalingEvent'
        description: The details of the scaling event.
      nextPageToken:
        type: string
        x-paging-output-token: true
        description: The token to use when requesting the next set of results. If not present, there are no additional results.
  ScalingEvent:
    type: object
    description: Details of a scaling event.
    properties:
      eventTimestamp:
        type: string
        format: date-time
        description: The time of the event creation.
      nodeCountBefore:
        type: integer
        format: int32
        description: Node count before scaling event.
      nodeCountAfter:
        type: integer
        format: int32
        description: Node count after scaling event.
      status:
        type: string
        description: Scaling event status.
      metric:
        type: string
        description: JSON of the metric name and value that triggered the scaling event.
      reason:
        type: string
        description: Reason for the scaling event in a readable format.
  ListEventsRequest:
    type: object
    description: List events request.
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      eventType:
        description: The type of the event.
        $ref: '#/definitions/EventType'
      fromTimestamp:
        type: string
        format: date-time
        description: The beginning timestamp for the search range (inclusive).
      toTimestamp:
        type: string
        format: date-time
        description: The ending timestamp for the search range (exclusive).
      pageSize:
        type: integer
        format: int32
        minimum: 5
        maximum: 20
        x-paging-page-size: true
        description: The page size.
      pageToken:
        type: string
        x-paging-input-token: true
        description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
      verbose:
        type: boolean
        description: Verbose flag. Set true to get a detailed response. Default is false.
  ListEventsResponse:
    type: object
    description: List events response.
    required:
      - events
    properties:
      events:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/Event'
        description: The list of events.
      nextPageToken:
        type: string
        x-paging-output-token: true
        description: The token to use when requesting the next set of results. If not present, there are no additional results.
  EventType:
    type: string
    description: Type of an Event
    enum:
      - ALERT_DELIVERY
      - AUTO_HEALING
  Event:
    type: object
    description: Details of an event.
    required:
      - id
      - type
      - status
    properties:
      id:
        type: integer
        format: int64
        description: The event ID.
      type:
        type: string
        description: Event type , currently value can be either ALERT_DELIVERY or AUTO_HEALING but more values could be introduced over time.
      status:
        type: string
        description: Event status.
      createTimestamp:
        type: string
        format: date-time
        description: The event creation timestamp.
      attributes:
        type: object
        description: Map containing event attributes. Set verbose true to get map of event attributes.
        additionalProperties:
          type: string
      statusReason:
        type: string
        description: Event reason. Set verbose true to get event reason.
      expiryTimestamp:
        type: string
        format: date-time
        description: The expiration timestamp of the event. Set verbose true to get the expiration timestamp.
      lastUpdateTimestamp:
        type: string
        format: date-time
        description: The last update timestamp of the event. Set verbose true to get last update timestamp.
      autoHealAlertId:
        type: string
        description: UUID linking the alert due to node failure and corresponding autoHealing event.
  Image:
    type: object
    description: Details of an Image.
    properties:
      id:
        type: string
        description: Image ID for the database.
      catalog:
        type: string
        description: Catalog name for the image.
  EdgeNode:
    type: object
    description: An instance of a edge nodes.
    required:
      - instanceId
      - discoveryFQDN
      - privateIp
      - publicIp
    properties:
      instanceId:
        type: string
        description: Instance ID.
      discoveryFQDN:
        type: string
        description: Fully qualified domain name
      privateIp:
        type: string
        description: Private IP.
      publicIp:
        type: string
        description: Public Ip
  ListEdgeNodesRequest:
    type: object
    description: The request for listing edge nodes in a database.
    required:
      - environment
      - database
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
  ListEdgeNodesResponse:
    type: object
    description: The response for listing edge nodes in a database.
    required:
      - environment
      - database
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      edgeNodes:
        type: array
        items:
          $ref: '#/definitions/EdgeNode'
        description: The list of edge nodes for a database.
  UpdateEdgeNodesRequest:
    type: object
    description: The request for updating edge nodes in a database.
    required:
      - environment
      - database
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      numAddEdgeNodes:
        type: integer
        format: int32
        description: The additional number of edge nodes for this database. A positive, non-zero number is required.
      deleteEdgeInstances:
        type: array
        items:
          type: string
        description: The instance(s) of database edge node to be deleted. An instance id of the node is required.
  UpdateEdgeNodesResponse:
    type: object
    description: The response for updating edge nodes in a database.
    required:
      - environment
      - database
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      edgeNodes:
        type: array
        items:
          $ref: '#/definitions/EdgeNode'
        description: The list of edge nodes for a database.
  GroupType:
    type: string
    description: "Group type for the database nodes.\n `GATEWAY` - GATEWAY value of the Group variable. `MASTER` - MASTER value of the Group variable."
    enum:
      - GATEWAY
      - MASTER
  ListCertificatesRequest:
    type: object
    description: The request of listing SHA-1 fingerprints of certificates in Global Trust Store
    required:
      - environment
      - database
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
  ListCertificatesResponse:
    type: object
    description: The response of listing fingerprints of certificates in Global Trust Store
    properties:
      fingerprints:
        type: array
        items:
          type: string
        description: List of certificate SHA-1 fingerprints in Global Trust Store
  UploadCertificateRequest:
    type: object
    description: The request of uploading a custom certificate to Global Trust Store
    required:
      - environment
      - database
      - certificate
    properties:
      environment:
        type: string
        description: The name or CRN of the environment.
      database:
        type: string
        description: The name or CRN of the database.
      certificate:
        type: string
        description: Custom certificate in PEM format
        x-sensitive: true
  UploadCertificateResponse:
    type: object
    description: The response of uploading a custom certificate to Global Trust Store
    properties:
      fingerprint:
        type: string
        description: SHA-1 fingerprint of the newly added certificate
  ListSupportedInstanceTypesRequest:
    type: object
    description: The request for listing supported instance types.
    required:
      - cloudPlatform
      - storageType
      - scaleType
    properties:
      cloudPlatform:
        description: The name of Cloud Platform.
        $ref: '#/definitions/CloudPlatform'
      storageType:
        description: The Storage Type.
        $ref: '#/definitions/StorageType'
      scaleType:
        description: The Scale Type.
        $ref: '#/definitions/ScaleType'
      instanceGroup:
        description: The Instance Group Type.
        $ref: '#/definitions/InstanceGroupType'
      architecture:
        description: The Architecture.
        $ref: '#/definitions/ArchitectureType'
  ListSupportedInstanceTypesResponse:
    type: object
    description: The response for listing supported instance types.
    properties:
      supportedInstances:
        type: array
        items:
          $ref: '#/definitions/SupportedInstanceTypesList'
        description: List of supported instance types.
  SupportedInstanceTypesList:
    type: object
    description: Instance Types list for listing supported instance types.
    properties:
      instanceGroup:
        type: string
        description: The Instance Group Type.
      defaultInstanceTypes:
        type: string
        description: The default instance type.
      supportedInstanceTypes:
        type: array
        items:
          type: string
        description: The other instance types supported.
x-audit: true