Service Health v1 API - Class ServiceHealthClientImpl (1.0.0-beta02)

Version 1.0.0-beta02

• 1.3.0 (latest)
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ServiceHealthClientImpl : ServiceHealthClient

Reference documentation and code samples for the Service Health v1 API class ServiceHealthClientImpl.

ServiceHealth client wrapper implementation, for convenient use.

Inheritance

object > ServiceHealthClient > ServiceHealthClientImpl

Inherited Members

ServiceHealthClient.DefaultEndpoint

ServiceHealthClient.DefaultScopes

ServiceHealthClient.ServiceMetadata

ServiceHealthClient.CreateAsync(CancellationToken)

ServiceHealthClient.Create()

ServiceHealthClient.ShutdownDefaultChannelsAsync()

ServiceHealthClient.ListEvents(string, string, int?, CallSettings)

ServiceHealthClient.ListEventsAsync(string, string, int?, CallSettings)

ServiceHealthClient.ListEvents(LocationName, string, int?, CallSettings)

ServiceHealthClient.ListEventsAsync(LocationName, string, int?, CallSettings)

ServiceHealthClient.GetEventAsync(GetEventRequest, CancellationToken)

ServiceHealthClient.GetEvent(string, CallSettings)

ServiceHealthClient.GetEventAsync(string, CallSettings)

ServiceHealthClient.GetEventAsync(string, CancellationToken)

ServiceHealthClient.GetEvent(EventName, CallSettings)

ServiceHealthClient.GetEventAsync(EventName, CallSettings)

ServiceHealthClient.GetEventAsync(EventName, CancellationToken)

ServiceHealthClient.ListOrganizationEvents(string, string, int?, CallSettings)

ServiceHealthClient.ListOrganizationEventsAsync(string, string, int?, CallSettings)

ServiceHealthClient.ListOrganizationEvents(OrganizationLocationName, string, int?, CallSettings)

ServiceHealthClient.ListOrganizationEventsAsync(OrganizationLocationName, string, int?, CallSettings)

ServiceHealthClient.GetOrganizationEventAsync(GetOrganizationEventRequest, CancellationToken)

ServiceHealthClient.GetOrganizationEvent(string, CallSettings)

ServiceHealthClient.GetOrganizationEventAsync(string, CallSettings)

ServiceHealthClient.GetOrganizationEventAsync(string, CancellationToken)

ServiceHealthClient.GetOrganizationEvent(OrganizationEventName, CallSettings)

ServiceHealthClient.GetOrganizationEventAsync(OrganizationEventName, CallSettings)

ServiceHealthClient.GetOrganizationEventAsync(OrganizationEventName, CancellationToken)

ServiceHealthClient.ListOrganizationImpacts(string, string, int?, CallSettings)

ServiceHealthClient.ListOrganizationImpactsAsync(string, string, int?, CallSettings)

ServiceHealthClient.ListOrganizationImpacts(OrganizationLocationName, string, int?, CallSettings)

ServiceHealthClient.ListOrganizationImpactsAsync(OrganizationLocationName, string, int?, CallSettings)

ServiceHealthClient.GetOrganizationImpactAsync(GetOrganizationImpactRequest, CancellationToken)

ServiceHealthClient.GetOrganizationImpact(string, CallSettings)

ServiceHealthClient.GetOrganizationImpactAsync(string, CallSettings)

ServiceHealthClient.GetOrganizationImpactAsync(string, CancellationToken)

ServiceHealthClient.GetOrganizationImpact(OrganizationImpactName, CallSettings)

ServiceHealthClient.GetOrganizationImpactAsync(OrganizationImpactName, CallSettings)

ServiceHealthClient.GetOrganizationImpactAsync(OrganizationImpactName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ServiceHealth.V1

Assembly

Google.Cloud.ServiceHealth.V1.dll

Remarks

Request service health events relevant to your Google Cloud project.

Constructors

ServiceHealthClientImpl(ServiceHealthClient, ServiceHealthSettings, ILogger)

public ServiceHealthClientImpl(ServiceHealth.ServiceHealthClient grpcClient, ServiceHealthSettings settings, ILogger logger)

Constructs a client wrapper for the ServiceHealth service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	ServiceHealthServiceHealthClient The underlying gRPC client.
settings	ServiceHealthSettings The base ServiceHealthSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override ServiceHealth.ServiceHealthClient GrpcClient { get; }

The underlying gRPC ServiceHealth client

Property Value
Type	Description
ServiceHealthServiceHealthClient

Overrides

ServiceHealthClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

ServiceHealthClient.LocationsClient

Methods

GetEvent(GetEventRequest, CallSettings)

public override Event GetEvent(GetEventRequest request, CallSettings callSettings = null)

Retrieves a resource containing information about an event.

Parameters
Name	Description
request	GetEventRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Event	The RPC response.

Overrides

ServiceHealthClient.GetEvent(GetEventRequest, CallSettings)

GetEventAsync(GetEventRequest, CallSettings)

public override Task<Event> GetEventAsync(GetEventRequest request, CallSettings callSettings = null)

Retrieves a resource containing information about an event.

Parameters
Name	Description
request	GetEventRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskEvent	A Task containing the RPC response.

Overrides

ServiceHealthClient.GetEventAsync(GetEventRequest, CallSettings)

GetOrganizationEvent(GetOrganizationEventRequest, CallSettings)

public override OrganizationEvent GetOrganizationEvent(GetOrganizationEventRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetOrganizationEventRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OrganizationEvent	The RPC response.

Overrides

ServiceHealthClient.GetOrganizationEvent(GetOrganizationEventRequest, CallSettings)

GetOrganizationEventAsync(GetOrganizationEventRequest, CallSettings)

public override Task<OrganizationEvent> GetOrganizationEventAsync(GetOrganizationEventRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetOrganizationEventRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOrganizationEvent	A Task containing the RPC response.

Overrides

ServiceHealthClient.GetOrganizationEventAsync(GetOrganizationEventRequest, CallSettings)

GetOrganizationImpact(GetOrganizationImpactRequest, CallSettings)

public override OrganizationImpact GetOrganizationImpact(GetOrganizationImpactRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetOrganizationImpactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OrganizationImpact	The RPC response.

Overrides

ServiceHealthClient.GetOrganizationImpact(GetOrganizationImpactRequest, CallSettings)

GetOrganizationImpactAsync(GetOrganizationImpactRequest, CallSettings)

public override Task<OrganizationImpact> GetOrganizationImpactAsync(GetOrganizationImpactRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetOrganizationImpactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOrganizationImpact	A Task containing the RPC response.

Overrides

ServiceHealthClient.GetOrganizationImpactAsync(GetOrganizationImpactRequest, CallSettings)

ListEvents(ListEventsRequest, CallSettings)

public override PagedEnumerable<ListEventsResponse, Event> ListEvents(ListEventsRequest request, CallSettings callSettings = null)

Lists events under a given project and location.

Parameters
Name	Description
request	ListEventsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListEventsResponseEvent	A pageable sequence of Event resources.

Overrides

ServiceHealthClient.ListEvents(ListEventsRequest, CallSettings)

ListEventsAsync(ListEventsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEventsResponse, Event> ListEventsAsync(ListEventsRequest request, CallSettings callSettings = null)

Lists events under a given project and location.

Parameters
Name	Description
request	ListEventsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListEventsResponseEvent	A pageable asynchronous sequence of Event resources.

Overrides

ServiceHealthClient.ListEventsAsync(ListEventsRequest, CallSettings)

ListOrganizationEvents(ListOrganizationEventsRequest, CallSettings)

public override PagedEnumerable<ListOrganizationEventsResponse, OrganizationEvent> ListOrganizationEvents(ListOrganizationEventsRequest request, CallSettings callSettings = null)

Lists organization events under a given organization and location.

Parameters
Name	Description
request	ListOrganizationEventsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListOrganizationEventsResponseOrganizationEvent	A pageable sequence of OrganizationEvent resources.

Overrides

ServiceHealthClient.ListOrganizationEvents(ListOrganizationEventsRequest, CallSettings)

ListOrganizationEventsAsync(ListOrganizationEventsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOrganizationEventsResponse, OrganizationEvent> ListOrganizationEventsAsync(ListOrganizationEventsRequest request, CallSettings callSettings = null)

Lists organization events under a given organization and location.

Parameters
Name	Description
request	ListOrganizationEventsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListOrganizationEventsResponseOrganizationEvent	A pageable asynchronous sequence of OrganizationEvent resources.

Overrides

ServiceHealthClient.ListOrganizationEventsAsync(ListOrganizationEventsRequest, CallSettings)

ListOrganizationImpacts(ListOrganizationImpactsRequest, CallSettings)

public override PagedEnumerable<ListOrganizationImpactsResponse, OrganizationImpact> ListOrganizationImpacts(ListOrganizationImpactsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListOrganizationImpactsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListOrganizationImpactsResponseOrganizationImpact	A pageable sequence of OrganizationImpact resources.

Overrides

ServiceHealthClient.ListOrganizationImpacts(ListOrganizationImpactsRequest, CallSettings)

ListOrganizationImpactsAsync(ListOrganizationImpactsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOrganizationImpactsResponse, OrganizationImpact> ListOrganizationImpactsAsync(ListOrganizationImpactsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListOrganizationImpactsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListOrganizationImpactsResponseOrganizationImpact	A pageable asynchronous sequence of OrganizationImpact resources.

Overrides

ServiceHealthClient.ListOrganizationImpactsAsync(ListOrganizationImpactsRequest, CallSettings)