Google Cloud Discovery Engine V1 Client - Class LicenseConfigServiceClient (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class LicenseConfigServiceClient.

Service Description: Service for managing license config related resources.

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

Methods

__construct

Constructor.

Parameters
Name Description
options array|Google\ApiCore\Options\ClientOptions

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 Google\Auth\FetchAuthTokenInterface|Google\ApiCore\CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\DiscoveryEngine\V1\LicenseConfigServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new LicenseConfigServiceClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ 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|Google\ApiCore\Transport\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.

↳ logger false|Psr\Log\LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain string

The service domain for the client. Defaults to 'googleapis.com'.

createLicenseConfig

Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.

The async variant is LicenseConfigServiceClient::createLicenseConfigAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\CreateLicenseConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\LicenseConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\LicenseConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CreateLicenseConfigRequest;
use Google\Cloud\DiscoveryEngine\V1\LicenseConfig;
use Google\Cloud\DiscoveryEngine\V1\SubscriptionTerm;
use Google\Cloud\DiscoveryEngine\V1\SubscriptionTier;
use Google\Type\Date;

/**
 * @param string $formattedParent               The parent resource name, such as
 *                                              `projects/{project}/locations/{location}`. Please see
 *                                              {@see LicenseConfigServiceClient::locationName()} for help formatting this field.
 * @param int    $licenseConfigLicenseCount     Number of licenses purchased.
 * @param int    $licenseConfigSubscriptionTier Subscription tier information for the license config.
 * @param int    $licenseConfigSubscriptionTerm Subscription term.
 */
function create_license_config_sample(
    string $formattedParent,
    int $licenseConfigLicenseCount,
    int $licenseConfigSubscriptionTier,
    int $licenseConfigSubscriptionTerm
): void {
    // Create a client.
    $licenseConfigServiceClient = new LicenseConfigServiceClient();

    // Prepare the request message.
    $licenseConfigStartDate = new Date();
    $licenseConfig = (new LicenseConfig())
        ->setLicenseCount($licenseConfigLicenseCount)
        ->setSubscriptionTier($licenseConfigSubscriptionTier)
        ->setStartDate($licenseConfigStartDate)
        ->setSubscriptionTerm($licenseConfigSubscriptionTerm);
    $request = (new CreateLicenseConfigRequest())
        ->setParent($formattedParent)
        ->setLicenseConfig($licenseConfig);

    // Call the API and handle any network failures.
    try {
        /** @var LicenseConfig $response */
        $response = $licenseConfigServiceClient->createLicenseConfig($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 = LicenseConfigServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $licenseConfigLicenseCount = 0;
    $licenseConfigSubscriptionTier = SubscriptionTier::SUBSCRIPTION_TIER_UNSPECIFIED;
    $licenseConfigSubscriptionTerm = SubscriptionTerm::SUBSCRIPTION_TERM_UNSPECIFIED;

    create_license_config_sample(
        $formattedParent,
        $licenseConfigLicenseCount,
        $licenseConfigSubscriptionTier,
        $licenseConfigSubscriptionTerm
    );
}

distributeLicenseConfig

Distributes a LicenseConfig from billing account level to project level.

The async variant is LicenseConfigServiceClient::distributeLicenseConfigAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\DistributeLicenseConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\DistributeLicenseConfigResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\LicenseConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DistributeLicenseConfigRequest;
use Google\Cloud\DiscoveryEngine\V1\DistributeLicenseConfigResponse;

/**
 * @param string $formattedBillingAccountLicenseConfig Full resource name of [BillingAccountLicenseConfig][].
 *
 *                                                     Format:
 *                                                     `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. Please see
 *                                                     {@see LicenseConfigServiceClient::billingAccountLicenseConfigName()} for help formatting this field.
 * @param int    $projectNumber                        The target GCP project number to distribute the license config
 *                                                     to.
 * @param string $location                             The target GCP project region to distribute the license config
 *                                                     to.
 * @param int    $licenseCount                         The number of licenses to distribute.
 */
function distribute_license_config_sample(
    string $formattedBillingAccountLicenseConfig,
    int $projectNumber,
    string $location,
    int $licenseCount
): void {
    // Create a client.
    $licenseConfigServiceClient = new LicenseConfigServiceClient();

    // Prepare the request message.
    $request = (new DistributeLicenseConfigRequest())
        ->setBillingAccountLicenseConfig($formattedBillingAccountLicenseConfig)
        ->setProjectNumber($projectNumber)
        ->setLocation($location)
        ->setLicenseCount($licenseCount);

    // Call the API and handle any network failures.
    try {
        /** @var DistributeLicenseConfigResponse $response */
        $response = $licenseConfigServiceClient->distributeLicenseConfig($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
{
    $formattedBillingAccountLicenseConfig = LicenseConfigServiceClient::billingAccountLicenseConfigName(
        '[BILLING_ACCOUNT]',
        '[BILLING_ACCOUNT_LICENSE_CONFIG]'
    );
    $projectNumber = 0;
    $location = '[LOCATION]';
    $licenseCount = 0;

    distribute_license_config_sample(
        $formattedBillingAccountLicenseConfig,
        $projectNumber,
        $location,
        $licenseCount
    );
}

getLicenseConfig

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\GetLicenseConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\LicenseConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\LicenseConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\GetLicenseConfigRequest;
use Google\Cloud\DiscoveryEngine\V1\LicenseConfig;

/**
 * @param string $formattedName Full resource name of
 *                              [LicenseConfig][google.cloud.discoveryengine.v1.LicenseConfig], such as
 *                              `projects/{project}/locations/{location}/licenseConfigs/*`.
 *
 *                              If the caller does not have permission to access the
 *                              [LicenseConfig][google.cloud.discoveryengine.v1.LicenseConfig], regardless
 *                              of whether or not it exists, a PERMISSION_DENIED error is returned.
 *
 *                              If the requested
 *                              [LicenseConfig][google.cloud.discoveryengine.v1.LicenseConfig] does not
 *                              exist, a NOT_FOUND error is returned. Please see
 *                              {@see LicenseConfigServiceClient::licenseConfigName()} for help formatting this field.
 */
function get_license_config_sample(string $formattedName): void
{
    // Create a client.
    $licenseConfigServiceClient = new LicenseConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var LicenseConfig $response */
        $response = $licenseConfigServiceClient->getLicenseConfig($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 = LicenseConfigServiceClient::licenseConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[LICENSE_CONFIG]'
    );

    get_license_config_sample($formattedName);
}

listLicenseConfigs

Lists all the LicenseConfigs associated with the project.

The async variant is LicenseConfigServiceClient::listLicenseConfigsAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\ListLicenseConfigsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\Client\LicenseConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\LicenseConfig;
use Google\Cloud\DiscoveryEngine\V1\ListLicenseConfigsRequest;

/**
 * @param string $formattedParent The parent branch resource name, such as
 *                                `projects/{project}/locations/{location}`. Please see
 *                                {@see LicenseConfigServiceClient::locationName()} for help formatting this field.
 */
function list_license_configs_sample(string $formattedParent): void
{
    // Create a client.
    $licenseConfigServiceClient = new LicenseConfigServiceClient();

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

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

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

    list_license_configs_sample($formattedParent);
}

retractLicenseConfig

This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.

The async variant is LicenseConfigServiceClient::retractLicenseConfigAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\RetractLicenseConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\RetractLicenseConfigResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\LicenseConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\RetractLicenseConfigRequest;
use Google\Cloud\DiscoveryEngine\V1\RetractLicenseConfigResponse;

/**
 * @param string $formattedBillingAccountLicenseConfig Full resource name of [BillingAccountLicenseConfig][].
 *
 *                                                     Format:
 *                                                     `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. Please see
 *                                                     {@see LicenseConfigServiceClient::billingAccountLicenseConfigName()} for help formatting this field.
 * @param string $formattedLicenseConfig               Full resource name of
 *                                                     [LicenseConfig][google.cloud.discoveryengine.v1.LicenseConfig].
 *
 *                                                     Format:
 *                                                     `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`. Please see
 *                                                     {@see LicenseConfigServiceClient::licenseConfigName()} for help formatting this field.
 */
function retract_license_config_sample(
    string $formattedBillingAccountLicenseConfig,
    string $formattedLicenseConfig
): void {
    // Create a client.
    $licenseConfigServiceClient = new LicenseConfigServiceClient();

    // Prepare the request message.
    $request = (new RetractLicenseConfigRequest())
        ->setBillingAccountLicenseConfig($formattedBillingAccountLicenseConfig)
        ->setLicenseConfig($formattedLicenseConfig);

    // Call the API and handle any network failures.
    try {
        /** @var RetractLicenseConfigResponse $response */
        $response = $licenseConfigServiceClient->retractLicenseConfig($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
{
    $formattedBillingAccountLicenseConfig = LicenseConfigServiceClient::billingAccountLicenseConfigName(
        '[BILLING_ACCOUNT]',
        '[BILLING_ACCOUNT_LICENSE_CONFIG]'
    );
    $formattedLicenseConfig = LicenseConfigServiceClient::licenseConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[LICENSE_CONFIG]'
    );

    retract_license_config_sample($formattedBillingAccountLicenseConfig, $formattedLicenseConfig);
}

updateLicenseConfig

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\UpdateLicenseConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\LicenseConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\LicenseConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\LicenseConfig;
use Google\Cloud\DiscoveryEngine\V1\SubscriptionTerm;
use Google\Cloud\DiscoveryEngine\V1\SubscriptionTier;
use Google\Cloud\DiscoveryEngine\V1\UpdateLicenseConfigRequest;
use Google\Type\Date;

/**
 * @param int $licenseConfigLicenseCount     Number of licenses purchased.
 * @param int $licenseConfigSubscriptionTier Subscription tier information for the license config.
 * @param int $licenseConfigSubscriptionTerm Subscription term.
 */
function update_license_config_sample(
    int $licenseConfigLicenseCount,
    int $licenseConfigSubscriptionTier,
    int $licenseConfigSubscriptionTerm
): void {
    // Create a client.
    $licenseConfigServiceClient = new LicenseConfigServiceClient();

    // Prepare the request message.
    $licenseConfigStartDate = new Date();
    $licenseConfig = (new LicenseConfig())
        ->setLicenseCount($licenseConfigLicenseCount)
        ->setSubscriptionTier($licenseConfigSubscriptionTier)
        ->setStartDate($licenseConfigStartDate)
        ->setSubscriptionTerm($licenseConfigSubscriptionTerm);
    $request = (new UpdateLicenseConfigRequest())
        ->setLicenseConfig($licenseConfig);

    // Call the API and handle any network failures.
    try {
        /** @var LicenseConfig $response */
        $response = $licenseConfigServiceClient->updateLicenseConfig($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
{
    $licenseConfigLicenseCount = 0;
    $licenseConfigSubscriptionTier = SubscriptionTier::SUBSCRIPTION_TIER_UNSPECIFIED;
    $licenseConfigSubscriptionTerm = SubscriptionTerm::SUBSCRIPTION_TERM_UNSPECIFIED;

    update_license_config_sample(
        $licenseConfigLicenseCount,
        $licenseConfigSubscriptionTier,
        $licenseConfigSubscriptionTerm
    );
}

createLicenseConfigAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\CreateLicenseConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\LicenseConfig>

distributeLicenseConfigAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\DistributeLicenseConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\DistributeLicenseConfigResponse>

getLicenseConfigAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\GetLicenseConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\LicenseConfig>

listLicenseConfigsAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\ListLicenseConfigsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

retractLicenseConfigAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\RetractLicenseConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\RetractLicenseConfigResponse>

updateLicenseConfigAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\UpdateLicenseConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\LicenseConfig>

static::billingAccountLicenseConfigName

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

Parameters
Name Description
billingAccount string
billingAccountLicenseConfig string
Returns
Type Description
string The formatted billing_account_license_config resource.

static::licenseConfigName

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

Parameters
Name Description
project string
location string
licenseConfig string
Returns
Type Description
string The formatted license_config 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::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

  • billingAccountLicenseConfig: billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}
  • licenseConfig: projects/{project}/locations/{location}/licenseConfigs/{license_config}
  • location: projects/{project}/locations/{location}

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.