Reference documentation and code samples for the Stackdriver Logging V2 Client class ConfigServiceV2Client.
Service Description: Service for configuring sinks used to route log entries.
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 \ Logging \ V2 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
copyLogEntries
Copies a set of log entries from a log bucket to a Cloud Storage bucket.
The async variant is ConfigServiceV2Client::copyLogEntriesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CopyLogEntriesRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CopyLogEntriesRequest;
use Google\Cloud\Logging\V2\CopyLogEntriesResponse;
use Google\Rpc\Status;
/**
* @param string $name Log bucket from which to copy log entries.
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-source-bucket"`
* @param string $destination Destination to which to copy log entries.
*/
function copy_log_entries_sample(string $name, string $destination): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new CopyLogEntriesRequest())
->setName($name)
->setDestination($destination);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $configServiceV2Client->copyLogEntries($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var CopyLogEntriesResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$name = '[NAME]';
$destination = '[DESTINATION]';
copy_log_entries_sample($name, $destination);
}
createBucket
Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.
The async variant is ConfigServiceV2Client::createBucketAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateBucketRequest
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\Logging\V2\LogBucket |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CreateBucketRequest;
use Google\Cloud\Logging\V2\LogBucket;
/**
* @param string $formattedParent The resource in which to create the log bucket:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
*
* For example:
*
* `"projects/my-project/locations/global"`
* Please see {@see ConfigServiceV2Client::organizationLocationName()} for help formatting this field.
* @param string $bucketId A client-assigned identifier such as `"my-bucket"`. Identifiers
* are limited to 100 characters and can include only letters, digits,
* underscores, hyphens, and periods.
*/
function create_bucket_sample(string $formattedParent, string $bucketId): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$bucket = new LogBucket();
$request = (new CreateBucketRequest())
->setParent($formattedParent)
->setBucketId($bucketId)
->setBucket($bucket);
// Call the API and handle any network failures.
try {
/** @var LogBucket $response */
$response = $configServiceV2Client->createBucket($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
{
$formattedParent = ConfigServiceV2Client::organizationLocationName('[ORGANIZATION]', '[LOCATION]');
$bucketId = '[BUCKET_ID]';
create_bucket_sample($formattedParent, $bucketId);
}
createBucketAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateBucketRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogBucket> |
createExclusion
Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.
The async variant is ConfigServiceV2Client::createExclusionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateExclusionRequest
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\Logging\V2\LogExclusion |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CreateExclusionRequest;
use Google\Cloud\Logging\V2\LogExclusion;
/**
* @param string $formattedParent The parent resource in which to create the exclusion:
*
* "projects/[PROJECT_ID]"
* "organizations/[ORGANIZATION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]"
* "folders/[FOLDER_ID]"
*
* For examples:
*
* `"projects/my-logging-project"`
* `"organizations/123456789"`
* Please see {@see ConfigServiceV2Client::projectName()} for help formatting this field.
* @param string $exclusionName A client-assigned identifier, such as
* `"load-balancer-exclusion"`. Identifiers are limited to 100 characters and
* can include only letters, digits, underscores, hyphens, and periods. First
* character has to be alphanumeric.
* @param string $exclusionFilter An [advanced logs
* filter](https://cloud.google.com/logging/docs/view/advanced-queries) that
* matches the log entries to be excluded. By using the [sample
* function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
* you can exclude less than 100% of the matching log entries.
*
* For example, the following query matches 99% of low-severity log entries
* from Google Cloud Storage buckets:
*
* `resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)`
*/
function create_exclusion_sample(
string $formattedParent,
string $exclusionName,
string $exclusionFilter
): void {
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$exclusion = (new LogExclusion())
->setName($exclusionName)
->setFilter($exclusionFilter);
$request = (new CreateExclusionRequest())
->setParent($formattedParent)
->setExclusion($exclusion);
// Call the API and handle any network failures.
try {
/** @var LogExclusion $response */
$response = $configServiceV2Client->createExclusion($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
{
$formattedParent = ConfigServiceV2Client::projectName('[PROJECT]');
$exclusionName = '[NAME]';
$exclusionFilter = '[FILTER]';
create_exclusion_sample($formattedParent, $exclusionName, $exclusionFilter);
}
createLink
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
The async variant is ConfigServiceV2Client::createLinkAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateLinkRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CreateLinkRequest;
use Google\Cloud\Logging\V2\Link;
use Google\Rpc\Status;
/**
* @param string $formattedParent The full resource name of the bucket to create a link for.
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* Please see {@see ConfigServiceV2Client::logBucketName()} for help formatting this field.
* @param string $linkId The ID to use for the link. The link_id can have up to 100
* characters. A valid link_id must only have alphanumeric characters and
* underscores within it.
*/
function create_link_sample(string $formattedParent, string $linkId): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$link = new Link();
$request = (new CreateLinkRequest())
->setParent($formattedParent)
->setLink($link)
->setLinkId($linkId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $configServiceV2Client->createLink($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Link $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = ConfigServiceV2Client::logBucketName('[PROJECT]', '[LOCATION]', '[BUCKET]');
$linkId = '[LINK_ID]';
create_link_sample($formattedParent, $linkId);
}
createSink
Creates a sink that exports specified log entries to a destination. The
export of newly-ingested log entries begins immediately, unless the sink's
writer_identity
is not permitted to write to the destination. A sink can
export log entries only from the resource owning the sink.
The async variant is ConfigServiceV2Client::createSinkAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateSinkRequest
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\Logging\V2\LogSink |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CreateSinkRequest;
use Google\Cloud\Logging\V2\LogSink;
/**
* @param string $formattedParent The resource in which to create the sink:
*
* "projects/[PROJECT_ID]"
* "organizations/[ORGANIZATION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]"
* "folders/[FOLDER_ID]"
*
* For examples:
*
* `"projects/my-project"`
* `"organizations/123456789"`
* Please see {@see ConfigServiceV2Client::projectName()} for help formatting this field.
* @param string $sinkName The client-assigned sink identifier, unique within the project.
*
* For example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are limited
* to 100 characters and can include only the following characters: upper and
* lower-case alphanumeric characters, underscores, hyphens, and periods.
* First character has to be alphanumeric.
* @param string $sinkDestination The export destination:
*
* "storage.googleapis.com/[GCS_BUCKET]"
* "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
* "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
*
* The sink's `writer_identity`, set when the sink is created, must have
* permission to write to the destination or else the log entries are not
* exported. For more information, see
* [Exporting Logs with
* Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
*/
function create_sink_sample(
string $formattedParent,
string $sinkName,
string $sinkDestination
): void {
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$sink = (new LogSink())
->setName($sinkName)
->setDestination($sinkDestination);
$request = (new CreateSinkRequest())
->setParent($formattedParent)
->setSink($sink);
// Call the API and handle any network failures.
try {
/** @var LogSink $response */
$response = $configServiceV2Client->createSink($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
{
$formattedParent = ConfigServiceV2Client::projectName('[PROJECT]');
$sinkName = '[NAME]';
$sinkDestination = '[DESTINATION]';
create_sink_sample($formattedParent, $sinkName, $sinkDestination);
}
createView
Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
The async variant is ConfigServiceV2Client::createViewAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateViewRequest
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\Logging\V2\LogView |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CreateViewRequest;
use Google\Cloud\Logging\V2\LogView;
/**
* @param string $parent The bucket in which to create the view
*
* `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"`
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket"`
* @param string $viewId A client-assigned identifier such as `"my-view"`. Identifiers are
* limited to 100 characters and can include only letters, digits,
* underscores, hyphens, and periods.
*/
function create_view_sample(string $parent, string $viewId): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$view = new LogView();
$request = (new CreateViewRequest())
->setParent($parent)
->setViewId($viewId)
->setView($view);
// Call the API and handle any network failures.
try {
/** @var LogView $response */
$response = $configServiceV2Client->createView($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
{
$parent = '[PARENT]';
$viewId = '[VIEW_ID]';
create_view_sample($parent, $viewId);
}
deleteBucket
Deletes a log bucket.
Changes the bucket's lifecycle_state
to the DELETE_REQUESTED
state.
After 7 days, the bucket will be purged and all log entries in the bucket
will be permanently deleted.
The async variant is ConfigServiceV2Client::deleteBucketAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteBucketRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\DeleteBucketRequest;
/**
* @param string $formattedName The full resource name of the bucket to delete.
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket"`
* Please see {@see ConfigServiceV2Client::logBucketName()} for help formatting this field.
*/
function delete_bucket_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new DeleteBucketRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$configServiceV2Client->deleteBucket($request);
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
{
$formattedName = ConfigServiceV2Client::logBucketName('[PROJECT]', '[LOCATION]', '[BUCKET]');
delete_bucket_sample($formattedName);
}
deleteExclusion
Deletes an exclusion in the _Default sink.
The async variant is ConfigServiceV2Client::deleteExclusionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteExclusionRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\DeleteExclusionRequest;
/**
* @param string $formattedName The resource name of an existing exclusion to delete:
*
* "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
* "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
* "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
*
* For example:
*
* `"projects/my-project/exclusions/my-exclusion"`
* Please see {@see ConfigServiceV2Client::logExclusionName()} for help formatting this field.
*/
function delete_exclusion_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new DeleteExclusionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$configServiceV2Client->deleteExclusion($request);
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
{
$formattedName = ConfigServiceV2Client::logExclusionName('[PROJECT]', '[EXCLUSION]');
delete_exclusion_sample($formattedName);
}
deleteLink
Deletes a link. This will also delete the corresponding BigQuery linked dataset.
The async variant is ConfigServiceV2Client::deleteLinkAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteLinkRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\DeleteLinkRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The full resource name of the link to delete.
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
* Please see {@see ConfigServiceV2Client::linkName()} for help formatting this field.
*/
function delete_link_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new DeleteLinkRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $configServiceV2Client->deleteLink($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = ConfigServiceV2Client::linkName('[PROJECT]', '[LOCATION]', '[BUCKET]', '[LINK]');
delete_link_sample($formattedName);
}
deleteSink
Deletes a sink. If the sink has a unique writer_identity
, then that
service account is also deleted.
The async variant is ConfigServiceV2Client::deleteSinkAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteSinkRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\DeleteSinkRequest;
/**
* @param string $formattedSinkName The full resource name of the sink to delete, including the
* parent resource and the sink identifier:
*
* "projects/[PROJECT_ID]/sinks/[SINK_ID]"
* "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
* "folders/[FOLDER_ID]/sinks/[SINK_ID]"
*
* For example:
*
* `"projects/my-project/sinks/my-sink"`
* Please see {@see ConfigServiceV2Client::logSinkName()} for help formatting this field.
*/
function delete_sink_sample(string $formattedSinkName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new DeleteSinkRequest())
->setSinkName($formattedSinkName);
// Call the API and handle any network failures.
try {
$configServiceV2Client->deleteSink($request);
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
{
$formattedSinkName = ConfigServiceV2Client::logSinkName('[PROJECT]', '[SINK]');
delete_sink_sample($formattedSinkName);
}
deleteView
Deletes a view on a log bucket.
If an UNAVAILABLE
error is returned, this indicates that system is not in
a state where it can delete the view. If this occurs, please try again in a
few minutes.
The async variant is ConfigServiceV2Client::deleteViewAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteViewRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\DeleteViewRequest;
/**
* @param string $formattedName The full resource name of the view to delete:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket/views/my-view"`
* Please see {@see ConfigServiceV2Client::logViewName()} for help formatting this field.
*/
function delete_view_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new DeleteViewRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$configServiceV2Client->deleteView($request);
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
{
$formattedName = ConfigServiceV2Client::logViewName(
'[PROJECT]',
'[LOCATION]',
'[BUCKET]',
'[VIEW]'
);
delete_view_sample($formattedName);
}
getBucket
Gets a log bucket.
The async variant is ConfigServiceV2Client::getBucketAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetBucketRequest
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\Logging\V2\LogBucket |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\GetBucketRequest;
use Google\Cloud\Logging\V2\LogBucket;
/**
* @param string $formattedName The resource name of the bucket:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket"`
* Please see {@see ConfigServiceV2Client::logBucketName()} for help formatting this field.
*/
function get_bucket_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new GetBucketRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var LogBucket $response */
$response = $configServiceV2Client->getBucket($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 = ConfigServiceV2Client::logBucketName('[PROJECT]', '[LOCATION]', '[BUCKET]');
get_bucket_sample($formattedName);
}
getCmekSettings
Gets the Logging CMEK settings for the given resource.
Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.
See Enabling CMEK for Log Router for more information.
The async variant is ConfigServiceV2Client::getCmekSettingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetCmekSettingsRequest
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\Logging\V2\CmekSettings |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CmekSettings;
use Google\Cloud\Logging\V2\GetCmekSettingsRequest;
/**
* 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_cmek_settings_sample(): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = new GetCmekSettingsRequest();
// Call the API and handle any network failures.
try {
/** @var CmekSettings $response */
$response = $configServiceV2Client->getCmekSettings($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getExclusion
Gets the description of an exclusion in the _Default sink.
The async variant is ConfigServiceV2Client::getExclusionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetExclusionRequest
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\Logging\V2\LogExclusion |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\GetExclusionRequest;
use Google\Cloud\Logging\V2\LogExclusion;
/**
* @param string $formattedName The resource name of an existing exclusion:
*
* "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
* "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
* "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
*
* For example:
*
* `"projects/my-project/exclusions/my-exclusion"`
* Please see {@see ConfigServiceV2Client::logExclusionName()} for help formatting this field.
*/
function get_exclusion_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new GetExclusionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var LogExclusion $response */
$response = $configServiceV2Client->getExclusion($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 = ConfigServiceV2Client::logExclusionName('[PROJECT]', '[EXCLUSION]');
get_exclusion_sample($formattedName);
}
getLink
Gets a link.
The async variant is ConfigServiceV2Client::getLinkAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetLinkRequest
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\Logging\V2\Link |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\GetLinkRequest;
use Google\Cloud\Logging\V2\Link;
/**
* @param string $formattedName The resource name of the link:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]
* Please see {@see ConfigServiceV2Client::linkName()} for help formatting this field.
*/
function get_link_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new GetLinkRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Link $response */
$response = $configServiceV2Client->getLink($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 = ConfigServiceV2Client::linkName('[PROJECT]', '[LOCATION]', '[BUCKET]', '[LINK]');
get_link_sample($formattedName);
}
getSettings
Gets the Log Router settings for the given resource.
Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.
See Enabling CMEK for Log Router for more information.
The async variant is ConfigServiceV2Client::getSettingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetSettingsRequest
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\Logging\V2\Settings |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\GetSettingsRequest;
use Google\Cloud\Logging\V2\Settings;
/**
* @param string $formattedName The resource for which to retrieve settings.
*
* "projects/[PROJECT_ID]/settings"
* "organizations/[ORGANIZATION_ID]/settings"
* "billingAccounts/[BILLING_ACCOUNT_ID]/settings"
* "folders/[FOLDER_ID]/settings"
*
* For example:
*
* `"organizations/12345/settings"`
*
* Note: Settings for the Log Router can be get for Google Cloud projects,
* folders, organizations and billing accounts. Currently it can only be
* configured for organizations. Once configured for an organization, it
* applies to all projects and folders in the Google Cloud organization. Please see
* {@see ConfigServiceV2Client::settingsName()} for help formatting this field.
*/
function get_settings_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new GetSettingsRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Settings $response */
$response = $configServiceV2Client->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 = ConfigServiceV2Client::settingsName('[PROJECT]');
get_settings_sample($formattedName);
}
getSink
Gets a sink.
The async variant is ConfigServiceV2Client::getSinkAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetSinkRequest
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\Logging\V2\LogSink |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\GetSinkRequest;
use Google\Cloud\Logging\V2\LogSink;
/**
* @param string $formattedSinkName The resource name of the sink:
*
* "projects/[PROJECT_ID]/sinks/[SINK_ID]"
* "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
* "folders/[FOLDER_ID]/sinks/[SINK_ID]"
*
* For example:
*
* `"projects/my-project/sinks/my-sink"`
* Please see {@see ConfigServiceV2Client::logSinkName()} for help formatting this field.
*/
function get_sink_sample(string $formattedSinkName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new GetSinkRequest())
->setSinkName($formattedSinkName);
// Call the API and handle any network failures.
try {
/** @var LogSink $response */
$response = $configServiceV2Client->getSink($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
{
$formattedSinkName = ConfigServiceV2Client::logSinkName('[PROJECT]', '[SINK]');
get_sink_sample($formattedSinkName);
}
getView
Gets a view on a log bucket..
The async variant is ConfigServiceV2Client::getViewAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetViewRequest
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\Logging\V2\LogView |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\GetViewRequest;
use Google\Cloud\Logging\V2\LogView;
/**
* @param string $formattedName The resource name of the policy:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket/views/my-view"`
* Please see {@see ConfigServiceV2Client::logViewName()} for help formatting this field.
*/
function get_view_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new GetViewRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var LogView $response */
$response = $configServiceV2Client->getView($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 = ConfigServiceV2Client::logViewName(
'[PROJECT]',
'[LOCATION]',
'[BUCKET]',
'[VIEW]'
);
get_view_sample($formattedName);
}
listBuckets
Lists log buckets.
The async variant is ConfigServiceV2Client::listBucketsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListBucketsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\ListBucketsRequest;
use Google\Cloud\Logging\V2\LogBucket;
/**
* @param string $formattedParent The parent resource whose buckets are to be listed:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]"
*
* Note: The locations portion of the resource must be specified, but
* supplying the character `-` in place of [LOCATION_ID] will return all
* buckets. Please see
* {@see ConfigServiceV2Client::organizationLocationName()} for help formatting this field.
*/
function list_buckets_sample(string $formattedParent): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new ListBucketsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $configServiceV2Client->listBuckets($request);
/** @var LogBucket $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 = ConfigServiceV2Client::organizationLocationName('[ORGANIZATION]', '[LOCATION]');
list_buckets_sample($formattedParent);
}
listExclusions
Lists all the exclusions on the _Default sink in a parent resource.
The async variant is ConfigServiceV2Client::listExclusionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListExclusionsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\ListExclusionsRequest;
use Google\Cloud\Logging\V2\LogExclusion;
/**
* @param string $formattedParent The parent resource whose exclusions are to be listed.
*
* "projects/[PROJECT_ID]"
* "organizations/[ORGANIZATION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]"
* "folders/[FOLDER_ID]"
* Please see {@see ConfigServiceV2Client::projectName()} for help formatting this field.
*/
function list_exclusions_sample(string $formattedParent): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new ListExclusionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $configServiceV2Client->listExclusions($request);
/** @var LogExclusion $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 = ConfigServiceV2Client::projectName('[PROJECT]');
list_exclusions_sample($formattedParent);
}
listLinks
Lists links.
The async variant is ConfigServiceV2Client::listLinksAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListLinksRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\Link;
use Google\Cloud\Logging\V2\ListLinksRequest;
/**
* @param string $formattedParent The parent resource whose links are to be listed:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/
* Please see {@see ConfigServiceV2Client::logBucketName()} for help formatting this field.
*/
function list_links_sample(string $formattedParent): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new ListLinksRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $configServiceV2Client->listLinks($request);
/** @var Link $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 = ConfigServiceV2Client::logBucketName('[PROJECT]', '[LOCATION]', '[BUCKET]');
list_links_sample($formattedParent);
}
listSinks
Lists sinks.
The async variant is ConfigServiceV2Client::listSinksAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListSinksRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\ListSinksRequest;
use Google\Cloud\Logging\V2\LogSink;
/**
* @param string $formattedParent The parent resource whose sinks are to be listed:
*
* "projects/[PROJECT_ID]"
* "organizations/[ORGANIZATION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]"
* "folders/[FOLDER_ID]"
* Please see {@see ConfigServiceV2Client::projectName()} for help formatting this field.
*/
function list_sinks_sample(string $formattedParent): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new ListSinksRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $configServiceV2Client->listSinks($request);
/** @var LogSink $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 = ConfigServiceV2Client::projectName('[PROJECT]');
list_sinks_sample($formattedParent);
}
listViews
Lists views on a log bucket.
The async variant is ConfigServiceV2Client::listViewsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListViewsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\ListViewsRequest;
use Google\Cloud\Logging\V2\LogView;
/**
* @param string $parent The bucket whose views are to be listed:
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
*/
function list_views_sample(string $parent): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new ListViewsRequest())
->setParent($parent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $configServiceV2Client->listViews($request);
/** @var LogView $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
{
$parent = '[PARENT]';
list_views_sample($parent);
}
undeleteBucket
Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.
The async variant is ConfigServiceV2Client::undeleteBucketAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UndeleteBucketRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\UndeleteBucketRequest;
/**
* @param string $formattedName The full resource name of the bucket to undelete.
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket"`
* Please see {@see ConfigServiceV2Client::logBucketName()} for help formatting this field.
*/
function undelete_bucket_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = (new UndeleteBucketRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$configServiceV2Client->undeleteBucket($request);
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
{
$formattedName = ConfigServiceV2Client::logBucketName('[PROJECT]', '[LOCATION]', '[BUCKET]');
undelete_bucket_sample($formattedName);
}
updateBucket
Updates a log bucket.
If the bucket has a lifecycle_state
of DELETE_REQUESTED
, then
FAILED_PRECONDITION
will be returned.
After a bucket has been created, the bucket's location cannot be changed.
The async variant is ConfigServiceV2Client::updateBucketAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateBucketRequest
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\Logging\V2\LogBucket |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\LogBucket;
use Google\Cloud\Logging\V2\UpdateBucketRequest;
use Google\Protobuf\FieldMask;
/**
* @param string $formattedName The full resource name of the bucket to update.
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
* "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket"`
* Please see {@see ConfigServiceV2Client::logBucketName()} for help formatting this field.
*/
function update_bucket_sample(string $formattedName): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$bucket = new LogBucket();
$updateMask = new FieldMask();
$request = (new UpdateBucketRequest())
->setName($formattedName)
->setBucket($bucket)
->setUpdateMask($updateMask);
// Call the API and handle any network failures.
try {
/** @var LogBucket $response */
$response = $configServiceV2Client->updateBucket($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 = ConfigServiceV2Client::logBucketName('[PROJECT]', '[LOCATION]', '[BUCKET]');
update_bucket_sample($formattedName);
}
updateBucketAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateBucketRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogBucket> |
updateCmekSettings
Updates the Log Router CMEK settings for the given resource.
Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.
UpdateCmekSettings
will fail if 1) kms_key_name
is invalid, or 2) the associated service
account does not have the required
roles/cloudkms.cryptoKeyEncrypterDecrypter
role assigned for the key, or
3) access to the key is disabled.
See Enabling CMEK for Log Router for more information.
The async variant is ConfigServiceV2Client::updateCmekSettingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateCmekSettingsRequest
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\Logging\V2\CmekSettings |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\CmekSettings;
use Google\Cloud\Logging\V2\UpdateCmekSettingsRequest;
/**
* 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 update_cmek_settings_sample(): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$request = new UpdateCmekSettingsRequest();
// Call the API and handle any network failures.
try {
/** @var CmekSettings $response */
$response = $configServiceV2Client->updateCmekSettings($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateExclusion
Changes one or more properties of an existing exclusion in the _Default sink.
The async variant is ConfigServiceV2Client::updateExclusionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateExclusionRequest
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\Logging\V2\LogExclusion |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\LogExclusion;
use Google\Cloud\Logging\V2\UpdateExclusionRequest;
use Google\Protobuf\FieldMask;
/**
* @param string $formattedName The resource name of the exclusion to update:
*
* "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
* "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
* "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
*
* For example:
*
* `"projects/my-project/exclusions/my-exclusion"`
* Please see {@see ConfigServiceV2Client::logExclusionName()} for help formatting this field.
* @param string $exclusionName A client-assigned identifier, such as
* `"load-balancer-exclusion"`. Identifiers are limited to 100 characters and
* can include only letters, digits, underscores, hyphens, and periods. First
* character has to be alphanumeric.
* @param string $exclusionFilter An [advanced logs
* filter](https://cloud.google.com/logging/docs/view/advanced-queries) that
* matches the log entries to be excluded. By using the [sample
* function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
* you can exclude less than 100% of the matching log entries.
*
* For example, the following query matches 99% of low-severity log entries
* from Google Cloud Storage buckets:
*
* `resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)`
*/
function update_exclusion_sample(
string $formattedName,
string $exclusionName,
string $exclusionFilter
): void {
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$exclusion = (new LogExclusion())
->setName($exclusionName)
->setFilter($exclusionFilter);
$updateMask = new FieldMask();
$request = (new UpdateExclusionRequest())
->setName($formattedName)
->setExclusion($exclusion)
->setUpdateMask($updateMask);
// Call the API and handle any network failures.
try {
/** @var LogExclusion $response */
$response = $configServiceV2Client->updateExclusion($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 = ConfigServiceV2Client::logExclusionName('[PROJECT]', '[EXCLUSION]');
$exclusionName = '[NAME]';
$exclusionFilter = '[FILTER]';
update_exclusion_sample($formattedName, $exclusionName, $exclusionFilter);
}
updateSettings
Updates the Log Router settings for the given resource.
Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.
UpdateSettings
will fail if 1) kms_key_name
is invalid, or 2) the associated service
account does not have the required
roles/cloudkms.cryptoKeyEncrypterDecrypter
role assigned for the key, or
3) access to the key is disabled. 4) location_id
is not supported by
Logging. 5) location_id
violate OrgPolicy.
See Enabling CMEK for Log Router for more information.
The async variant is ConfigServiceV2Client::updateSettingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateSettingsRequest
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\Logging\V2\Settings |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\Settings;
use Google\Cloud\Logging\V2\UpdateSettingsRequest;
/**
* @param string $name The resource name for the settings to update.
*
* "organizations/[ORGANIZATION_ID]/settings"
*
* For example:
*
* `"organizations/12345/settings"`
*
* Note: Settings for the Log Router can currently only be configured for
* Google Cloud organizations. Once configured, it applies to all projects and
* folders in the Google Cloud organization.
*/
function update_settings_sample(string $name): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$settings = new Settings();
$request = (new UpdateSettingsRequest())
->setName($name)
->setSettings($settings);
// Call the API and handle any network failures.
try {
/** @var Settings $response */
$response = $configServiceV2Client->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
{
$name = '[NAME]';
update_settings_sample($name);
}
updateSink
Updates a sink. This method replaces the following fields in the existing
sink with values from the new sink: destination
, and filter
.
The updated sink might also have a new writer_identity
; see the
unique_writer_identity
field.
The async variant is ConfigServiceV2Client::updateSinkAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateSinkRequest
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\Logging\V2\LogSink |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\LogSink;
use Google\Cloud\Logging\V2\UpdateSinkRequest;
/**
* @param string $formattedSinkName The full resource name of the sink to update, including the
* parent resource and the sink identifier:
*
* "projects/[PROJECT_ID]/sinks/[SINK_ID]"
* "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
* "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
* "folders/[FOLDER_ID]/sinks/[SINK_ID]"
*
* For example:
*
* `"projects/my-project/sinks/my-sink"`
* Please see {@see ConfigServiceV2Client::logSinkName()} for help formatting this field.
* @param string $sinkName The client-assigned sink identifier, unique within the project.
*
* For example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are limited
* to 100 characters and can include only the following characters: upper and
* lower-case alphanumeric characters, underscores, hyphens, and periods.
* First character has to be alphanumeric.
* @param string $sinkDestination The export destination:
*
* "storage.googleapis.com/[GCS_BUCKET]"
* "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
* "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
*
* The sink's `writer_identity`, set when the sink is created, must have
* permission to write to the destination or else the log entries are not
* exported. For more information, see
* [Exporting Logs with
* Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
*/
function update_sink_sample(
string $formattedSinkName,
string $sinkName,
string $sinkDestination
): void {
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$sink = (new LogSink())
->setName($sinkName)
->setDestination($sinkDestination);
$request = (new UpdateSinkRequest())
->setSinkName($formattedSinkName)
->setSink($sink);
// Call the API and handle any network failures.
try {
/** @var LogSink $response */
$response = $configServiceV2Client->updateSink($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
{
$formattedSinkName = ConfigServiceV2Client::logSinkName('[PROJECT]', '[SINK]');
$sinkName = '[NAME]';
$sinkDestination = '[DESTINATION]';
update_sink_sample($formattedSinkName, $sinkName, $sinkDestination);
}
updateView
Updates a view on a log bucket. This method replaces the following fields
in the existing view with values from the new view: filter
.
If an UNAVAILABLE
error is returned, this indicates that system is not in
a state where it can update the view. If this occurs, please try again in a
few minutes.
The async variant is ConfigServiceV2Client::updateViewAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateViewRequest
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\Logging\V2\LogView |
use Google\ApiCore\ApiException;
use Google\Cloud\Logging\V2\Client\ConfigServiceV2Client;
use Google\Cloud\Logging\V2\LogView;
use Google\Cloud\Logging\V2\UpdateViewRequest;
/**
* @param string $name The full resource name of the view to update
*
* "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
*
* For example:
*
* `"projects/my-project/locations/global/buckets/my-bucket/views/my-view"`
*/
function update_view_sample(string $name): void
{
// Create a client.
$configServiceV2Client = new ConfigServiceV2Client();
// Prepare the request message.
$view = new LogView();
$request = (new UpdateViewRequest())
->setName($name)
->setView($view);
// Call the API and handle any network failures.
try {
/** @var LogView $response */
$response = $configServiceV2Client->updateView($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
{
$name = '[NAME]';
update_view_sample($name);
}
copyLogEntriesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CopyLogEntriesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createBucketAsyncAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateBucketRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createExclusionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateExclusionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogExclusion> |
createLinkAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateLinkRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createSinkAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateSinkRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogSink> |
createViewAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\CreateViewRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogView> |
deleteBucketAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteBucketRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
deleteExclusionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteExclusionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
deleteLinkAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteLinkRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteSinkAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteSinkRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
deleteViewAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\DeleteViewRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getBucketAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetBucketRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogBucket> |
getCmekSettingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetCmekSettingsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\CmekSettings> |
getExclusionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetExclusionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogExclusion> |
getLinkAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetLinkRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\Link> |
getSettingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetSettingsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\Settings> |
getSinkAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetSinkRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogSink> |
getViewAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\GetViewRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogView> |
listBucketsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListBucketsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listExclusionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListExclusionsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listLinksAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListLinksRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listSinksAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListSinksRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listViewsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\ListViewsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
undeleteBucketAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UndeleteBucketRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
updateBucketAsyncAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateBucketRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
updateCmekSettingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateCmekSettingsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\CmekSettings> |
updateExclusionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateExclusionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogExclusion> |
updateSettingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateSettingsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\Settings> |
updateSinkAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateSinkRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogSink> |
updateViewAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Logging\V2\UpdateViewRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Logging\V2\LogView> |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::billingAccountName
Formats a string containing the fully-qualified path to represent a billing_account resource.
Parameter | |
---|---|
Name | Description |
billingAccount |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account resource. |
static::billingAccountCmekSettingsName
Formats a string containing the fully-qualified path to represent a billing_account_cmekSettings resource.
Parameter | |
---|---|
Name | Description |
billingAccount |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_cmekSettings resource. |
static::billingAccountExclusionName
Formats a string containing the fully-qualified path to represent a billing_account_exclusion resource.
Parameters | |
---|---|
Name | Description |
billingAccount |
string
|
exclusion |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_exclusion resource. |
static::billingAccountLocationName
Formats a string containing the fully-qualified path to represent a billing_account_location resource.
Parameters | |
---|---|
Name | Description |
billingAccount |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_location resource. |
static::billingAccountLocationBucketName
Formats a string containing the fully-qualified path to represent a billing_account_location_bucket resource.
Parameters | |
---|---|
Name | Description |
billingAccount |
string
|
location |
string
|
bucket |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_location_bucket resource. |
static::billingAccountLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a billing_account_location_bucket_link resource.
Parameters | |
---|---|
Name | Description |
billingAccount |
string
|
location |
string
|
bucket |
string
|
link |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_location_bucket_link resource. |
static::billingAccountLocationBucketViewName
Formats a string containing the fully-qualified path to represent a billing_account_location_bucket_view resource.
Parameters | |
---|---|
Name | Description |
billingAccount |
string
|
location |
string
|
bucket |
string
|
view |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_location_bucket_view resource. |
static::billingAccountSettingsName
Formats a string containing the fully-qualified path to represent a billing_account_settings resource.
Parameter | |
---|---|
Name | Description |
billingAccount |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_settings resource. |
static::billingAccountSinkName
Formats a string containing the fully-qualified path to represent a billing_account_sink resource.
Parameters | |
---|---|
Name | Description |
billingAccount |
string
|
sink |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted billing_account_sink resource. |
static::cmekSettingsName
Formats a string containing the fully-qualified path to represent a cmek_settings resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted cmek_settings resource. |
static::folderName
Formats a string containing the fully-qualified path to represent a folder resource.
Parameter | |
---|---|
Name | Description |
folder |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder resource. |
static::folderCmekSettingsName
Formats a string containing the fully-qualified path to represent a folder_cmekSettings resource.
Parameter | |
---|---|
Name | Description |
folder |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_cmekSettings resource. |
static::folderExclusionName
Formats a string containing the fully-qualified path to represent a folder_exclusion resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
exclusion |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_exclusion resource. |
static::folderLocationName
Formats a string containing the fully-qualified path to represent a folder_location resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_location resource. |
static::folderLocationBucketName
Formats a string containing the fully-qualified path to represent a folder_location_bucket resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
bucket |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_location_bucket resource. |
static::folderLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a folder_location_bucket_link resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
bucket |
string
|
link |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_location_bucket_link resource. |
static::folderLocationBucketViewName
Formats a string containing the fully-qualified path to represent a folder_location_bucket_view resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
bucket |
string
|
view |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_location_bucket_view resource. |
static::folderSettingsName
Formats a string containing the fully-qualified path to represent a folder_settings resource.
Parameter | |
---|---|
Name | Description |
folder |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_settings resource. |
static::folderSinkName
Formats a string containing the fully-qualified path to represent a folder_sink resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
sink |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted folder_sink resource. |
static::linkName
Formats a string containing the fully-qualified path to represent a link resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
bucket |
string
|
link |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted link 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::logBucketName
Formats a string containing the fully-qualified path to represent a log_bucket resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
bucket |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted log_bucket resource. |
static::logExclusionName
Formats a string containing the fully-qualified path to represent a log_exclusion resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
exclusion |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted log_exclusion resource. |
static::logSinkName
Formats a string containing the fully-qualified path to represent a log_sink resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
sink |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted log_sink resource. |
static::logViewName
Formats a string containing the fully-qualified path to represent a log_view resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
bucket |
string
|
view |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted log_view resource. |
static::organizationName
Formats a string containing the fully-qualified path to represent a organization resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization resource. |
static::organizationCmekSettingsName
Formats a string containing the fully-qualified path to represent a organization_cmekSettings resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_cmekSettings resource. |
static::organizationExclusionName
Formats a string containing the fully-qualified path to represent a organization_exclusion resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
exclusion |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_exclusion 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::organizationLocationBucketName
Formats a string containing the fully-qualified path to represent a organization_location_bucket resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
bucket |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_location_bucket resource. |
static::organizationLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a organization_location_bucket_link resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
bucket |
string
|
link |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_location_bucket_link resource. |
static::organizationLocationBucketViewName
Formats a string containing the fully-qualified path to represent a organization_location_bucket_view resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
bucket |
string
|
view |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_location_bucket_view resource. |
static::organizationSettingsName
Formats a string containing the fully-qualified path to represent a organization_settings resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_settings resource. |
static::organizationSinkName
Formats a string containing the fully-qualified path to represent a organization_sink resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
sink |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_sink resource. |
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project resource. |
static::projectCmekSettingsName
Formats a string containing the fully-qualified path to represent a project_cmekSettings resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_cmekSettings resource. |
static::projectExclusionName
Formats a string containing the fully-qualified path to represent a project_exclusion resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
exclusion |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_exclusion resource. |
static::projectLocationBucketName
Formats a string containing the fully-qualified path to represent a project_location_bucket resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
bucket |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_bucket resource. |
static::projectLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a project_location_bucket_link resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
bucket |
string
|
link |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_bucket_link resource. |
static::projectLocationBucketViewName
Formats a string containing the fully-qualified path to represent a project_location_bucket_view resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
bucket |
string
|
view |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_bucket_view resource. |
static::projectSettingsName
Formats a string containing the fully-qualified path to represent a project_settings resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_settings resource. |
static::projectSinkName
Formats a string containing the fully-qualified path to represent a project_sink resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
sink |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_sink resource. |
static::settingsName
Formats a string containing the fully-qualified path to represent a settings resource.
Parameter | |
---|---|
Name | Description |
project |
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
- billingAccount: billingAccounts/{billing_account}
- billingAccountCmekSettings: billingAccounts/{billing_account}/cmekSettings
- billingAccountExclusion: billingAccounts/{billing_account}/exclusions/{exclusion}
- billingAccountLocation: billingAccounts/{billing_account}/locations/{location}
- billingAccountLocationBucket: billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}
- billingAccountLocationBucketLink: billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}
- billingAccountLocationBucketView: billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/views/{view}
- billingAccountSettings: billingAccounts/{billing_account}/settings
- billingAccountSink: billingAccounts/{billing_account}/sinks/{sink}
- cmekSettings: projects/{project}/cmekSettings
- folder: folders/{folder}
- folderCmekSettings: folders/{folder}/cmekSettings
- folderExclusion: folders/{folder}/exclusions/{exclusion}
- folderLocation: folders/{folder}/locations/{location}
- folderLocationBucket: folders/{folder}/locations/{location}/buckets/{bucket}
- folderLocationBucketLink: folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}
- folderLocationBucketView: folders/{folder}/locations/{location}/buckets/{bucket}/views/{view}
- folderSettings: folders/{folder}/settings
- folderSink: folders/{folder}/sinks/{sink}
- link: projects/{project}/locations/{location}/buckets/{bucket}/links/{link}
- location: projects/{project}/locations/{location}
- logBucket: projects/{project}/locations/{location}/buckets/{bucket}
- logExclusion: projects/{project}/exclusions/{exclusion}
- logSink: projects/{project}/sinks/{sink}
- logView: projects/{project}/locations/{location}/buckets/{bucket}/views/{view}
- organization: organizations/{organization}
- organizationCmekSettings: organizations/{organization}/cmekSettings
- organizationExclusion: organizations/{organization}/exclusions/{exclusion}
- organizationLocation: organizations/{organization}/locations/{location}
- organizationLocationBucket: organizations/{organization}/locations/{location}/buckets/{bucket}
- organizationLocationBucketLink: organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}
- organizationLocationBucketView: organizations/{organization}/locations/{location}/buckets/{bucket}/views/{view}
- organizationSettings: organizations/{organization}/settings
- organizationSink: organizations/{organization}/sinks/{sink}
- project: projects/{project}
- projectCmekSettings: projects/{project}/cmekSettings
- projectExclusion: projects/{project}/exclusions/{exclusion}
- projectLocationBucket: projects/{project}/locations/{location}/buckets/{bucket}
- projectLocationBucketLink: projects/{project}/locations/{location}/buckets/{bucket}/links/{link}
- projectLocationBucketView: projects/{project}/locations/{location}/buckets/{bucket}/views/{view}
- projectSettings: projects/{project}/settings
- projectSink: projects/{project}/sinks/{sink}
- settings: projects/{project}/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. |