REST Resource: projects.locations.importJobs

Resource: ImportJob

A resource that represents the background job that imports asset frames.

JSON representation 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "completeTime": string,
  "state": enum (ImportJobState),
  "labels": {
    string: string,
    ...
  },
  "assetSource": string,

  // Union field report can be only one of the following:
  "validationReport": {
    object (ValidationReport)
  },
  "executionReport": {
    object (ExecutionReport)
  }
  // End of list of possible types for union field report.

  // Union field payload_info can be only one of the following:
  "inlinePayload": {
    object (InlinePayloadInfo)
  },
  "gcsPayload": {
    object (GCSPayloadInfo)
  }
  // End of list of possible types for union field payload_info.
}
Fields
name

string

Output only. The full name of the import job.
displayName

string

User-friendly display name. Maximum length is 63 characters.
createTime

string (Timestamp format)

Output only. The timestamp when the import job was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The timestamp when the import job was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
completeTime

string (Timestamp format)

Output only. The timestamp when the import job was completed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (ImportJobState)

Output only. The state of the import job.
labels

map (key: string, value: string)

Labels as key value pairs.

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

string

Required. Reference to a source.
Union field report. Holds the various report types of an import job. report can be only one of the following:
validationReport

object (ValidationReport)

Output only. The report with the validation results of the import job.
executionReport

object (ExecutionReport)

Output only. The report with the results of running the import job.
Union field payload_info. The import job payload data. payload_info can be only one of the following:
inlinePayload

object (InlinePayloadInfo)

The payload is included in the request, mainly used for small import jobs.
gcsPayload
(deprecated)

object (GCSPayloadInfo)

The payload is in Google Cloud Storage.

ImportJobState

Enumerates possible states of an import job.

Enums
IMPORT_JOB_STATE_UNSPECIFIED Default value.
IMPORT_JOB_STATE_PENDING The import job is pending.
IMPORT_JOB_STATE_RUNNING The processing of the import job is ongoing.
IMPORT_JOB_STATE_COMPLETED The import job processing has completed.
IMPORT_JOB_STATE_FAILED The import job failed to be processed.
IMPORT_JOB_STATE_VALIDATING The import job is being validated.
IMPORT_JOB_STATE_FAILED_VALIDATION The import job contains blocking errors.
IMPORT_JOB_STATE_READY The validation of the job completed with no blocking errors.

ValidationReport

A resource that aggregates errors across import job files.

JSON representation 
{
  "fileValidations": [
    {
      object (FileValidationReport)
    }
  ],
  "jobErrors": [
    {
      object (ImportError)
    }
  ]
}
Fields
fileValidations[]

object (FileValidationReport)

List of errors found in files.
jobErrors[]

object (ImportError)

List of job level errors.

FileValidationReport

A resource that aggregates the validation errors found in an import job file.

JSON representation 
{
  "fileName": string,
  "rowErrors": [
    {
      object (ImportRowError)
    }
  ],
  "partialReport": boolean,
  "fileErrors": [
    {
      object (ImportError)
    }
  ]
}
Fields
fileName

string

The name of the file.
rowErrors[]

object (ImportRowError)

Partial list of rows that encountered validation error.
partialReport

boolean

Flag indicating that processing was aborted due to maximum number of errors.
fileErrors[]

object (ImportError)

List of file level errors.

ImportRowError

A resource that reports the import job errors at row level.

JSON representation 
{
  "rowNumber": integer,
  "vmName": string,
  "vmUuid": string,
  "assetTitle": string,
  "errors": [
    {
      object (ImportError)
    }
  ],

  // Union field error_details can be only one of the following:
  "csvError": {
    object (CsvErrorDetails)
  },
  "xlsxError": {
    object (XlsxErrorDetails)
  },
  "jsonError": {
    object (JsonErrorDetails)
  },
  "archiveError": {
    object (ArchiveErrorDetails)
  }
  // End of list of possible types for union field error_details.
}
Fields
rowNumber
(deprecated)

integer

The row number where the error was detected.
vmName

string

The name of the VM in the row.
vmUuid

string

The VM UUID.
assetTitle

string

The asset title.
errors[]

object (ImportError)

The list of errors detected in the row.
Union field error_details. Additional error details per file type. error_details can be only one of the following:
csvError

object (CsvErrorDetails)

Error details for a CSV file.
xlsxError

object (XlsxErrorDetails)

Error details for an XLSX file.
jsonError

object (JsonErrorDetails)

Error details for a JSON file.
archiveError

object (ArchiveErrorDetails)

Error details for an archive file.

ImportError

A resource that reports the errors encountered while processing an import job.

JSON representation 
{
  "errorDetails": string,
  "severity": enum (Severity)
}
Fields
errorDetails

string

The error information.
severity

enum (Severity)

The severity of the error.

Severity

Enumerate possible error severity.

Enums
SEVERITY_UNSPECIFIED
ERROR
WARNING
INFO

CsvErrorDetails

Error details for a CSV file.

JSON representation 
{
  "rowNumber": integer
}
Fields
rowNumber

integer

The row number where the error was detected.

XlsxErrorDetails

Error details for an XLSX file.

JSON representation 
{
  "sheet": string,
  "rowNumber": integer
}
Fields
sheet

string

The name of the sheet where the error was detected.
rowNumber

integer

The row number where the error was detected.

JsonErrorDetails

This type has no fields.

Error details for a JSON file.

ArchiveErrorDetails

Error details for an archive file.

JSON representation 
{
  "filePath": string,

  // Union field error_details can be only one of the following:
  "csvError": {
    object (CsvErrorDetails)
  }
  // End of list of possible types for union field error_details.
}
Fields
filePath

string

The file path inside the archive where the error was detected.
Union field error_details. Additional error details per file type. error_details can be only one of the following:
csvError

object (CsvErrorDetails)

Error details for a CSV file.

ExecutionReport

A resource that reports result of the import job execution.

JSON representation 
{
  "framesReported": integer,
  "executionErrors": {
    object (ValidationReport)
  },
  "jobErrors": [
    {
      object (ImportError)
    }
  ],
  "totalRowsCount": integer
}
Fields
framesReported

integer

Total number of asset frames reported for the import job.
executionErrors

object (ValidationReport)

Validation errors encountered during the execution of the import job.
jobErrors[]
(deprecated)

object (ImportError)

List of job-level errors. Deprecated, use the job errors under executionErrors instead.
totalRowsCount

integer

Total number of rows in the import job.

InlinePayloadInfo

A resource that represents the inline import job payload.

JSON representation 
{
  "format": enum (ImportJobFormat),
  "payload": [
    {
      object (PayloadFile)
    }
  ]
}
Fields
format

enum (ImportJobFormat)

The import job format.
payload[]

object (PayloadFile)

List of payload files.

PayloadFile

Payload file for inline import job payload.

JSON representation 
{
  "name": string,
  "data": string
}
Fields
name

string

The file name.
data

string (bytes format)

The file data.

A base64-encoded string.

GCSPayloadInfo

A resource that represents a payload hosted on Google Cloud Storage.

JSON representation 
{
  "format": enum (ImportJobFormat),
  "path": string
}
Fields
format

enum (ImportJobFormat)

The import job format.
path

string

The payload path in Google Cloud Storage.

Methods

create

 Creates an import job.

delete

 Deletes an import job.

get

 Gets the details of an import job.

list

 Lists all import jobs.

patch

 Updates an import job.

run

 Runs an import job.

validate

 Validates an import job.