Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Commit

Permalink
fix(tasks): deprecate resource name helper methods (via synth) (#9864)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoshi-automation @busunkim96
yoshi-automation authored and busunkim96 committed Nov 20, 2019
1 parent c1dd3ce commit ccf2cab
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/_static/custom.css
View file
@@ -1,4 +1,4 @@
div#python2-eol {
border-color: red;
border-width: medium;
}
}
1 change: 1 addition & 0 deletions docs/_templates/layout.html
View file
@@ -1,3 +1,4 @@

{% extends "!layout.html" %}
{%- block content %}
{%- if theme_fixed_sidebar|lower == 'true' %}
Expand Down
28 changes: 24 additions & 4 deletions google/cloud/tasks_v2/gapic/cloud_tasks_client.py
View file
Expand Up @@ -83,7 +83,12 @@ def from_service_account_file(cls, filename, *args, **kwargs):

@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 All @@ -92,14 +97,24 @@ def location_path(cls, project, location):

@classmethod
def project_path(cls, project):
"""Return a fully-qualified project string."""
"""DEPRECATED. Return a fully-qualified project string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}", project=project
)

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

@classmethod
def task_path(cls, project, location, queue, task):
"""Return a fully-qualified task string."""
"""DEPRECATED. Return a fully-qualified task string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/queues/{queue}/tasks/{task}",
project=project,
Expand Down
28 changes: 24 additions & 4 deletions google/cloud/tasks_v2beta2/gapic/cloud_tasks_client.py
View file
Expand Up @@ -85,7 +85,12 @@ def from_service_account_file(cls, filename, *args, **kwargs):

@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 All @@ -94,14 +99,24 @@ def location_path(cls, project, location):

@classmethod
def project_path(cls, project):
"""Return a fully-qualified project string."""
"""DEPRECATED. Return a fully-qualified project string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}", project=project
)

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

@classmethod
def task_path(cls, project, location, queue, task):
"""Return a fully-qualified task string."""
"""DEPRECATED. Return a fully-qualified task string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/queues/{queue}/tasks/{task}",
project=project,
Expand Down
28 changes: 24 additions & 4 deletions google/cloud/tasks_v2beta3/gapic/cloud_tasks_client.py
View file
Expand Up @@ -83,7 +83,12 @@ def from_service_account_file(cls, filename, *args, **kwargs):

@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 All @@ -92,14 +97,24 @@ def location_path(cls, project, location):

@classmethod
def project_path(cls, project):
"""Return a fully-qualified project string."""
"""DEPRECATED. Return a fully-qualified project string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}", project=project
)

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

@classmethod
def task_path(cls, project, location, queue, task):
"""Return a fully-qualified task string."""
"""DEPRECATED. Return a fully-qualified task string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/queues/{queue}/tasks/{task}",
project=project,
Expand Down
10 changes: 5 additions & 5 deletions synth.metadata
View file
@@ -1,19 +1,19 @@
{
"updateTime": "2019-11-02T12:36:27.240345Z",
"updateTime": "2019-11-20T13:32:31.947238Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.41.0",
"dockerImage": "googleapis/artman@sha256:75b38a3b073a7b243545f2332463096624c802bb1e56b8cb6f22ba1ecd325fa9"
"version": "0.42.1",
"dockerImage": "googleapis/artman@sha256:c773192618c608a7a0415dd95282f841f8e6bcdef7dd760a988c93b77a64bd57"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "aac770126e2def40dcc387f50e8007b21c869e58",
"internalRef": "278016738"
"sha": "16543773103e2619d2b5f52456264de5bb9be104",
"internalRef": "281423227"
}
},
{
Expand Down

0 comments on commit ccf2cab

Please sign in to comment.