REST Resource: projects.locations.assetsExportJobs

Resource: AssetsExportJob

Assets export job message.

JSON representation 
{
  "name": string,
  "condition": {
    object (ExportCondition)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "recentExecutions": [
    {
      object (AssetsExportJobExecution)
    }
  ],
  "showHidden": boolean,

  // Union field export_type can be only one of the following:
  "networkDependencies": {
    object (NetworkDependencies)
  },
  "inventory": {
    object (Inventory)
  },
  "performanceData": {
    object (PerformanceData)
  }
  // End of list of possible types for union field export_type.

  // Union field destination can be only one of the following:
  "signedUriDestination": {
    object (SignedUriDestination)
  }
  // End of list of possible types for union field destination.
}
Fields
name

string

Output only. Identifier. Resource name.
condition

object (ExportCondition)

Optional. Conditions for selecting assets to export.
createTime

string (Timestamp format)

Output only. Resource creation time.

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. Resource update time.

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".
labels

map (key: string, value: string)

Optional. Labels as key value pairs. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
  • All characters must use UTF-8 encoding, and international characters are allowed.
  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

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

object (AssetsExportJobExecution)

Output only. Recent non expired executions of the job.
showHidden

boolean

Optional. When this value is set to 'true' the response will include all assets, including those that are hidden.
Union field export_type. Type of data to export for assets. export_type can be only one of the following:
networkDependencies

object (NetworkDependencies)

Export data regarding asset network dependencies.
inventory

object (Inventory)

Export asset inventory details.
performanceData

object (PerformanceData)

Export asset with performance data.
Union field destination. Destination for export artifacts. destination can be only one of the following:
signedUriDestination

object (SignedUriDestination)

Export to Cloud Storage files downloadable using signed URIs.

ExportCondition

Conditions for selecting assets to export.

JSON representation 
{
  "filter": string
}
Fields
filter

string

Optional. Assets filter, supports the same syntax as asset listing.

NetworkDependencies

Configuration for network dependencies exports.

JSON representation 
{
  "maxDays": integer
}
Fields
maxDays

integer

Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned.

Inventory

This type has no fields.

Configuration for asset inventory details exports.

PerformanceData

Configuration for performance data exports.

JSON representation 
{
  "maxDays": integer
}
Fields
maxDays

integer

Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used.

SignedUriDestination

This type has no fields.

Signed URI destination configuration.

AssetsExportJobExecution

Execution status of assets export job.

JSON representation 
{
  "executionId": string,
  "startTime": string,
  "endTime": string,
  "expireTime": string,
  "requestedAssetCount": integer,
  "result": {
    object (Result)
  }
}
Fields
executionId

string

Output only. Globally unique identifier of the execution.
startTime

string (Timestamp format)

Output only. Execution timestamp.

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".
endTime

string (Timestamp format)

Output only. Completion time of the export.

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".
expireTime

string (Timestamp format)

Output only. Expiration time for the export and artifacts.

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".
requestedAssetCount

integer

Output only. Number of assets requested for export after resolving the requested filters.
result

object (Result)

Output only. Result of the export execution.

Result

Contains the result of the assets export.

JSON representation 
{

  // Union field result can be only one of the following:
  "signedUris": {
    object (SignedUris)
  },
  "outputFiles": {
    object (OutputFileList)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Fields

Union field result.

result can be only one of the following:
signedUris

object (SignedUris)

Output only. Signed URLs for downloading export artifacts.
outputFiles

object (OutputFileList)

Output only. List of output files.
error

object (Status)

Output only. Error encountered during export.

SignedUris

Contains a list of Signed URIs.

JSON representation 
{
  "signedUris": [
    {
      object (SignedUri)
    }
  ]
}
Fields
signedUris[]

object (SignedUri)

Output only. List of signed URIs.

SignedUri

Contains a signed URI.

JSON representation 
{
  "file": string,
  "uri": string
}
Fields
file

string

Output only. Name of the file the Signed URI references.
uri

string

Output only. Download URI for the file.

OutputFileList

Contains a list of output files.

JSON representation 
{
  "entries": [
    {
      object (OutputFile)
    }
  ]
}
Fields
entries[]

object (OutputFile)

List of output files.

OutputFile

Contains a single output file.

JSON representation 
{
  "fileSizeBytes": integer,

  // Union field type can be only one of the following:
  "csvOutputFile": {
    object (CsvOutputFile)
  }
  // End of list of possible types for union field type.
}
Fields
fileSizeBytes

integer

Output only. File size in bytes.
Union field type. The type of the output file. type can be only one of the following:
csvOutputFile

object (CsvOutputFile)

Output only. CSV output file.

CsvOutputFile

Contains a single output file of type CSV.

JSON representation 
{
  "columnsCount": integer,
  "rowCount": integer,

  // Union field destination can be only one of the following:
  "signedUri": {
    object (SignedUri)
  }
  // End of list of possible types for union field destination.
}
Fields
columnsCount

integer

Output only. Number of columns in the file.
rowCount

integer

Output only. Number of rows in the file.
Union field destination. The destination of the output file. destination can be only one of the following:
signedUri

object (SignedUri)

Output only. Signed URI destination.

Methods

create

 Creates a new assets export job.

delete

 Deletes an assets export job.

get

 Gets the details of an assets export job.

list

 Lists all the assets export jobs in a given project and location.

run

 Runs an assets export job, returning an AssetsExportJobExecution.