1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.analytics.html">analytics</a> . <a href="apigee_v1.organizations.environments.analytics.exports.html">exports</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">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".</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">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`.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists the details and status of all analytics export jobs belonging to the parent organization and environment.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 97 <pre>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". 98 99Args: 100 parent: string, Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`. (required) 101 body: object, The request body. 102 The object takes the form of: 103 104{ # Request body for [CreateExportRequest] 105 "csvDelimiter": "A String", # 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`). 106 "datastoreName": "A String", # Required. Name of the preconfigured datastore. 107 "dateRange": { # Date range of the data to export. # Required. Date range of the data to export. 108 "end": "A String", # Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- which will not be in the output. 109 "start": "A String", # Required. Start date of the data to export in the format `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start date. 110 }, 111 "description": "A String", # Optional. Description of the export job. 112 "name": "A String", # Required. Display name of the export job. 113 "outputFormat": "A String", # 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. 114} 115 116 x__xgafv: string, V1 error format. 117 Allowed values 118 1 - v1 error format 119 2 - v2 error format 120 121Returns: 122 An object of the form: 123 124 { # Details of an export job. 125 "created": "A String", # Output only. Time the export job was created. 126 "datastoreName": "A String", # Name of the datastore that is the destination of the export job [datastore] 127 "description": "A String", # Description of the export job. 128 "error": "A String", # Output only. Error is set when export fails 129 "executionTime": "A 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 since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds. 130 "name": "A String", # Display name of the export job. 131 "self": "A 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` 132 "state": "A String", # Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`. 133 "updated": "A String", # Output only. Time the export job was last updated. 134}</pre> 135</div> 136 137<div class="method"> 138 <code class="details" id="get">get(name, x__xgafv=None)</code> 139 <pre>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`. 140 141Args: 142 name: string, Required. Resource name of the export to get. (required) 143 x__xgafv: string, V1 error format. 144 Allowed values 145 1 - v1 error format 146 2 - v2 error format 147 148Returns: 149 An object of the form: 150 151 { # Details of an export job. 152 "created": "A String", # Output only. Time the export job was created. 153 "datastoreName": "A String", # Name of the datastore that is the destination of the export job [datastore] 154 "description": "A String", # Description of the export job. 155 "error": "A String", # Output only. Error is set when export fails 156 "executionTime": "A 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 since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds. 157 "name": "A String", # Display name of the export job. 158 "self": "A 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` 159 "state": "A String", # Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`. 160 "updated": "A String", # Output only. Time the export job was last updated. 161}</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="list">list(parent, x__xgafv=None)</code> 166 <pre>Lists the details and status of all analytics export jobs belonging to the parent organization and environment. 167 168Args: 169 parent: string, Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`. (required) 170 x__xgafv: string, V1 error format. 171 Allowed values 172 1 - v1 error format 173 2 - v2 error format 174 175Returns: 176 An object of the form: 177 178 { # The response for ListExports 179 "exports": [ # Details of the export jobs. 180 { # Details of an export job. 181 "created": "A String", # Output only. Time the export job was created. 182 "datastoreName": "A String", # Name of the datastore that is the destination of the export job [datastore] 183 "description": "A String", # Description of the export job. 184 "error": "A String", # Output only. Error is set when export fails 185 "executionTime": "A 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 since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds. 186 "name": "A String", # Display name of the export job. 187 "self": "A 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` 188 "state": "A String", # Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`. 189 "updated": "A String", # Output only. Time the export job was last updated. 190 }, 191 ], 192}</pre> 193</div> 194 195</body></html>