Recommender V1 Client - Class RecommenderClient (1.10.0)

Version 1.10.0

• 2.0.2 (latest)
• 2.0.1
• 1.11.5
• 1.10.0
• 1.9.1
• 1.8.2
• 1.7.8

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Recommender V1 Client class RecommenderClient.

Service Description: Provides insights and recommendations for cloud customers for various categories like performance optimization, cost savings, reliability, feature discovery, etc. Insights and recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.

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.

This class is currently experimental and may be subject to changes. See Google\Cloud\Recommender\V1\RecommenderClient for the stable implementation

Namespace

Google \ Cloud \ Recommender \ 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.

getInsight

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::getInsightAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetInsightRequest 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\Recommender\V1\Insight

getInsightTypeConfig

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::getInsightTypeConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetInsightTypeConfigRequest 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\Recommender\V1\InsightTypeConfig

getRecommendation

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::getRecommendationAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetRecommendationRequest 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\Recommender\V1\Recommendation

getRecommenderConfig

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::getRecommenderConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetRecommenderConfigRequest 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\Recommender\V1\RecommenderConfig

listInsights

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::listInsightsAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\ListInsightsRequest 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

listRecommendations

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::listRecommendationsAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\ListRecommendationsRequest 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

markInsightAccepted

Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated.

MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::markInsightAcceptedAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkInsightAcceptedRequest 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\Recommender\V1\Insight

markRecommendationClaimed

Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.

MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state.

Requires the recommender.*.update IAM permission for the specified recommender.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::markRecommendationClaimedAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationClaimedRequest 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\Recommender\V1\Recommendation

markRecommendationDismissed

Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED.

MarkRecommendationDismissed can be applied to recommendations in ACTIVE state.

Requires the recommender.*.update IAM permission for the specified recommender.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::markRecommendationDismissedAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationDismissedRequest 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\Recommender\V1\Recommendation

markRecommendationFailed

Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.

MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.

Requires the recommender.*.update IAM permission for the specified recommender.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::markRecommendationFailedAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationFailedRequest 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\Recommender\V1\Recommendation

markRecommendationSucceeded

Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.

MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.

Requires the recommender.*.update IAM permission for the specified recommender.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::markRecommendationSucceededAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationSucceededRequest 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\Recommender\V1\Recommendation

updateInsightTypeConfig

Updates an InsightTypeConfig change. This will create a new revision of the config.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::updateInsightTypeConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\UpdateInsightTypeConfigRequest 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\Recommender\V1\InsightTypeConfig

updateRecommenderConfig

Updates a Recommender Config. This will create a new revision of the config.

The async variant is Google\Cloud\Recommender\V1\Client\RecommenderClient::updateRecommenderConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\UpdateRecommenderConfigRequest 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\Recommender\V1\RecommenderConfig

getInsightAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetInsightRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getInsightTypeConfigAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetInsightTypeConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getRecommendationAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetRecommendationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getRecommenderConfigAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\GetRecommenderConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listInsightsAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\ListInsightsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listRecommendationsAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\ListRecommendationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

markInsightAcceptedAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkInsightAcceptedRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

markRecommendationClaimedAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationClaimedRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

markRecommendationDismissedAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationDismissedRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

markRecommendationFailedAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationFailedRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

markRecommendationSucceededAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\MarkRecommendationSucceededRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateInsightTypeConfigAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\UpdateInsightTypeConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateRecommenderConfigAsync

Parameters
Name	Description
request	Google\Cloud\Recommender\V1\UpdateRecommenderConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

static::billingAccountLocationInsightTypeName

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

Parameters
Name	Description
billingAccount	string
location	string
insightType	string

Returns
Type	Description
string	The formatted billing_account_location_insight_type resource.

static::billingAccountLocationInsightTypeConfigName

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

Parameters
Name	Description
billingAccount	string
location	string
insightType	string

Returns
Type	Description
string	The formatted billing_account_location_insight_type_config resource.

static::billingAccountLocationInsightTypeInsightName

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

Parameters
Name	Description
billingAccount	string
location	string
insightType	string
insight	string

Returns
Type	Description
string	The formatted billing_account_location_insight_type_insight resource.

static::billingAccountLocationRecommenderName

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

Parameters
Name	Description
billingAccount	string
location	string
recommender	string

Returns
Type	Description
string	The formatted billing_account_location_recommender resource.

static::billingAccountLocationRecommenderConfigName

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

Parameters
Name	Description
billingAccount	string
location	string
recommender	string

Returns
Type	Description
string	The formatted billing_account_location_recommender_config resource.

static::billingAccountLocationRecommenderRecommendationName

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

Parameters
Name	Description
billingAccount	string
location	string
recommender	string
recommendation	string

Returns
Type	Description
string	The formatted billing_account_location_recommender_recommendation resource.

static::folderLocationInsightTypeName

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

Parameters
Name	Description
folder	string
location	string
insightType	string

Returns
Type	Description
string	The formatted folder_location_insight_type resource.

static::folderLocationInsightTypeInsightName

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

Parameters
Name	Description
folder	string
location	string
insightType	string
insight	string

Returns
Type	Description
string	The formatted folder_location_insight_type_insight resource.

static::folderLocationRecommenderName

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

Parameters
Name	Description
folder	string
location	string
recommender	string

Returns
Type	Description
string	The formatted folder_location_recommender resource.

static::folderLocationRecommenderRecommendationName

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

Parameters
Name	Description
folder	string
location	string
recommender	string
recommendation	string

Returns
Type	Description
string	The formatted folder_location_recommender_recommendation resource.

static::insightName

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

Parameters
Name	Description
project	string
location	string
insightType	string
insight	string

Returns
Type	Description
string	The formatted insight resource.

static::insightTypeName

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

Parameters
Name	Description
project	string
location	string
insightType	string

Returns
Type	Description
string	The formatted insight_type resource.

static::insightTypeConfigName

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

Parameters
Name	Description
project	string
location	string
insightType	string

Returns
Type	Description
string	The formatted insight_type_config resource.

static::organizationLocationInsightTypeName

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

Parameters
Name	Description
organization	string
location	string
insightType	string

Returns
Type	Description
string	The formatted organization_location_insight_type resource.

static::organizationLocationInsightTypeConfigName

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

Parameters
Name	Description
organization	string
location	string
insightType	string

Returns
Type	Description
string	The formatted organization_location_insight_type_config resource.

static::organizationLocationInsightTypeInsightName

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

Parameters
Name	Description
organization	string
location	string
insightType	string
insight	string

Returns
Type	Description
string	The formatted organization_location_insight_type_insight resource.

static::organizationLocationRecommenderName

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

Parameters
Name	Description
organization	string
location	string
recommender	string

Returns
Type	Description
string	The formatted organization_location_recommender resource.

static::organizationLocationRecommenderConfigName

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

Parameters
Name	Description
organization	string
location	string
recommender	string

Returns
Type	Description
string	The formatted organization_location_recommender_config resource.

static::organizationLocationRecommenderRecommendationName

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

Parameters
Name	Description
organization	string
location	string
recommender	string
recommendation	string

Returns
Type	Description
string	The formatted organization_location_recommender_recommendation resource.

static::projectLocationInsightTypeName

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

Parameters
Name	Description
project	string
location	string
insightType	string

Returns
Type	Description
string	The formatted project_location_insight_type resource.

static::projectLocationInsightTypeConfigName

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

Parameters
Name	Description
project	string
location	string
insightType	string

Returns
Type	Description
string	The formatted project_location_insight_type_config resource.

static::projectLocationInsightTypeInsightName

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

Parameters
Name	Description
project	string
location	string
insightType	string
insight	string

Returns
Type	Description
string	The formatted project_location_insight_type_insight resource.

static::projectLocationRecommenderName

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

Parameters
Name	Description
project	string
location	string
recommender	string

Returns
Type	Description
string	The formatted project_location_recommender resource.

static::projectLocationRecommenderConfigName

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

Parameters
Name	Description
project	string
location	string
recommender	string

Returns
Type	Description
string	The formatted project_location_recommender_config resource.

static::projectLocationRecommenderRecommendationName

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

Parameters
Name	Description
project	string
location	string
recommender	string
recommendation	string

Returns
Type	Description
string	The formatted project_location_recommender_recommendation resource.

static::recommendationName

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

Parameters
Name	Description
project	string
location	string
recommender	string
recommendation	string

Returns
Type	Description
string	The formatted recommendation resource.

static::recommenderName

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

Parameters
Name	Description
project	string
location	string
recommender	string

Returns
Type	Description
string	The formatted recommender resource.

static::recommenderConfigName

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

Parameters
Name	Description
project	string
location	string
recommender	string

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

• billingAccountLocationInsightType: billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}
• billingAccountLocationInsightTypeConfig: billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/config
• billingAccountLocationInsightTypeInsight: billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
• billingAccountLocationRecommender: billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}
• billingAccountLocationRecommenderConfig: billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/config
• billingAccountLocationRecommenderRecommendation: billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
• folderLocationInsightType: folders/{folder}/locations/{location}/insightTypes/{insight_type}
• folderLocationInsightTypeInsight: folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
• folderLocationRecommender: folders/{folder}/locations/{location}/recommenders/{recommender}
• folderLocationRecommenderRecommendation: folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
• insight: projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
• insightType: projects/{project}/locations/{location}/insightTypes/{insight_type}
• insightTypeConfig: projects/{project}/locations/{location}/insightTypes/{insight_type}/config
• organizationLocationInsightType: organizations/{organization}/locations/{location}/insightTypes/{insight_type}
• organizationLocationInsightTypeConfig: organizations/{organization}/locations/{location}/insightTypes/{insight_type}/config
• organizationLocationInsightTypeInsight: organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
• organizationLocationRecommender: organizations/{organization}/locations/{location}/recommenders/{recommender}
• organizationLocationRecommenderConfig: organizations/{organization}/locations/{location}/recommenders/{recommender}/config
• organizationLocationRecommenderRecommendation: organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
• projectLocationInsightType: projects/{project}/locations/{location}/insightTypes/{insight_type}
• projectLocationInsightTypeConfig: projects/{project}/locations/{location}/insightTypes/{insight_type}/config
• projectLocationInsightTypeInsight: projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}
• projectLocationRecommender: projects/{project}/locations/{location}/recommenders/{recommender}
• projectLocationRecommenderConfig: projects/{project}/locations/{location}/recommenders/{recommender}/config
• projectLocationRecommenderRecommendation: projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
• recommendation: projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}
• recommender: projects/{project}/locations/{location}/recommenders/{recommender}
• recommenderConfig: projects/{project}/locations/{location}/recommenders/{recommender}/config

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.