Skip to content

Commit 0c0f37d

Browse files
gcf-owl-bot[bot]vchudnov-g
gcf-owl-bot[bot]
and
vchudnov-g
authored
docs: [google-cloud-kms] code documentation improvements (#13366)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 706891520 Source-Link: googleapis/googleapis@edbf799 Source-Link: googleapis/googleapis-gen@dfaa238 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWttcy8uT3dsQm90LnlhbWwiLCJoIjoiZGZhYTIzODA0OTA2YTNjZGI2MzIwOGU2NTRhMzc4YzNkOWExZDU4NiJ9 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Victor Chudnovsky <[email protected]>
1 parent aa99816 commit 0c0f37d

File tree

13 files changed

+47
-41
lines changed

13 files changed

+47
-41
lines changed

‎packages/google-cloud-kms/google/cloud/kms/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "3.2.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-kms/google/cloud/kms_v1/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "3.2.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-kms/google/cloud/kms_v1/services/autokey/async_client.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -321,10 +321,11 @@ async def create_key_handle(
321321
triggering the provisioning of a new
322322
[CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the
323323
given resource type in the configured key project and the same
324-
location. [GetOperation][Operations.GetOperation] should be used
325-
to resolve the resulting long-running operation and get the
326-
resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and
327-
[CryptoKey][google.cloud.kms.v1.CryptoKey].
324+
location.
325+
[GetOperation][google.longrunning.Operations.GetOperation]
326+
should be used to resolve the resulting long-running operation
327+
and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle]
328+
and [CryptoKey][google.cloud.kms.v1.CryptoKey].
328329
329330
.. code-block:: python
330331

‎packages/google-cloud-kms/google/cloud/kms_v1/services/autokey/client.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -740,10 +740,11 @@ def create_key_handle(
740740
triggering the provisioning of a new
741741
[CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the
742742
given resource type in the configured key project and the same
743-
location. [GetOperation][Operations.GetOperation] should be used
744-
to resolve the resulting long-running operation and get the
745-
resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and
746-
[CryptoKey][google.cloud.kms.v1.CryptoKey].
743+
location.
744+
[GetOperation][google.longrunning.Operations.GetOperation]
745+
should be used to resolve the resulting long-running operation
746+
and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle]
747+
and [CryptoKey][google.cloud.kms.v1.CryptoKey].
747748
748749
.. code-block:: python
749750

‎packages/google-cloud-kms/google/cloud/kms_v1/services/autokey/transports/grpc.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -369,10 +369,11 @@ def create_key_handle(
369369
triggering the provisioning of a new
370370
[CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the
371371
given resource type in the configured key project and the same
372-
location. [GetOperation][Operations.GetOperation] should be used
373-
to resolve the resulting long-running operation and get the
374-
resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and
375-
[CryptoKey][google.cloud.kms.v1.CryptoKey].
372+
location.
373+
[GetOperation][google.longrunning.Operations.GetOperation]
374+
should be used to resolve the resulting long-running operation
375+
and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle]
376+
and [CryptoKey][google.cloud.kms.v1.CryptoKey].
376377
377378
Returns:
378379
Callable[[~.CreateKeyHandleRequest],

‎packages/google-cloud-kms/google/cloud/kms_v1/services/autokey/transports/grpc_asyncio.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -378,10 +378,11 @@ def create_key_handle(
378378
triggering the provisioning of a new
379379
[CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK use with the
380380
given resource type in the configured key project and the same
381-
location. [GetOperation][Operations.GetOperation] should be used
382-
to resolve the resulting long-running operation and get the
383-
resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and
384-
[CryptoKey][google.cloud.kms.v1.CryptoKey].
381+
location.
382+
[GetOperation][google.longrunning.Operations.GetOperation]
383+
should be used to resolve the resulting long-running operation
384+
and get the resulting [KeyHandle][google.cloud.kms.v1.KeyHandle]
385+
and [CryptoKey][google.cloud.kms.v1.CryptoKey].
385386
386387
Returns:
387388
Callable[[~.CreateKeyHandleRequest],

‎packages/google-cloud-kms/google/cloud/kms_v1/services/ekm_service/async_client.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,7 @@ async def sample_get_ekm_connection():
491491
with a
492492
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
493493
of
494-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
494+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
495495
as well as performing cryptographic operations using
496496
keys created within the
497497
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -630,7 +630,7 @@ async def sample_create_ekm_connection():
630630
with a
631631
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
632632
of
633-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
633+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
634634
as well as performing cryptographic operations using
635635
keys created within the
636636
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -761,7 +761,7 @@ async def sample_update_ekm_connection():
761761
with a
762762
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
763763
of
764-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
764+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
765765
as well as performing cryptographic operations using
766766
keys created within the
767767
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -884,7 +884,7 @@ async def sample_get_ekm_config():
884884
with a
885885
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
886886
of
887-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC]
887+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC]
888888
in a given project and location.
889889
890890
"""
@@ -1007,7 +1007,7 @@ async def sample_update_ekm_config():
10071007
with a
10081008
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
10091009
of
1010-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC]
1010+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC]
10111011
in a given project and location.
10121012
10131013
"""

‎packages/google-cloud-kms/google/cloud/kms_v1/services/ekm_service/client.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -922,7 +922,7 @@ def sample_get_ekm_connection():
922922
with a
923923
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
924924
of
925-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
925+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
926926
as well as performing cryptographic operations using
927927
keys created within the
928928
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -1058,7 +1058,7 @@ def sample_create_ekm_connection():
10581058
with a
10591059
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
10601060
of
1061-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
1061+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
10621062
as well as performing cryptographic operations using
10631063
keys created within the
10641064
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -1186,7 +1186,7 @@ def sample_update_ekm_connection():
11861186
with a
11871187
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
11881188
of
1189-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
1189+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
11901190
as well as performing cryptographic operations using
11911191
keys created within the
11921192
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -1306,7 +1306,7 @@ def sample_get_ekm_config():
13061306
with a
13071307
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
13081308
of
1309-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC]
1309+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC]
13101310
in a given project and location.
13111311
13121312
"""
@@ -1426,7 +1426,7 @@ def sample_update_ekm_config():
14261426
with a
14271427
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
14281428
of
1429-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC]
1429+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC]
14301430
in a given project and location.
14311431
14321432
"""

‎packages/google-cloud-kms/google/cloud/kms_v1/services/ekm_service/transports/rest.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ def __call__(
609609
with a
610610
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
611611
of
612-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
612+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
613613
as well as performing cryptographic operations using
614614
keys created within the
615615
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -769,7 +769,7 @@ def __call__(
769769
with a
770770
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
771771
of
772-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC]
772+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC]
773773
in a given project and location.
774774
775775
"""
@@ -924,7 +924,7 @@ def __call__(
924924
with a
925925
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
926926
of
927-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
927+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
928928
as well as performing cryptographic operations using
929929
keys created within the
930930
[EkmConnection][google.cloud.kms.v1.EkmConnection].
@@ -1227,7 +1227,7 @@ def __call__(
12271227
with a
12281228
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
12291229
of
1230-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC]
1230+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC]
12311231
in a given project and location.
12321232
12331233
"""
@@ -1386,7 +1386,7 @@ def __call__(
13861386
with a
13871387
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
13881388
of
1389-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC],
1389+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC],
13901390
as well as performing cryptographic operations using
13911391
keys created within the
13921392
[EkmConnection][google.cloud.kms.v1.EkmConnection].

‎packages/google-cloud-kms/google/cloud/kms_v1/types/ekm_service.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ class EkmConnection(proto.Message):
334334
[CryptoKeys][google.cloud.kms.v1.CryptoKey] and
335335
[CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
336336
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
337-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as
337+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC], as
338338
well as performing cryptographic operations using keys created
339339
within the [EkmConnection][google.cloud.kms.v1.EkmConnection].
340340
@@ -412,7 +412,7 @@ class KeyManagementMode(proto.Enum):
412412
- Destruction of external key material associated with this
413413
[EkmConnection][google.cloud.kms.v1.EkmConnection] can be
414414
requested by calling
415-
[DestroyCryptoKeyVersion][EkmService.DestroyCryptoKeyVersion].
415+
[DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion].
416416
- Automatic rotation of key material is supported.
417417
"""
418418
KEY_MANAGEMENT_MODE_UNSPECIFIED = 0
@@ -502,8 +502,8 @@ class EkmConfig(proto.Message):
502502
[CryptoKeys][google.cloud.kms.v1.CryptoKey] and
503503
[CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
504504
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
505-
[EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] in a
506-
given project and location.
505+
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] in
506+
a given project and location.
507507
508508
Attributes:
509509
name (str):

0 commit comments

Comments
 (0)