Google Cloud Service Health V1 Client - Class ServiceHealthClient (0.1.8)

Reference documentation and code samples for the Google Cloud Service Health V1 Client class ServiceHealthClient.

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.

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 parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ ServiceHealth \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

getEvent

Retrieves a resource containing information about an event.

The async variant is ServiceHealthClient::getEventAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\GetEventRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\ServiceHealth\V1\Event`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;
use Google\Cloud\ServiceHealth\V1\Event;
use Google\Cloud\ServiceHealth\V1\GetEventRequest;

/**
 * @param string $formattedName 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. <br>
 *                              `location` - The location to get the service health events from. <br>
 *                              `event_id` - Event ID to retrieve. Please see
 *                              {@see ServiceHealthClient::eventName()} for help formatting this field.
 */
function get_event_sample(string $formattedName): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = (new GetEventRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Event $response */
        $response = $serviceHealthClient->getEvent($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ServiceHealthClient::eventName('[PROJECT]', '[LOCATION]', '[EVENT]');

    get_event_sample($formattedName);
}

getOrganizationEvent

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

The async variant is ServiceHealthClient::getOrganizationEventAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\GetOrganizationEventRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\ServiceHealth\V1\OrganizationEvent`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;
use Google\Cloud\ServiceHealth\V1\GetOrganizationEventRequest;
use Google\Cloud\ServiceHealth\V1\OrganizationEvent;

/**
 * @param string $formattedName 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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
 *                              `event_id` - Organization event ID to retrieve. Please see
 *                              {@see ServiceHealthClient::organizationEventName()} for help formatting this field.
 */
function get_organization_event_sample(string $formattedName): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = (new GetOrganizationEventRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OrganizationEvent $response */
        $response = $serviceHealthClient->getOrganizationEvent($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ServiceHealthClient::organizationEventName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[EVENT]'
    );

    get_organization_event_sample($formattedName);
}

getOrganizationImpact

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

The async variant is ServiceHealthClient::getOrganizationImpactAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\GetOrganizationImpactRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\ServiceHealth\V1\OrganizationImpact`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;
use Google\Cloud\ServiceHealth\V1\GetOrganizationImpactRequest;
use Google\Cloud\ServiceHealth\V1\OrganizationImpact;

/**
 * @param string $formattedName 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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
 *                              `organization_impact_id` - ID of the [OrganizationImpact
 *                              resource](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact). Please see
 *                              {@see ServiceHealthClient::organizationImpactName()} for help formatting this field.
 */
function get_organization_impact_sample(string $formattedName): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = (new GetOrganizationImpactRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OrganizationImpact $response */
        $response = $serviceHealthClient->getOrganizationImpact($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ServiceHealthClient::organizationImpactName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[ORGANIZATION_IMPACT]'
    );

    get_organization_impact_sample($formattedName);
}

listEvents

Lists events under a given project and location.

The async variant is ServiceHealthClient::listEventsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\ListEventsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;
use Google\Cloud\ServiceHealth\V1\Event;
use Google\Cloud\ServiceHealth\V1\ListEventsRequest;

/**
 * @param string $formattedParent 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`. Please see
 *                                {@see ServiceHealthClient::locationName()} for help formatting this field.
 */
function list_events_sample(string $formattedParent): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = (new ListEventsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $serviceHealthClient->listEvents($request);

        /** @var Event $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ServiceHealthClient::locationName('[PROJECT]', '[LOCATION]');

    list_events_sample($formattedParent);
}

listOrganizationEvents

Lists organization events under a given organization and location.

The async variant is ServiceHealthClient::listOrganizationEventsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\ListOrganizationEventsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;
use Google\Cloud\ServiceHealth\V1\ListOrganizationEventsRequest;
use Google\Cloud\ServiceHealth\V1\OrganizationEvent;

/**
 * @param string $formattedParent 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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
 *                                `location` - The location to get the service health events from. To
 *                                retrieve service health events of category = INCIDENT, use `location` =
 *                                `global`. Please see
 *                                {@see ServiceHealthClient::organizationLocationName()} for help formatting this field.
 */
function list_organization_events_sample(string $formattedParent): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = (new ListOrganizationEventsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $serviceHealthClient->listOrganizationEvents($request);

        /** @var OrganizationEvent $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ServiceHealthClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');

    list_organization_events_sample($formattedParent);
}

listOrganizationImpacts

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

The async variant is ServiceHealthClient::listOrganizationImpactsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\ListOrganizationImpactsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;
use Google\Cloud\ServiceHealth\V1\ListOrganizationImpactsRequest;
use Google\Cloud\ServiceHealth\V1\OrganizationImpact;

/**
 * @param string $formattedParent 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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). Please see
 *                                {@see ServiceHealthClient::organizationLocationName()} for help formatting this field.
 */
function list_organization_impacts_sample(string $formattedParent): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = (new ListOrganizationImpactsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $serviceHealthClient->listOrganizationImpacts($request);

        /** @var OrganizationImpact $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ServiceHealthClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');

    list_organization_impacts_sample($formattedParent);
}

getLocation

Gets information about a location.

The async variant is ServiceHealthClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $serviceHealthClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is ServiceHealthClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ServiceHealth\V1\Client\ServiceHealthClient;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $serviceHealthClient = new ServiceHealthClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $serviceHealthClient->listLocations($request);

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getEventAsync

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\GetEventRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ServiceHealth\V1\Event>`

getOrganizationEventAsync

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\GetOrganizationEventRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ServiceHealth\V1\OrganizationEvent>`

getOrganizationImpactAsync

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\GetOrganizationImpactRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ServiceHealth\V1\OrganizationImpact>`

listEventsAsync

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\ListEventsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

listOrganizationEventsAsync

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\ListOrganizationEventsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

listOrganizationImpactsAsync

Parameters
Name	Description
`request`	`Google\Cloud\ServiceHealth\V1\ListOrganizationImpactsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

static::eventName

Formats a string containing the fully-qualified path to represent a event resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`event`	`string`

Returns
Type	Description
`string`	The formatted event resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::organizationEventName

Formats a string containing the fully-qualified path to represent a organization_event resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`event`	`string`

Returns
Type	Description
`string`	The formatted organization_event resource.

static::organizationImpactName

Formats a string containing the fully-qualified path to represent a organization_impact resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`organizationImpact`	`string`

Returns
Type	Description
`string`	The formatted organization_impact resource.

static::organizationLocationName

Formats a string containing the fully-qualified path to represent a organization_location resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted organization_location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

event: projects/{project}/locations/{location}/events/{event}
location: projects/{project}/locations/{location}
organizationEvent: organizations/{organization}/locations/{location}/organizationEvents/{event}
organizationImpact: organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}
organizationLocation: organizations/{organization}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.