Class ServiceHealthClient (2.33.0)

Request service health events relevant to your Google Cloud project.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ServiceHealthClient(ServiceHealthClient const &)

Copy and move support

Parameter
Name	Description
	`ServiceHealthClient const &`

ServiceHealthClient(ServiceHealthClient &&)

Copy and move support

Parameter
Name	Description
	`ServiceHealthClient &&`

ServiceHealthClient(std::shared_ptr< ServiceHealthConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ServiceHealthConnection >`
`opts`	`Options`

Operators

operator=(ServiceHealthClient const &)

Copy and move support

Parameter
Name	Description
	`ServiceHealthClient const &`

Returns
Type	Description
`ServiceHealthClient &`

operator=(ServiceHealthClient &&)

Copy and move support

Parameter
Name	Description
	`ServiceHealthClient &&`

Returns
Type	Description
`ServiceHealthClient &`

Functions

ListEvents(std::string const &, Options)

Lists events under a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value using the form `projects/{project_id}/locations/{location}/events`. `project_id` - ID of the project for which to list service health events. `location` - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use `location` = `global`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::servicehealth::v1::Event >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.servicehealth.v1.Event, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEvents(google::cloud::servicehealth::v1::ListEventsRequest, Options)

Lists events under a given project and location.

Parameters
Name	Description
`request`	`google::cloud::servicehealth::v1::ListEventsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.servicehealth.v1.ListEventsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::servicehealth::v1::Event >

GetEvent(std::string const &, Options)

Retrieves a resource containing information about an event.

Parameters
Name	Description
`name`	`std::string const &` Required. Unique name of the event in this scope including project and location using the form `projects/{project_id}/locations/{location}/events/{event_id}`. `project_id` - Project ID of the project that contains the event. `location` - The location to get the service health events from. `event_id` - Event ID to retrieve.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::servicehealth::v1::Event >`	the result of the RPC. The response message type (google.cloud.servicehealth.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEvent(google::cloud::servicehealth::v1::GetEventRequest const &, Options)

Retrieves a resource containing information about an event.

Parameters
Name	Description
`request`	`google::cloud::servicehealth::v1::GetEventRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.servicehealth.v1.GetEventRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::servicehealth::v1::Event >`	the result of the RPC. The response message type (google.cloud.servicehealth.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListOrganizationEvents(std::string const &, Options)

Lists organization events under a given organization and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value using the form `organizations/{organization_id}/locations/{location}/organizationEvents`. `organization_id` - ID (number) of the project that contains the event. To get your `organization_id`, see Getting your organization resource ID. `location` - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use `location` = `global`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::servicehealth::v1::OrganizationEvent >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.servicehealth.v1.OrganizationEvent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOrganizationEvents(google::cloud::servicehealth::v1::ListOrganizationEventsRequest, Options)

Lists organization events under a given organization and location.

Parameters
Name	Description
`request`	`google::cloud::servicehealth::v1::ListOrganizationEventsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.servicehealth.v1.ListOrganizationEventsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::servicehealth::v1::OrganizationEvent >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.servicehealth.v1.OrganizationEvent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOrganizationEvent(std::string const &, Options)

Retrieves a resource containing information about an event affecting an organization .

Parameters
Name	Description
`name`	`std::string const &` Required. Unique name of the event in this scope including organization and event ID using the form `organizations/{organization_id}/locations/locations/global/organizationEvents/{event_id}`. `organization_id` - ID (number) of the project that contains the event. To get your `organization_id`, see Getting your organization resource ID. `event_id` - Organization event ID to retrieve.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::servicehealth::v1::OrganizationEvent >`	the result of the RPC. The response message type (google.cloud.servicehealth.v1.OrganizationEvent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOrganizationEvent(google::cloud::servicehealth::v1::GetOrganizationEventRequest const &, Options)

Retrieves a resource containing information about an event affecting an organization .

Parameters
Name	Description
`request`	`google::cloud::servicehealth::v1::GetOrganizationEventRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.servicehealth.v1.GetOrganizationEventRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::servicehealth::v1::OrganizationEvent >`	the result of the RPC. The response message type (google.cloud.servicehealth.v1.OrganizationEvent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListOrganizationImpacts(std::string const &, Options)

Lists assets impacted by organization events under a given organization and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value using the form `organizations/{organization_id}/locations/{location}/organizationImpacts`. `organization_id` - ID (number) of the project that contains the event. To get your `organization_id`, see Getting your organization resource ID.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::servicehealth::v1::OrganizationImpact >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.servicehealth.v1.OrganizationImpact, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOrganizationImpacts(google::cloud::servicehealth::v1::ListOrganizationImpactsRequest, Options)

Lists assets impacted by organization events under a given organization and location.

Parameters
Name	Description
`request`	`google::cloud::servicehealth::v1::ListOrganizationImpactsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.servicehealth.v1.ListOrganizationImpactsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::servicehealth::v1::OrganizationImpact >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.servicehealth.v1.OrganizationImpact, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOrganizationImpact(std::string const &, Options)

Retrieves a resource containing information about impact to an asset under an organization affected by a service health event.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource using the form `organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}`. `organization_id` - ID (number) of the organization that contains the event. To get your `organization_id`, see Getting your organization resource ID. `organization_impact_id` - ID of the OrganizationImpact resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::servicehealth::v1::OrganizationImpact >`	the result of the RPC. The response message type (google.cloud.servicehealth.v1.OrganizationImpact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOrganizationImpact(google::cloud::servicehealth::v1::GetOrganizationImpactRequest const &, Options)

Retrieves a resource containing information about impact to an asset under an organization affected by a service health event.

Parameters
Name	Description
`request`	`google::cloud::servicehealth::v1::GetOrganizationImpactRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.servicehealth.v1.GetOrganizationImpactRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::servicehealth::v1::OrganizationImpact >`	the result of the RPC. The response message type (google.cloud.servicehealth.v1.OrganizationImpact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`google::cloud::location::ListLocationsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::location::Location >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name	Description
`request`	`google::cloud::location::GetLocationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::location::Location >`	the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.