Stackdriver Logging V2 Client - Class LoggingServiceV2Client (1.24.10)

use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\LoggingServiceV2Client;

/**
 * @param string $formattedLogName The resource name of the log to delete:
 *
 *                                 * `projects/[PROJECT_ID]/logs/[LOG_ID]`
 *                                 * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
 *                                 * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
 *                                 * `folders/[FOLDER_ID]/logs/[LOG_ID]`
 *
 *                                 `[LOG_ID]` must be URL-encoded. For example,
 *                                 `"projects/my-project-id/logs/syslog"`,
 *                                 `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
 *
 *                                 For more information about log names, see
 *                                 [LogEntry][google.logging.v2.LogEntry]. Please see
 *                                 {@see LoggingServiceV2Client::logName()} for help formatting this field.
 */
function delete_log_sample(string $formattedLogName): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Call the API and handle any network failures.
    try {
        $loggingServiceV2Client->deleteLog($formattedLogName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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
{
    $formattedLogName = LoggingServiceV2Client::logName('[PROJECT]', '[LOG]');

    delete_log_sample($formattedLogName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\LogEntry;
use Google\Cloud\Logging\V2\LoggingServiceV2Client;

/**
 * @param string $formattedResourceNamesElement Names of one or more parent resources from which to
 *                                              retrieve log entries:
 *
 *                                              *  `projects/[PROJECT_ID]`
 *                                              *  `organizations/[ORGANIZATION_ID]`
 *                                              *  `billingAccounts/[BILLING_ACCOUNT_ID]`
 *                                              *  `folders/[FOLDER_ID]`
 *
 *                                              May alternatively be one or more views:
 *
 *                                              * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                              * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                              * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                              * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *
 *                                              Projects listed in the `project_ids` field are added to this list. Please see
 *                                              {@see LoggingServiceV2Client::projectName()} for help formatting this field.
 */
function list_log_entries_sample(string $formattedResourceNamesElement): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare any non-scalar elements to be passed along with the request.
    $formattedResourceNames = [$formattedResourceNamesElement,];

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

        /** @var LogEntry $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());
    }
}

/**
 * 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
{
    $formattedResourceNamesElement = LoggingServiceV2Client::projectName('[PROJECT]');

    list_log_entries_sample($formattedResourceNamesElement);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\LoggingServiceV2Client;

/**
 * @param string $formattedParent The resource name that owns the logs:
 *
 *                                *  `projects/[PROJECT_ID]`
 *                                *  `organizations/[ORGANIZATION_ID]`
 *                                *  `billingAccounts/[BILLING_ACCOUNT_ID]`
 *                                *  `folders/[FOLDER_ID]`
 *                                Please see {@see LoggingServiceV2Client::projectName()} for help formatting this field.
 */
function list_logs_sample(string $formattedParent): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

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

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

/**
 * 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 = LoggingServiceV2Client::projectName('[PROJECT]');

    list_logs_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Api\MonitoredResourceDescriptor;
use Google\Cloud\Logging\V2\LoggingServiceV2Client;

/**
 * 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_monitored_resource_descriptors_sample(): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

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

        /** @var MonitoredResourceDescriptor $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());
    }
}

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Logging\V2\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\TailLogEntriesRequest;
use Google\Cloud\Logging\V2\TailLogEntriesResponse;

/**
 * @param string $resourceNamesElement Name of a parent resource from which to retrieve log entries:
 *
 *                                     *  `projects/[PROJECT_ID]`
 *                                     *  `organizations/[ORGANIZATION_ID]`
 *                                     *  `billingAccounts/[BILLING_ACCOUNT_ID]`
 *                                     *  `folders/[FOLDER_ID]`
 *
 *                                     May alternatively be one or more views:
 *
 *                                     * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                     * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                     * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 *                                     * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
 */
function tail_log_entries_sample(string $resourceNamesElement): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare any non-scalar elements to be passed along with the request.
    $resourceNames = [$resourceNamesElement,];
    $request = (new TailLogEntriesRequest())
        ->setResourceNames($resourceNames);

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $loggingServiceV2Client->tailLogEntries();
        $stream->writeAll([$request,]);

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

/**
 * 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
{
    $resourceNamesElement = '[RESOURCE_NAMES]';

    tail_log_entries_sample($resourceNamesElement);
}

use Google\ApiCore\ApiException;
use Google\Api\MonitoredResource;
use Google\Cloud\Logging\V2\LogEntry;
use Google\Cloud\Logging\V2\LoggingServiceV2Client;
use Google\Cloud\Logging\V2\WriteLogEntriesResponse;

/**
 * @param string $entriesLogName The resource name of the log to which this log entry belongs:
 *
 *                               "projects/[PROJECT_ID]/logs/[LOG_ID]"
 *                               "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
 *                               "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
 *                               "folders/[FOLDER_ID]/logs/[LOG_ID]"
 *
 *                               A project number may be used in place of PROJECT_ID. The project number is
 *                               translated to its corresponding PROJECT_ID internally and the `log_name`
 *                               field will contain PROJECT_ID in queries and exports.
 *
 *                               `[LOG_ID]` must be URL-encoded within `log_name`. Example:
 *                               `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
 *
 *                               `[LOG_ID]` must be less than 512 characters long and can only include the
 *                               following characters: upper and lower case alphanumeric characters,
 *                               forward-slash, underscore, hyphen, and period.
 *
 *                               For backward compatibility, if `log_name` begins with a forward-slash, such
 *                               as `/projects/...`, then the log entry is ingested as usual, but the
 *                               forward-slash is removed. Listing the log entry will not show the leading
 *                               slash and filtering for a log name with a leading slash will never return
 *                               any results.
 */
function write_log_entries_sample(string $entriesLogName): void
{
    // Create a client.
    $loggingServiceV2Client = new LoggingServiceV2Client();

    // Prepare any non-scalar elements to be passed along with the request.
    $entriesResource = new MonitoredResource();
    $logEntry = (new LogEntry())
        ->setLogName($entriesLogName)
        ->setResource($entriesResource);
    $entries = [$logEntry,];

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

/**
 * 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
{
    $entriesLogName = '[LOG_NAME]';

    write_log_entries_sample($entriesLogName);
}