docs: [google-cloud-servicehealth] update documentation for various messages (#13374)

gcf-owl-bot[bot] · parthea · web-flow · commit 8e531455b2ea · 2024-12-23T05:55:49.000-05:00
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 707746489 Source-Link: googleapis/googleapis@09d4103 Source-Link: googleapis/googleapis-gen@63936c2 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlcnZpY2VoZWFsdGgvLk93bEJvdC55YW1sIiwiaCI6IjYzOTM2YzIwNGRkMGU4YWUzMjZjMzdkZmFmZmQ5ODczYjU2MzU5NDYifQ== --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
diff --git a/packages/google-cloud-servicehealth/google/cloud/servicehealth/gapic_version.py b/packages/google-cloud-servicehealth/google/cloud/servicehealth/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.9"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/gapic_version.py b/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.9"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/services/service_health/async_client.py b/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/services/service_health/async_client.py
@@ -341,8 +341,7 @@ async def sample_list_events():
 
         Args:
             request (Optional[Union[google.cloud.servicehealth_v1.types.ListEventsRequest, dict]]):
-                The request object. Message for requesting list of
-                events.
+                The request object. Requests list of events.
             parent (:class:`str`):
                 Required. Parent value using the form
                 ``projects/{project_id}/locations/{location}/events``.
@@ -366,7 +365,7 @@ async def sample_list_events():
 
         Returns:
             google.cloud.servicehealth_v1.services.service_health.pagers.ListEventsAsyncPager:
-                Message for response to listing
+                Response to request for listing
                 events.
                 Iterating over this object will yield
                 results and resolve additional pages
@@ -470,7 +469,8 @@ async def sample_get_event():
 
         Args:
             request (Optional[Union[google.cloud.servicehealth_v1.types.GetEventRequest, dict]]):
-                The request object. Message for getting an event.
+                The request object. Gets information about a specific
+                event.
             name (:class:`str`):
                 Required. Unique name of the event in this scope
                 including project and location using the form
@@ -590,8 +590,8 @@ async def sample_list_organization_events():
 
         Args:
             request (Optional[Union[google.cloud.servicehealth_v1.types.ListOrganizationEventsRequest, dict]]):
-                The request object. Message for requesting list of
-                organization events.
+                The request object. Requests list of events that affect
+                an organization.
             parent (:class:`str`):
                 Required. Parent value using the form
                 ``organizations/{organization_id}/locations/{location}/organizationEvents``.
@@ -617,7 +617,7 @@ async def sample_list_organization_events():
 
         Returns:
             google.cloud.servicehealth_v1.services.service_health.pagers.ListOrganizationEventsAsyncPager:
-                Message for response to listing
+                Response to request for listing
                 organization events.
                 Iterating over this object will yield
                 results and resolve additional pages
@@ -723,8 +723,8 @@ async def sample_get_organization_event():
 
         Args:
             request (Optional[Union[google.cloud.servicehealth_v1.types.GetOrganizationEventRequest, dict]]):
-                The request object. Message for getting an organization
-                event.
+                The request object. Gets information about a specific
+                event affecting an organization.
             name (:class:`str`):
                 Required. Unique name of the event in this scope
                 including organization and event ID using the form
@@ -845,8 +845,8 @@ async def sample_list_organization_impacts():
 
         Args:
             request (Optional[Union[google.cloud.servicehealth_v1.types.ListOrganizationImpactsRequest, dict]]):
-                The request object. Message for requesting list of
-                organization impacts.
+                The request object. Requests list of projects under an
+                organization affected by an event.
             parent (:class:`str`):
                 Required. Parent value using the form
                 ``organizations/{organization_id}/locations/{location}/organizationImpacts``.
@@ -869,8 +869,10 @@ async def sample_list_organization_impacts():
 
         Returns:
             google.cloud.servicehealth_v1.services.service_health.pagers.ListOrganizationImpactsAsyncPager:
-                Message for response to listing
-                organization impacts.
+                Response to request for listing
+                projects under an organization affected
+                by an event.
+
                 Iterating over this object will yield
                 results and resolve additional pages
                 automatically.
@@ -976,8 +978,8 @@ async def sample_get_organization_impact():
 
         Args:
             request (Optional[Union[google.cloud.servicehealth_v1.types.GetOrganizationImpactRequest, dict]]):
-                The request object. Message for getting an organization
-                impact.
+                The request object. Gets information about an event that
+                affects a project under an organization.
             name (:class:`str`):
                 Required. Name of the resource using the form
                 ``organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}``.
diff --git a/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/services/service_health/client.py b/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/services/service_health/client.py
@@ -767,8 +767,7 @@ def sample_list_events():
 
         Args:
             request (Union[google.cloud.servicehealth_v1.types.ListEventsRequest, dict]):
-                The request object. Message for requesting list of
-                events.
+                The request object. Requests list of events.
             parent (str):
                 Required. Parent value using the form
                 ``projects/{project_id}/locations/{location}/events``.
@@ -792,7 +791,7 @@ def sample_list_events():
 
         Returns:
             google.cloud.servicehealth_v1.services.service_health.pagers.ListEventsPager:
-                Message for response to listing
+                Response to request for listing
                 events.
                 Iterating over this object will yield
                 results and resolve additional pages
@@ -893,7 +892,8 @@ def sample_get_event():
 
         Args:
             request (Union[google.cloud.servicehealth_v1.types.GetEventRequest, dict]):
-                The request object. Message for getting an event.
+                The request object. Gets information about a specific
+                event.
             name (str):
                 Required. Unique name of the event in this scope
                 including project and location using the form
@@ -1010,8 +1010,8 @@ def sample_list_organization_events():
 
         Args:
             request (Union[google.cloud.servicehealth_v1.types.ListOrganizationEventsRequest, dict]):
-                The request object. Message for requesting list of
-                organization events.
+                The request object. Requests list of events that affect
+                an organization.
             parent (str):
                 Required. Parent value using the form
                 ``organizations/{organization_id}/locations/{location}/organizationEvents``.
@@ -1037,7 +1037,7 @@ def sample_list_organization_events():
 
         Returns:
             google.cloud.servicehealth_v1.services.service_health.pagers.ListOrganizationEventsPager:
-                Message for response to listing
+                Response to request for listing
                 organization events.
                 Iterating over this object will yield
                 results and resolve additional pages
@@ -1140,8 +1140,8 @@ def sample_get_organization_event():
 
         Args:
             request (Union[google.cloud.servicehealth_v1.types.GetOrganizationEventRequest, dict]):
-                The request object. Message for getting an organization
-                event.
+                The request object. Gets information about a specific
+                event affecting an organization.
             name (str):
                 Required. Unique name of the event in this scope
                 including organization and event ID using the form
@@ -1259,8 +1259,8 @@ def sample_list_organization_impacts():
 
         Args:
             request (Union[google.cloud.servicehealth_v1.types.ListOrganizationImpactsRequest, dict]):
-                The request object. Message for requesting list of
-                organization impacts.
+                The request object. Requests list of projects under an
+                organization affected by an event.
             parent (str):
                 Required. Parent value using the form
                 ``organizations/{organization_id}/locations/{location}/organizationImpacts``.
@@ -1283,8 +1283,10 @@ def sample_list_organization_impacts():
 
         Returns:
             google.cloud.servicehealth_v1.services.service_health.pagers.ListOrganizationImpactsPager:
-                Message for response to listing
-                organization impacts.
+                Response to request for listing
+                projects under an organization affected
+                by an event.
+
                 Iterating over this object will yield
                 results and resolve additional pages
                 automatically.
@@ -1389,8 +1391,8 @@ def sample_get_organization_impact():
 
         Args:
             request (Union[google.cloud.servicehealth_v1.types.GetOrganizationImpactRequest, dict]):
-                The request object. Message for getting an organization
-                impact.
+                The request object. Gets information about an event that
+                affects a project under an organization.
             name (str):
                 Required. Name of the resource using the form
                 ``organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}``.
diff --git a/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/services/service_health/transports/rest.py b/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/services/service_health/transports/rest.py
@@ -453,7 +453,8 @@ def __call__(
 
             Args:
                 request (~.event_resources.GetEventRequest):
-                    The request object. Message for getting an event.
+                    The request object. Gets information about a specific
+                event.
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -602,8 +603,8 @@ def __call__(
 
             Args:
                 request (~.event_resources.GetOrganizationEventRequest):
-                    The request object. Message for getting an organization
-                event.
+                    The request object. Gets information about a specific
+                event affecting an organization.
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -753,8 +754,8 @@ def __call__(
 
             Args:
                 request (~.event_resources.GetOrganizationImpactRequest):
-                    The request object. Message for getting an organization
-                impact.
+                    The request object. Gets information about an event that
+                affects a project under an organization.
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -902,8 +903,7 @@ def __call__(
 
             Args:
                 request (~.event_resources.ListEventsRequest):
-                    The request object. Message for requesting list of
-                events.
+                    The request object. Requests list of events.
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -914,7 +914,7 @@ def __call__(
 
             Returns:
                 ~.event_resources.ListEventsResponse:
-                    Message for response to listing
+                    Response to request for listing
                 events.
 
             """
@@ -1052,8 +1052,8 @@ def __call__(
 
             Args:
                 request (~.event_resources.ListOrganizationEventsRequest):
-                    The request object. Message for requesting list of
-                organization events.
+                    The request object. Requests list of events that affect
+                an organization.
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1064,7 +1064,7 @@ def __call__(
 
             Returns:
                 ~.event_resources.ListOrganizationEventsResponse:
-                    Message for response to listing
+                    Response to request for listing
                 organization events.
 
             """
@@ -1200,8 +1200,8 @@ def __call__(
 
             Args:
                 request (~.event_resources.ListOrganizationImpactsRequest):
-                    The request object. Message for requesting list of
-                organization impacts.
+                    The request object. Requests list of projects under an
+                organization affected by an event.
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1212,8 +1212,9 @@ def __call__(
 
             Returns:
                 ~.event_resources.ListOrganizationImpactsResponse:
-                    Message for response to listing
-                organization impacts.
+                    Response to request for listing
+                projects under an organization affected
+                by an event.
 
             """
 
diff --git a/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/types/event_resources.py b/packages/google-cloud-servicehealth/google/cloud/servicehealth_v1/types/event_resources.py
@@ -737,7 +737,7 @@ class Asset(proto.Message):
 
 
 class ListEventsRequest(proto.Message):
-    r"""Message for requesting list of events.
+    r"""Requests list of events.
 
     Attributes:
         parent (str):
@@ -816,7 +816,7 @@ class ListEventsRequest(proto.Message):
 
 
 class ListEventsResponse(proto.Message):
-    r"""Message for response to listing events.
+    r"""Response to request for listing events.
 
     Attributes:
         events (MutableSequence[google.cloud.servicehealth_v1.types.Event]):
@@ -853,7 +853,7 @@ def raw_page(self):
 
 
 class GetEventRequest(proto.Message):
-    r"""Message for getting an event.
+    r"""Gets information about a specific event.
 
     Attributes:
         name (str):
@@ -873,7 +873,7 @@ class GetEventRequest(proto.Message):
 
 
 class ListOrganizationEventsRequest(proto.Message):
-    r"""Message for requesting list of organization events.
+    r"""Requests list of events that affect an organization.
 
     Attributes:
         parent (str):
@@ -953,7 +953,7 @@ class ListOrganizationEventsRequest(proto.Message):
 
 
 class ListOrganizationEventsResponse(proto.Message):
-    r"""Message for response to listing organization events.
+    r"""Response to request for listing organization events.
 
     Attributes:
         organization_events (MutableSequence[google.cloud.servicehealth_v1.types.OrganizationEvent]):
@@ -991,7 +991,8 @@ def raw_page(self):
 
 
 class GetOrganizationEventRequest(proto.Message):
-    r"""Message for getting an organization event.
+    r"""Gets information about a specific event affecting an
+    organization.
 
     Attributes:
         name (str):
@@ -1013,7 +1014,8 @@ class GetOrganizationEventRequest(proto.Message):
 
 
 class ListOrganizationImpactsRequest(proto.Message):
-    r"""Message for requesting list of organization impacts.
+    r"""Requests list of projects under an organization affected by
+    an event.
 
     Attributes:
         parent (str):
@@ -1085,7 +1087,8 @@ class ListOrganizationImpactsRequest(proto.Message):
 
 
 class ListOrganizationImpactsResponse(proto.Message):
-    r"""Message for response to listing organization impacts.
+    r"""Response to request for listing projects under an
+    organization affected by an event.
 
     Attributes:
         organization_impacts (MutableSequence[google.cloud.servicehealth_v1.types.OrganizationImpact]):
@@ -1124,7 +1127,8 @@ def raw_page(self):
 
 
 class GetOrganizationImpactRequest(proto.Message):
-    r"""Message for getting an organization impact.
+    r"""Gets information about an event that affects a project under
+    an organization.
 
     Attributes:
         name (str):
diff --git a/packages/google-cloud-servicehealth/samples/generated_samples/snippet_metadata_google.cloud.servicehealth.v1.json b/packages/google-cloud-servicehealth/samples/generated_samples/snippet_metadata_google.cloud.servicehealth.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-servicehealth",
-    "version": "0.1.9"
+    "version": "0.1.0"
   },
   "snippets": [
     {

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@`
`13`	`13`	`# See the License for the specific language governing permissions and`
`14`	`14`	`# limitations under the License.`
`15`	`15`	`#`
`16`		`-__version__ = "0.1.9" # {x-release-please-version}`
	`16`	`+__version__ = "0.0.0" # {x-release-please-version}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`],`
`9`	`9`	`"language": "PYTHON",`
`10`	`10`	`"name": "google-cloud-servicehealth",`
`11`		`- "version": "0.1.9"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`