Reference documentation and code samples for the Google Cloud Support V2 Client class CaseServiceClient.
Service Description: A service to manage Google Cloud support cases.
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 \ Support \ 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. |
closeCase
Close the specified case.
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::closeCaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\CloseCaseRequest
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\Support\V2\PBCase |
use Google\ApiCore\ApiException;
use Google\Cloud\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\CloseCaseRequest;
use Google\Cloud\Support\V2\PBCase;
/**
* @param string $formattedName The fully qualified name of the case resource to be closed. Please see
* {@see CaseServiceClient::caseName()} for help formatting this field.
*/
function close_case_sample(string $formattedName): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$request = (new CloseCaseRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PBCase $response */
$response = $caseServiceClient->closeCase($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 = CaseServiceClient::caseName('[ORGANIZATION]', '[CASE]');
close_case_sample($formattedName);
}
createCase
Create a new case and associate it with the given Google Cloud Resource.
The case object must have the following fields set: display_name
,
description
, classification
, and priority
.
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::createCaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\CreateCaseRequest
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\Support\V2\PBCase |
use Google\ApiCore\ApiException;
use Google\Cloud\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\CreateCaseRequest;
use Google\Cloud\Support\V2\PBCase;
/**
* @param string $formattedParent The name of the Google Cloud Resource under which the case should
* be created. Please see
* {@see CaseServiceClient::projectName()} for help formatting this field.
*/
function create_case_sample(string $formattedParent): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$case = new PBCase();
$request = (new CreateCaseRequest())
->setParent($formattedParent)
->setCase($case);
// Call the API and handle any network failures.
try {
/** @var PBCase $response */
$response = $caseServiceClient->createCase($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 = CaseServiceClient::projectName('[PROJECT]');
create_case_sample($formattedParent);
}
escalateCase
Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process.
This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::escalateCaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\EscalateCaseRequest
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\Support\V2\PBCase |
use Google\ApiCore\ApiException;
use Google\Cloud\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\EscalateCaseRequest;
use Google\Cloud\Support\V2\PBCase;
/**
* @param string $formattedName The fully qualified name of the Case resource to be escalated. Please see
* {@see CaseServiceClient::caseName()} for help formatting this field.
*/
function escalate_case_sample(string $formattedName): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$request = (new EscalateCaseRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PBCase $response */
$response = $caseServiceClient->escalateCase($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 = CaseServiceClient::caseName('[ORGANIZATION]', '[CASE]');
escalate_case_sample($formattedName);
}
getCase
Retrieve the specified case.
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::getCaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\GetCaseRequest
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\Support\V2\PBCase |
use Google\ApiCore\ApiException;
use Google\Cloud\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\GetCaseRequest;
use Google\Cloud\Support\V2\PBCase;
/**
* @param string $formattedName The fully qualified name of a case to be retrieved. Please see
* {@see CaseServiceClient::caseName()} for help formatting this field.
*/
function get_case_sample(string $formattedName): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$request = (new GetCaseRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PBCase $response */
$response = $caseServiceClient->getCase($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 = CaseServiceClient::caseName('[ORGANIZATION]', '[CASE]');
get_case_sample($formattedName);
}
listCases
Retrieve all cases under the specified parent.
Note: Listing cases under an Organization returns only the cases directly
parented by that organization. To retrieve all cases under an organization,
including cases parented by projects under that organization, use
cases.search
.
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::listCasesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\ListCasesRequest
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\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\ListCasesRequest;
use Google\Cloud\Support\V2\PBCase;
/**
* @param string $formattedParent The fully qualified name of parent resource to list cases under. Please see
* {@see CaseServiceClient::projectName()} for help formatting this field.
*/
function list_cases_sample(string $formattedParent): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$request = (new ListCasesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $caseServiceClient->listCases($request);
/** @var PBCase $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 = CaseServiceClient::projectName('[PROJECT]');
list_cases_sample($formattedParent);
}
searchCaseClassifications
Retrieve valid classifications to be used when creating a support case.
The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by " > ". For example "Technical Issue > Compute > Compute Engine".
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::searchCaseClassificationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\SearchCaseClassificationsRequest
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\Support\V2\CaseClassification;
use Google\Cloud\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\SearchCaseClassificationsRequest;
/**
* 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 search_case_classifications_sample(): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$request = new SearchCaseClassificationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $caseServiceClient->searchCaseClassifications($request);
/** @var CaseClassification $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());
}
}
searchCases
Search cases using the specified query.
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::searchCasesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\SearchCasesRequest
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\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\PBCase;
use Google\Cloud\Support\V2\SearchCasesRequest;
/**
* 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 search_cases_sample(): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$request = new SearchCasesRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $caseServiceClient->searchCases($request);
/** @var PBCase $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());
}
}
updateCase
Update the specified case. Only a subset of fields can be updated.
The async variant is Google\Cloud\Support\V2\Client\CaseServiceClient::updateCaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\UpdateCaseRequest
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\Support\V2\PBCase |
use Google\ApiCore\ApiException;
use Google\Cloud\Support\V2\Client\CaseServiceClient;
use Google\Cloud\Support\V2\PBCase;
use Google\Cloud\Support\V2\UpdateCaseRequest;
/**
* 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_case_sample(): void
{
// Create a client.
$caseServiceClient = new CaseServiceClient();
// Prepare the request message.
$case = new PBCase();
$request = (new UpdateCaseRequest())
->setCase($case);
// Call the API and handle any network failures.
try {
/** @var PBCase $response */
$response = $caseServiceClient->updateCase($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
closeCaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\CloseCaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createCaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\CreateCaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
escalateCaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\EscalateCaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getCaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\GetCaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listCasesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\ListCasesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
searchCaseClassificationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\SearchCaseClassificationsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
searchCasesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\SearchCasesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateCaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Support\V2\UpdateCaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
static::caseName
Formats a string containing the fully-qualified path to represent a case resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
case |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted case 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::organizationCaseName
Formats a string containing the fully-qualified path to represent a organization_case resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
case |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted organization_case 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::projectCaseName
Formats a string containing the fully-qualified path to represent a project_case resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
case |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_case 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
- case: organizations/{organization}/cases/{case}
- organization: organizations/{organization}
- organizationCase: organizations/{organization}/cases/{case}
- project: projects/{project}
- projectCase: projects/{project}/cases/{case}
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. |