Stackdriver Logging V2 Client - Class LoggingServiceV2Client (1.28.5)

Reference documentation and code samples for the Stackdriver Logging V2 Client class LoggingServiceV2Client.

Service Description: Service for ingesting and querying logs.

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:

$loggingServiceV2Client = new LoggingServiceV2Client();
try {
    $formattedLogName = $loggingServiceV2Client->logName('[PROJECT]', '[LOG]');
    $loggingServiceV2Client->deleteLog($formattedLogName);
} finally {
    $loggingServiceV2Client->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\Logging\V2\Client\LoggingServiceV2Client to use the new surface.

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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.

deleteLog

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.

Parameters
NameDescription
logName string

Required. 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.

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.

Example
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());
    }
}

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

    delete_log_sample($formattedLogName);
}

listLogEntries

Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.

Parameters
NameDescription
resourceNames string[]

Required. 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. A maximum of 100 resources may be specified in a single request.

optionalArgs array

Optional.

↳ filter string

Optional. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of a filter is 20,000 characters.

↳ orderBy string

Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc" (default) and "timestamp desc". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.

↳ 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.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
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.
 *                                              A maximum of 100 resources may be specified in a single request. 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());
    }
}

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

    list_log_entries_sample($formattedResourceNamesElement);
}

listLogs

Lists the logs in projects, organizations, folders, or billing accounts.

Only logs that have entries are listed.

Parameters
NameDescription
parent string

Required. The resource name to list logs for:

  • projects/[PROJECT_ID]
  • organizations/[ORGANIZATION_ID]
  • billingAccounts/[BILLING_ACCOUNT_ID]
  • folders/[FOLDER_ID]
optionalArgs array

Optional.

↳ resourceNames string[]

Optional. List of resource names to list logs for: * 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] To support legacy queries, it could also be: * projects/[PROJECT_ID] * organizations/[ORGANIZATION_ID] * billingAccounts/[BILLING_ACCOUNT_ID] * folders/[FOLDER_ID] The resource name in the parent field is added to this list.

↳ 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.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\LoggingServiceV2Client;

/**
 * @param string $formattedParent The resource name to list logs for:
 *
 *                                *  `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());
    }
}

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

    list_logs_sample($formattedParent);
}

listMonitoredResourceDescriptors

Lists the descriptors for monitored resource types used by Logging.

Parameters
NameDescription
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.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
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());
    }
}

tailLogEntries

Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.

Parameters
NameDescription
optionalArgs array

Optional.

↳ timeoutMillis int

Timeout to use for this call.

Returns
TypeDescription
Google\ApiCore\BidiStream
Example
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());
    }
}

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

    tail_log_entries_sample($resourceNamesElement);
}

writeLogEntries

Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging.

A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)

Parameters
NameDescription
entries array<Google\Cloud\Logging\V2\LogEntry>

Required. The log entries to send to Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.

If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.

Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling entries.list. However, those log entries can still be exported with LogSinks.

To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry.

optionalArgs array

Optional.

↳ logName string

Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: * 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" The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.

↳ resource MonitoredResource

Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See LogEntry.

↳ labels array

Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.

↳ partialSuccess bool

Optional. Whether a batch's valid entries should be written even if some other entry failed due to a permanent error such as INVALID_ARGUMENT or PERMISSION_DENIED. If any entry failed, then the response status is the response status of one of the failed entries. The response will include error details in WriteLogEntriesPartialErrors.log_entry_errors keyed by the entries' zero-based index in the entries. Failed requests for which no entries are written will not include per-entry errors.

↳ dryRun bool

Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.

↳ 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
TypeDescription
Google\Cloud\Logging\V2\WriteLogEntriesResponse
Example
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());
    }
}

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

    write_log_entries_sample($entriesLogName);
}

static::billingAccountName

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

Parameter
NameDescription
billingAccount string
Returns
TypeDescription
stringThe formatted billing_account resource.

static::billingAccountLogName

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

Parameters
NameDescription
billingAccount string
log string
Returns
TypeDescription
stringThe formatted billing_account_log resource.

static::folderName

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

Parameter
NameDescription
folder string
Returns
TypeDescription
stringThe formatted folder resource.

static::folderLogName

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

Parameters
NameDescription
folder string
log string
Returns
TypeDescription
stringThe formatted folder_log resource.

static::logName

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

Parameters
NameDescription
project string
log string
Returns
TypeDescription
stringThe formatted log resource.

static::organizationName

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

Parameter
NameDescription
organization string
Returns
TypeDescription
stringThe formatted organization resource.

static::organizationLogName

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

Parameters
NameDescription
organization string
log string
Returns
TypeDescription
stringThe formatted organization_log resource.

static::projectName

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

Parameter
NameDescription
project string
Returns
TypeDescription
stringThe formatted project resource.

static::projectLogName

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

Parameters
NameDescription
project string
log string
Returns
TypeDescription
stringThe formatted project_log 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

  • billingAccount: billingAccounts/{billing_account}
  • billingAccountLog: billingAccounts/{billing_account}/logs/{log}
  • folder: folders/{folder}
  • folderLog: folders/{folder}/logs/{log}
  • log: projects/{project}/logs/{log}
  • organization: organizations/{organization}
  • organizationLog: organizations/{organization}/logs/{log}
  • project: projects/{project}
  • projectLog: projects/{project}/logs/{log}

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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.logging.v2.LoggingServiceV2'

The name of the service.

SERVICE_ADDRESS

Value: 'logging.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.