datastores

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

Overview

Name	datastores
Type	Resource
Id	google.apigee.datastores

Fields

The following fields are returned by SELECT queries:

organizations_analytics_datastores_get

Successful response

Name	Datatype	Description
createTime	string (int64)	Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
datastoreConfig	object	Datastore Configurations. (id: GoogleCloudApigeeV1DatastoreConfig)
displayName	string	Required. Display name in UI
lastUpdateTime	string (int64)	Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
org	string	Output only. Organization that the datastore belongs to
self	string	Output only. Resource link of Datastore. Example: /organizations/{org}/analytics/datastores/{uuid}
targetType	string	Destination storage type. Supported types gcs or bigquery.

organizations_analytics_datastores_list

Successful response

Name	Datatype	Description
datastores	array	A list of datastores

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_analytics_datastores_get	select	organizationsId, datastoresId		Get a Datastore
organizations_analytics_datastores_list	select	organizationsId	targetType	List Datastores
organizations_analytics_datastores_create	insert	organizationsId		Create a Datastore for an org
organizations_analytics_datastores_update	replace	organizationsId, datastoresId		Update a Datastore
organizations_analytics_datastores_delete	delete	organizationsId, datastoresId		Delete a Datastore from an org.
organizations_analytics_datastores_test	exec	organizationsId		Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

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
datastoresId	string
organizationsId	string
targetType	string

SELECT examples

organizations_analytics_datastores_get

Get a Datastore

SELECT
createTime,
datastoreConfig,
displayName,
lastUpdateTime,
org,
self,
targetType
FROM google.apigee.datastores
WHERE organizationsId = '{{ organizationsId }}' -- required
AND datastoresId = '{{ datastoresId }}' -- required;

organizations_analytics_datastores_list

List Datastores

SELECT
datastores
FROM google.apigee.datastores
WHERE organizationsId = '{{ organizationsId }}' -- required
AND targetType = '{{ targetType }}';

INSERT examples

organizations_analytics_datastores_create

Create a Datastore for an org

INSERT INTO google.apigee.datastores (
data__displayName,
data__targetType,
data__datastoreConfig,
organizationsId
)
SELECT 
'{{ displayName }}',
'{{ targetType }}',
'{{ datastoreConfig }}',
'{{ organizationsId }}'
RETURNING
createTime,
datastoreConfig,
displayName,
lastUpdateTime,
org,
self,
targetType
;

Manifest

# Description fields are for documentation purposes
- name: datastores
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the datastores resource.
    - name: displayName
      value: string
      description: >
        Required. Display name in UI
        
    - name: targetType
      value: string
      description: >
        Destination storage type. Supported types `gcs` or `bigquery`.
        
    - name: datastoreConfig
      value: object
      description: >
        Datastore Configurations.
        

REPLACE examples

organizations_analytics_datastores_update

Update a Datastore

REPLACE google.apigee.datastores
SET 
data__displayName = '{{ displayName }}',
data__targetType = '{{ targetType }}',
data__datastoreConfig = '{{ datastoreConfig }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND datastoresId = '{{ datastoresId }}' --required
RETURNING
createTime,
datastoreConfig,
displayName,
lastUpdateTime,
org,
self,
targetType;

DELETE examples

organizations_analytics_datastores_delete

Delete a Datastore from an org.

DELETE FROM google.apigee.datastores
WHERE organizationsId = '{{ organizationsId }}' --required
AND datastoresId = '{{ datastoresId }}' --required;

Lifecycle Methods

organizations_analytics_datastores_test

Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

EXEC google.apigee.datastores.organizations_analytics_datastores_test 
@organizationsId='{{ organizationsId }}' --required 
@@json=
'{
"displayName": "{{ displayName }}", 
"targetType": "{{ targetType }}", 
"datastoreConfig": "{{ datastoreConfig }}"
}';