Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(irm): deprecate resource name helper methods (via synth) #9860

Merged
merged 1 commit into from
Nov 20, 2019
Merged

fix(irm): deprecate resource name helper methods (via synth) #9860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion irm/docs/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
div#python2-eol {
border-color: red;
border-width: medium;
}
}
1 change: 1 addition & 0 deletions irm/docs/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

{% extends "!layout.html" %}
{%- block content %}
{%- if theme_fixed_sidebar|lower == 'true' %}
Expand Down
56 changes: 48 additions & 8 deletions irm/google/cloud/irm_v1alpha2/gapic/incident_service_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,12 @@ def from_service_account_file(cls, filename, *args, **kwargs):

@classmethod
def annotation_path(cls, project, incident, annotation):
"""Return a fully-qualified annotation string."""
"""DEPRECATED. Return a fully-qualified annotation string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/incidents/{incident}/annotations/{annotation}",
project=project,
Expand All @@ -87,7 +92,12 @@ def annotation_path(cls, project, incident, annotation):

@classmethod
def artifact_path(cls, project, incident, artifact):
"""Return a fully-qualified artifact string."""
"""DEPRECATED. Return a fully-qualified artifact string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/incidents/{incident}/artifacts/{artifact}",
project=project,
Expand All @@ -97,7 +107,12 @@ def artifact_path(cls, project, incident, artifact):

@classmethod
def incident_path(cls, project, incident):
"""Return a fully-qualified incident string."""
"""DEPRECATED. Return a fully-qualified incident string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/incidents/{incident}",
project=project,
Expand All @@ -106,14 +121,24 @@ def incident_path(cls, project, incident):

@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 role_assignment_path(cls, project, incident, role_assignment):
"""Return a fully-qualified role_assignment string."""
"""DEPRECATED. Return a fully-qualified role_assignment string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/incidents/{incident}/roleAssignments/{role_assignment}",
project=project,
Expand All @@ -123,14 +148,24 @@ def role_assignment_path(cls, project, incident, role_assignment):

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

@classmethod
def subscription_path(cls, project, incident, subscription):
"""Return a fully-qualified subscription string."""
"""DEPRECATED. Return a fully-qualified subscription string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/incidents/{incident}/subscriptions/{subscription}",
project=project,
Expand All @@ -140,7 +175,12 @@ def subscription_path(cls, project, incident, subscription):

@classmethod
def tag_path(cls, project, incident, tag):
"""Return a fully-qualified tag string."""
"""DEPRECATED. Return a fully-qualified tag string."""
warnings.warn(
"Resource name helper functions are deprecated.",
PendingDeprecationWarning,
stacklevel=1,
)
return google.api_core.path_template.expand(
"projects/{project}/incidents/{incident}/tags/{tag}",
project=project,
Expand Down
12 changes: 6 additions & 6 deletions irm/synth.metadata
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
{
"updateTime": "2019-10-05T12:26:52.725480Z",
"updateTime": "2019-11-20T13:23:46.362060Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.38.0",
"dockerImage": "googleapis/artman@sha256:0d2f8d429110aeb8d82df6550ef4ede59d40df9062d260a1580fce688b0512bf"
"version": "0.42.1",
"dockerImage": "googleapis/artman@sha256:c773192618c608a7a0415dd95282f841f8e6bcdef7dd760a988c93b77a64bd57"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "ceb8e2fb12f048cc94caae532ef0b4cf026a78f3",
"internalRef": "272971705"
"sha": "16543773103e2619d2b5f52456264de5bb9be104",
"internalRef": "281423227"
}
},
{
"template": {
"name": "python_library",
"origin": "synthtool.gcp",
"version": "2019.5.2"
"version": "2019.10.17"
}
}
],
Expand Down