Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
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".
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`.
Lists the details and status of all analytics export jobs belonging to the parent organization and environment.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
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".
Args:
parent: string, Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request body for [CreateExportRequest]
"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`).
"datastoreName": "A String", # Required. Name of the preconfigured datastore.
"dateRange": { # Date range of the data to export. # Required. Date range of the data to export.
"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.
"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.
},
"description": "A String", # Optional. Description of the export job.
"name": "A String", # Required. Display name of the export job.
"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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Details of an export job.
"created": "A String", # Output only. Time the export job was created.
"datastoreName": "A String", # Name of the datastore that is the destination of the export job [datastore]
"description": "A String", # Description of the export job.
"error": "A String", # Output only. Error is set when export fails
"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.
"name": "A String", # Display name of the export job.
"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`
"state": "A String", # Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`.
"updated": "A String", # Output only. Time the export job was last updated.
}
get(name, x__xgafv=None)
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`.
Args:
name: string, Required. Resource name of the export to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Details of an export job.
"created": "A String", # Output only. Time the export job was created.
"datastoreName": "A String", # Name of the datastore that is the destination of the export job [datastore]
"description": "A String", # Description of the export job.
"error": "A String", # Output only. Error is set when export fails
"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.
"name": "A String", # Display name of the export job.
"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`
"state": "A String", # Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`.
"updated": "A String", # Output only. Time the export job was last updated.
}
list(parent, x__xgafv=None)
Lists the details and status of all analytics export jobs belonging to the parent organization and environment.
Args:
parent: string, Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for ListExports
"exports": [ # Details of the export jobs.
{ # Details of an export job.
"created": "A String", # Output only. Time the export job was created.
"datastoreName": "A String", # Name of the datastore that is the destination of the export job [datastore]
"description": "A String", # Description of the export job.
"error": "A String", # Output only. Error is set when export fails
"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.
"name": "A String", # Display name of the export job.
"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`
"state": "A String", # Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`.
"updated": "A String", # Output only. Time the export job was last updated.
},
],
}