1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a Datastore for an org</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a Datastore from an org.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a Datastore</p>
<p class="toc_element">
<code><a href="#list">list(parent, targetType=None, x__xgafv=None)</a></code></p>
<p class="firstline">List Datastores</p>
<p class="toc_element">
<code><a href="#test">test(parent, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a Datastore</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Create a Datastore for an org
Args:
parent: string, Required. The parent organization name. Must be of the form `organizations/{org}`. (required)
body: object, The request body.
The object takes the form of:
{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
"createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
"bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
"datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
"path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
"projectId": "A String", # Required. Google Cloud project in which the datastore exists
"tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
},
"displayName": "A String", # Required. Display name in UI
"lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"org": "A String", # Output only. Organization that the datastore belongs to
"self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
"targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
"createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
"bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
"datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
"path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
"projectId": "A String", # Required. Google Cloud project in which the datastore exists
"tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
},
"displayName": "A String", # Required. Display name in UI
"lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"org": "A String", # Output only. Organization that the datastore belongs to
"self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
"targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete a Datastore from an org.
Args:
name: string, Required. Resource name of the Datastore to be deleted. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get a Datastore
Args:
name: string, Required. Resource name of the Datastore to be get. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
"createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
"bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
"datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
"path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
"projectId": "A String", # Required. Google Cloud project in which the datastore exists
"tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
},
"displayName": "A String", # Required. Display name in UI
"lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"org": "A String", # Output only. Organization that the datastore belongs to
"self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
"targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, targetType=None, x__xgafv=None)</code>
<pre>List Datastores
Args:
parent: string, Required. The parent organization name. Must be of the form `organizations/{org}`. (required)
targetType: string, Optional. TargetType is used to fetch all Datastores that match the type
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 ListDatastores
"datastores": [ # A list of datastores
{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
"createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
"bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
"datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
"path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
"projectId": "A String", # Required. Google Cloud project in which the datastore exists
"tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
},
"displayName": "A String", # Required. Display name in UI
"lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"org": "A String", # Output only. Organization that the datastore belongs to
"self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
"targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="test">test(parent, body=None, x__xgafv=None)</code>
<pre>Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage
Args:
parent: string, Required. The parent organization name Must be of the form `organizations/{org}` (required)
body: object, The request body.
The object takes the form of:
{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
"createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
"bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
"datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
"path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
"projectId": "A String", # Required. Google Cloud project in which the datastore exists
"tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
},
"displayName": "A String", # Required. Display name in UI
"lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"org": "A String", # Output only. Organization that the datastore belongs to
"self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
"targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}
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 TestDatastore
"error": "A String", # Output only. Error message of test connection failure
"state": "A String", # Output only. It could be `completed` or `failed`
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Update a Datastore
Args:
name: string, Required. The resource name of datastore to be updated. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required)
body: object, The request body.
The object takes the form of:
{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
"createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
"bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
"datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
"path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
"projectId": "A String", # Required. Google Cloud project in which the datastore exists
"tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
},
"displayName": "A String", # Required. Display name in UI
"lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"org": "A String", # Output only. Organization that the datastore belongs to
"self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
"targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
"createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
"bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
"datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
"path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
"projectId": "A String", # Required. Google Cloud project in which the datastore exists
"tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
},
"displayName": "A String", # Required. Display name in UI
"lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
"org": "A String", # Output only. Organization that the datastore belongs to
"self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
"targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}</pre>
</div>
</body></html>
|
