google-cloud-apigee_registry-v1 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/apigee_registry/v1/provisioning/client.rb +1 -1
- data/lib/google/cloud/apigee_registry/v1/registry/client.rb +88 -82
- data/lib/google/cloud/apigee_registry/v1/version.rb +1 -1
- data/lib/google/cloud/apigeeregistry/v1/registry_service_pb.rb +2 -0
- data/lib/google/cloud/apigeeregistry/v1/registry_service_services_pb.rb +37 -37
- data/proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb +1 -1
- data/proto_docs/google/cloud/apigeeregistry/v1/registry_models.rb +22 -22
- data/proto_docs/google/cloud/apigeeregistry/v1/registry_service.rb +50 -42
- data/proto_docs/google/protobuf/empty.rb +0 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7012cd6d477eea878a01cfd064edb058bc520988f79d9060625a41d75bfa816e
|
4
|
+
data.tar.gz: 60a7d7093c4e2b88be3b67267b7fcd55abe56205a64745f15bd9689c91239d32
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fcb419ddd225adb649da9890a0394a1ba2a85950f7c5597602d97e4c8e0ce856aba3c4d37172623aa1843d853eefa018ffa8658958fc3db2bcae1e9e0e1208ba
|
7
|
+
data.tar.gz: 47a6b92fdae0513a0025f3bfd164b1dbf75642ccd8fdd7f6c1cbf250d8da7c577481a60e1d541451e274ce54702c071ba8521cebc214e20eb066b23fe4b2cbaa
|
@@ -19,7 +19,7 @@
|
|
19
19
|
require "google/cloud/errors"
|
20
20
|
require "google/cloud/apigeeregistry/v1/registry_service_pb"
|
21
21
|
require "google/cloud/location"
|
22
|
-
require "google/iam/v1
|
22
|
+
require "google/iam/v1"
|
23
23
|
|
24
24
|
module Google
|
25
25
|
module Cloud
|
@@ -342,7 +342,7 @@ module Google
|
|
342
342
|
# Service calls
|
343
343
|
|
344
344
|
##
|
345
|
-
#
|
345
|
+
# Returns matching APIs.
|
346
346
|
#
|
347
347
|
# @overload list_apis(request, options = nil)
|
348
348
|
# Pass arguments to `list_apis` via a request object, either of type
|
@@ -361,7 +361,7 @@ module Google
|
|
361
361
|
#
|
362
362
|
# @param parent [::String]
|
363
363
|
# Required. The parent, which owns this collection of APIs.
|
364
|
-
# Format: projects/*/locations
|
364
|
+
# Format: `projects/*/locations/*`
|
365
365
|
# @param page_size [::Integer]
|
366
366
|
# The maximum number of APIs to return.
|
367
367
|
# The service may return fewer than this value.
|
@@ -449,7 +449,7 @@ module Google
|
|
449
449
|
end
|
450
450
|
|
451
451
|
##
|
452
|
-
#
|
452
|
+
# Returns a specified API.
|
453
453
|
#
|
454
454
|
# @overload get_api(request, options = nil)
|
455
455
|
# Pass arguments to `get_api` via a request object, either of type
|
@@ -468,7 +468,7 @@ module Google
|
|
468
468
|
#
|
469
469
|
# @param name [::String]
|
470
470
|
# Required. The name of the API to retrieve.
|
471
|
-
# Format: projects/*/locations/*/apis
|
471
|
+
# Format: `projects/*/locations/*/apis/*`
|
472
472
|
#
|
473
473
|
# @yield [response, operation] Access the result along with the RPC operation
|
474
474
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::Api]
|
@@ -535,7 +535,7 @@ module Google
|
|
535
535
|
end
|
536
536
|
|
537
537
|
##
|
538
|
-
#
|
538
|
+
# Creates a specified API.
|
539
539
|
#
|
540
540
|
# @overload create_api(request, options = nil)
|
541
541
|
# Pass arguments to `create_api` via a request object, either of type
|
@@ -554,12 +554,12 @@ module Google
|
|
554
554
|
#
|
555
555
|
# @param parent [::String]
|
556
556
|
# Required. The parent, which owns this collection of APIs.
|
557
|
-
# Format: projects/*/locations
|
557
|
+
# Format: `projects/*/locations/*`
|
558
558
|
# @param api [::Google::Cloud::ApigeeRegistry::V1::Api, ::Hash]
|
559
559
|
# Required. The API to create.
|
560
560
|
# @param api_id [::String]
|
561
|
-
# Required. The ID to use for the
|
562
|
-
# the
|
561
|
+
# Required. The ID to use for the API, which will become the final component of
|
562
|
+
# the API's resource name.
|
563
563
|
#
|
564
564
|
# This value should be 4-63 characters, and valid characters
|
565
565
|
# are /[a-z][0-9]-/.
|
@@ -631,7 +631,7 @@ module Google
|
|
631
631
|
end
|
632
632
|
|
633
633
|
##
|
634
|
-
#
|
634
|
+
# Used to modify a specified API.
|
635
635
|
#
|
636
636
|
# @overload update_api(request, options = nil)
|
637
637
|
# Pass arguments to `update_api` via a request object, either of type
|
@@ -652,14 +652,14 @@ module Google
|
|
652
652
|
# Required. The API to update.
|
653
653
|
#
|
654
654
|
# The `name` field is used to identify the API to update.
|
655
|
-
# Format: projects/*/locations/*/apis
|
655
|
+
# Format: `projects/*/locations/*/apis/*`
|
656
656
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
657
657
|
# The list of fields to be updated. If omitted, all fields are updated that
|
658
658
|
# are set in the request message (fields set to default values are ignored).
|
659
|
-
# If
|
660
|
-
# unspecified/default in the request.
|
659
|
+
# If an asterisk "*" is specified, all fields are updated, including fields
|
660
|
+
# that are unspecified/default in the request.
|
661
661
|
# @param allow_missing [::Boolean]
|
662
|
-
# If set to true, and the
|
662
|
+
# If set to true, and the API is not found, a new API will be created.
|
663
663
|
# In this situation, `update_mask` is ignored.
|
664
664
|
#
|
665
665
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -727,7 +727,7 @@ module Google
|
|
727
727
|
end
|
728
728
|
|
729
729
|
##
|
730
|
-
#
|
730
|
+
# Removes a specified API and all of the resources that it
|
731
731
|
# owns.
|
732
732
|
#
|
733
733
|
# @overload delete_api(request, options = nil)
|
@@ -740,14 +740,17 @@ module Google
|
|
740
740
|
# @param options [::Gapic::CallOptions, ::Hash]
|
741
741
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
742
742
|
#
|
743
|
-
# @overload delete_api(name: nil)
|
743
|
+
# @overload delete_api(name: nil, force: nil)
|
744
744
|
# Pass arguments to `delete_api` via keyword arguments. Note that at
|
745
745
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
746
746
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
747
747
|
#
|
748
748
|
# @param name [::String]
|
749
749
|
# Required. The name of the API to delete.
|
750
|
-
# Format: projects/*/locations/*/apis
|
750
|
+
# Format: `projects/*/locations/*/apis/*`
|
751
|
+
# @param force [::Boolean]
|
752
|
+
# If set to true, any child resources will also be deleted.
|
753
|
+
# (Otherwise, the request will only work if there are no child resources.)
|
751
754
|
#
|
752
755
|
# @yield [response, operation] Access the result along with the RPC operation
|
753
756
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -814,7 +817,7 @@ module Google
|
|
814
817
|
end
|
815
818
|
|
816
819
|
##
|
817
|
-
#
|
820
|
+
# Returns matching versions.
|
818
821
|
#
|
819
822
|
# @overload list_api_versions(request, options = nil)
|
820
823
|
# Pass arguments to `list_api_versions` via a request object, either of type
|
@@ -833,7 +836,7 @@ module Google
|
|
833
836
|
#
|
834
837
|
# @param parent [::String]
|
835
838
|
# Required. The parent, which owns this collection of versions.
|
836
|
-
# Format: projects/*/locations/*/apis
|
839
|
+
# Format: `projects/*/locations/*/apis/*`
|
837
840
|
# @param page_size [::Integer]
|
838
841
|
# The maximum number of versions to return.
|
839
842
|
# The service may return fewer than this value.
|
@@ -921,7 +924,7 @@ module Google
|
|
921
924
|
end
|
922
925
|
|
923
926
|
##
|
924
|
-
#
|
927
|
+
# Returns a specified version.
|
925
928
|
#
|
926
929
|
# @overload get_api_version(request, options = nil)
|
927
930
|
# Pass arguments to `get_api_version` via a request object, either of type
|
@@ -940,7 +943,7 @@ module Google
|
|
940
943
|
#
|
941
944
|
# @param name [::String]
|
942
945
|
# Required. The name of the version to retrieve.
|
943
|
-
# Format: projects/*/locations/*/apis/*/versions
|
946
|
+
# Format: `projects/*/locations/*/apis/*/versions/*`
|
944
947
|
#
|
945
948
|
# @yield [response, operation] Access the result along with the RPC operation
|
946
949
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::ApiVersion]
|
@@ -1007,7 +1010,7 @@ module Google
|
|
1007
1010
|
end
|
1008
1011
|
|
1009
1012
|
##
|
1010
|
-
#
|
1013
|
+
# Creates a specified version.
|
1011
1014
|
#
|
1012
1015
|
# @overload create_api_version(request, options = nil)
|
1013
1016
|
# Pass arguments to `create_api_version` via a request object, either of type
|
@@ -1026,7 +1029,7 @@ module Google
|
|
1026
1029
|
#
|
1027
1030
|
# @param parent [::String]
|
1028
1031
|
# Required. The parent, which owns this collection of versions.
|
1029
|
-
# Format: projects/*/locations/*/apis
|
1032
|
+
# Format: `projects/*/locations/*/apis/*`
|
1030
1033
|
# @param api_version [::Google::Cloud::ApigeeRegistry::V1::ApiVersion, ::Hash]
|
1031
1034
|
# Required. The version to create.
|
1032
1035
|
# @param api_version_id [::String]
|
@@ -1103,7 +1106,7 @@ module Google
|
|
1103
1106
|
end
|
1104
1107
|
|
1105
1108
|
##
|
1106
|
-
#
|
1109
|
+
# Used to modify a specified version.
|
1107
1110
|
#
|
1108
1111
|
# @overload update_api_version(request, options = nil)
|
1109
1112
|
# Pass arguments to `update_api_version` via a request object, either of type
|
@@ -1124,12 +1127,12 @@ module Google
|
|
1124
1127
|
# Required. The version to update.
|
1125
1128
|
#
|
1126
1129
|
# The `name` field is used to identify the version to update.
|
1127
|
-
# Format: projects/*/locations/*/apis/*/versions
|
1130
|
+
# Format: `projects/*/locations/*/apis/*/versions/*`
|
1128
1131
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1129
1132
|
# The list of fields to be updated. If omitted, all fields are updated that
|
1130
1133
|
# are set in the request message (fields set to default values are ignored).
|
1131
|
-
# If
|
1132
|
-
# unspecified/default in the request.
|
1134
|
+
# If an asterisk "*" is specified, all fields are updated, including fields
|
1135
|
+
# that are unspecified/default in the request.
|
1133
1136
|
# @param allow_missing [::Boolean]
|
1134
1137
|
# If set to true, and the version is not found, a new version will be
|
1135
1138
|
# created. In this situation, `update_mask` is ignored.
|
@@ -1199,7 +1202,7 @@ module Google
|
|
1199
1202
|
end
|
1200
1203
|
|
1201
1204
|
##
|
1202
|
-
#
|
1205
|
+
# Removes a specified version and all of the resources that
|
1203
1206
|
# it owns.
|
1204
1207
|
#
|
1205
1208
|
# @overload delete_api_version(request, options = nil)
|
@@ -1212,14 +1215,17 @@ module Google
|
|
1212
1215
|
# @param options [::Gapic::CallOptions, ::Hash]
|
1213
1216
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1214
1217
|
#
|
1215
|
-
# @overload delete_api_version(name: nil)
|
1218
|
+
# @overload delete_api_version(name: nil, force: nil)
|
1216
1219
|
# Pass arguments to `delete_api_version` via keyword arguments. Note that at
|
1217
1220
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
1218
1221
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1219
1222
|
#
|
1220
1223
|
# @param name [::String]
|
1221
1224
|
# Required. The name of the version to delete.
|
1222
|
-
# Format: projects/*/locations/*/apis/*/versions
|
1225
|
+
# Format: `projects/*/locations/*/apis/*/versions/*`
|
1226
|
+
# @param force [::Boolean]
|
1227
|
+
# If set to true, any child resources will also be deleted.
|
1228
|
+
# (Otherwise, the request will only work if there are no child resources.)
|
1223
1229
|
#
|
1224
1230
|
# @yield [response, operation] Access the result along with the RPC operation
|
1225
1231
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -1286,7 +1292,7 @@ module Google
|
|
1286
1292
|
end
|
1287
1293
|
|
1288
1294
|
##
|
1289
|
-
#
|
1295
|
+
# Returns matching specs.
|
1290
1296
|
#
|
1291
1297
|
# @overload list_api_specs(request, options = nil)
|
1292
1298
|
# Pass arguments to `list_api_specs` via a request object, either of type
|
@@ -1305,7 +1311,7 @@ module Google
|
|
1305
1311
|
#
|
1306
1312
|
# @param parent [::String]
|
1307
1313
|
# Required. The parent, which owns this collection of specs.
|
1308
|
-
# Format: projects/*/locations/*/apis/*/versions
|
1314
|
+
# Format: `projects/*/locations/*/apis/*/versions/*`
|
1309
1315
|
# @param page_size [::Integer]
|
1310
1316
|
# The maximum number of specs to return.
|
1311
1317
|
# The service may return fewer than this value.
|
@@ -1393,7 +1399,7 @@ module Google
|
|
1393
1399
|
end
|
1394
1400
|
|
1395
1401
|
##
|
1396
|
-
#
|
1402
|
+
# Returns a specified spec.
|
1397
1403
|
#
|
1398
1404
|
# @overload get_api_spec(request, options = nil)
|
1399
1405
|
# Pass arguments to `get_api_spec` via a request object, either of type
|
@@ -1412,7 +1418,7 @@ module Google
|
|
1412
1418
|
#
|
1413
1419
|
# @param name [::String]
|
1414
1420
|
# Required. The name of the spec to retrieve.
|
1415
|
-
# Format: projects/*/locations/*/apis/*/versions/*/specs
|
1421
|
+
# Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
|
1416
1422
|
#
|
1417
1423
|
# @yield [response, operation] Access the result along with the RPC operation
|
1418
1424
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::ApiSpec]
|
@@ -1479,7 +1485,7 @@ module Google
|
|
1479
1485
|
end
|
1480
1486
|
|
1481
1487
|
##
|
1482
|
-
#
|
1488
|
+
# Returns the contents of a specified spec.
|
1483
1489
|
# If specs are stored with GZip compression, the default behavior
|
1484
1490
|
# is to return the spec uncompressed (the mime_type response field
|
1485
1491
|
# indicates the exact format returned).
|
@@ -1501,7 +1507,7 @@ module Google
|
|
1501
1507
|
#
|
1502
1508
|
# @param name [::String]
|
1503
1509
|
# Required. The name of the spec whose contents should be retrieved.
|
1504
|
-
# Format: projects/*/locations/*/apis/*/versions/*/specs
|
1510
|
+
# Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
|
1505
1511
|
#
|
1506
1512
|
# @yield [response, operation] Access the result along with the RPC operation
|
1507
1513
|
# @yieldparam response [::Google::Api::HttpBody]
|
@@ -1568,7 +1574,7 @@ module Google
|
|
1568
1574
|
end
|
1569
1575
|
|
1570
1576
|
##
|
1571
|
-
#
|
1577
|
+
# Creates a specified spec.
|
1572
1578
|
#
|
1573
1579
|
# @overload create_api_spec(request, options = nil)
|
1574
1580
|
# Pass arguments to `create_api_spec` via a request object, either of type
|
@@ -1587,7 +1593,7 @@ module Google
|
|
1587
1593
|
#
|
1588
1594
|
# @param parent [::String]
|
1589
1595
|
# Required. The parent, which owns this collection of specs.
|
1590
|
-
# Format: projects/*/locations/*/apis/*/versions
|
1596
|
+
# Format: `projects/*/locations/*/apis/*/versions/*`
|
1591
1597
|
# @param api_spec [::Google::Cloud::ApigeeRegistry::V1::ApiSpec, ::Hash]
|
1592
1598
|
# Required. The spec to create.
|
1593
1599
|
# @param api_spec_id [::String]
|
@@ -1664,7 +1670,7 @@ module Google
|
|
1664
1670
|
end
|
1665
1671
|
|
1666
1672
|
##
|
1667
|
-
#
|
1673
|
+
# Used to modify a specified spec.
|
1668
1674
|
#
|
1669
1675
|
# @overload update_api_spec(request, options = nil)
|
1670
1676
|
# Pass arguments to `update_api_spec` via a request object, either of type
|
@@ -1685,12 +1691,12 @@ module Google
|
|
1685
1691
|
# Required. The spec to update.
|
1686
1692
|
#
|
1687
1693
|
# The `name` field is used to identify the spec to update.
|
1688
|
-
# Format: projects/*/locations/*/apis/*/versions/*/specs
|
1694
|
+
# Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
|
1689
1695
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1690
1696
|
# The list of fields to be updated. If omitted, all fields are updated that
|
1691
1697
|
# are set in the request message (fields set to default values are ignored).
|
1692
|
-
# If
|
1693
|
-
# unspecified/default in the request.
|
1698
|
+
# If an asterisk "*" is specified, all fields are updated, including fields
|
1699
|
+
# that are unspecified/default in the request.
|
1694
1700
|
# @param allow_missing [::Boolean]
|
1695
1701
|
# If set to true, and the spec is not found, a new spec will be created.
|
1696
1702
|
# In this situation, `update_mask` is ignored.
|
@@ -1760,8 +1766,8 @@ module Google
|
|
1760
1766
|
end
|
1761
1767
|
|
1762
1768
|
##
|
1763
|
-
#
|
1764
|
-
# resources (e.g
|
1769
|
+
# Removes a specified spec, all revisions, and all child
|
1770
|
+
# resources (e.g., artifacts).
|
1765
1771
|
#
|
1766
1772
|
# @overload delete_api_spec(request, options = nil)
|
1767
1773
|
# Pass arguments to `delete_api_spec` via a request object, either of type
|
@@ -1780,7 +1786,7 @@ module Google
|
|
1780
1786
|
#
|
1781
1787
|
# @param name [::String]
|
1782
1788
|
# Required. The name of the spec to delete.
|
1783
|
-
# Format: projects/*/locations/*/apis/*/versions/*/specs
|
1789
|
+
# Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
|
1784
1790
|
# @param force [::Boolean]
|
1785
1791
|
# If set to true, any child resources will also be deleted.
|
1786
1792
|
# (Otherwise, the request will only work if there are no child resources.)
|
@@ -1850,7 +1856,7 @@ module Google
|
|
1850
1856
|
end
|
1851
1857
|
|
1852
1858
|
##
|
1853
|
-
#
|
1859
|
+
# Adds a tag to a specified revision of a spec.
|
1854
1860
|
#
|
1855
1861
|
# @overload tag_api_spec_revision(request, options = nil)
|
1856
1862
|
# Pass arguments to `tag_api_spec_revision` via a request object, either of type
|
@@ -1938,7 +1944,7 @@ module Google
|
|
1938
1944
|
end
|
1939
1945
|
|
1940
1946
|
##
|
1941
|
-
#
|
1947
|
+
# Lists all revisions of a spec.
|
1942
1948
|
# Revisions are returned in descending order of revision creation time.
|
1943
1949
|
#
|
1944
1950
|
# @overload list_api_spec_revisions(request, options = nil)
|
@@ -2036,7 +2042,7 @@ module Google
|
|
2036
2042
|
end
|
2037
2043
|
|
2038
2044
|
##
|
2039
|
-
#
|
2045
|
+
# Sets the current revision to a specified prior revision.
|
2040
2046
|
# Note that this creates a new revision with a new revision ID.
|
2041
2047
|
#
|
2042
2048
|
# @overload rollback_api_spec(request, options = nil)
|
@@ -2060,7 +2066,7 @@ module Google
|
|
2060
2066
|
# Required. The revision ID to roll back to.
|
2061
2067
|
# It must be a revision of the same spec.
|
2062
2068
|
#
|
2063
|
-
# Example: c7cfa2a8
|
2069
|
+
# Example: `c7cfa2a8`
|
2064
2070
|
#
|
2065
2071
|
# @yield [response, operation] Access the result along with the RPC operation
|
2066
2072
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::ApiSpec]
|
@@ -2127,7 +2133,7 @@ module Google
|
|
2127
2133
|
end
|
2128
2134
|
|
2129
2135
|
##
|
2130
|
-
#
|
2136
|
+
# Deletes a revision of a spec.
|
2131
2137
|
#
|
2132
2138
|
# @overload delete_api_spec_revision(request, options = nil)
|
2133
2139
|
# Pass arguments to `delete_api_spec_revision` via a request object, either of type
|
@@ -2149,7 +2155,7 @@ module Google
|
|
2149
2155
|
# with a revision ID explicitly included.
|
2150
2156
|
#
|
2151
2157
|
# Example:
|
2152
|
-
# projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8
|
2158
|
+
# `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8`
|
2153
2159
|
#
|
2154
2160
|
# @yield [response, operation] Access the result along with the RPC operation
|
2155
2161
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::ApiSpec]
|
@@ -2216,7 +2222,7 @@ module Google
|
|
2216
2222
|
end
|
2217
2223
|
|
2218
2224
|
##
|
2219
|
-
#
|
2225
|
+
# Returns matching deployments.
|
2220
2226
|
#
|
2221
2227
|
# @overload list_api_deployments(request, options = nil)
|
2222
2228
|
# Pass arguments to `list_api_deployments` via a request object, either of type
|
@@ -2235,7 +2241,7 @@ module Google
|
|
2235
2241
|
#
|
2236
2242
|
# @param parent [::String]
|
2237
2243
|
# Required. The parent, which owns this collection of deployments.
|
2238
|
-
# Format: projects/*/locations/*/apis
|
2244
|
+
# Format: `projects/*/locations/*/apis/*`
|
2239
2245
|
# @param page_size [::Integer]
|
2240
2246
|
# The maximum number of deployments to return.
|
2241
2247
|
# The service may return fewer than this value.
|
@@ -2323,7 +2329,7 @@ module Google
|
|
2323
2329
|
end
|
2324
2330
|
|
2325
2331
|
##
|
2326
|
-
#
|
2332
|
+
# Returns a specified deployment.
|
2327
2333
|
#
|
2328
2334
|
# @overload get_api_deployment(request, options = nil)
|
2329
2335
|
# Pass arguments to `get_api_deployment` via a request object, either of type
|
@@ -2342,7 +2348,7 @@ module Google
|
|
2342
2348
|
#
|
2343
2349
|
# @param name [::String]
|
2344
2350
|
# Required. The name of the deployment to retrieve.
|
2345
|
-
# Format: projects/*/locations/*/apis/*/deployments
|
2351
|
+
# Format: `projects/*/locations/*/apis/*/deployments/*`
|
2346
2352
|
#
|
2347
2353
|
# @yield [response, operation] Access the result along with the RPC operation
|
2348
2354
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::ApiDeployment]
|
@@ -2409,7 +2415,7 @@ module Google
|
|
2409
2415
|
end
|
2410
2416
|
|
2411
2417
|
##
|
2412
|
-
#
|
2418
|
+
# Creates a specified deployment.
|
2413
2419
|
#
|
2414
2420
|
# @overload create_api_deployment(request, options = nil)
|
2415
2421
|
# Pass arguments to `create_api_deployment` via a request object, either of type
|
@@ -2428,7 +2434,7 @@ module Google
|
|
2428
2434
|
#
|
2429
2435
|
# @param parent [::String]
|
2430
2436
|
# Required. The parent, which owns this collection of deployments.
|
2431
|
-
# Format: projects/*/locations/*/apis
|
2437
|
+
# Format: `projects/*/locations/*/apis/*`
|
2432
2438
|
# @param api_deployment [::Google::Cloud::ApigeeRegistry::V1::ApiDeployment, ::Hash]
|
2433
2439
|
# Required. The deployment to create.
|
2434
2440
|
# @param api_deployment_id [::String]
|
@@ -2505,7 +2511,7 @@ module Google
|
|
2505
2511
|
end
|
2506
2512
|
|
2507
2513
|
##
|
2508
|
-
#
|
2514
|
+
# Used to modify a specified deployment.
|
2509
2515
|
#
|
2510
2516
|
# @overload update_api_deployment(request, options = nil)
|
2511
2517
|
# Pass arguments to `update_api_deployment` via a request object, either of type
|
@@ -2526,12 +2532,12 @@ module Google
|
|
2526
2532
|
# Required. The deployment to update.
|
2527
2533
|
#
|
2528
2534
|
# The `name` field is used to identify the deployment to update.
|
2529
|
-
# Format: projects/*/locations/*/apis/*/deployments
|
2535
|
+
# Format: `projects/*/locations/*/apis/*/deployments/*`
|
2530
2536
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2531
2537
|
# The list of fields to be updated. If omitted, all fields are updated that
|
2532
2538
|
# are set in the request message (fields set to default values are ignored).
|
2533
|
-
# If
|
2534
|
-
# unspecified/default in the request.
|
2539
|
+
# If an asterisk "*" is specified, all fields are updated, including fields
|
2540
|
+
# that are unspecified/default in the request.
|
2535
2541
|
# @param allow_missing [::Boolean]
|
2536
2542
|
# If set to true, and the deployment is not found, a new deployment will be
|
2537
2543
|
# created. In this situation, `update_mask` is ignored.
|
@@ -2601,8 +2607,8 @@ module Google
|
|
2601
2607
|
end
|
2602
2608
|
|
2603
2609
|
##
|
2604
|
-
#
|
2605
|
-
# child resources (e.g
|
2610
|
+
# Removes a specified deployment, all revisions, and all
|
2611
|
+
# child resources (e.g., artifacts).
|
2606
2612
|
#
|
2607
2613
|
# @overload delete_api_deployment(request, options = nil)
|
2608
2614
|
# Pass arguments to `delete_api_deployment` via a request object, either of type
|
@@ -2621,7 +2627,7 @@ module Google
|
|
2621
2627
|
#
|
2622
2628
|
# @param name [::String]
|
2623
2629
|
# Required. The name of the deployment to delete.
|
2624
|
-
# Format: projects/*/locations/*/apis/*/deployments
|
2630
|
+
# Format: `projects/*/locations/*/apis/*/deployments/*`
|
2625
2631
|
# @param force [::Boolean]
|
2626
2632
|
# If set to true, any child resources will also be deleted.
|
2627
2633
|
# (Otherwise, the request will only work if there are no child resources.)
|
@@ -2691,7 +2697,7 @@ module Google
|
|
2691
2697
|
end
|
2692
2698
|
|
2693
2699
|
##
|
2694
|
-
#
|
2700
|
+
# Adds a tag to a specified revision of a
|
2695
2701
|
# deployment.
|
2696
2702
|
#
|
2697
2703
|
# @overload tag_api_deployment_revision(request, options = nil)
|
@@ -2780,7 +2786,7 @@ module Google
|
|
2780
2786
|
end
|
2781
2787
|
|
2782
2788
|
##
|
2783
|
-
#
|
2789
|
+
# Lists all revisions of a deployment.
|
2784
2790
|
# Revisions are returned in descending order of revision creation time.
|
2785
2791
|
#
|
2786
2792
|
# @overload list_api_deployment_revisions(request, options = nil)
|
@@ -2878,7 +2884,7 @@ module Google
|
|
2878
2884
|
end
|
2879
2885
|
|
2880
2886
|
##
|
2881
|
-
#
|
2887
|
+
# Sets the current revision to a specified prior
|
2882
2888
|
# revision. Note that this creates a new revision with a new revision ID.
|
2883
2889
|
#
|
2884
2890
|
# @overload rollback_api_deployment(request, options = nil)
|
@@ -2902,7 +2908,7 @@ module Google
|
|
2902
2908
|
# Required. The revision ID to roll back to.
|
2903
2909
|
# It must be a revision of the same deployment.
|
2904
2910
|
#
|
2905
|
-
# Example: c7cfa2a8
|
2911
|
+
# Example: `c7cfa2a8`
|
2906
2912
|
#
|
2907
2913
|
# @yield [response, operation] Access the result along with the RPC operation
|
2908
2914
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::ApiDeployment]
|
@@ -2969,7 +2975,7 @@ module Google
|
|
2969
2975
|
end
|
2970
2976
|
|
2971
2977
|
##
|
2972
|
-
#
|
2978
|
+
# Deletes a revision of a deployment.
|
2973
2979
|
#
|
2974
2980
|
# @overload delete_api_deployment_revision(request, options = nil)
|
2975
2981
|
# Pass arguments to `delete_api_deployment_revision` via a request object, either of type
|
@@ -2991,7 +2997,7 @@ module Google
|
|
2991
2997
|
# with a revision ID explicitly included.
|
2992
2998
|
#
|
2993
2999
|
# Example:
|
2994
|
-
# projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8
|
3000
|
+
# `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`
|
2995
3001
|
#
|
2996
3002
|
# @yield [response, operation] Access the result along with the RPC operation
|
2997
3003
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::ApiDeployment]
|
@@ -3058,7 +3064,7 @@ module Google
|
|
3058
3064
|
end
|
3059
3065
|
|
3060
3066
|
##
|
3061
|
-
#
|
3067
|
+
# Returns matching artifacts.
|
3062
3068
|
#
|
3063
3069
|
# @overload list_artifacts(request, options = nil)
|
3064
3070
|
# Pass arguments to `list_artifacts` via a request object, either of type
|
@@ -3077,7 +3083,7 @@ module Google
|
|
3077
3083
|
#
|
3078
3084
|
# @param parent [::String]
|
3079
3085
|
# Required. The parent, which owns this collection of artifacts.
|
3080
|
-
# Format:
|
3086
|
+
# Format: `{parent}`
|
3081
3087
|
# @param page_size [::Integer]
|
3082
3088
|
# The maximum number of artifacts to return.
|
3083
3089
|
# The service may return fewer than this value.
|
@@ -3165,7 +3171,7 @@ module Google
|
|
3165
3171
|
end
|
3166
3172
|
|
3167
3173
|
##
|
3168
|
-
#
|
3174
|
+
# Returns a specified artifact.
|
3169
3175
|
#
|
3170
3176
|
# @overload get_artifact(request, options = nil)
|
3171
3177
|
# Pass arguments to `get_artifact` via a request object, either of type
|
@@ -3184,7 +3190,7 @@ module Google
|
|
3184
3190
|
#
|
3185
3191
|
# @param name [::String]
|
3186
3192
|
# Required. The name of the artifact to retrieve.
|
3187
|
-
# Format:
|
3193
|
+
# Format: `{parent}/artifacts/*`
|
3188
3194
|
#
|
3189
3195
|
# @yield [response, operation] Access the result along with the RPC operation
|
3190
3196
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::Artifact]
|
@@ -3251,7 +3257,7 @@ module Google
|
|
3251
3257
|
end
|
3252
3258
|
|
3253
3259
|
##
|
3254
|
-
#
|
3260
|
+
# Returns the contents of a specified artifact.
|
3255
3261
|
# If artifacts are stored with GZip compression, the default behavior
|
3256
3262
|
# is to return the artifact uncompressed (the mime_type response field
|
3257
3263
|
# indicates the exact format returned).
|
@@ -3273,7 +3279,7 @@ module Google
|
|
3273
3279
|
#
|
3274
3280
|
# @param name [::String]
|
3275
3281
|
# Required. The name of the artifact whose contents should be retrieved.
|
3276
|
-
# Format:
|
3282
|
+
# Format: `{parent}/artifacts/*`
|
3277
3283
|
#
|
3278
3284
|
# @yield [response, operation] Access the result along with the RPC operation
|
3279
3285
|
# @yieldparam response [::Google::Api::HttpBody]
|
@@ -3340,7 +3346,7 @@ module Google
|
|
3340
3346
|
end
|
3341
3347
|
|
3342
3348
|
##
|
3343
|
-
#
|
3349
|
+
# Creates a specified artifact.
|
3344
3350
|
#
|
3345
3351
|
# @overload create_artifact(request, options = nil)
|
3346
3352
|
# Pass arguments to `create_artifact` via a request object, either of type
|
@@ -3359,7 +3365,7 @@ module Google
|
|
3359
3365
|
#
|
3360
3366
|
# @param parent [::String]
|
3361
3367
|
# Required. The parent, which owns this collection of artifacts.
|
3362
|
-
# Format:
|
3368
|
+
# Format: `{parent}`
|
3363
3369
|
# @param artifact [::Google::Cloud::ApigeeRegistry::V1::Artifact, ::Hash]
|
3364
3370
|
# Required. The artifact to create.
|
3365
3371
|
# @param artifact_id [::String]
|
@@ -3436,7 +3442,7 @@ module Google
|
|
3436
3442
|
end
|
3437
3443
|
|
3438
3444
|
##
|
3439
|
-
#
|
3445
|
+
# Used to replace a specified artifact.
|
3440
3446
|
#
|
3441
3447
|
# @overload replace_artifact(request, options = nil)
|
3442
3448
|
# Pass arguments to `replace_artifact` via a request object, either of type
|
@@ -3457,7 +3463,7 @@ module Google
|
|
3457
3463
|
# Required. The artifact to replace.
|
3458
3464
|
#
|
3459
3465
|
# The `name` field is used to identify the artifact to replace.
|
3460
|
-
# Format:
|
3466
|
+
# Format: `{parent}/artifacts/*`
|
3461
3467
|
#
|
3462
3468
|
# @yield [response, operation] Access the result along with the RPC operation
|
3463
3469
|
# @yieldparam response [::Google::Cloud::ApigeeRegistry::V1::Artifact]
|
@@ -3524,7 +3530,7 @@ module Google
|
|
3524
3530
|
end
|
3525
3531
|
|
3526
3532
|
##
|
3527
|
-
#
|
3533
|
+
# Removes a specified artifact.
|
3528
3534
|
#
|
3529
3535
|
# @overload delete_artifact(request, options = nil)
|
3530
3536
|
# Pass arguments to `delete_artifact` via a request object, either of type
|
@@ -3543,7 +3549,7 @@ module Google
|
|
3543
3549
|
#
|
3544
3550
|
# @param name [::String]
|
3545
3551
|
# Required. The name of the artifact to delete.
|
3546
|
-
# Format:
|
3552
|
+
# Format: `{parent}/artifacts/*`
|
3547
3553
|
#
|
3548
3554
|
# @yield [response, operation] Access the result along with the RPC operation
|
3549
3555
|
# @yieldparam response [::Google::Protobuf::Empty]
|