REST Resource: projects.locations.instances.dataExports

Resource: DataExport

DataExport resource.

JSON representation
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "logType": string,
  "gcsBucket": string,
  "dataExportStatus": {
    object (DataExportStatus)
  },
  "exportAllLogs": boolean,
  "includeLogTypes": [
    string
  ],
  "estimatedVolume": string,
  "exportedVolume": string,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. Name of the DataExport.

startTime

string (Timestamp format)

Required. Start, inclusive time from the range.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Required. Last, exclusive time from the range.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

logType

string

Optional. Log type to export. Format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{logType}

gcsBucket

string

Required. Link to the destination Cloud Storage bucket.

dataExportStatus

object (DataExportStatus)

Output only. Status of the current export.

exportAllLogs

boolean

Optional. Option to indicate export of all log types.

includeLogTypes[]

string

Optional. The specific log types to include in the Data Export request. Each string must be a resource name for a LogType. Format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{logType} This field is optional. If empty, all available log types for the specified data source(s) and time range(s) will be included in the export.

estimatedVolume

string (int64 format)

Output only. The estimated export volume in bytes, estimated at job creation/updation

exportedVolume

string (int64 format)

Output only. Actual volume of data exported, measured upon job completion.

createTime

string (Timestamp format)

Output only. Timestamp indicating when the DataExport resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Timestamp indicating the last time the DataExport resource was updated, including status changes.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

DataExportStatus

Represents a data export status.

JSON representation
{
  "stage": enum (Stage),
  "progressPercentage": integer,
  "error": string,
  "exportedGlobPatterns": [
    string
  ]
}
Fields
stage

enum (Stage)

Output only. The stage/status of a given data export request.

progressPercentage

integer

Output only. The progress in percentage, only applicable for stage "PROCESSING".

error

string

Output only. The error message if the stage is FINISHED_FAILURE

exportedGlobPatterns[]

string

Output only. List of exported glob patterns for the export request.

Stage

Represents the stage/status of the data export request.

Enums
STAGE_UNSPECIFIED Unspecified stage.
IN_QUEUE The request is still in the queue and yet to be processed.
PROCESSING The request is being processed.
FINISHED_FAILURE The system wasn't able to process the request successfully.
FINISHED_SUCCESS The system processed the request successfully.
CANCELLED The request has been cancelled by the system.

Methods

cancel

Cancels a DataExport.

create

Creates a new DataExport.

fetchavailablelogtypes

Fetches available log types for export.

get

Gets a DataExport.