CatalogReport

Aggregated report at the catalog level.

JSON representation 
{
  "catalogType": enum (CatalogType),
  "catalog": string,
  "databaseReports": {
    string: {
      object (DatabaseReport)
    },
    ...
  }
}
Fields
catalogType

enum (CatalogType)

The type of catalog.
catalog

string

The name of the catalog (format: projects/*/catalogs/*).
databaseReports

map (key: string, value: object (DatabaseReport))

A map of database names to their respective reports.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

DatabaseReport

Aggregated report at the database level.

JSON representation 
{
  "database": string,
  "executionPlan": {
    object (ExecutionPlan)
  },
  "executionResult": {
    object (ExecutionResult)
  },
  "tableReports": {
    string: {
      object (TableReport)
    },
    ...
  }
}
Fields
database

string

The name of the database.
executionPlan

object (ExecutionPlan)

The discovered intent for the database (what we found and what we planned).
executionResult

object (ExecutionResult)

The actual outcome of the database migration.
tableReports

map (key: string, value: object (TableReport))

A map of table names to their respective reports.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ExecutionPlan

Represents the migration plan for a specific resource (e.g. Database, Table).

JSON representation 
{
  "action": enum (Action),
  "reason": string,
  "diffs": {
    string: {
      object (ValueDiff)
    },
    ...
  }
}
Fields
action

enum (Action)

The action that will be taken for a resource during migration.
reason

string

A human-readable string explaining why the action was chosen.
diffs

map (key: string, value: object (ValueDiff))

A map of field names to their respective value diff.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ValueDiff

A field-level metadata mismatch for a resource between the source and target.

JSON representation 
{
  "sourceValue": string,
  "targetValue": string
}
Fields
sourceValue

string

The value of the field at the source.
targetValue

string

The value of the field at the target.

ExecutionResult

Represents the actual migration result for a specific resource (e.g. Database, Table).

JSON representation 
{
  "state": enum (State),
  "errorMessage": string,
  "remediation": string
}
Fields
state

enum (State)

Output only. The state of the migration for a resource.
errorMessage

string

Description of the error if the state is FAILED.
remediation

string

Remediation steps for the error if the state is FAILED.

TableReport

Aggregated report at the table level.

JSON representation 
{
  "table": string,
  "executionPlan": {
    object (ExecutionPlan)
  },
  "executionResult": {
    object (ExecutionResult)
  },
  "partitionDiscoveredCount": string,
  "partitionReport": {
    object (PartitionReport)
  }
}
Fields
table

string

The name of the table.
executionPlan

object (ExecutionPlan)

The discovered intent for the table (what we found and what we planned).
executionResult

object (ExecutionResult)

The actual outcome of the table migration.
partitionDiscoveredCount

string (int64 format)

The total number of partitions identified at the source during discovery. This is only relevant for Hive Partitioned tables.
partitionReport

object (PartitionReport)

services.report containing the results of partition migration for this table. This is only relevant for Hive Partitioned tables.

PartitionReport

Partition migration report for a Hive table.

JSON representation 
{
  "state": enum (State),
  "partitionSuccessCount": string,
  "partitionFailedCount": string
}
Fields
state

enum (State)

Output only. The state of the partition migration.
partitionSuccessCount

string (int64 format)

The number of partitions successfully migrated at the target.
partitionFailedCount

string (int64 format)

The number of partitions that failed to migrate at the target.