exports

Creates, updates, deletes, gets or lists an exports resource.

Overview

Name	exports
Type	Resource
Id	google.apigee.exports

Fields

The following fields are returned by SELECT queries:

organizations_environments_analytics_exports_get

Successful response

Name	Datatype	Description
name	string	Display name of the export job.
created	string	Output only. Time the export job was created.
datastoreName	string	Name of the datastore that is the destination of the export job [datastore]
description	string	Description of the export job.
error	string	Output only. Error is set when export fails
executionTime	string	Output only. Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
self	string	Output only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
state	string	Output only. Status of the export job. Valid values include enqueued, running, completed, and failed.
updated	string	Output only. Time the export job was last updated.

organizations_environments_analytics_exports_list

Successful response

Name	Datatype	Description
exports	array	Details of the export jobs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_analytics_exports_get	select	organizationsId, environmentsId, exportsId		Gets the details and status of an analytics export job. If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.
organizations_environments_analytics_exports_list	select	organizationsId, environmentsId		Lists the details and status of all analytics export jobs belonging to the parent organization and environment.
organizations_environments_analytics_exports_create	insert	organizationsId, environmentsId		Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state value of "enqueued".

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environmentsId	string
exportsId	string
organizationsId	string

SELECT examples

organizations_environments_analytics_exports_get

Gets the details and status of an analytics export job. If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.

SELECT
name,
created,
datastoreName,
description,
error,
executionTime,
self,
state,
updated
FROM google.apigee.exports
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND exportsId = '{{ exportsId }}' -- required;

organizations_environments_analytics_exports_list

Lists the details and status of all analytics export jobs belonging to the parent organization and environment.

SELECT
exports
FROM google.apigee.exports
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;

INSERT examples

organizations_environments_analytics_exports_create

Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state value of "enqueued".

INSERT INTO google.apigee.exports (
data__name,
data__description,
data__dateRange,
data__outputFormat,
data__csvDelimiter,
data__datastoreName,
organizationsId,
environmentsId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ dateRange }}',
'{{ outputFormat }}',
'{{ csvDelimiter }}',
'{{ datastoreName }}',
'{{ organizationsId }}',
'{{ environmentsId }}'
RETURNING
name,
created,
datastoreName,
description,
error,
executionTime,
self,
state,
updated
;

Manifest

# Description fields are for documentation purposes
- name: exports
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the exports resource.
    - name: environmentsId
      value: string
      description: Required parameter for the exports resource.
    - name: name
      value: string
      description: >
        Required. Display name of the export job.
        
    - name: description
      value: string
      description: >
        Optional. Description of the export job.
        
    - name: dateRange
      value: object
      description: >
        Required. Date range of the data to export.
        
    - name: outputFormat
      value: string
      description: >
        Optional. Output format of the export. Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the `csvDelimiter` property.
        
    - name: csvDelimiter
      value: string
      description: >
        Optional. Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\t`).
        
    - name: datastoreName
      value: string
      description: >
        Required. Name of the preconfigured datastore.