Delphix HyperscaleObjects API

The HyperscaleObjects API from Delphix — 17 operation(s) for hyperscaleobjects.

OpenAPI Specification

delphix-hyperscaleobjects-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Delphix DCT Algorithms HyperscaleObjects API
  version: 3.28.0
  description: Delphix DCT API
  contact:
    name: Delphix Support
    url: https://portal.perforce.com/s/
    email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: HyperscaleObjects
paths:
  /hyperscale-mount-points:
    get:
      tags:
      - HyperscaleObjects
      summary: Returns a list of Hyperscale Mount Points.
      operationId: get_hyperscale_mount_points
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hyperscaleMountPointsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListHyperscaleMountPointsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleMountPoint'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      tags:
      - HyperscaleObjects
      summary: Create a Hyperscale Mount Point
      operationId: create_hyperscale_mount_point
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: hyperscale_mount_point
              $ref: '#/components/schemas/HyperscaleMountPoint'
        description: Request to create a Hyperscale Mount Point.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: CreateHyperscaleMountPointResponse
                properties:
                  id:
                    type: string
                    description: The created Hyperscale Mount Point's ID
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /hyperscale-mount-points/{hyperscaleMountPointId}:
    parameters:
    - $ref: '#/components/parameters/hyperscaleMountPointIdParam'
    get:
      tags:
      - HyperscaleObjects
      summary: Get a Hyperscale Mount Points.
      operationId: get_hyperscale_mount_point_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HyperscaleMountPoint'
    patch:
      tags:
      - HyperscaleObjects
      summary: Update a Hyperscale Mount Point by ID.
      operationId: update_hyperscale_mount_point_by_id
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_hyperscale_mount_point_parameter
              $ref: '#/components/schemas/HyperscaleMountPointUpdateParameters'
        description: The new data to update a Hyperscale Mount Point.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateHyperscaleMountPointResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
    delete:
      tags:
      - HyperscaleObjects
      summary: Delete a Hyperscale Mount Point.
      operationId: delete_hyperscale_mount_point
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteHyperscaleMountPointResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /hyperscale-mount-points/{hyperscaleMountPointId}/validate:
    parameters:
    - $ref: '#/components/parameters/hyperscaleMountPointIdParam'
    get:
      tags:
      - HyperscaleObjects
      summary: Validate the permissions for the Hyperscale Mount Point.
      operationId: validate_hyperscale_mount_point
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ValidateHyperscaleMountPointResponse'
  /hyperscale-mount-points/search:
    post:
      summary: Search for Hyperscale Mount Points.
      operationId: search_hyperscale_mount_points
      tags:
      - HyperscaleObjects
      x-filterable:
        fields:
          id:
            type: string
          hyperscale_instance_id:
            type: string
          name:
            type: string
          hostname:
            type: string
          mount_type:
            type: string
          mount_path:
            type: string
          options:
            type: string
          staging_storage_type:
            type: string
          auth_mechanism:
            type: string
          aws_bucket_name:
            type: string
          aws_bucket_region:
            type: string
          aws_bucket_prefix:
            type: string
          aws_bucket_delimiter:
            type: string
          blob_auth_type:
            type: string
          blob_account_name:
            type: string
          blob_container_name:
            type: string
          blob_container_prefix:
            type: string
          blob_container_delimiter:
            type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hyperscaleMountPointsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchHyperscaleMountPointsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleMountPoint'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /hyperscale-connectors:
    get:
      tags:
      - HyperscaleObjects
      summary: Returns a list of Hyperscale Connectors.
      operationId: get_hyperscale_connectors
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hyperscaleConnectorsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListHyperscaleConnectorsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleConnector'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      tags:
      - HyperscaleObjects
      summary: Create a Hyperscale Connector.
      operationId: create_hyperscale_connector
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: hyperscale_connector
              $ref: '#/components/schemas/HyperscaleConnectorCreateParameters'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: CreateHyperscaleConnectorResponse
                properties:
                  id:
                    type: string
                    description: The created Hyperscale Connector's ID.
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /hyperscale-connectors/{hyperscaleConnectorId}:
    parameters:
    - $ref: '#/components/parameters/hyperscaleConnectorIdParam'
    get:
      tags:
      - HyperscaleObjects
      summary: Get a Hyperscale Connector.
      operationId: get_hyperscale_connector_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HyperscaleConnector'
    patch:
      tags:
      - HyperscaleObjects
      summary: Update a Hyperscale Connector by ID.
      operationId: update_hyperscale_connector_by_id
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_hyperscale_connector_parameter
              $ref: '#/components/schemas/HyperscaleConnectorUpdateParameters'
        description: The new data to update a Hyperscale Connector.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateHyperscaleConnectorResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
    delete:
      tags:
      - HyperscaleObjects
      summary: Delete a Hyperscale Connector.
      operationId: delete_hyperscale_connector
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: DeleteHyperscaleConnectorResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
  /hyperscale-connectors/{hyperscaleConnectorId}/tags:
    parameters:
    - $ref: '#/components/parameters/hyperscaleConnectorIdParam'
    post:
      tags:
      - HyperscaleObjects
      summary: Create tags for a Hyperscale Connector.
      operationId: create_hyperscale_connector_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: hyperscale_connector_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tag information for a Hyperscale Connector.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - HyperscaleObjects
      summary: Get tags for a Hyperscale Connector.
      operationId: get_hyperscale_connector_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /hyperscale-connectors/{hyperscaleConnectorId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/hyperscaleConnectorIdParam'
    post:
      tags:
      - HyperscaleObjects
      summary: Delete tags for a Hyperscale Connector.
      operationId: delete_hyperscale_connector_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
  /hyperscale-connectors/search:
    post:
      summary: Search for Hyperscale Connectors.
      operationId: search_hyperscale_connectors
      tags:
      - HyperscaleObjects
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          hyperscale_instance_id:
            type: string
          data_type:
            type: string
          source_username:
            type: string
          source_jdbc_url:
            type: string
          source_mongo_url:
            type: string
          source_filesystem_path:
            type: string
          target_username:
            type: string
          target_jdbc_url:
            type: string
          target_mongo_url:
            type: string
          target_filesystem_path:
            type: string
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hyperscaleConnectorsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchHyperscaleConnectorsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleConnector'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /hyperscale-datasets:
    get:
      tags:
      - HyperscaleObjects
      summary: Returns a list of Hyperscale Datasets.
      operationId: get_hyperscale_datasets
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hyperscaleDatasetsSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListHyperscaleDatasetsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleDataset'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /hyperscale-datasets/{hyperscaleDatasetId}:
    parameters:
    - $ref: '#/components/parameters/hyperscaleDatasetIdParam'
    get:
      tags:
      - HyperscaleObjects
      summary: Get a Hyperscale Dataset.
      operationId: get_hyperscale_dataset_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HyperscaleDataset'
    patch:
      tags:
      - HyperscaleObjects
      summary: Update a Hyperscale Dataset by ID.
      operationId: update_hyperscale_dataset_by_id
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_hyperscale_dataset_parameter
              $ref: '#/components/schemas/HyperscaleDatasetUpdateParameters'
        description: The new data to update a Hyperscale Dataset.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateHyperscaleDatasetResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
  /hyperscale-datasets/{hyperscaleDatasetId}/tags:
    parameters:
    - $ref: '#/components/parameters/hyperscaleDatasetIdParam'
    post:
      tags:
      - HyperscaleObjects
      summary: Create tags for a Hyperscale Dataset.
      operationId: create_hyperscale_dataset_tags
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: hyperscale_dataset_tags
              $ref: '#/components/schemas/TagsRequest'
        description: Tag information for a Hyperscale Dataset.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - HyperscaleObjects
      summary: Get tags for a Hyperscale Dataset.
      operationId: get_hyperscale_dataset_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /hyperscale-datasets/{hyperscaleDatasetId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/hyperscaleDatasetIdParam'
    post:
      tags:
      - HyperscaleObjects
      summary: Delete tags for a Hyperscale Dataset.
      operationId: delete_hyperscale_dataset_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
  /hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/{hyperscaleDatasetTableOrFileId}:
    parameters:
    - $ref: '#/components/parameters/hyperscaleDatasetIdParam'
    - $ref: '#/components/parameters/hyperscaleDatasetTableOrFileIdParam'
    get:
      tags:
      - HyperscaleObjects
      summary: Get a Hyperscale Dataset table or file by ID.
      operationId: get_hyperscale_dataset_table_or_file_by_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HyperscaleDatasetTableOrFile'
    patch:
      tags:
      - HyperscaleObjects
      summary: Update a Hyperscale Dataset table or file by ID.
      operationId: update_hyperscale_dataset_table_or_file_by_id
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: update_hyperscale_dataset_table_or_file_parameter
              $ref: '#/components/schemas/HyperscaleDatasetTableOrFileUpdateParameters'
        description: The new data to update a Hyperscale Dataset table or file.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: UpdateHyperscaleDatasetTableOrFileResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
  /hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files:
    parameters:
    - $ref: '#/components/parameters/hyperscaleDatasetIdParam'
    - $ref: '#/components/parameters/limit'
    - $ref: '#/components/parameters/cursor'
    - $ref: '#/components/parameters/hyperscaleDatasetTablesOrFilesSortParam'
    get:
      tags:
      - HyperscaleObjects
      summary: Get the tables or files of a hyperscale dataset
      operationId: get_hyperscale_dataset_tables_or_files
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListHyperscaleDatasetTablesOrFilesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleDatasetTableOrFile'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/search:
    parameters:
    - $ref: '#/components/parameters/hyperscaleDatasetIdParam'
    - $ref: '#/components/parameters/limit'
    - $ref: '#/components/parameters/cursor'
    - $ref: '#/components/parameters/hyperscaleDatasetTablesOrFilesSortParam'
    post:
      tags:
      - HyperscaleObjects
      x-filterable:
        fields:
          id:
            type: string
          schema_name:
            type: string
          table_name:
            type: string
          filter_key:
            type: string
          column_array_rows:
            type: integer
          unload_split:
            type: integer
          stream_size:
            type: integer
          masking_inventory:
            type: array[object]
            fields:
              field_name:
                type: string
              domain_name:
                type: string
              algorithm_name:
                type: string
              date_format:
                type: string
              algorithm_field_name:
                type: string
              algorithm_group_no:
                type: integer
      summary: Search the tables or files of a hyperscale dataset
      operationId: search_hyperscale_dataset_tables_or_files
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchHyperscaleDatasetTablesOrFilesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleDatasetTableOrFile'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /hyperscale-datasets/search:
    post:
      summary: Search for Hyperscale Datasets.
      operationId: search_hyperscale_datasets
      tags:
      - HyperscaleObjects
      x-filterable:
        fields:
          id:
            type: string
          hyperscale_instance_id:
            type: string
          data_type:
            type: string
          mount_point_id:
            type: string
          connector_id:
            type: string
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hyperscaleDatasetsSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchHyperscaleDatasetsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HyperscaleDataset'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
components:
  schemas:
    Tag:
      type: object
      required:
      - key
      - value
      properties:
        key:
          description: Key of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: key-1
        value:
          description: Value of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: value-1
    HyperscaleMountPoint:
      title: HyperscaleMountPoint
      type: object
      description: A Mount Point for the Hyperscale instance to write to a staging area and engines to read from.
      required:
      - hyperscale_instance_id
      properties:
        id:
          description: The ID of the Hyperscale Mount Point.
          type: string
          readOnly: true
        hyperscale_instance_id:
          description: The ID of the Hyperscale instance of this Mount Point.
          type: string
        name:
          description: Name of the mount, unique for a hyperscale instance. This name will be used as a directory name by the Hyperscale instance.
          type: string
        hostname:
          description: The host name of the server.
          type: string
        mount_path:
          description: The path to the directory on the filesystem to mount.
          type: string
        mount_type:
          description: The type of mount filesystem. Enum having values- CIFS, NFS3, NFS4.
          type: string
          enum:
          - CIFS
          - NFS3
          - NFS4
        options:
          type: string
          description: The options for mount. The endpoint will return all default options and user specified options.
        staging_storage_type:
          description: The type of staging storage.
          type: string
          enum:
          - MOUNT
          - AWS_S3
          - AZURE_BLOB_STORAGE
        auth_mechanism:
          description: The authentication mechanism for AWS_S3 storage.
          type: string
          enum:
          - AWS_ROLE
          - AWS_SECRET
        aws_bucket_name:
          type: string
          description: The aws bucket name for AWS_S3 storage.
        aws_bucket_region:
          type: string
          description: The aws bucket region for AWS_S3 storage.
        aws_bucket_prefix:
          type: string
          description: The aws bucket prefix for AWS_S3 storage.
        aws_bucket_delimiter:
          type: string
          description: The aws bucket delimiter for AWS_S3 storage.
        blob_auth_type:
          description: The authentication type for Azure blob storage.
          type: string
          enum:
          - AZURE_SECRET
          - AZURE_MANAGED_IDENTITY
        blob_account_name:
          type: string
          description: The storage account name for Azure blob storage.
        blob_container_name:
          type: string
          description: The blob container name for Azure blob storage.
        blob_container_prefix:
          type: string
          description: The blob container prefix for Azure blob storage.
        blob_container_delimiter:
          type: string
          description: The blob container delimiter for Azure blob storage.
    VirtualizationTaskEvent:
      deprecated: true
      properties:
        message_details:
          type: string
    HyperscaleConnectorUpdateParameters:
      title: HyperscaleConnectorUpdateParameters
      type: object
      description: The updatable properties of a Hyperscale Connector.
      properties:
        name:
          type: string
        source_username:
          description: The username this Connector will use to connect to the source database.
          type: string
        source_password:
          x-dct-toolkit-credential-field: true
          description: The password this Connector will use to connect to the source database.
          type: string
        source_jdbc_url:
          description: The JDBC URL used to connect to the source database.
          type: string
        source_mongo_url:
          description: The MongoDB URL used to connect to the source database.
          type: string
          example: mongodb://host:27017
        source_filesystem_path:
          description: The path on the filesystem where source files must be read (Delimited files Only).
          type: string
        source_connection_properties:
          additionalProperties:
            type: string
        target_username:
          description: The username this Connector will use to connect to the target database.
          type: string
        target_password:
          x-dct-toolkit-credential-field: true
          description: The username this Connector will use to connect to the target database.
          type: string
        target_jdbc_url:
          description: The JDBC URL used to connect to the target database.
          type: string
        target_mongo_url:
          description: The MongoDB URL used to connect to the target database.
          type: string
          example: mongodb://host:27017
        target_filesystem_path:
          description: The path on the filesystem where target files must be written (Delimited files Only).
          type: string
        target_connection_properties:
          additionalProperties:
            type: string
    Engine:
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 4000
        engine_name:
          type: string
          minLength: 1
          maxLength: 4000
    PaginatedResponseMetadata:
      type: object
      properties:
        prev_cursor:
          description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
          type: string
        next_cursor:
          description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
          type: string
        total:
          description: The total number of results. This value may not be provided.
          type: integer
          format: int_64
    ValidateHyperscaleMountPointResponse:
      title: ValidateHyperscaleMountPointResponse
      type: object
      description: Mount File system permissions validation.
      properties:
        isValid:
          description: The flag to validate whether a file mount is valid.
          type: boolean
          default: false
      example:
        isValid: true
    JobTaskEvent:
      properties:
        message_details:
          type: string
    HyperscaleConnector:
      title: HyperscaleConnector
      type: object
      description: A Hyperscale connector to read/write data from/to a datasource.
      properties:
        id:
          description: The ID of the Hyperscale Connector.
          type: string
          readOnly: true
        hyperscale_instance_id:
          description: The ID of the Hyperscale instance of this Connector.
          type: string
        data_type:
          $ref: '#/components/schemas/HyperscaleDataTypeEnum'
        name:
          type: string
        source_username:
          description: The username this Connector will use to connect to the source database.
          type: string
        source_password:
          x-dct-toolkit-credential-field: true
          description: The password this Connector will use to connect to the source database.
          type: string
        source_jdbc_url:
          description: The JDBC URL used to connect to the source database.
          type: string
        source_mongo_url:
          description: The MongoDB URL used to connect to the source database.
          type: string
          example: mongodb://host:27017
        source_filesystem_path:
          description: The path on the filesystem where source files must be read (Delimited files Only).
          type: string
        source_connection_properties:
          additionalProperties:
            type: string
        target_username:
          description: The username this Connector will use to connect to the target database.
          type: string
        target_password:
          x-dct-toolkit-credential-field: true
          description: The username this Connector will use to connect to the target database.
          type: string
        target_jdbc_url:
          description: The JDBC URL used to connect to the target database.
          type: string
        target_mongo_url:
          description: The MongoDB URL used to connect to the target database.
          type: string
          example: mongodb://host:27017
        target_filesystem_path:
          description: The path on the filesystem where target files must be written (Delimited files Only).
          type: string
        target_connection_properties:
          additionalProperties:
            type: string
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    DeleteTag:
      type: object
      properties:
        key:
          description: Key of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: key-1
        value:
          description: Value of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: value-1
        tags:
          description: List of tags to be deleted
          type: array
          minItems: 1
          maxItems: 1000
          uniqueItems: true
          items:
            $ref: '#/components/schemas/Tag'
    JobTask:
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/JobTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-hyperscaleobjects-api-openapi.yml