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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
|
<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="apihub_v1.html">API hub API</a> . <a href="apihub_v1.projects.html">projects</a> . <a href="apihub_v1.projects.locations.html">locations</a> . <a href="apihub_v1.projects.locations.plugins.html">plugins</a> . <a href="apihub_v1.projects.locations.plugins.instances.html">instances</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, pluginInstanceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Plugin instance in the API hub.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a plugin instance in the API hub.</p>
<p class="toc_element">
<code><a href="#disableAction">disableAction(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Disables a plugin instance in the API hub.</p>
<p class="toc_element">
<code><a href="#enableAction">enableAction(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enables a plugin instance in the API hub.</p>
<p class="toc_element">
<code><a href="#executeAction">executeAction(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Executes a plugin instance in the API hub.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get an API Hub plugin instance.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all the plugins in a given project and location. `-` can be used as wildcard value for {plugin_id}</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently: * display_name * schedule_cron_expression The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.</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, pluginInstanceId=None, x__xgafv=None)</code>
<pre>Creates a Plugin instance in the API hub.
Args:
parent: string, Required. The parent of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}` (required)
body: object, The request body.
The object takes the form of:
{ # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
"actions": [ # Required. The action status for the plugin instance.
{ # PluginInstanceAction represents an action which can be executed in the plugin instance.
"actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
"curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
"curationType": "A String", # Required. The curation type for this plugin instance.
"customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
"curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
},
},
"hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
"currentExecutionState": "A String", # Output only. The current state of the execution.
"lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
"endTime": "A String", # Output only. The last execution end time of the plugin instance.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
"result": "A String", # Output only. The result of the last execution of the plugin instance.
"startTime": "A String", # Output only. The last execution start time of the plugin instance.
},
},
"resourceConfig": { # The configuration of resources created for a given plugin instance action. # Output only. The configuration of resources created for a given plugin instance action. Note these will be returned only in case of Non-GCP plugins like OPDK.
"actionType": "A String", # Output only. The type of the action.
"pubsubTopic": "A String", # Output only. The pubsub topic to publish the data to. Format is projects/{project}/topics/{topic}
},
"scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
"scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
"serviceAccount": "A String", # Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
"state": "A String", # Output only. The current state of the plugin action in the plugin instance.
},
],
"additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
"a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
"boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
"enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
"intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
"key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
"multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
"values": [ # Optional. The config variable value of data type multi int.
42,
],
},
"multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
"values": [ # Optional. The config variable value of data type multi select.
{ # ConfigValueOption represents an option for a config variable of type enum or multi select.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
],
},
"multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
"values": [ # Optional. The config variable value of data type multi string.
"A String",
],
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
},
},
"authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
"apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
"apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
"name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
},
"authType": "A String", # Required. The authentication type.
"googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
"serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
},
"oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
"clientId": "A String", # Required. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
"password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Required. Username.
},
},
"createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
"displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
"name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"sourceProjectId": "A String", # Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.
"state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
"updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
}
pluginInstanceId: string, Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource. * If not provided, a system generated id will be used. This value should be 4-63 characters, and valid characters are /a-z[0-9]-_/.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a plugin instance in the API hub.
Args:
name: string, Required. The name of the plugin instance to delete. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="disableAction">disableAction(name, body=None, x__xgafv=None)</code>
<pre>Disables a plugin instance in the API hub.
Args:
name: string, Required. The name of the plugin instance to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
body: object, The request body.
The object takes the form of:
{ # The DisablePluginInstanceAction method's request.
"actionId": "A String", # Required. The action id to disable.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="enableAction">enableAction(name, body=None, x__xgafv=None)</code>
<pre>Enables a plugin instance in the API hub.
Args:
name: string, Required. The name of the plugin instance to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
body: object, The request body.
The object takes the form of:
{ # The EnablePluginInstanceAction method's request.
"actionId": "A String", # Required. The action id to enable.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="executeAction">executeAction(name, body=None, x__xgafv=None)</code>
<pre>Executes a plugin instance in the API hub.
Args:
name: string, Required. The name of the plugin instance to execute. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
body: object, The request body.
The object takes the form of:
{ # The ExecutePluginInstanceAction method's request.
"actionExecutionDetail": { # The details for the action to execute. # Required. The execution details for the action to execute.
"actionId": "A String", # Required. The action id of the plugin to execute.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get an API Hub plugin instance.
Args:
name: string, Required. The name of the plugin instance to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
"actions": [ # Required. The action status for the plugin instance.
{ # PluginInstanceAction represents an action which can be executed in the plugin instance.
"actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
"curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
"curationType": "A String", # Required. The curation type for this plugin instance.
"customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
"curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
},
},
"hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
"currentExecutionState": "A String", # Output only. The current state of the execution.
"lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
"endTime": "A String", # Output only. The last execution end time of the plugin instance.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
"result": "A String", # Output only. The result of the last execution of the plugin instance.
"startTime": "A String", # Output only. The last execution start time of the plugin instance.
},
},
"resourceConfig": { # The configuration of resources created for a given plugin instance action. # Output only. The configuration of resources created for a given plugin instance action. Note these will be returned only in case of Non-GCP plugins like OPDK.
"actionType": "A String", # Output only. The type of the action.
"pubsubTopic": "A String", # Output only. The pubsub topic to publish the data to. Format is projects/{project}/topics/{topic}
},
"scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
"scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
"serviceAccount": "A String", # Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
"state": "A String", # Output only. The current state of the plugin action in the plugin instance.
},
],
"additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
"a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
"boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
"enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
"intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
"key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
"multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
"values": [ # Optional. The config variable value of data type multi int.
42,
],
},
"multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
"values": [ # Optional. The config variable value of data type multi select.
{ # ConfigValueOption represents an option for a config variable of type enum or multi select.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
],
},
"multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
"values": [ # Optional. The config variable value of data type multi string.
"A String",
],
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
},
},
"authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
"apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
"apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
"name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
},
"authType": "A String", # Required. The authentication type.
"googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
"serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
},
"oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
"clientId": "A String", # Required. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
"password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Required. Username.
},
},
"createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
"displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
"name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"sourceProjectId": "A String", # Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.
"state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
"updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List all the plugins in a given project and location. `-` can be used as wildcard value for {plugin_id}
Args:
parent: string, Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. To list plugin instances for multiple plugins, use the - character instead of the plugin ID. (required)
filter: string, Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `PluginInstances` are eligible for filtering: * `state` - The state of the Plugin Instance. Allowed comparison operators: `=`. A filter function is also supported in the filter string. The filter function is `id(name)`. The `id(name)` function returns the id of the resource name. For example, `id(name) = \"plugin-instance-1\"` is equivalent to `name = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"` provided the parent is `projects/test-project-id/locations/test-location-id/plugins/plugin-1`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `state = ENABLED` - The plugin instance is in enabled state.
pageSize: integer, Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListPluginInstances` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluginInstances` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The ListPluginInstances method's response.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"pluginInstances": [ # The plugin instances from the specified parent resource.
{ # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
"actions": [ # Required. The action status for the plugin instance.
{ # PluginInstanceAction represents an action which can be executed in the plugin instance.
"actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
"curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
"curationType": "A String", # Required. The curation type for this plugin instance.
"customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
"curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
},
},
"hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
"currentExecutionState": "A String", # Output only. The current state of the execution.
"lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
"endTime": "A String", # Output only. The last execution end time of the plugin instance.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
"result": "A String", # Output only. The result of the last execution of the plugin instance.
"startTime": "A String", # Output only. The last execution start time of the plugin instance.
},
},
"resourceConfig": { # The configuration of resources created for a given plugin instance action. # Output only. The configuration of resources created for a given plugin instance action. Note these will be returned only in case of Non-GCP plugins like OPDK.
"actionType": "A String", # Output only. The type of the action.
"pubsubTopic": "A String", # Output only. The pubsub topic to publish the data to. Format is projects/{project}/topics/{topic}
},
"scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
"scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
"serviceAccount": "A String", # Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
"state": "A String", # Output only. The current state of the plugin action in the plugin instance.
},
],
"additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
"a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
"boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
"enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
"intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
"key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
"multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
"values": [ # Optional. The config variable value of data type multi int.
42,
],
},
"multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
"values": [ # Optional. The config variable value of data type multi select.
{ # ConfigValueOption represents an option for a config variable of type enum or multi select.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
],
},
"multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
"values": [ # Optional. The config variable value of data type multi string.
"A String",
],
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
},
},
"authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
"apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
"apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
"name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
},
"authType": "A String", # Required. The authentication type.
"googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
"serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
},
"oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
"clientId": "A String", # Required. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
"password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Required. Username.
},
},
"createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
"displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
"name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"sourceProjectId": "A String", # Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.
"state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
"updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently: * display_name * schedule_cron_expression The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.
Args:
name: string, Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
body: object, The request body.
The object takes the form of:
{ # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
"actions": [ # Required. The action status for the plugin instance.
{ # PluginInstanceAction represents an action which can be executed in the plugin instance.
"actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
"curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
"curationType": "A String", # Required. The curation type for this plugin instance.
"customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
"curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
},
},
"hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
"currentExecutionState": "A String", # Output only. The current state of the execution.
"lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
"endTime": "A String", # Output only. The last execution end time of the plugin instance.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
"result": "A String", # Output only. The result of the last execution of the plugin instance.
"startTime": "A String", # Output only. The last execution start time of the plugin instance.
},
},
"resourceConfig": { # The configuration of resources created for a given plugin instance action. # Output only. The configuration of resources created for a given plugin instance action. Note these will be returned only in case of Non-GCP plugins like OPDK.
"actionType": "A String", # Output only. The type of the action.
"pubsubTopic": "A String", # Output only. The pubsub topic to publish the data to. Format is projects/{project}/topics/{topic}
},
"scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
"scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
"serviceAccount": "A String", # Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
"state": "A String", # Output only. The current state of the plugin action in the plugin instance.
},
],
"additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
"a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
"boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
"enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
"intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
"key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
"multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
"values": [ # Optional. The config variable value of data type multi int.
42,
],
},
"multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
"values": [ # Optional. The config variable value of data type multi select.
{ # ConfigValueOption represents an option for a config variable of type enum or multi select.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
],
},
"multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
"values": [ # Optional. The config variable value of data type multi string.
"A String",
],
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
},
},
"authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
"apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
"apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
"name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
},
"authType": "A String", # Required. The authentication type.
"googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
"serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
},
"oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
"clientId": "A String", # Required. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
"password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Required. Username.
},
},
"createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
"displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
"name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"sourceProjectId": "A String", # Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.
"state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
"updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
}
updateMask: string, Optional. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
"actions": [ # Required. The action status for the plugin instance.
{ # PluginInstanceAction represents an action which can be executed in the plugin instance.
"actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
"curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
"curationType": "A String", # Required. The curation type for this plugin instance.
"customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
"curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
},
},
"hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
"currentExecutionState": "A String", # Output only. The current state of the execution.
"lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
"endTime": "A String", # Output only. The last execution end time of the plugin instance.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
"result": "A String", # Output only. The result of the last execution of the plugin instance.
"startTime": "A String", # Output only. The last execution start time of the plugin instance.
},
},
"resourceConfig": { # The configuration of resources created for a given plugin instance action. # Output only. The configuration of resources created for a given plugin instance action. Note these will be returned only in case of Non-GCP plugins like OPDK.
"actionType": "A String", # Output only. The type of the action.
"pubsubTopic": "A String", # Output only. The pubsub topic to publish the data to. Format is projects/{project}/topics/{topic}
},
"scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
"scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
"serviceAccount": "A String", # Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
"state": "A String", # Output only. The current state of the plugin action in the plugin instance.
},
],
"additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
"a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
"boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
"enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
"intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
"key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
"multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
"values": [ # Optional. The config variable value of data type multi int.
42,
],
},
"multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
"values": [ # Optional. The config variable value of data type multi select.
{ # ConfigValueOption represents an option for a config variable of type enum or multi select.
"description": "A String", # Optional. Description of the option.
"displayName": "A String", # Required. Display name of the option.
"id": "A String", # Required. Id of the option.
},
],
},
"multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
"values": [ # Optional. The config variable value of data type multi string.
"A String",
],
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
},
},
"authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
"apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
"apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
"name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
},
"authType": "A String", # Required. The authentication type.
"googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
"serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
},
"oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
"clientId": "A String", # Required. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
"password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
"secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Required. Username.
},
},
"createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
"displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
"errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
"name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"sourceProjectId": "A String", # Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.
"state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
"updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
}</pre>
</div>
</body></html>
|
