exports

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

Overview

Name	exports
Type	Resource
Id	google.apigee.exports

Fields

Name	Datatype	Description
name	string	Display name of the export job.
description	string	Description 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]
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.

Methods

Name	Accessible by	Required Params	Description
organizations_environments_analytics_exports_get	SELECT	environmentsId, exportsId, organizationsId	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	environmentsId, organizationsId	Lists the details and status of all analytics export jobs belonging to the parent organization and environment.
organizations_environments_analytics_exports_create	INSERT	environmentsId, organizationsId	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".

SELECT examples

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

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

INSERT example

Use the following StackQL query and manifest file to create a new exports resource.

All Properties

/*+ create */
INSERT INTO google.apigee.exports (
environmentsId,
organizationsId,
description,
csvDelimiter,
outputFormat,
datastoreName,
name,
dateRange
)
SELECT 
'{{ environmentsId }}',
'{{ organizationsId }}',
'{{ description }}',
'{{ csvDelimiter }}',
'{{ outputFormat }}',
'{{ datastoreName }}',
'{{ name }}',
'{{ dateRange }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: description
      value: string
    - name: csvDelimiter
      value: string
    - name: outputFormat
      value: string
    - name: datastoreName
      value: string
    - name: name
      value: string
    - name: dateRange
      value:
        - name: end
          value: string
        - name: start
          value: string