Skip to content
This repository has been archived by the owner on Dec 31, 2023. It is now read-only.

Commit

Permalink
fix(kms): deprecate resource name helper methods (via synth) (#9836)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and busunkim96 committed Nov 19, 2019
1 parent 665b533 commit a3eca00
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 11 deletions.
42 changes: 36 additions & 6 deletions google/cloud/kms_v1/gapic/key_management_service_client.py
Expand Up @@ -92,7 +92,12 @@ def from_service_account_file(cls, filename, *args, **kwargs):

@classmethod
def crypto_key_path(cls, project, location, key_ring, crypto_key):
"""Return a fully-qualified crypto_key string."""
"""DEPRECATED. Return a fully-qualified crypto_key string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}",
project=project,
Expand All @@ -103,7 +108,12 @@ def crypto_key_path(cls, project, location, key_ring, crypto_key):

@classmethod
def crypto_key_path_path(cls, project, location, key_ring, crypto_key_path):
"""Return a fully-qualified crypto_key_path string."""
"""DEPRECATED. Return a fully-qualified crypto_key_path string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key_path=**}",
project=project,
Expand All @@ -116,7 +126,12 @@ def crypto_key_path_path(cls, project, location, key_ring, crypto_key_path):
def crypto_key_version_path(
cls, project, location, key_ring, crypto_key, crypto_key_version
):
"""Return a fully-qualified crypto_key_version string."""
"""DEPRECATED. Return a fully-qualified crypto_key_version string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}",
project=project,
Expand All @@ -128,7 +143,12 @@ def crypto_key_version_path(

@classmethod
def import_job_path(cls, project, location, key_ring, import_job):
"""Return a fully-qualified import_job string."""
"""DEPRECATED. Return a fully-qualified import_job string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}",
project=project,
Expand All @@ -139,7 +159,12 @@ def import_job_path(cls, project, location, key_ring, import_job):

@classmethod
def key_ring_path(cls, project, location, key_ring):
"""Return a fully-qualified key_ring string."""
"""DEPRECATED. Return a fully-qualified key_ring string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/keyRings/{key_ring}",
project=project,
Expand All @@ -149,7 +174,12 @@ def key_ring_path(cls, project, location, key_ring):

@classmethod
def location_path(cls, project, location):
"""Return a fully-qualified location string."""
"""DEPRECATED. Return a fully-qualified location string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}",
project=project,
Expand Down
10 changes: 5 additions & 5 deletions synth.metadata
@@ -1,19 +1,19 @@
{
"updateTime": "2019-11-12T13:31:26.937119Z",
"updateTime": "2019-11-19T13:25:29.291044Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.41.1",
"dockerImage": "googleapis/artman@sha256:545c758c76c3f779037aa259023ec3d1ef2d57d2c8cd00a222cb187d63ceac5e"
"version": "0.42.1",
"dockerImage": "googleapis/artman@sha256:c773192618c608a7a0415dd95282f841f8e6bcdef7dd760a988c93b77a64bd57"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "f69562be0608904932bdcfbc5ad8b9a22d9dceb8",
"internalRef": "279774957"
"sha": "d8dd7fe8d5304f7bd1c52207703d7f27d5328c5a",
"internalRef": "281088257"
}
},
{
Expand Down

0 comments on commit a3eca00

Please sign in to comment.