Class ServiceHealthClient (0.4.0)

Service Description: Request service health events relevant to your Google Cloud project.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   EventName name = EventName.of("[PROJECT]", "[LOCATION]", "[EVENT]");
   Event response = serviceHealthClient.getEvent(name);
 }

Note: close() needs to be called on the ServiceHealthClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ListEvents	Lists events under a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEvents(ListEventsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEvents(LocationName parent) listEvents(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listEventsPagedCallable() listEventsCallable()
GetEvent	Retrieves a resource containing information about an event.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEvent(GetEventRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEvent(EventName name) getEvent(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getEventCallable()
ListOrganizationEvents	Lists organization events under a given organization and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listOrganizationEvents(ListOrganizationEventsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listOrganizationEvents(OrganizationLocationName parent) listOrganizationEvents(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listOrganizationEventsPagedCallable() listOrganizationEventsCallable()
GetOrganizationEvent	Retrieves a resource containing information about an event affecting an organization .	Request object method variants only take one parameter, a request object, which must be constructed before the call. getOrganizationEvent(GetOrganizationEventRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getOrganizationEvent(OrganizationEventName name) getOrganizationEvent(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getOrganizationEventCallable()
ListOrganizationImpacts	Lists assets impacted by organization events under a given organization and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listOrganizationImpacts(ListOrganizationImpactsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listOrganizationImpacts(OrganizationLocationName parent) listOrganizationImpacts(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listOrganizationImpactsPagedCallable() listOrganizationImpactsCallable()
GetOrganizationImpact	Retrieves a resource containing information about impact to an asset under an organization affected by a service health event.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getOrganizationImpact(GetOrganizationImpactRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getOrganizationImpact(OrganizationImpactName name) getOrganizationImpact(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getOrganizationImpactCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ServiceHealthSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServiceHealthSettings serviceHealthSettings =
     ServiceHealthSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServiceHealthClient serviceHealthClient = ServiceHealthClient.create(serviceHealthSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServiceHealthSettings serviceHealthSettings =
     ServiceHealthSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServiceHealthClient serviceHealthClient = ServiceHealthClient.create(serviceHealthSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServiceHealthSettings serviceHealthSettings =
     ServiceHealthSettings.newHttpJsonBuilder().build();
 ServiceHealthClient serviceHealthClient = ServiceHealthClient.create(serviceHealthSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ServiceHealthClient

Static Methods

create()

public static final ServiceHealthClient create()

Constructs an instance of ServiceHealthClient with default settings.

Returns
Type	Description
`ServiceHealthClient`

Exceptions
Type	Description
`IOException`

create(ServiceHealthSettings settings)

public static final ServiceHealthClient create(ServiceHealthSettings settings)

Constructs an instance of ServiceHealthClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`ServiceHealthSettings`

Returns
Type	Description
`ServiceHealthClient`

Exceptions
Type	Description
`IOException`

create(ServiceHealthStub stub)

public static final ServiceHealthClient create(ServiceHealthStub stub)

Constructs an instance of ServiceHealthClient, using the given stub for making calls. This is for advanced usage - prefer using create(ServiceHealthSettings).

Parameter
Name	Description
`stub`	`ServiceHealthStub`

Returns
Type	Description
`ServiceHealthClient`

Constructors

ServiceHealthClient(ServiceHealthSettings settings)

protected ServiceHealthClient(ServiceHealthSettings settings)

Constructs an instance of ServiceHealthClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`ServiceHealthSettings`

ServiceHealthClient(ServiceHealthStub stub)

protected ServiceHealthClient(ServiceHealthStub stub)

Parameter
Name	Description
`stub`	`ServiceHealthStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getEvent(EventName name)

public final Event getEvent(EventName name)

Retrieves a resource containing information about an event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   EventName name = EventName.of("[PROJECT]", "[LOCATION]", "[EVENT]");
   Event response = serviceHealthClient.getEvent(name);
 }

Parameter

Name Description

name

EventName

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.

Returns
Type	Description
`Event`

getEvent(GetEventRequest request)

public final Event getEvent(GetEventRequest request)

Retrieves a resource containing information about an event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetEventRequest request =
       GetEventRequest.newBuilder()
           .setName(EventName.of("[PROJECT]", "[LOCATION]", "[EVENT]").toString())
           .build();
   Event response = serviceHealthClient.getEvent(request);
 }

Parameter
Name	Description
`request`	`GetEventRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Event`

getEvent(String name)

public final Event getEvent(String name)

Retrieves a resource containing information about an event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   String name = EventName.of("[PROJECT]", "[LOCATION]", "[EVENT]").toString();
   Event response = serviceHealthClient.getEvent(name);
 }

Parameter

Name Description

name

String

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.

Returns
Type	Description
`Event`

getEventCallable()

public final UnaryCallable<GetEventRequest,Event> getEventCallable()

Retrieves a resource containing information about an event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetEventRequest request =
       GetEventRequest.newBuilder()
           .setName(EventName.of("[PROJECT]", "[LOCATION]", "[EVENT]").toString())
           .build();
   ApiFuture<Event> future = serviceHealthClient.getEventCallable().futureCall(request);
   // Do something.
   Event response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetEventRequest,Event>`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = serviceHealthClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = serviceHealthClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getOrganizationEvent(GetOrganizationEventRequest request)

public final OrganizationEvent getOrganizationEvent(GetOrganizationEventRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetOrganizationEventRequest request =
       GetOrganizationEventRequest.newBuilder()
           .setName(
               OrganizationEventName.of("[ORGANIZATION]", "[LOCATION]", "[EVENT]").toString())
           .build();
   OrganizationEvent response = serviceHealthClient.getOrganizationEvent(request);
 }

Parameter
Name	Description
`request`	`GetOrganizationEventRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OrganizationEvent`

getOrganizationEvent(OrganizationEventName name)

public final OrganizationEvent getOrganizationEvent(OrganizationEventName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   OrganizationEventName name =
       OrganizationEventName.of("[ORGANIZATION]", "[LOCATION]", "[EVENT]");
   OrganizationEvent response = serviceHealthClient.getOrganizationEvent(name);
 }

Parameter

Name Description

name

OrganizationEventName

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.

Returns
Type	Description
`OrganizationEvent`

getOrganizationEvent(String name)

public final OrganizationEvent getOrganizationEvent(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   String name = OrganizationEventName.of("[ORGANIZATION]", "[LOCATION]", "[EVENT]").toString();
   OrganizationEvent response = serviceHealthClient.getOrganizationEvent(name);
 }

Parameter

Name Description

name

String

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.

Returns
Type	Description
`OrganizationEvent`

getOrganizationEventCallable()

public final UnaryCallable<GetOrganizationEventRequest,OrganizationEvent> getOrganizationEventCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetOrganizationEventRequest request =
       GetOrganizationEventRequest.newBuilder()
           .setName(
               OrganizationEventName.of("[ORGANIZATION]", "[LOCATION]", "[EVENT]").toString())
           .build();
   ApiFuture<OrganizationEvent> future =
       serviceHealthClient.getOrganizationEventCallable().futureCall(request);
   // Do something.
   OrganizationEvent response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetOrganizationEventRequest,OrganizationEvent>`

getOrganizationImpact(GetOrganizationImpactRequest request)

public final OrganizationImpact getOrganizationImpact(GetOrganizationImpactRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetOrganizationImpactRequest request =
       GetOrganizationImpactRequest.newBuilder()
           .setName(
               OrganizationImpactName.of("[ORGANIZATION]", "[LOCATION]", "[ORGANIZATION_IMPACT]")
                   .toString())
           .build();
   OrganizationImpact response = serviceHealthClient.getOrganizationImpact(request);
 }

Parameter
Name	Description
`request`	`GetOrganizationImpactRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OrganizationImpact`

getOrganizationImpact(OrganizationImpactName name)

public final OrganizationImpact getOrganizationImpact(OrganizationImpactName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   OrganizationImpactName name =
       OrganizationImpactName.of("[ORGANIZATION]", "[LOCATION]", "[ORGANIZATION_IMPACT]");
   OrganizationImpact response = serviceHealthClient.getOrganizationImpact(name);
 }

Parameter

Name Description

name

OrganizationImpactName

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.

Returns
Type	Description
`OrganizationImpact`

getOrganizationImpact(String name)

public final OrganizationImpact getOrganizationImpact(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   String name =
       OrganizationImpactName.of("[ORGANIZATION]", "[LOCATION]", "[ORGANIZATION_IMPACT]")
           .toString();
   OrganizationImpact response = serviceHealthClient.getOrganizationImpact(name);
 }

Parameter

Name Description

name

String

Required. Name of the resource using the form organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}.

Returns
Type	Description
`OrganizationImpact`

getOrganizationImpactCallable()

public final UnaryCallable<GetOrganizationImpactRequest,OrganizationImpact> getOrganizationImpactCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   GetOrganizationImpactRequest request =
       GetOrganizationImpactRequest.newBuilder()
           .setName(
               OrganizationImpactName.of("[ORGANIZATION]", "[LOCATION]", "[ORGANIZATION_IMPACT]")
                   .toString())
           .build();
   ApiFuture<OrganizationImpact> future =
       serviceHealthClient.getOrganizationImpactCallable().futureCall(request);
   // Do something.
   OrganizationImpact response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetOrganizationImpactRequest,OrganizationImpact>`

getSettings()

public final ServiceHealthSettings getSettings()

Returns
Type	Description
`ServiceHealthSettings`

getStub()

public ServiceHealthStub getStub()

Returns
Type	Description
`ServiceHealthStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listEvents(ListEventsRequest request)

public final ServiceHealthClient.ListEventsPagedResponse listEvents(ListEventsRequest request)

Lists events under a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(EventView.forNumber(0))
           .build();
   for (Event element : serviceHealthClient.listEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListEventsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ServiceHealthClient.ListEventsPagedResponse`

listEvents(LocationName parent)

public final ServiceHealthClient.ListEventsPagedResponse listEvents(LocationName parent)

Lists events under a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Event element : serviceHealthClient.listEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

LocationName

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.

Returns
Type	Description
`ServiceHealthClient.ListEventsPagedResponse`

listEvents(String parent)

public final ServiceHealthClient.ListEventsPagedResponse listEvents(String parent)

Lists events under a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Event element : serviceHealthClient.listEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. Parent value using the form projects/{project_id}/locations/{location}/events.

Returns
Type	Description
`ServiceHealthClient.ListEventsPagedResponse`

listEventsCallable()

public final UnaryCallable<ListEventsRequest,ListEventsResponse> listEventsCallable()

Lists events under a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(EventView.forNumber(0))
           .build();
   while (true) {
     ListEventsResponse response = serviceHealthClient.listEventsCallable().call(request);
     for (Event element : response.getEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListEventsRequest,ListEventsResponse>`

listEventsPagedCallable()

public final UnaryCallable<ListEventsRequest,ServiceHealthClient.ListEventsPagedResponse> listEventsPagedCallable()

Lists events under a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(EventView.forNumber(0))
           .build();
   ApiFuture<Event> future = serviceHealthClient.listEventsPagedCallable().futureCall(request);
   // Do something.
   for (Event element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListEventsRequest,ListEventsPagedResponse>`

listLocations(ListLocationsRequest request)

public final ServiceHealthClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : serviceHealthClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ServiceHealthClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = serviceHealthClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,ServiceHealthClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       serviceHealthClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

listOrganizationEvents(ListOrganizationEventsRequest request)

public final ServiceHealthClient.ListOrganizationEventsPagedResponse listOrganizationEvents(ListOrganizationEventsRequest request)

Lists organization events under a given organization and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListOrganizationEventsRequest request =
       ListOrganizationEventsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(OrganizationEventView.forNumber(0))
           .build();
   for (OrganizationEvent element :
       serviceHealthClient.listOrganizationEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListOrganizationEventsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ServiceHealthClient.ListOrganizationEventsPagedResponse`

listOrganizationEvents(OrganizationLocationName parent)

public final ServiceHealthClient.ListOrganizationEventsPagedResponse listOrganizationEvents(OrganizationLocationName parent)

Lists organization events under a given organization and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (OrganizationEvent element :
       serviceHealthClient.listOrganizationEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

OrganizationLocationName

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.

Returns
Type	Description
`ServiceHealthClient.ListOrganizationEventsPagedResponse`

listOrganizationEvents(String parent)

public final ServiceHealthClient.ListOrganizationEventsPagedResponse listOrganizationEvents(String parent)

Lists organization events under a given organization and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (OrganizationEvent element :
       serviceHealthClient.listOrganizationEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationEvents.

Returns
Type	Description
`ServiceHealthClient.ListOrganizationEventsPagedResponse`

listOrganizationEventsCallable()

public final UnaryCallable<ListOrganizationEventsRequest,ListOrganizationEventsResponse> listOrganizationEventsCallable()

Lists organization events under a given organization and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListOrganizationEventsRequest request =
       ListOrganizationEventsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(OrganizationEventView.forNumber(0))
           .build();
   while (true) {
     ListOrganizationEventsResponse response =
         serviceHealthClient.listOrganizationEventsCallable().call(request);
     for (OrganizationEvent element : response.getOrganizationEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListOrganizationEventsRequest,ListOrganizationEventsResponse>`

listOrganizationEventsPagedCallable()

public final UnaryCallable<ListOrganizationEventsRequest,ServiceHealthClient.ListOrganizationEventsPagedResponse> listOrganizationEventsPagedCallable()

Lists organization events under a given organization and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListOrganizationEventsRequest request =
       ListOrganizationEventsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(OrganizationEventView.forNumber(0))
           .build();
   ApiFuture<OrganizationEvent> future =
       serviceHealthClient.listOrganizationEventsPagedCallable().futureCall(request);
   // Do something.
   for (OrganizationEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListOrganizationEventsRequest,ListOrganizationEventsPagedResponse>`

listOrganizationImpacts(ListOrganizationImpactsRequest request)

public final ServiceHealthClient.ListOrganizationImpactsPagedResponse listOrganizationImpacts(ListOrganizationImpactsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListOrganizationImpactsRequest request =
       ListOrganizationImpactsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (OrganizationImpact element :
       serviceHealthClient.listOrganizationImpacts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListOrganizationImpactsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ServiceHealthClient.ListOrganizationImpactsPagedResponse`

listOrganizationImpacts(OrganizationLocationName parent)

public final ServiceHealthClient.ListOrganizationImpactsPagedResponse listOrganizationImpacts(OrganizationLocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (OrganizationImpact element :
       serviceHealthClient.listOrganizationImpacts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

OrganizationLocationName

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.

Returns
Type	Description
`ServiceHealthClient.ListOrganizationImpactsPagedResponse`

listOrganizationImpacts(String parent)

public final ServiceHealthClient.ListOrganizationImpactsPagedResponse listOrganizationImpacts(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (OrganizationImpact element :
       serviceHealthClient.listOrganizationImpacts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

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.

Returns
Type	Description
`ServiceHealthClient.ListOrganizationImpactsPagedResponse`

listOrganizationImpactsCallable()

public final UnaryCallable<ListOrganizationImpactsRequest,ListOrganizationImpactsResponse> listOrganizationImpactsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListOrganizationImpactsRequest request =
       ListOrganizationImpactsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListOrganizationImpactsResponse response =
         serviceHealthClient.listOrganizationImpactsCallable().call(request);
     for (OrganizationImpact element : response.getOrganizationImpactsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListOrganizationImpactsRequest,ListOrganizationImpactsResponse>`

listOrganizationImpactsPagedCallable()

public final UnaryCallable<ListOrganizationImpactsRequest,ServiceHealthClient.ListOrganizationImpactsPagedResponse> listOrganizationImpactsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceHealthClient serviceHealthClient = ServiceHealthClient.create()) {
   ListOrganizationImpactsRequest request =
       ListOrganizationImpactsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<OrganizationImpact> future =
       serviceHealthClient.listOrganizationImpactsPagedCallable().futureCall(request);
   // Do something.
   for (OrganizationImpact element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListOrganizationImpactsRequest,ListOrganizationImpactsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()