forked from google/google-api-objectivec-client-for-rest
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathGTLRAPIhubQuery.h
More file actions
4187 lines (3738 loc) · 159 KB
/
GTLRAPIhubQuery.h
File metadata and controls
4187 lines (3738 loc) · 159 KB
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
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// NOTE: This file was generated by the ServiceGenerator.
// ----------------------------------------------------------------------------
// API:
// API hub API (apihub/v1)
// Documentation:
// https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
#import <GoogleAPIClientForREST/GTLRQuery.h>
#if GTLR_RUNTIME_VERSION != 3000
#error This file was generated by a different version of ServiceGenerator which is incompatible with this GTLR library source.
#endif
#import "GTLRAPIhubObjects.h"
// Generated comments include content from the discovery document; avoid them
// causing warnings since clang's checks are some what arbitrary.
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
NS_ASSUME_NONNULL_BEGIN
/**
* Parent class for other API hub query classes.
*/
@interface GTLRAPIhubQuery : GTLRQuery
/** Selector specifying which fields to include in a partial response. */
@property(nonatomic, copy, nullable) NSString *fields;
@end
/**
* Provisions instance resources for the API Hub.
*
* Method: apihub.projects.locations.apiHubInstances.create
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesCreate : GTLRAPIhubQuery
/**
* Optional. Identifier to assign to the Api Hub instance. Must be unique
* within scope of the parent resource. If the field is not provided, system
* generated id will be used. This value should be 4-40 characters, and valid
* characters are `/a-z[0-9]-_/`.
*/
@property(nonatomic, copy, nullable) NSString *apiHubInstanceId;
/**
* Required. The parent resource for the Api Hub instance resource. Format:
* `projects/{project}/locations/{location}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Fetches a @c GTLRAPIhub_GoogleLongrunningOperation.
*
* Provisions instance resources for the API Hub.
*
* @param object The @c GTLRAPIhub_GoogleCloudApihubV1ApiHubInstance to include
* in the query.
* @param parent Required. The parent resource for the Api Hub instance
* resource. Format: `projects/{project}/locations/{location}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesCreate
*/
+ (instancetype)queryWithObject:(GTLRAPIhub_GoogleCloudApihubV1ApiHubInstance *)object
parent:(NSString *)parent;
@end
/**
* Deletes the API hub instance. Deleting the API hub instance will also result
* in the removal of all associated runtime project attachments and the host
* project registration.
*
* Method: apihub.projects.locations.apiHubInstances.delete
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesDelete : GTLRAPIhubQuery
/**
* Required. The name of the Api Hub instance to delete. Format:
* `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_GoogleLongrunningOperation.
*
* Deletes the API hub instance. Deleting the API hub instance will also result
* in the removal of all associated runtime project attachments and the host
* project registration.
*
* @param name Required. The name of the Api Hub instance to delete. Format:
* `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
*
* @return GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesDelete
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* Gets details of a single API Hub instance.
*
* Method: apihub.projects.locations.apiHubInstances.get
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesGet : GTLRAPIhubQuery
/**
* Required. The name of the Api Hub instance to retrieve. Format:
* `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1ApiHubInstance.
*
* Gets details of a single API Hub instance.
*
* @param name Required. The name of the Api Hub instance to retrieve. Format:
* `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
*
* @return GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesGet
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* Looks up an Api Hub instance in a given GCP project. There will always be
* only one Api Hub instance for a GCP project across all locations.
*
* Method: apihub.projects.locations.apiHubInstances.lookup
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesLookup : GTLRAPIhubQuery
/**
* Required. There will always be only one Api Hub instance for a GCP project
* across all locations. The parent resource for the Api Hub instance resource.
* Format: `projects/{project}/locations/{location}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1LookupApiHubInstanceResponse.
*
* Looks up an Api Hub instance in a given GCP project. There will always be
* only one Api Hub instance for a GCP project across all locations.
*
* @param parent Required. There will always be only one Api Hub instance for a
* GCP project across all locations. The parent resource for the Api Hub
* instance resource. Format: `projects/{project}/locations/{location}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApiHubInstancesLookup
*/
+ (instancetype)queryWithParent:(NSString *)parent;
@end
/**
* Create an API resource in the API hub. Once an API resource is created,
* versions can be added to it.
*
* Method: apihub.projects.locations.apis.create
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisCreate : GTLRAPIhubQuery
/**
* Optional. The ID to use for the API resource, which will become the final
* component of the API'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 API resource in the API hub. * If not provided, a
* system generated id will be used. This value should be 4-500 characters, and
* valid characters are /a-z[0-9]-_/.
*/
@property(nonatomic, copy, nullable) NSString *apiId;
/**
* Required. The parent resource for the API resource. Format:
* `projects/{project}/locations/{location}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1Api.
*
* Create an API resource in the API hub. Once an API resource is created,
* versions can be added to it.
*
* @param object The @c GTLRAPIhub_GoogleCloudApihubV1Api to include in the
* query.
* @param parent Required. The parent resource for the API resource. Format:
* `projects/{project}/locations/{location}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisCreate
*/
+ (instancetype)queryWithObject:(GTLRAPIhub_GoogleCloudApihubV1Api *)object
parent:(NSString *)parent;
@end
/**
* Delete an API resource in the API hub. API can only be deleted if all
* underlying versions are deleted.
*
* Method: apihub.projects.locations.apis.delete
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisDelete : GTLRAPIhubQuery
/**
* Optional. If set to true, any versions from this API will also be deleted.
* Otherwise, the request will only work if the API has no versions.
*/
@property(nonatomic, assign) BOOL force;
/**
* Required. The name of the API resource to delete. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_Empty.
*
* Delete an API resource in the API hub. API can only be deleted if all
* underlying versions are deleted.
*
* @param name Required. The name of the API resource to delete. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisDelete
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* Get API resource details including the API versions contained in it.
*
* Method: apihub.projects.locations.apis.get
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisGet : GTLRAPIhubQuery
/**
* Required. The name of the API resource to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1Api.
*
* Get API resource details including the API versions contained in it.
*
* @param name Required. The name of the API resource to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisGet
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* List API resources in the API hub.
*
* Method: apihub.projects.locations.apis.list
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisList : GTLRAPIhubQuery
/**
* Optional. An expression that filters the list of ApiResources. 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 `ApiResource` are eligible for filtering: * `owner.email` -
* The email of the team which owns the ApiResource. Allowed comparison
* operators: `=`. * `create_time` - The time at which the ApiResource was
* created. The value should be in the
* (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison
* operators: `>` and `<`. * `display_name` - The display name of the
* ApiResource. Allowed comparison operators: `=`. *
* `target_user.enum_values.values.id` - The allowed value id of the target
* users attribute associated with the ApiResource. Allowed comparison operator
* is `:`. * `target_user.enum_values.values.display_name` - The allowed value
* display name of the target users attribute associated with the ApiResource.
* Allowed comparison operator is `:`. * `team.enum_values.values.id` - The
* allowed value id of the team attribute associated with the ApiResource.
* Allowed comparison operator is `:`. * `team.enum_values.values.display_name`
* - The allowed value display name of the team attribute associated with the
* ApiResource. Allowed comparison operator is `:`. *
* `business_unit.enum_values.values.id` - The allowed value id of the business
* unit attribute associated with the ApiResource. Allowed comparison operator
* is `:`. * `business_unit.enum_values.values.display_name` - The allowed
* value display name of the business unit attribute associated with the
* ApiResource. Allowed comparison operator is `:`. *
* `maturity_level.enum_values.values.id` - The allowed value id of the
* maturity level attribute associated with the ApiResource. Allowed comparison
* operator is `:`. * `maturity_level.enum_values.values.display_name` - The
* allowed value display name of the maturity level attribute associated with
* the ApiResource. Allowed comparison operator is `:`. *
* `api_style.enum_values.values.id` - The allowed value id of the api style
* attribute associated with the ApiResource. Allowed comparison operator is
* `:`. * `api_style.enum_values.values.display_name` - The allowed value
* display name of the api style attribute associated with the ApiResource.
* Allowed comparison operator is `:`. *
* `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.enum_values.values.id` - The allowed
* value id of the user defined enum attribute associated with the Resource.
* Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a
* placeholder that can be replaced with any user defined enum attribute name.
* * `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.enum_values.values.display_name` - The
* allowed value display name of the user defined enum attribute associated
* with the Resource. Allowed comparison operator is `:`. Here
* user-defined-attribute-enum-display-name is a placeholder that can be
* replaced with any user defined enum attribute enum name. *
* `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.string_values.values` - The allowed
* value of the user defined string attribute associated with the Resource.
* Allowed comparison operator is `:`. Here user-defined-attribute-string is a
* placeholder that can be replaced with any user defined string attribute
* name. * `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.json_values.values` - The allowed value
* of the user defined JSON attribute associated with the Resource. Allowed
* comparison operator is `:`. Here user-defined-attribute-json is a
* placeholder that can be replaced with any user defined JSON attribute name.
* 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) = \\"api-1\\"` is equivalent to `name
* = \\"projects/test-project-id/locations/test-location-id/apis/api-1\\"`
* provided the parent is
* `projects/test-project-id/locations/test-location-id`. 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: *
* `owner.email = \\"apihub\@google.com\\"` - - The owner team email is
* _apihub\@google.com_. * `owner.email = \\"apihub\@google.com\\" AND
* create_time < \\"2021-08-15T14:50:00Z\\" AND create_time >
* \\"2021-08-10T12:00:00Z\\"` - The owner team email is _apihub\@google.com_
* and the api was created before _2021-08-15 14:50:00 UTC_ and after
* _2021-08-10 12:00:00 UTC_. * `owner.email = \\"apihub\@google.com\\" OR
* team.enum_values.values.id: apihub-team-id` - The filter string specifies
* the APIs where the owner team email is _apihub\@google.com_ or the id of the
* allowed value associated with the team attribute is _apihub-team-id_. *
* `owner.email = \\"apihub\@google.com\\" OR
* team.enum_values.values.display_name: ApiHub Team` - The filter string
* specifies the APIs where the owner team email is _apihub\@google.com_ or the
* display name of the allowed value associated with the team attribute is
* `ApiHub Team`. * `owner.email = \\"apihub\@google.com\\" AND
* attributes.projects/test-project-id/locations/test-location-id/
* attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id:
* test_enum_id AND
* attributes.projects/test-project-id/locations/test-location-id/
* attributes/1765\\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values:
* test_string_value` - The filter string specifies the APIs where the owner
* team email is _apihub\@google.com_ and the id of the allowed value
* associated with the user defined attribute of type enum is _test_enum_id_
* and the value of the user defined attribute of type string is _test_..
*/
@property(nonatomic, copy, nullable) NSString *filter;
/**
* Optional. The maximum number of API resources to return. The service may
* return fewer than this value. If unspecified, at most 50 Apis will be
* returned. The maximum value is 1000; values above 1000 will be coerced to
* 1000.
*/
@property(nonatomic, assign) NSInteger pageSize;
/**
* Optional. A page token, received from a previous `ListApis` call. Provide
* this to retrieve the subsequent page. When paginating, all other parameters
* (except page_size) provided to `ListApis` must match the call that provided
* the page token.
*/
@property(nonatomic, copy, nullable) NSString *pageToken;
/**
* Required. The parent, which owns this collection of API resources. Format:
* `projects/{project}/locations/{location}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1ListApisResponse.
*
* List API resources in the API hub.
*
* @param parent Required. The parent, which owns this collection of API
* resources. Format: `projects/{project}/locations/{location}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisList
*
* @note Automatic pagination will be done when @c shouldFetchNextPages is
* enabled. See @c shouldFetchNextPages on @c GTLRService for more
* information.
*/
+ (instancetype)queryWithParent:(NSString *)parent;
@end
/**
* Update an API resource in the API hub. The following fields in the API can
* be updated: * display_name * description * owner * documentation *
* target_user * team * business_unit * maturity_level * api_style * attributes
* The update_mask should be used to specify the fields being updated. Updating
* the owner field requires complete owner message and updates both owner and
* email fields.
*
* Method: apihub.projects.locations.apis.patch
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisPatch : GTLRAPIhubQuery
/**
* Identifier. The name of the API resource in the API Hub. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Required. The list of fields to update.
*
* String format is a comma-separated list of fields.
*/
@property(nonatomic, copy, nullable) NSString *updateMask;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1Api.
*
* Update an API resource in the API hub. The following fields in the API can
* be updated: * display_name * description * owner * documentation *
* target_user * team * business_unit * maturity_level * api_style * attributes
* The update_mask should be used to specify the fields being updated. Updating
* the owner field requires complete owner message and updates both owner and
* email fields.
*
* @param object The @c GTLRAPIhub_GoogleCloudApihubV1Api to include in the
* query.
* @param name Identifier. The name of the API resource in the API Hub. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisPatch
*/
+ (instancetype)queryWithObject:(GTLRAPIhub_GoogleCloudApihubV1Api *)object
name:(NSString *)name;
@end
/**
* Create an API version for an API resource in the API hub.
*
* Method: apihub.projects.locations.apis.versions.create
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsCreate : GTLRAPIhubQuery
/**
* Required. The parent resource for API version. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Optional. The ID to use for the API version, which will become the final
* component of the version'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 version in the API resource. * If
* not provided, a system generated id will be used. This value should be 4-500
* characters, overall resource name which will be of format
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`, its
* length is limited to 700 characters and valid characters are /a-z[0-9]-_/.
*/
@property(nonatomic, copy, nullable) NSString *versionId;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1Version.
*
* Create an API version for an API resource in the API hub.
*
* @param object The @c GTLRAPIhub_GoogleCloudApihubV1Version to include in the
* query.
* @param parent Required. The parent resource for API version. Format:
* `projects/{project}/locations/{location}/apis/{api}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsCreate
*/
+ (instancetype)queryWithObject:(GTLRAPIhub_GoogleCloudApihubV1Version *)object
parent:(NSString *)parent;
@end
/**
* Get details about a definition in an API version.
*
* Method: apihub.projects.locations.apis.versions.definitions.get
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsDefinitionsGet : GTLRAPIhubQuery
/**
* Required. The name of the definition to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1Definition.
*
* Get details about a definition in an API version.
*
* @param name Required. The name of the definition to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsDefinitionsGet
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* Delete an API version. Version can only be deleted if all underlying specs,
* operations, definitions and linked deployments are deleted.
*
* Method: apihub.projects.locations.apis.versions.delete
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsDelete : GTLRAPIhubQuery
/**
* Optional. If set to true, any specs from this version will also be deleted.
* Otherwise, the request will only work if the version has no specs.
*/
@property(nonatomic, assign) BOOL force;
/**
* Required. The name of the version to delete. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_Empty.
*
* Delete an API version. Version can only be deleted if all underlying specs,
* operations, definitions and linked deployments are deleted.
*
* @param name Required. The name of the version to delete. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsDelete
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* Get details about the API version of an API resource. This will include
* information about the specs and operations present in the API version as
* well as the deployments linked to it.
*
* Method: apihub.projects.locations.apis.versions.get
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsGet : GTLRAPIhubQuery
/**
* Required. The name of the API version to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1Version.
*
* Get details about the API version of an API resource. This will include
* information about the specs and operations present in the API version as
* well as the deployments linked to it.
*
* @param name Required. The name of the API version to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsGet
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* List API versions of an API resource in the API hub.
*
* Method: apihub.projects.locations.apis.versions.list
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsList : GTLRAPIhubQuery
/**
* Optional. An expression that filters the list of Versions. A filter
* expression consists of a field name, a comparison operator, and a value for
* filtering. The value must be a string, a number, or a boolean. The
* comparison operator must be one of: `<`, `>` or `=`. Filters are not case
* sensitive. The following fields in the `Version` are eligible for filtering:
* * `display_name` - The display name of the Version. Allowed comparison
* operators: `=`. * `create_time` - The time at which the Version was created.
* The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
* format. Allowed comparison operators: `>` and `<`. *
* `lifecycle.enum_values.values.id` - The allowed value id of the lifecycle
* attribute associated with the Version. Allowed comparison operators: `:`. *
* `lifecycle.enum_values.values.display_name` - The allowed value display name
* of the lifecycle attribute associated with the Version. Allowed comparison
* operators: `:`. * `compliance.enum_values.values.id` - The allowed value id
* of the compliances attribute associated with the Version. Allowed comparison
* operators: `:`. * `compliance.enum_values.values.display_name` - The allowed
* value display name of the compliances attribute associated with the Version.
* Allowed comparison operators: `:`. * `accreditation.enum_values.values.id` -
* The allowed value id of the accreditations attribute associated with the
* Version. Allowed comparison operators: `:`. *
* `accreditation.enum_values.values.display_name` - The allowed value display
* name of the accreditations attribute associated with the Version. Allowed
* comparison operators: `:`. *
* `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.enum_values.values.id` - The allowed
* value id of the user defined enum attribute associated with the Resource.
* Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a
* placeholder that can be replaced with any user defined enum attribute name.
* * `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.enum_values.values.display_name` - The
* allowed value display name of the user defined enum attribute associated
* with the Resource. Allowed comparison operator is `:`. Here
* user-defined-attribute-enum-display-name is a placeholder that can be
* replaced with any user defined enum attribute enum name. *
* `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.string_values.values` - The allowed
* value of the user defined string attribute associated with the Resource.
* Allowed comparison operator is `:`. Here user-defined-attribute-string is a
* placeholder that can be replaced with any user defined string attribute
* name. * `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.json_values.values` - The allowed value
* of the user defined JSON attribute associated with the Resource. Allowed
* comparison operator is `:`. Here user-defined-attribute-json is a
* placeholder that can be replaced with any user defined JSON attribute name.
* 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: * `lifecycle.enum_values.values.id: preview-id` - The filter
* string specifies that the id of the allowed value associated with the
* lifecycle attribute of the Version is _preview-id_. *
* `lifecycle.enum_values.values.display_name: \\"Preview Display Name\\"` -
* The filter string specifies that the display name of the allowed value
* associated with the lifecycle attribute of the Version is `Preview Display
* Name`. * `lifecycle.enum_values.values.id: preview-id AND create_time <
* \\"2021-08-15T14:50:00Z\\" AND create_time > \\"2021-08-10T12:00:00Z\\"` -
* The id of the allowed value associated with the lifecycle attribute of the
* Version is _preview-id_ and it was created before _2021-08-15 14:50:00 UTC_
* and after _2021-08-10 12:00:00 UTC_. * `compliance.enum_values.values.id:
* gdpr-id OR compliance.enum_values.values.id: pci-dss-id` - The id of the
* allowed value associated with the compliance attribute is _gdpr-id_ or
* _pci-dss-id_. * `lifecycle.enum_values.values.id: preview-id AND
* attributes.projects/test-project-id/locations/test-location-id/
* attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test`
* - The filter string specifies that the id of the allowed value associated
* with the lifecycle attribute of the Version is _preview-id_ and the value of
* the user defined attribute of type string is _test_.
*/
@property(nonatomic, copy, nullable) NSString *filter;
/**
* Optional. The maximum number of versions to return. The service may return
* fewer than this value. If unspecified, at most 50 versions will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
@property(nonatomic, assign) NSInteger pageSize;
/**
* Optional. A page token, received from a previous `ListVersions` call.
* Provide this to retrieve the subsequent page. When paginating, all other
* parameters (except page_size) provided to `ListVersions` must match the call
* that provided the page token.
*/
@property(nonatomic, copy, nullable) NSString *pageToken;
/**
* Required. The parent which owns this collection of API versions i.e., the
* API resource Format: `projects/{project}/locations/{location}/apis/{api}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1ListVersionsResponse.
*
* List API versions of an API resource in the API hub.
*
* @param parent Required. The parent which owns this collection of API
* versions i.e., the API resource Format:
* `projects/{project}/locations/{location}/apis/{api}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsList
*
* @note Automatic pagination will be done when @c shouldFetchNextPages is
* enabled. See @c shouldFetchNextPages on @c GTLRService for more
* information.
*/
+ (instancetype)queryWithParent:(NSString *)parent;
@end
/**
* Create an apiOperation in an API version. An apiOperation can be created
* only if the version has no apiOperations which were created by parsing a
* spec.
*
* Method: apihub.projects.locations.apis.versions.operations.create
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsCreate : GTLRAPIhubQuery
/**
* Optional. The ID to use for the operation resource, which will become the
* final component of the operation'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 operation resource in the API hub. *
* If not provided, a system generated id will be used. This value should be
* 4-500 characters, overall resource name which will be of format
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`,
* its length is limited to 700 characters, and valid characters are
* /a-z[0-9]-_/.
*/
@property(nonatomic, copy, nullable) NSString *apiOperationId;
/**
* Required. The parent resource for the operation resource. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1ApiOperation.
*
* Create an apiOperation in an API version. An apiOperation can be created
* only if the version has no apiOperations which were created by parsing a
* spec.
*
* @param object The @c GTLRAPIhub_GoogleCloudApihubV1ApiOperation to include
* in the query.
* @param parent Required. The parent resource for the operation resource.
* Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsCreate
*/
+ (instancetype)queryWithObject:(GTLRAPIhub_GoogleCloudApihubV1ApiOperation *)object
parent:(NSString *)parent;
@end
/**
* Delete an operation in an API version and we can delete only the operations
* created via create API. If the operation was created by parsing the spec,
* then it can be deleted by editing or deleting the spec.
*
* Method: apihub.projects.locations.apis.versions.operations.delete
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsDelete : GTLRAPIhubQuery
/**
* Required. The name of the operation resource to delete. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_Empty.
*
* Delete an operation in an API version and we can delete only the operations
* created via create API. If the operation was created by parsing the spec,
* then it can be deleted by editing or deleting the spec.
*
* @param name Required. The name of the operation resource to delete. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsDelete
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* Get details about a particular operation in API version.
*
* Method: apihub.projects.locations.apis.versions.operations.get
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsGet : GTLRAPIhubQuery
/**
* Required. The name of the operation to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1ApiOperation.
*
* Get details about a particular operation in API version.
*
* @param name Required. The name of the operation to retrieve. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsGet
*/
+ (instancetype)queryWithName:(NSString *)name;
@end
/**
* List operations in an API version.
*
* Method: apihub.projects.locations.apis.versions.operations.list
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsList : GTLRAPIhubQuery
/**
* Optional. An expression that filters the list of ApiOperations. A filter
* expression consists of a field name, a comparison operator, and a value for
* filtering. The value must be a string or a boolean. The comparison operator
* must be one of: `<`, `>` or `=`. Filters are not case sensitive. The
* following fields in the `ApiOperation` are eligible for filtering: * `name`
* - The ApiOperation resource name. Allowed comparison operators: `=`. *
* `details.http_operation.path.path` - The http operation's complete path
* relative to server endpoint. Allowed comparison operators: `=`. *
* `details.http_operation.method` - The http operation method type. Allowed
* comparison operators: `=`. * `details.deprecated` - Indicates if the
* ApiOperation is deprecated. Allowed values are True / False indicating the
* deprycation status of the ApiOperation. Allowed comparison operators: `=`. *
* `create_time` - The time at which the ApiOperation was created. The value
* should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
* Allowed comparison operators: `>` and `<`. *
* `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.enum_values.values.id` - The allowed
* value id of the user defined enum attribute associated with the Resource.
* Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a
* placeholder that can be replaced with any user defined enum attribute name.
* * `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.enum_values.values.display_name` - The
* allowed value display name of the user defined enum attribute associated
* with the Resource. Allowed comparison operator is `:`. Here
* user-defined-attribute-enum-display-name is a placeholder that can be
* replaced with any user defined enum attribute enum name. *
* `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.string_values.values` - The allowed
* value of the user defined string attribute associated with the Resource.
* Allowed comparison operator is `:`. Here user-defined-attribute-string is a
* placeholder that can be replaced with any user defined string attribute
* name. * `attributes.projects/test-project-id/locations/test-location-id/
* attributes/user-defined-attribute-id.json_values.values` - The allowed value
* of the user defined JSON attribute associated with the Resource. Allowed
* comparison operator is `:`. Here user-defined-attribute-json is a
* placeholder that can be replaced with any user defined JSON attribute name.
* 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: * `details.deprecated = True` - The ApiOperation is
* deprecated. * `details.http_operation.method = GET AND create_time <
* \\"2021-08-15T14:50:00Z\\" AND create_time > \\"2021-08-10T12:00:00Z\\"` -
* The method of the http operation of the ApiOperation is _GET_ and the spec
* was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00
* UTC_. * `details.http_operation.method = GET OR
* details.http_operation.method = POST`. - The http operation of the method of
* ApiOperation is _GET_ or _POST_. * `details.deprecated = True AND
* attributes.projects/test-project-id/locations/test-location-id/
* attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test`
* - The filter string specifies that the ApiOperation is deprecated and the
* value of the user defined attribute of type string is _test_.
*/
@property(nonatomic, copy, nullable) NSString *filter;
/**
* Optional. The maximum number of operations to return. The service may return
* fewer than this value. If unspecified, at most 50 operations will be
* returned. The maximum value is 1000; values above 1000 will be coerced to
* 1000.
*/
@property(nonatomic, assign) NSInteger pageSize;
/**
* Optional. A page token, received from a previous `ListApiOperations` call.
* Provide this to retrieve the subsequent page. When paginating, all other
* parameters (except page_size) provided to `ListApiOperations` must match the
* call that provided the page token.
*/
@property(nonatomic, copy, nullable) NSString *pageToken;
/**
* Required. The parent which owns this collection of operations i.e., the API
* version. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*/
@property(nonatomic, copy, nullable) NSString *parent;
/**
* Fetches a @c GTLRAPIhub_GoogleCloudApihubV1ListApiOperationsResponse.
*
* List operations in an API version.
*
* @param parent Required. The parent which owns this collection of operations
* i.e., the API version. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
*
* @return GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsList
*
* @note Automatic pagination will be done when @c shouldFetchNextPages is
* enabled. See @c shouldFetchNextPages on @c GTLRService for more
* information.
*/
+ (instancetype)queryWithParent:(NSString *)parent;
@end
/**
* Update an operation in an API version. The following fields in the
* ApiOperation resource can be updated: * details.description *
* details.documentation * details.http_operation.path *
* details.http_operation.method * details.deprecated * attributes The
* update_mask should be used to specify the fields being updated. An operation
* can be updated only if the operation was created via CreateApiOperation API.
* If the operation was created by parsing the spec, then it can be edited by
* updating the spec.
*
* Method: apihub.projects.locations.apis.versions.operations.patch
*
* Authorization scope(s):
* @c kGTLRAuthScopeAPIhubCloudPlatform
*/
@interface GTLRAPIhubQuery_ProjectsLocationsApisVersionsOperationsPatch : GTLRAPIhubQuery
/**
* Identifier. The name of the operation. Format:
* `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
*/
@property(nonatomic, copy, nullable) NSString *name;
/**
* Required. The list of fields to update.