Google Cloud Quotas V1 Client - Class CloudQuotasClient (0.2.3)

Reference documentation and code samples for the Google Cloud Quotas V1 Client class CloudQuotasClient.

Service Description: The Cloud Quotas API is an infrastructure service for Google Cloud that lets service consumers list and manage their resource usage limits.

List/Get the metadata and current status of the quotas for a service.
Create/Update quota preferencess that declare the preferred quota values.
Check the status of a quota preference request.
List/Get pending and historical quota preference.

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 \ CloudQuotas \ V1 \ Client

Methods

__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 `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createQuotaPreference

Creates a new QuotaPreference that declares the desired value for a quota.

The async variant is Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient::createQuotaPreferenceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\CreateQuotaPreferenceRequest` 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\CloudQuotas\V1\QuotaPreference`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient;
use Google\Cloud\CloudQuotas\V1\CreateQuotaPreferenceRequest;
use Google\Cloud\CloudQuotas\V1\QuotaConfig;
use Google\Cloud\CloudQuotas\V1\QuotaPreference;

/**
 * @param string $formattedParent                          Value for parent.
 *
 *                                                         Example:
 *                                                         `projects/123/locations/global`
 *                                                         Please see {@see CloudQuotasClient::locationName()} for help formatting this field.
 * @param int    $quotaPreferenceQuotaConfigPreferredValue The preferred value. Must be greater than or equal to -1. If set
 *                                                         to -1, it means the value is "unlimited".
 * @param string $quotaPreferenceService                   The name of the service to which the quota preference is applied.
 * @param string $quotaPreferenceQuotaId                   The id of the quota to which the quota preference is applied. A
 *                                                         quota name is unique in the service. Example: `CpusPerProjectPerRegion`
 */
function create_quota_preference_sample(
    string $formattedParent,
    int $quotaPreferenceQuotaConfigPreferredValue,
    string $quotaPreferenceService,
    string $quotaPreferenceQuotaId
): void {
    // Create a client.
    $cloudQuotasClient = new CloudQuotasClient();

    // Prepare the request message.
    $quotaPreferenceQuotaConfig = (new QuotaConfig())
        ->setPreferredValue($quotaPreferenceQuotaConfigPreferredValue);
    $quotaPreference = (new QuotaPreference())
        ->setQuotaConfig($quotaPreferenceQuotaConfig)
        ->setService($quotaPreferenceService)
        ->setQuotaId($quotaPreferenceQuotaId);
    $request = (new CreateQuotaPreferenceRequest())
        ->setParent($formattedParent)
        ->setQuotaPreference($quotaPreference);

    // Call the API and handle any network failures.
    try {
        /** @var QuotaPreference $response */
        $response = $cloudQuotasClient->createQuotaPreference($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 = CloudQuotasClient::locationName('[PROJECT]', '[LOCATION]');
    $quotaPreferenceQuotaConfigPreferredValue = 0;
    $quotaPreferenceService = '[SERVICE]';
    $quotaPreferenceQuotaId = '[QUOTA_ID]';

    create_quota_preference_sample(
        $formattedParent,
        $quotaPreferenceQuotaConfigPreferredValue,
        $quotaPreferenceService,
        $quotaPreferenceQuotaId
    );
}

getQuotaInfo

Retrieve the QuotaInfo of a quota for a project, folder or organization.

The async variant is Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient::getQuotaInfoAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\GetQuotaInfoRequest` 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\CloudQuotas\V1\QuotaInfo`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient;
use Google\Cloud\CloudQuotas\V1\GetQuotaInfoRequest;
use Google\Cloud\CloudQuotas\V1\QuotaInfo;

/**
 * @param string $formattedName The resource name of the quota info.
 *
 *                              An example name:
 *                              `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
 *                              Please see {@see CloudQuotasClient::quotaInfoName()} for help formatting this field.
 */
function get_quota_info_sample(string $formattedName): void
{
    // Create a client.
    $cloudQuotasClient = new CloudQuotasClient();

    // Prepare the request message.
    $request = (new GetQuotaInfoRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var QuotaInfo $response */
        $response = $cloudQuotasClient->getQuotaInfo($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 = CloudQuotasClient::quotaInfoName(
        '[PROJECT]',
        '[LOCATION]',
        '[SERVICE]',
        '[QUOTA_INFO]'
    );

    get_quota_info_sample($formattedName);
}

getQuotaPreference

Gets details of a single QuotaPreference.

The async variant is Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient::getQuotaPreferenceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\GetQuotaPreferenceRequest` 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\CloudQuotas\V1\QuotaPreference`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient;
use Google\Cloud\CloudQuotas\V1\GetQuotaPreferenceRequest;
use Google\Cloud\CloudQuotas\V1\QuotaPreference;

/**
 * @param string $formattedName Name of the resource
 *
 *                              Example name:
 *                              `projects/123/locations/global/quota_preferences/my-config-for-us-east1`
 *                              Please see {@see CloudQuotasClient::quotaPreferenceName()} for help formatting this field.
 */
function get_quota_preference_sample(string $formattedName): void
{
    // Create a client.
    $cloudQuotasClient = new CloudQuotasClient();

    // Prepare the request message.
    $request = (new GetQuotaPreferenceRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var QuotaPreference $response */
        $response = $cloudQuotasClient->getQuotaPreference($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 = CloudQuotasClient::quotaPreferenceName(
        '[PROJECT]',
        '[LOCATION]',
        '[QUOTA_PREFERENCE]'
    );

    get_quota_preference_sample($formattedName);
}

listQuotaInfos

Lists QuotaInfos of all quotas for a given project, folder or organization.

The async variant is Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient::listQuotaInfosAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\ListQuotaInfosRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient;
use Google\Cloud\CloudQuotas\V1\ListQuotaInfosRequest;
use Google\Cloud\CloudQuotas\V1\QuotaInfo;

/**
 * @param string $formattedParent Parent value of QuotaInfo resources.
 *                                Listing across different resource containers (such as 'projects/-') is not
 *                                allowed.
 *
 *                                Example names:
 *                                `projects/123/locations/global/services/compute.googleapis.com`
 *                                `folders/234/locations/global/services/compute.googleapis.com`
 *                                `organizations/345/locations/global/services/compute.googleapis.com`
 *                                Please see {@see CloudQuotasClient::serviceName()} for help formatting this field.
 */
function list_quota_infos_sample(string $formattedParent): void
{
    // Create a client.
    $cloudQuotasClient = new CloudQuotasClient();

    // Prepare the request message.
    $request = (new ListQuotaInfosRequest())
        ->setParent($formattedParent);

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

        /** @var QuotaInfo $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 = CloudQuotasClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');

    list_quota_infos_sample($formattedParent);
}

listQuotaPreferences

Lists QuotaPreferences in a given project, folder or organization.

The async variant is Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient::listQuotaPreferencesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\ListQuotaPreferencesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient;
use Google\Cloud\CloudQuotas\V1\ListQuotaPreferencesRequest;
use Google\Cloud\CloudQuotas\V1\QuotaPreference;

/**
 * @param string $formattedParent Parent value of QuotaPreference resources.
 *                                Listing across different resource containers (such as 'projects/-') is not
 *                                allowed.
 *
 *                                When the value starts with 'folders' or 'organizations', it lists the
 *                                QuotaPreferences for org quotas in the container. It does not list the
 *                                QuotaPreferences in the descendant projects of the container.
 *
 *                                Example parents:
 *                                `projects/123/locations/global`
 *                                Please see {@see CloudQuotasClient::locationName()} for help formatting this field.
 */
function list_quota_preferences_sample(string $formattedParent): void
{
    // Create a client.
    $cloudQuotasClient = new CloudQuotasClient();

    // Prepare the request message.
    $request = (new ListQuotaPreferencesRequest())
        ->setParent($formattedParent);

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

        /** @var QuotaPreference $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 = CloudQuotasClient::locationName('[PROJECT]', '[LOCATION]');

    list_quota_preferences_sample($formattedParent);
}

updateQuotaPreference

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

The async variant is Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient::updateQuotaPreferenceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\UpdateQuotaPreferenceRequest` 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\CloudQuotas\V1\QuotaPreference`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\CloudQuotas\V1\Client\CloudQuotasClient;
use Google\Cloud\CloudQuotas\V1\QuotaConfig;
use Google\Cloud\CloudQuotas\V1\QuotaPreference;
use Google\Cloud\CloudQuotas\V1\UpdateQuotaPreferenceRequest;

/**
 * @param int    $quotaPreferenceQuotaConfigPreferredValue The preferred value. Must be greater than or equal to -1. If set
 *                                                         to -1, it means the value is "unlimited".
 * @param string $quotaPreferenceService                   The name of the service to which the quota preference is applied.
 * @param string $quotaPreferenceQuotaId                   The id of the quota to which the quota preference is applied. A
 *                                                         quota name is unique in the service. Example: `CpusPerProjectPerRegion`
 */
function update_quota_preference_sample(
    int $quotaPreferenceQuotaConfigPreferredValue,
    string $quotaPreferenceService,
    string $quotaPreferenceQuotaId
): void {
    // Create a client.
    $cloudQuotasClient = new CloudQuotasClient();

    // Prepare the request message.
    $quotaPreferenceQuotaConfig = (new QuotaConfig())
        ->setPreferredValue($quotaPreferenceQuotaConfigPreferredValue);
    $quotaPreference = (new QuotaPreference())
        ->setQuotaConfig($quotaPreferenceQuotaConfig)
        ->setService($quotaPreferenceService)
        ->setQuotaId($quotaPreferenceQuotaId);
    $request = (new UpdateQuotaPreferenceRequest())
        ->setQuotaPreference($quotaPreference);

    // Call the API and handle any network failures.
    try {
        /** @var QuotaPreference $response */
        $response = $cloudQuotasClient->updateQuotaPreference($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
{
    $quotaPreferenceQuotaConfigPreferredValue = 0;
    $quotaPreferenceService = '[SERVICE]';
    $quotaPreferenceQuotaId = '[QUOTA_ID]';

    update_quota_preference_sample(
        $quotaPreferenceQuotaConfigPreferredValue,
        $quotaPreferenceService,
        $quotaPreferenceQuotaId
    );
}

createQuotaPreferenceAsync

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\CreateQuotaPreferenceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getQuotaInfoAsync

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\GetQuotaInfoRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getQuotaPreferenceAsync

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\GetQuotaPreferenceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listQuotaInfosAsync

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\ListQuotaInfosRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listQuotaPreferencesAsync

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\ListQuotaPreferencesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateQuotaPreferenceAsync

Parameters
Name	Description
`request`	`Google\Cloud\CloudQuotas\V1\UpdateQuotaPreferenceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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::folderLocationQuotaPreferenceName

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

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`quotaPreference`	`string`

Returns
Type	Description
`string`	The formatted folder_location_quota_preference resource.

static::folderLocationServiceName

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

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted folder_location_service resource.

static::folderLocationServiceQuotaInfoName

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

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`service`	`string`
`quotaInfo`	`string`

Returns
Type	Description
`string`	The formatted folder_location_service_quota_info 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::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::organizationLocationQuotaPreferenceName

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

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`quotaPreference`	`string`

Returns
Type	Description
`string`	The formatted organization_location_quota_preference resource.

static::organizationLocationServiceName

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

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted organization_location_service resource.

static::organizationLocationServiceQuotaInfoName

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

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`service`	`string`
`quotaInfo`	`string`

Returns
Type	Description
`string`	The formatted organization_location_service_quota_info resource.

static::projectLocationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted project_location resource.

static::projectLocationQuotaPreferenceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`quotaPreference`	`string`

Returns
Type	Description
`string`	The formatted project_location_quota_preference resource.

static::projectLocationServiceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted project_location_service resource.

static::projectLocationServiceQuotaInfoName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`service`	`string`
`quotaInfo`	`string`

Returns
Type	Description
`string`	The formatted project_location_service_quota_info resource.

static::quotaInfoName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`service`	`string`
`quotaInfo`	`string`

Returns
Type	Description
`string`	The formatted quota_info resource.

static::quotaPreferenceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`quotaPreference`	`string`

Returns
Type	Description
`string`	The formatted quota_preference resource.

static::serviceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted service 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

folderLocation: folders/{folder}/locations/{location}
folderLocationQuotaPreference: folders/{folder}/locations/{location}/quotaPreferences/{quota_preference}
folderLocationService: folders/{folder}/locations/{location}/services/{service}
folderLocationServiceQuotaInfo: folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}
location: projects/{project}/locations/{location}
organizationLocation: organizations/{organization}/locations/{location}
organizationLocationQuotaPreference: organizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}
organizationLocationService: organizations/{organization}/locations/{location}/services/{service}
organizationLocationServiceQuotaInfo: organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}
projectLocation: projects/{project}/locations/{location}
projectLocationQuotaPreference: projects/{project}/locations/{location}/quotaPreferences/{quota_preference}
projectLocationService: projects/{project}/locations/{location}/services/{service}
projectLocationServiceQuotaInfo: projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}
quotaInfo: projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}
quotaPreference: projects/{project}/locations/{location}/quotaPreferences/{quota_preference}
service: projects/{project}/locations/{location}/services/{service}

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.