ApiTransformCopylistingReq Data Model

Represents the arguments required for transforming copylisting files.

  • pathMappings: Mapping rules from source to target paths. The paths should be absolute paths without protocol and HDFS namenode address/Ozone service ID. Example: /source/path to /target/path.
    • null values are not allowed.
  • statusType: The type of the status objects in the input sequence file. Based on the values of com.cloudera.enterprise.distcp.util.StatusTypes.
  • fromSequenceFile: Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the source sequence file. This file must exist before calling the endpoint Example: hdfs://namenode:8020/source/seqfile or ofs://ozone-service/vol/bkt/file.
  • fromRenameDeleteSequenceFile: Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the source rename/delete sequence file. This file must exist before calling the endpoint
  • toSequenceFile: Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the destination sequence file. This file must not exist before calling the endpoint
  • toRenameDeleteSequenceFile: Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the destination rename/delete sequence file. This file must not exist before calling the endpoint
  • additionalConfigs: A map of additional configuration options for the transformation. These will be merged with the configuration gathered for the command automatically. null values are not allowed.
  • unsetConfigs: A set of configuration options to be unset. null values are not allowed.
  • additionalEnvironmentVariables: A map of additional environment variables to be used in the one-off process. null values are not allowed.

Properties
name data type description
pathMappings map of string Mapping rules from source to target paths.

The paths should be absolute paths without protocol and HDFS namenode address/Ozone service ID. Example: /source/path to /target/path. null values are not allowed.

statusType string The type of the status objects in the input sequence file.

Based on the values of com.cloudera.enterprise.distcp.util.StatusTypes.

fromSequenceFile string Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the source sequence file.

This file must exist before calling the endpoint Example: hdfs://namenode:8020/source/seqfile or ofs://ozone-service/vol/bkt/file.

fromRenameDeleteSequenceFile string Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the source rename/delete sequence file.

This file must exist before calling the endpoint

toSequenceFile string Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the destination sequence file.

This file must not exist before calling the endpoint

toRenameDeleteSequenceFile string Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the destination rename/delete sequence file.

This file must not exist before calling the endpoint

additionalConfigs map of string A map of additional configuration options for the transformation. These will be merged with the configuration gathered for the command automatically. null values are not allowed.
unsetConfigs array of string A set of configuration options to be unset. null values are not allowed.
additionalEnvironmentVariables map of string A map of additional environment variables to be used in the one-off process

This is the place to add environment variables related to e.g. kinit that acquires the TGT on the execution-side (usually the destination) or JVM options.

null values are not allowed; this interface must be changed should that be necessary.

Example

{
  "pathMappings" : {
    "property1" : "...",
    "property2" : "..."
  },
  "statusType" : "...",
  "fromSequenceFile" : "...",
  "fromRenameDeleteSequenceFile" : "...",
  "toSequenceFile" : "...",
  "toRenameDeleteSequenceFile" : "...",
  "additionalConfigs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "unsetConfigs" : [ "...", "..." ],
  "additionalEnvironmentVariables" : {
    "property1" : "...",
    "property2" : "..."
  }
}