Service Health v1 API - Class ServiceHealth.ServiceHealthClient (1.3.0)

public class ServiceHealth.ServiceHealthClient : ClientBase<ServiceHealth.ServiceHealthClient>

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

Client for ServiceHealth

Inheritance

object > ClientBase > ClientBase ServiceHealth ServiceHealthClient > ServiceHealth.ServiceHealthClient

Inherited Members

ClientBase<ServiceHealth.ServiceHealthClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ServiceHealth.V1

Assembly

Google.Cloud.ServiceHealth.V1.dll

Constructors

ServiceHealthClient()

protected ServiceHealthClient()

Protected parameterless constructor to allow creation of test doubles.

ServiceHealthClient(CallInvoker)

public ServiceHealthClient(CallInvoker callInvoker)

Creates a new client for ServiceHealth that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

ServiceHealthClient(ChannelBase)

public ServiceHealthClient(ChannelBase channel)

Creates a new client for ServiceHealth

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

ServiceHealthClient(ClientBaseConfiguration)

protected ServiceHealthClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
`LocationsLocationsClient`	A new Locations.LocationsClient for the same target as this client.

GetEvent(GetEventRequest, CallOptions)

public virtual Event GetEvent(GetEventRequest request, CallOptions options)

Retrieves a resource containing information about an event.

Parameters
Name	Description
`request`	`GetEventRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Event`	The response received from the server.

GetEvent(GetEventRequest, Metadata, DateTime?, CancellationToken)

public virtual Event GetEvent(GetEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a resource containing information about an event.

Parameters
Name	Description
`request`	`GetEventRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Event`	The response received from the server.

GetEventAsync(GetEventRequest, CallOptions)

public virtual AsyncUnaryCall<Event> GetEventAsync(GetEventRequest request, CallOptions options)

Retrieves a resource containing information about an event.

Parameters
Name	Description
`request`	`GetEventRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEvent`	The call object.

GetEventAsync(GetEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Event> GetEventAsync(GetEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a resource containing information about an event.

Parameters
Name	Description
`request`	`GetEventRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEvent`	The call object.

GetOrganizationEvent(GetOrganizationEventRequest, CallOptions)

public virtual OrganizationEvent GetOrganizationEvent(GetOrganizationEventRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`GetOrganizationEventRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`OrganizationEvent`	The response received from the server.

GetOrganizationEvent(GetOrganizationEventRequest, Metadata, DateTime?, CancellationToken)

public virtual OrganizationEvent GetOrganizationEvent(GetOrganizationEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`GetOrganizationEventRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`OrganizationEvent`	The response received from the server.

GetOrganizationEventAsync(GetOrganizationEventRequest, CallOptions)

public virtual AsyncUnaryCall<OrganizationEvent> GetOrganizationEventAsync(GetOrganizationEventRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`GetOrganizationEventRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOrganizationEvent`	The call object.

GetOrganizationEventAsync(GetOrganizationEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<OrganizationEvent> GetOrganizationEventAsync(GetOrganizationEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`GetOrganizationEventRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOrganizationEvent`	The call object.

GetOrganizationImpact(GetOrganizationImpactRequest, CallOptions)

public virtual OrganizationImpact GetOrganizationImpact(GetOrganizationImpactRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`OrganizationImpact`	The response received from the server.

GetOrganizationImpact(GetOrganizationImpactRequest, Metadata, DateTime?, CancellationToken)

public virtual OrganizationImpact GetOrganizationImpact(GetOrganizationImpactRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`OrganizationImpact`	The response received from the server.

GetOrganizationImpactAsync(GetOrganizationImpactRequest, CallOptions)

public virtual AsyncUnaryCall<OrganizationImpact> GetOrganizationImpactAsync(GetOrganizationImpactRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOrganizationImpact`	The call object.

GetOrganizationImpactAsync(GetOrganizationImpactRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<OrganizationImpact> GetOrganizationImpactAsync(GetOrganizationImpactRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOrganizationImpact`	The call object.

ListEvents(ListEventsRequest, CallOptions)

public virtual ListEventsResponse ListEvents(ListEventsRequest request, CallOptions options)

Lists events under a given project and location.

Parameters
Name	Description
`request`	`ListEventsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListEventsResponse`	The response received from the server.

ListEvents(ListEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEventsResponse ListEvents(ListEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists events under a given project and location.

Parameters
Name	Description
`request`	`ListEventsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListEventsResponse`	The response received from the server.

ListEventsAsync(ListEventsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEventsResponse> ListEventsAsync(ListEventsRequest request, CallOptions options)

Lists events under a given project and location.

Parameters
Name	Description
`request`	`ListEventsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListEventsResponse`	The call object.

ListEventsAsync(ListEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEventsResponse> ListEventsAsync(ListEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists events under a given project and location.

Parameters
Name	Description
`request`	`ListEventsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListEventsResponse`	The call object.

ListOrganizationEvents(ListOrganizationEventsRequest, CallOptions)

public virtual ListOrganizationEventsResponse ListOrganizationEvents(ListOrganizationEventsRequest request, CallOptions options)

Lists organization events under a given organization and location.

Parameters
Name	Description
`request`	`ListOrganizationEventsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListOrganizationEventsResponse`	The response received from the server.

ListOrganizationEvents(ListOrganizationEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListOrganizationEventsResponse ListOrganizationEvents(ListOrganizationEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists organization events under a given organization and location.

Parameters
Name	Description
`request`	`ListOrganizationEventsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListOrganizationEventsResponse`	The response received from the server.

ListOrganizationEventsAsync(ListOrganizationEventsRequest, CallOptions)

public virtual AsyncUnaryCall<ListOrganizationEventsResponse> ListOrganizationEventsAsync(ListOrganizationEventsRequest request, CallOptions options)

Lists organization events under a given organization and location.

Parameters
Name	Description
`request`	`ListOrganizationEventsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListOrganizationEventsResponse`	The call object.

ListOrganizationEventsAsync(ListOrganizationEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListOrganizationEventsResponse> ListOrganizationEventsAsync(ListOrganizationEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists organization events under a given organization and location.

Parameters
Name	Description
`request`	`ListOrganizationEventsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListOrganizationEventsResponse`	The call object.

ListOrganizationImpacts(ListOrganizationImpactsRequest, CallOptions)

public virtual ListOrganizationImpactsResponse ListOrganizationImpacts(ListOrganizationImpactsRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`ListOrganizationImpactsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListOrganizationImpactsResponse`	The response received from the server.

ListOrganizationImpacts(ListOrganizationImpactsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListOrganizationImpactsResponse ListOrganizationImpacts(ListOrganizationImpactsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`ListOrganizationImpactsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListOrganizationImpactsResponse`	The response received from the server.

ListOrganizationImpactsAsync(ListOrganizationImpactsRequest, CallOptions)

public virtual AsyncUnaryCall<ListOrganizationImpactsResponse> ListOrganizationImpactsAsync(ListOrganizationImpactsRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`ListOrganizationImpactsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListOrganizationImpactsResponse`	The call object.

ListOrganizationImpactsAsync(ListOrganizationImpactsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListOrganizationImpactsResponse> ListOrganizationImpactsAsync(ListOrganizationImpactsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`ListOrganizationImpactsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListOrganizationImpactsResponse`	The call object.

NewInstance(ClientBaseConfiguration)

protected override ServiceHealth.ServiceHealthClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`ServiceHealthServiceHealthClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.ServiceHealth.V1.ServiceHealth.ServiceHealthClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)