Delphix HyperscaleObjects API

openapi: 3.2.0
info:
  title: Delphix DCT Hyperscale Objects 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
    Job:
      description: An asynchronous task.
      type: object
      properties:
        id:
          description: The Job entity ID.
          type: string
          example: job-123
        status:
          description: The status of the job.
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
          example: RUNNING
        is_waiting_for_telemetry:
          description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.
          type: boolean
        type:
          description: The type of job being done.
          type: string
          example: DB_REFRESH
        localized_type:
          description: The i18n translated type of job being done.
          type: string
          example: DB Refresh
        error_details:
          description: Details about the failure for FAILED jobs.
          type: string
          example: Unable to connect to the engine.
        warning_message:
          description: Warnings for the job.
          type: string
          example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.'
        target_id:
          description: A reference to the job's target.
          type: string
          example: vdb-123
        target_name:
          description: A reference to the job's target name.
          type: string
          example: vdb
        start_time:
          description: The time the job started executing.
          type: string
          format: date-time
          example: '2022-01-02T05:11:24.148000+00:00'
        update_time:
          description: The time the job was last updated.
          type: string
          format: date-time
          example: '2022-01-02T06:11:24.148000+00:00'
        trace_id:
          description: traceId of the request which created this Job
          type: string
        engine_ids:
          description: IDs of the engines this Job is executing on.
          type: array
          items:
            type: string
          deprecated: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        engines:
          type: array
          items:
            $ref: '#/components/schemas/Engine'
        account_id:
          description: The ID of the account who initiated this job.
          type: integer
          example: 1
        account_name:
          description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-<id>.
          type: string
          example: User 1
        compliance_node_id:
          type:
          - string
          - 'null'
          description: The ID of the associated compliance node, if applicable.
        compliance_node_name:
          type:
          - string
          - 'null'
          description: The name of the associated compliance node, if applicable.
        percent_complete:
          description: Completion percentage of the Job.
          type: integer
          minimum: 0
          maximum: 100
          example: '50'
        virtualization_tasks:
          deprecated: true
          type: array
          items:
            $ref: '#/components/schemas/VirtualizationTask'
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/JobTask'
        execution_id:
          description: The ID of the associated masking execution, if any.
          type:
          - string
          - 'null'
        result_type:
          description: The type of the job result. This is the type of the object present in the result.
          type: string
        result:
          description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.
          type: object
    HyperscaleDatasetUpdateParameters:
      title: HyperscaleDatasetUpdateParameters
      type: object
      description: The updatable properties of a Hyperscale Dataset.
      properties:
        mount_point_id:
          description: The Id of the Hyperscale Mount Point used for this Dataset.
          type: string
        connector_id:
          description: Id the Hyperscale Connector used to read sensitive data and write masked data.
          type: string
    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
    JobTaskEvent:
      properties:
        message_details:
          type: string
    HyperscaleDatasetTableOrFile:
      title: HyperscaleDatasetTableOrFile
      type: object
      description: A table or file which is part of a hyperscale dataset.
      properties:
        id:
          description: The ID of the Hyperscale Dataset table or file.
          type: string
        schema_name:
          type: string
          description: Name of the table schema (Oracle/MSSql only).
        table_name:
          type: string
          description: Name of the table (Oracle/MSSql only).
        collection_name:
          type: string
          description: Name of the collection (MongoDB only).
        database_name:
          type: string
          description: Name of the database (MongoDB only).
        filter_key:
          description: The unique database column field to filter the source data.
          type: string
        column_array_rows:
          description: The number of column array rows to be used by the sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built.
          type: integer
          format: int64
        unload_split:
          description: The number of unloaded files to be generated from the source database.
          type: integer
          format: int64
        stream_size:
          description: Long The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server.
          type: integer
          format: int64
        end_of_record:
          description: The end of line character. Support values are \n, \r  and \r\n (Delimited files only).
          type: string
        delimiter:
          description: The single character length delimiter used in source files (Delimited files only).
          type: string
        enclosure:
          description: The single character length quote character used in the source files (Delimited files only).
          type: string
        enclosure_escape_character:
          description: The escape character used to escape quote characters (Delimited files only).
          type: string
        escape_enclosure_escape_character:
          description: Whether to escape the enclosure escape character (Delimited files only).
          type: boolean
        has_headers:
          description: Whether source files have header column names or not (Delimited files only). If set to true, format files with the same column names are created and the same can be used for the masking inventory. If set to false, the column names of pattern f0, f1, f2, and so on are used to create the format files for delimited file masking.
          type: boolean
        unique_source_files_identifier:
          description: This is the source key that maps the load-service and masking-service data sets with the unload-service data set (Delimited files only). Please ensure that this value is different for each HyperscaleDatasetTableOrFile.
          type: string
        source_files:
          description: List of all source files that need to be masked (Delimited files only). All files should have the same delimiter character and other helper characters. All files should have the same number of columns and same column names if it has a header line.
          type: array
          items:
            type: string
        perform_join:
          description: Whether the split files must be joined (Delimited files only).
          type: boolean
        masking_inventory:
          type: array
          description: DataSet information for masking inventory.
          items:
            type: object
            title: HyperscaleColumnOrField
            properties:
              field_name:
                description: Name of the field.
                type: string
              domain_name:
                description: The name of the domain assigned to this field.
                type: string
              algorithm_name:
                description: The name of the algorithm assigned to this field.
                type: string
              date_format:
                description: The format of the date assigned to this field.
                type: string
              algorithm_field_name:
                description: The name of the algorithm field that is associated with th

# --- 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