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.analytics.html">analytics</a> . <a href="apigee_v1.organizations.analytics.datastores.html">datastores</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">Create a Datastore for an org</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Delete a Datastore from an org.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Get a Datastore</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, targetType=None, x__xgafv=None)</a></code></p> 91<p class="firstline">List Datastores</p> 92<p class="toc_element"> 93 <code><a href="#test">test(parent, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage</p> 95<p class="toc_element"> 96 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Update a Datastore</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <pre>Create a Datastore for an org 107 108Args: 109 parent: string, Required. The parent organization name. Must be of the form `organizations/{org}`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. 114 "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 115 "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations. 116 "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type. 117 "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type. 118 "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type. 119 "projectId": "A String", # Required. GCP project in which the datastore exists 120 "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type. 121 }, 122 "displayName": "A String", # Required. Display name in UI 123 "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 124 "org": "A String", # Output only. Organization that the datastore belongs to 125 "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` 126 "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`. 127} 128 129 x__xgafv: string, V1 error format. 130 Allowed values 131 1 - v1 error format 132 2 - v2 error format 133 134Returns: 135 An object of the form: 136 137 { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. 138 "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 139 "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations. 140 "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type. 141 "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type. 142 "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type. 143 "projectId": "A String", # Required. GCP project in which the datastore exists 144 "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type. 145 }, 146 "displayName": "A String", # Required. Display name in UI 147 "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 148 "org": "A String", # Output only. Organization that the datastore belongs to 149 "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` 150 "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`. 151}</pre> 152</div> 153 154<div class="method"> 155 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 156 <pre>Delete a Datastore from an org. 157 158Args: 159 name: string, Required. Resource name of the Datastore to be deleted. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required) 160 x__xgafv: string, V1 error format. 161 Allowed values 162 1 - v1 error format 163 2 - v2 error format 164 165Returns: 166 An object of the form: 167 168 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 169}</pre> 170</div> 171 172<div class="method"> 173 <code class="details" id="get">get(name, x__xgafv=None)</code> 174 <pre>Get a Datastore 175 176Args: 177 name: string, Required. Resource name of the Datastore to be get. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required) 178 x__xgafv: string, V1 error format. 179 Allowed values 180 1 - v1 error format 181 2 - v2 error format 182 183Returns: 184 An object of the form: 185 186 { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. 187 "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 188 "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations. 189 "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type. 190 "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type. 191 "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type. 192 "projectId": "A String", # Required. GCP project in which the datastore exists 193 "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type. 194 }, 195 "displayName": "A String", # Required. Display name in UI 196 "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 197 "org": "A String", # Output only. Organization that the datastore belongs to 198 "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` 199 "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`. 200}</pre> 201</div> 202 203<div class="method"> 204 <code class="details" id="list">list(parent, targetType=None, x__xgafv=None)</code> 205 <pre>List Datastores 206 207Args: 208 parent: string, Required. The parent organization name. Must be of the form `organizations/{org}`. (required) 209 targetType: string, Optional. TargetType is used to fetch all Datastores that match the type 210 x__xgafv: string, V1 error format. 211 Allowed values 212 1 - v1 error format 213 2 - v2 error format 214 215Returns: 216 An object of the form: 217 218 { # The response for ListDatastores 219 "datastores": [ # A list of datastores 220 { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. 221 "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 222 "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations. 223 "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type. 224 "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type. 225 "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type. 226 "projectId": "A String", # Required. GCP project in which the datastore exists 227 "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type. 228 }, 229 "displayName": "A String", # Required. Display name in UI 230 "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 231 "org": "A String", # Output only. Organization that the datastore belongs to 232 "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` 233 "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`. 234 }, 235 ], 236}</pre> 237</div> 238 239<div class="method"> 240 <code class="details" id="test">test(parent, body=None, x__xgafv=None)</code> 241 <pre>Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage 242 243Args: 244 parent: string, Required. The parent organization name Must be of the form `organizations/{org}` (required) 245 body: object, The request body. 246 The object takes the form of: 247 248{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. 249 "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 250 "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations. 251 "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type. 252 "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type. 253 "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type. 254 "projectId": "A String", # Required. GCP project in which the datastore exists 255 "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type. 256 }, 257 "displayName": "A String", # Required. Display name in UI 258 "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 259 "org": "A String", # Output only. Organization that the datastore belongs to 260 "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` 261 "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`. 262} 263 264 x__xgafv: string, V1 error format. 265 Allowed values 266 1 - v1 error format 267 2 - v2 error format 268 269Returns: 270 An object of the form: 271 272 { # The response for TestDatastore 273 "error": "A String", # Output only. Error message of test connection failure 274 "state": "A String", # Output only. It could be `completed` or `failed` 275}</pre> 276</div> 277 278<div class="method"> 279 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> 280 <pre>Update a Datastore 281 282Args: 283 name: string, Required. The resource name of datastore to be updated. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required) 284 body: object, The request body. 285 The object takes the form of: 286 287{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. 288 "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 289 "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations. 290 "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type. 291 "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type. 292 "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type. 293 "projectId": "A String", # Required. GCP project in which the datastore exists 294 "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type. 295 }, 296 "displayName": "A String", # Required. Display name in UI 297 "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 298 "org": "A String", # Output only. Organization that the datastore belongs to 299 "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` 300 "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`. 301} 302 303 x__xgafv: string, V1 error format. 304 Allowed values 305 1 - v1 error format 306 2 - v2 error format 307 308Returns: 309 An object of the form: 310 311 { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. 312 "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 313 "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations. 314 "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type. 315 "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type. 316 "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type. 317 "projectId": "A String", # Required. GCP project in which the datastore exists 318 "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type. 319 }, 320 "displayName": "A String", # Required. Display name in UI 321 "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z 322 "org": "A String", # Output only. Organization that the datastore belongs to 323 "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` 324 "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`. 325}</pre> 326</div> 327 328</body></html>