Reference documentation and code samples for the Stackdriver Error Reporting V1beta1 Client class ErrorGroupServiceClient.
Service Description: Service for retrieving and updating individual error groups.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ ErrorReporting \ V1beta1 \ 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. |
getGroup
Get the specified group.
The async variant is Google\Cloud\ErrorReporting\V1beta1\Client\BaseClient\self::getGroupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ErrorReporting\V1beta1\GetGroupRequest
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\ErrorReporting\V1beta1\ErrorGroup |
use Google\ApiCore\ApiException;
use Google\Cloud\ErrorReporting\V1beta1\Client\ErrorGroupServiceClient;
use Google\Cloud\ErrorReporting\V1beta1\ErrorGroup;
use Google\Cloud\ErrorReporting\V1beta1\GetGroupRequest;
/**
* @param string $formattedGroupName The group resource name. Written as
* `projects/{projectID}/groups/{group_name}`. Call
* [`groupStats.list`](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list)
* to return a list of groups belonging to this project.
*
* Example: `projects/my-project-123/groups/my-group`
* Please see {@see ErrorGroupServiceClient::errorGroupName()} for help formatting this field.
*/
function get_group_sample(string $formattedGroupName): void
{
// Create a client.
$errorGroupServiceClient = new ErrorGroupServiceClient();
// Prepare the request message.
$request = (new GetGroupRequest())
->setGroupName($formattedGroupName);
// Call the API and handle any network failures.
try {
/** @var ErrorGroup $response */
$response = $errorGroupServiceClient->getGroup($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
{
$formattedGroupName = ErrorGroupServiceClient::errorGroupName('[PROJECT]', '[GROUP]');
get_group_sample($formattedGroupName);
}
updateGroup
Replace the data for the specified group.
Fails if the group does not exist.
The async variant is Google\Cloud\ErrorReporting\V1beta1\Client\BaseClient\self::updateGroupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ErrorReporting\V1beta1\UpdateGroupRequest
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\ErrorReporting\V1beta1\ErrorGroup |
use Google\ApiCore\ApiException;
use Google\Cloud\ErrorReporting\V1beta1\Client\ErrorGroupServiceClient;
use Google\Cloud\ErrorReporting\V1beta1\ErrorGroup;
use Google\Cloud\ErrorReporting\V1beta1\UpdateGroupRequest;
/**
* 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_group_sample(): void
{
// Create a client.
$errorGroupServiceClient = new ErrorGroupServiceClient();
// Prepare the request message.
$group = new ErrorGroup();
$request = (new UpdateGroupRequest())
->setGroup($group);
// Call the API and handle any network failures.
try {
/** @var ErrorGroup $response */
$response = $errorGroupServiceClient->updateGroup($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getGroupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ErrorReporting\V1beta1\GetGroupRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateGroupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ErrorReporting\V1beta1\UpdateGroupRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
static::errorGroupName
Formats a string containing the fully-qualified path to represent a error_group resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
group |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted error_group 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
- errorGroup: projects/{project}/groups/{group}
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. |