Google Cloud Advisory Notifications V1 Client - Class AdvisoryNotificationsServiceClient (0.6.0)

Reference documentation and code samples for the Google Cloud Advisory Notifications V1 Client class AdvisoryNotificationsServiceClient.

Service Description: Service to manage Security and Privacy Notifications.

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:

$advisoryNotificationsServiceClient = new AdvisoryNotificationsServiceClient();
try {
    $formattedName = $advisoryNotificationsServiceClient->notificationName('[ORGANIZATION]', '[LOCATION]', '[NOTIFICATION]');
    $response = $advisoryNotificationsServiceClient->getNotification($formattedName);
} finally {
    $advisoryNotificationsServiceClient->close();
}

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.

This service has a new (beta) implementation. See Google\Cloud\AdvisoryNotifications\V1\Client\AdvisoryNotificationsServiceClient to use the new surface.

Namespace

Google \ Cloud \ AdvisoryNotifications \ V1

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.

getNotification

Gets a notification.

Parameters
Name	Description
`name`	`string` Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{projects}/locations/{location}/notifications/{notification}.
`optionalArgs`	`array` Optional.
`↳ languageCode`	`string` ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
`↳ 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\AdvisoryNotifications\V1\Notification`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AdvisoryNotifications\V1\Client\AdvisoryNotificationsServiceClient;
use Google\Cloud\AdvisoryNotifications\V1\GetNotificationRequest;
use Google\Cloud\AdvisoryNotifications\V1\Notification;

/**
 * @param string $formattedName A name of the notification to retrieve.
 *                              Format:
 *                              organizations/{organization}/locations/{location}/notifications/{notification}
 *                              or projects/{projects}/locations/{location}/notifications/{notification}. Please see
 *                              {@see AdvisoryNotificationsServiceClient::notificationName()} for help formatting this field.
 */
function get_notification_sample(string $formattedName): void
{
    // Create a client.
    $advisoryNotificationsServiceClient = new AdvisoryNotificationsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Notification $response */
        $response = $advisoryNotificationsServiceClient->getNotification($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 = AdvisoryNotificationsServiceClient::notificationName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[NOTIFICATION]'
    );

    get_notification_sample($formattedName);
}

getSettings

Get notification settings.

Parameters
Name	Description
`name`	`string` Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.
`optionalArgs`	`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\AdvisoryNotifications\V1\Settings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AdvisoryNotifications\V1\Client\AdvisoryNotificationsServiceClient;
use Google\Cloud\AdvisoryNotifications\V1\GetSettingsRequest;
use Google\Cloud\AdvisoryNotifications\V1\Settings;

/**
 * @param string $formattedName The resource name of the settings to retrieve.
 *                              Format:
 *                              organizations/{organization}/locations/{location}/settings. Please see
 *                              {@see AdvisoryNotificationsServiceClient::settingsName()} for help formatting this field.
 */
function get_settings_sample(string $formattedName): void
{
    // Create a client.
    $advisoryNotificationsServiceClient = new AdvisoryNotificationsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Settings $response */
        $response = $advisoryNotificationsServiceClient->getSettings($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 = AdvisoryNotificationsServiceClient::settingsName('[ORGANIZATION]', '[LOCATION]');

    get_settings_sample($formattedName);
}

listNotifications

Lists notifications under a given parent.

Parameters
Name	Description
`parent`	`string` Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}"
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ view`	`int` Specifies which parts of the notification resource should be returned in the response. For allowed values, use constants defined on Google\Cloud\AdvisoryNotifications\V1\NotificationView
`↳ languageCode`	`string` ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
`↳ 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\AdvisoryNotifications\V1\Client\AdvisoryNotificationsServiceClient;
use Google\Cloud\AdvisoryNotifications\V1\ListNotificationsRequest;
use Google\Cloud\AdvisoryNotifications\V1\Notification;

/**
 * @param string $formattedParent The parent, which owns this collection of notifications.
 *                                Must be of the form "organizations/{organization}/locations/{location}"
 *                                or "projects/{project}/locations/{location}"
 *                                Please see {@see AdvisoryNotificationsServiceClient::locationName()} for help formatting this field.
 */
function list_notifications_sample(string $formattedParent): void
{
    // Create a client.
    $advisoryNotificationsServiceClient = new AdvisoryNotificationsServiceClient();

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

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

        /** @var Notification $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 = AdvisoryNotificationsServiceClient::locationName('[ORGANIZATION]', '[LOCATION]');

    list_notifications_sample($formattedParent);
}

updateSettings

Update notification settings.

Parameters
Name	Description
`settings`	`Google\Cloud\AdvisoryNotifications\V1\Settings` Required. New settings.
`optionalArgs`	`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\AdvisoryNotifications\V1\Settings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AdvisoryNotifications\V1\Client\AdvisoryNotificationsServiceClient;
use Google\Cloud\AdvisoryNotifications\V1\Settings;
use Google\Cloud\AdvisoryNotifications\V1\UpdateSettingsRequest;

/**
 * @param string $settingsEtag Fingerprint for optimistic concurrency returned in Get requests.
 *                             Must be provided for Update requests. If the value provided does not match
 *                             the value known to the server, ABORTED will be thrown, and the client
 *                             should retry the read-modify-write cycle.
 */
function update_settings_sample(string $settingsEtag): void
{
    // Create a client.
    $advisoryNotificationsServiceClient = new AdvisoryNotificationsServiceClient();

    // Prepare the request message.
    $settingsNotificationSettings = [];
    $settings = (new Settings())
        ->setNotificationSettings($settingsNotificationSettings)
        ->setEtag($settingsEtag);
    $request = (new UpdateSettingsRequest())
        ->setSettings($settings);

    // Call the API and handle any network failures.
    try {
        /** @var Settings $response */
        $response = $advisoryNotificationsServiceClient->updateSettings($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
{
    $settingsEtag = '[ETAG]';

    update_settings_sample($settingsEtag);
}

static::locationName

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

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

Returns
Type	Description
`string`	The formatted location resource.

static::notificationName

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

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

Returns
Type	Description
`string`	The formatted notification 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::organizationLocationNotificationName

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

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

Returns
Type	Description
`string`	The formatted organization_location_notification resource.

static::projectLocationName

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

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

Returns
Type	Description
`string`	The formatted project_location resource.

static::projectLocationNotificationName

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

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

Returns
Type	Description
`string`	The formatted project_location_notification resource.

static::settingsName

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

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

Returns
Type	Description
`string`	The formatted settings 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

location: organizations/{organization}/locations/{location}
notification: organizations/{organization}/locations/{location}/notifications/{notification}
organizationLocation: organizations/{organization}/locations/{location}
organizationLocationNotification: organizations/{organization}/locations/{location}/notifications/{notification}
projectLocation: projects/{project}/locations/{location}
projectLocationNotification: projects/{project}/locations/{location}/notifications/{notification}
settings: organizations/{organization}/locations/{location}/settings

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.

Constants

SERVICE_NAME

Value: 'google.cloud.advisorynotifications.v1.AdvisoryNotificationsService'

The name of the service.

SERVICE_ADDRESS

Value: 'advisorynotifications.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.