Skip to content

Commit

Permalink
feat(advisorynotifications): update the api
Browse files Browse the repository at this point in the history
#### advisorynotifications:v1

The following keys were added:
- resources.projects.resources.locations.methods.getSettings (Total Keys: 11)
- resources.projects.resources.locations.methods.updateSettings (Total Keys: 12)
  • Loading branch information
yoshi-automation committed Apr 9, 2024
1 parent 708a3f2 commit 16da4be
Show file tree
Hide file tree
Showing 5 changed files with 137 additions and 13 deletions.
10 changes: 5 additions & 5 deletions docs/dyn/advisorynotifications_v1.organizations.locations.html
Expand Up @@ -99,7 +99,7 @@ <h3>Method Details</h3>
<pre>Get notification settings.

Args:
name: string, Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings. (required)
name: string, Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand All @@ -110,7 +110,7 @@ <h3>Method Details</h3>

{ # Settings for Advisory Notifications.
&quot;etag&quot;: &quot;A String&quot;, # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
&quot;notificationSettings&quot;: { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
&quot;a_key&quot;: { # Settings for each NotificationType.
&quot;enabled&quot;: True or False, # Whether the associated NotificationType is enabled.
Expand All @@ -124,13 +124,13 @@ <h3>Method Details</h3>
<pre>Update notification settings.

Args:
name: string, Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings. (required)
name: string, Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
body: object, The request body.
The object takes the form of:

{ # Settings for Advisory Notifications.
&quot;etag&quot;: &quot;A String&quot;, # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
&quot;notificationSettings&quot;: { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
&quot;a_key&quot;: { # Settings for each NotificationType.
&quot;enabled&quot;: True or False, # Whether the associated NotificationType is enabled.
Expand All @@ -148,7 +148,7 @@ <h3>Method Details</h3>

{ # Settings for Advisory Notifications.
&quot;etag&quot;: &quot;A String&quot;, # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
&quot;notificationSettings&quot;: { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
&quot;a_key&quot;: { # Settings for each NotificationType.
&quot;enabled&quot;: True or False, # Whether the associated NotificationType is enabled.
Expand Down
Expand Up @@ -156,7 +156,7 @@ <h3>Method Details</h3>
<pre>Lists notifications under a given parent.

Args:
parent: string, Required. The parent, which owns this collection of notifications. Must be of the form &quot;organizations/{organization}/locations/{location}&quot; or &quot;projects/{project}/locations/{location}&quot; (required)
parent: string, Required. The parent, which owns this collection of notifications. Must be of the form &quot;organizations/{organization}/locations/{location}&quot; or &quot;projects/{project}/locations/{location}&quot;. (required)
languageCode: string, ISO code for requested localization language. If unset, will be interpereted as &quot;en&quot;. If the requested language is valid, but not supported for this notification, English will be returned with an &quot;Not applicable&quot; LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
pageSize: integer, The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
pageToken: string, A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.
Expand Down
69 changes: 69 additions & 0 deletions docs/dyn/advisorynotifications_v1.projects.locations.html
Expand Up @@ -82,10 +82,79 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getSettings">getSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get notification settings.</p>
<p class="toc_element">
<code><a href="#updateSettings">updateSettings(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update notification settings.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="getSettings">getSettings(name, x__xgafv=None)</code>
<pre>Get notification settings.

Args:
name: string, Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Settings for Advisory Notifications.
&quot;etag&quot;: &quot;A String&quot;, # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
&quot;notificationSettings&quot;: { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
&quot;a_key&quot;: { # Settings for each NotificationType.
&quot;enabled&quot;: True or False, # Whether the associated NotificationType is enabled.
},
},
}</pre>
</div>

<div class="method">
<code class="details" id="updateSettings">updateSettings(name, body=None, x__xgafv=None)</code>
<pre>Update notification settings.

Args:
name: string, Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
body: object, The request body.
The object takes the form of:

{ # Settings for Advisory Notifications.
&quot;etag&quot;: &quot;A String&quot;, # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
&quot;notificationSettings&quot;: { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
&quot;a_key&quot;: { # Settings for each NotificationType.
&quot;enabled&quot;: True or False, # Whether the associated NotificationType is enabled.
},
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Settings for Advisory Notifications.
&quot;etag&quot;: &quot;A String&quot;, # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
&quot;notificationSettings&quot;: { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
&quot;a_key&quot;: { # Settings for each NotificationType.
&quot;enabled&quot;: True or False, # Whether the associated NotificationType is enabled.
},
},
}</pre>
</div>

</body></html>
Expand Up @@ -156,7 +156,7 @@ <h3>Method Details</h3>
<pre>Lists notifications under a given parent.

Args:
parent: string, Required. The parent, which owns this collection of notifications. Must be of the form &quot;organizations/{organization}/locations/{location}&quot; or &quot;projects/{project}/locations/{location}&quot; (required)
parent: string, Required. The parent, which owns this collection of notifications. Must be of the form &quot;organizations/{organization}/locations/{location}&quot; or &quot;projects/{project}/locations/{location}&quot;. (required)
languageCode: string, ISO code for requested localization language. If unset, will be interpereted as &quot;en&quot;. If the requested language is valid, but not supported for this notification, English will be returned with an &quot;Not applicable&quot; LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
pageSize: integer, The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
pageToken: string, A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.
Expand Down
Expand Up @@ -119,7 +119,7 @@
],
"parameters": {
"name": {
"description": "Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.",
"description": "Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/settings$",
"required": true,
Expand All @@ -144,7 +144,7 @@
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.",
"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/settings$",
"required": true,
Expand Down Expand Up @@ -222,7 +222,7 @@
"type": "string"
},
"parent": {
"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\"",
"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\".",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
Expand Down Expand Up @@ -261,6 +261,61 @@
"projects": {
"resources": {
"locations": {
"methods": {
"getSettings": {
"description": "Get notification settings.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings",
"httpMethod": "GET",
"id": "advisorynotifications.projects.locations.getSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/settings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAdvisorynotificationsV1Settings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateSettings": {
"description": "Update notification settings.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings",
"httpMethod": "PATCH",
"id": "advisorynotifications.projects.locations.updateSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/settings$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAdvisorynotificationsV1Settings"
},
"response": {
"$ref": "GoogleCloudAdvisorynotificationsV1Settings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"notifications": {
"methods": {
Expand Down Expand Up @@ -320,7 +375,7 @@
"type": "string"
},
"parent": {
"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\"",
"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\".",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
Expand Down Expand Up @@ -357,7 +412,7 @@
}
}
},
"revision": "20240324",
"revision": "20240331",
"rootUrl": "https://advisorynotifications.googleapis.com/",
"schemas": {
"GoogleCloudAdvisorynotificationsV1Attachment": {
Expand Down Expand Up @@ -538,7 +593,7 @@
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.",
"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.",
"type": "string"
},
"notificationSettings": {
Expand Down

0 comments on commit 16da4be

Please sign in to comment.