src/apis/recommender/v1.ts
Recommender API
const {google} = require('googleapis');
const recommender = google.recommender('v1');
Properties |
constructor(options: GlobalOptions, google?: GoogleConfigurable)
|
|||||||||
|
Defined in src/apis/recommender/v1.ts:119
|
|||||||||
|
Parameters :
|
| billingAccounts |
Type : Resource$Billingaccounts
|
|
Defined in src/apis/recommender/v1.ts:116
|
| context |
Type : APIRequestContext
|
|
Defined in src/apis/recommender/v1.ts:115
|
| folders |
Type : Resource$Folders
|
|
Defined in src/apis/recommender/v1.ts:117
|
| organizations |
Type : Resource$Organizations
|
|
Defined in src/apis/recommender/v1.ts:118
|
| projects |
Type : Resource$Projects
|
|
Defined in src/apis/recommender/v1.ts:119
|
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosPromise,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace recommender_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Recommender API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
* ```
*/
export class Recommender {
context: APIRequestContext;
billingAccounts: Resource$Billingaccounts;
folders: Resource$Folders;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.billingAccounts = new Resource$Billingaccounts(this.context);
this.folders = new Resource$Folders(this.context);
this.organizations = new Resource$Organizations(this.context);
this.projects = new Resource$Projects(this.context);
}
}
/**
* Contains metadata about how much money a recommendation can save or incur.
*/
export interface Schema$GoogleCloudRecommenderV1CostProjection {
/**
* An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.
*/
cost?: Schema$GoogleTypeMoney;
/**
* Duration for which this cost applies.
*/
duration?: string | null;
}
/**
* Contains the impact a recommendation can have for a given category.
*/
export interface Schema$GoogleCloudRecommenderV1Impact {
/**
* Category that is being targeted.
*/
category?: string | null;
/**
* Use with CategoryType.COST
*/
costProjection?: Schema$GoogleCloudRecommenderV1CostProjection;
/**
* Use with CategoryType.SECURITY
*/
securityProjection?: Schema$GoogleCloudRecommenderV1SecurityProjection;
}
/**
* An insight along with the information used to derive the insight. The insight may have associated recomendations as well.
*/
export interface Schema$GoogleCloudRecommenderV1Insight {
/**
* Recommendations derived from this insight.
*/
associatedRecommendations?: Schema$GoogleCloudRecommenderV1InsightRecommendationReference[];
/**
* Category being targeted by the insight.
*/
category?: string | null;
/**
* A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000"
*/
content?: {[key: string]: any} | null;
/**
* Free-form human readable summary in English. The maximum length is 500 characters.
*/
description?: string | null;
/**
* Fingerprint of the Insight. Provides optimistic locking when updating states.
*/
etag?: string | null;
/**
* Insight subtype. Insight content schema will be stable for a given subtype.
*/
insightSubtype?: string | null;
/**
* Timestamp of the latest data used to generate the insight.
*/
lastRefreshTime?: string | null;
/**
* Name of the insight.
*/
name?: string | null;
/**
* Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period).
*/
observationPeriod?: string | null;
/**
* Insight's severity.
*/
severity?: string | null;
/**
* Information state and metadata.
*/
stateInfo?: Schema$GoogleCloudRecommenderV1InsightStateInfo;
/**
* Fully qualified resource names that this insight is targeting.
*/
targetResources?: string[] | null;
}
/**
* Reference to an associated recommendation.
*/
export interface Schema$GoogleCloudRecommenderV1InsightRecommendationReference {
/**
* Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
*/
recommendation?: string | null;
}
/**
* Information related to insight state.
*/
export interface Schema$GoogleCloudRecommenderV1InsightStateInfo {
/**
* Insight state.
*/
state?: string | null;
/**
* A map of metadata for the state, provided by user or automations systems.
*/
stateMetadata?: {[key: string]: string} | null;
}
/**
* Response to the `ListInsights` method.
*/
export interface Schema$GoogleCloudRecommenderV1ListInsightsResponse {
/**
* The set of insights for the `parent` resource.
*/
insights?: Schema$GoogleCloudRecommenderV1Insight[];
/**
* A token that can be used to request the next page of results. This field is empty if there are no additional results.
*/
nextPageToken?: string | null;
}
/**
* Response to the `ListRecommendations` method.
*/
export interface Schema$GoogleCloudRecommenderV1ListRecommendationsResponse {
/**
* A token that can be used to request the next page of results. This field is empty if there are no additional results.
*/
nextPageToken?: string | null;
/**
* The set of recommendations for the `parent` resource.
*/
recommendations?: Schema$GoogleCloudRecommenderV1Recommendation[];
}
/**
* Request for the `MarkInsightAccepted` method.
*/
export interface Schema$GoogleCloudRecommenderV1MarkInsightAcceptedRequest {
/**
* Required. Fingerprint of the Insight. Provides optimistic locking.
*/
etag?: string | null;
/**
* Optional. State properties user wish to include with this state. Full replace of the current state_metadata.
*/
stateMetadata?: {[key: string]: string} | null;
}
/**
* Request for the `MarkRecommendationClaimed` Method.
*/
export interface Schema$GoogleCloudRecommenderV1MarkRecommendationClaimedRequest {
/**
* Required. Fingerprint of the Recommendation. Provides optimistic locking.
*/
etag?: string | null;
/**
* State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62\}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255\}$/.
*/
stateMetadata?: {[key: string]: string} | null;
}
/**
* Request for the `MarkRecommendationFailed` Method.
*/
export interface Schema$GoogleCloudRecommenderV1MarkRecommendationFailedRequest {
/**
* Required. Fingerprint of the Recommendation. Provides optimistic locking.
*/
etag?: string | null;
/**
* State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62\}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255\}$/.
*/
stateMetadata?: {[key: string]: string} | null;
}
/**
* Request for the `MarkRecommendationSucceeded` Method.
*/
export interface Schema$GoogleCloudRecommenderV1MarkRecommendationSucceededRequest {
/**
* Required. Fingerprint of the Recommendation. Provides optimistic locking.
*/
etag?: string | null;
/**
* State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62\}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255\}$/.
*/
stateMetadata?: {[key: string]: string} | null;
}
/**
* Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.
*/
export interface Schema$GoogleCloudRecommenderV1Operation {
/**
* Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.
*/
action?: string | null;
/**
* Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.
*/
path?: string | null;
/**
* Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/x/name" : "it-123" "/versions/x/targetSize/percent": 20 \} * Example: { "/bindings/x/role": "roles/owner" "/bindings/x/condition" : null \} * Example: { "/bindings/x/role": "roles/owner" "/bindings/x/members/x" : ["x@example.com", "y@example.com"] \} When both path_filters and path_value_matchers are set, an implicit AND must be performed.
*/
pathFilters?: {[key: string]: any} | null;
/**
* Similar to path_filters, this contains set of filters to apply if `path` field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.
*/
pathValueMatchers?: {
[key: string]: Schema$GoogleCloudRecommenderV1ValueMatcher;
} | null;
/**
* Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.
*/
resource?: string | null;
/**
* Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance
*/
resourceType?: string | null;
/**
* Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.
*/
sourcePath?: string | null;
/**
* Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`.
*/
sourceResource?: string | null;
/**
* Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.
*/
value?: any | null;
/**
* Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation.
*/
valueMatcher?: Schema$GoogleCloudRecommenderV1ValueMatcher;
}
/**
* Group of operations that need to be performed atomically.
*/
export interface Schema$GoogleCloudRecommenderV1OperationGroup {
/**
* List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.
*/
operations?: Schema$GoogleCloudRecommenderV1Operation[];
}
/**
* A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc
*/
export interface Schema$GoogleCloudRecommenderV1Recommendation {
/**
* Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.
*/
additionalImpact?: Schema$GoogleCloudRecommenderV1Impact[];
/**
* Insights that led to this recommendation.
*/
associatedInsights?: Schema$GoogleCloudRecommenderV1RecommendationInsightReference[];
/**
* Content of the recommendation describing recommended changes to resources.
*/
content?: Schema$GoogleCloudRecommenderV1RecommendationContent;
/**
* Free-form human readable summary in English. The maximum length is 500 characters.
*/
description?: string | null;
/**
* Fingerprint of the Recommendation. Provides optimistic locking when updating states.
*/
etag?: string | null;
/**
* Last time this recommendation was refreshed by the system that created it in the first place.
*/
lastRefreshTime?: string | null;
/**
* Name of recommendation.
*/
name?: string | null;
/**
* The primary impact that this recommendation can have while trying to optimize for one category.
*/
primaryImpact?: Schema$GoogleCloudRecommenderV1Impact;
/**
* Recommendation's priority.
*/
priority?: string | null;
/**
* Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"
*/
recommenderSubtype?: string | null;
/**
* Information for state. Contains state and metadata.
*/
stateInfo?: Schema$GoogleCloudRecommenderV1RecommendationStateInfo;
}
/**
* Contains what resources are changing and how they are changing.
*/
export interface Schema$GoogleCloudRecommenderV1RecommendationContent {
/**
* Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.
*/
operationGroups?: Schema$GoogleCloudRecommenderV1OperationGroup[];
/**
* Condensed overview information about the recommendation.
*/
overview?: {[key: string]: any} | null;
}
/**
* Reference to an associated insight.
*/
export interface Schema$GoogleCloudRecommenderV1RecommendationInsightReference {
/**
* Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]
*/
insight?: string | null;
}
/**
* Information for state. Contains state and metadata.
*/
export interface Schema$GoogleCloudRecommenderV1RecommendationStateInfo {
/**
* The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
*/
state?: string | null;
/**
* A map of metadata for the state, provided by user or automations systems.
*/
stateMetadata?: {[key: string]: string} | null;
}
/**
* Contains various ways of describing the impact on Security.
*/
export interface Schema$GoogleCloudRecommenderV1SecurityProjection {
/**
* Additional security impact details that is provided by the recommender.
*/
details?: {[key: string]: any} | null;
}
/**
* Contains various matching options for values for a GCP resource field.
*/
export interface Schema$GoogleCloudRecommenderV1ValueMatcher {
/**
* To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch
*/
matchesPattern?: string | null;
}
/**
* Represents an amount of money with its currency type.
*/
export interface Schema$GoogleTypeMoney {
/**
* The three-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number | null;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string | null;
}
export class Resource$Billingaccounts {
context: APIRequestContext;
locations: Resource$Billingaccounts$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Billingaccounts$Locations(this.context);
}
}
export class Resource$Billingaccounts$Locations {
context: APIRequestContext;
insightTypes: Resource$Billingaccounts$Locations$Insighttypes;
recommenders: Resource$Billingaccounts$Locations$Recommenders;
constructor(context: APIRequestContext) {
this.context = context;
this.insightTypes = new Resource$Billingaccounts$Locations$Insighttypes(
this.context
);
this.recommenders = new Resource$Billingaccounts$Locations$Recommenders(
this.context
);
}
}
export class Resource$Billingaccounts$Locations$Insighttypes {
context: APIRequestContext;
insights: Resource$Billingaccounts$Locations$Insighttypes$Insights;
constructor(context: APIRequestContext) {
this.context = context;
this.insights =
new Resource$Billingaccounts$Locations$Insighttypes$Insights(
this.context
);
}
}
export class Resource$Billingaccounts$Locations$Insighttypes$Insights {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.insightTypes.insights.get({
* // Required. Name of the insight.
* name: 'billingAccounts/my-billingAccount/locations/my-location/insightTypes/my-insightType/insights/my-insight',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
get(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
/**
* Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.insightTypes.insights.list({
* // Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
* parent:
* 'billingAccounts/my-billingAccount/locations/my-location/insightTypes/my-insightType',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "insights": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>;
list(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/insights').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.insightTypes.insights.markAccepted(
* {
* // Required. Name of the insight.
* name: 'billingAccounts/my-billingAccount/locations/my-location/insightTypes/my-insightType/insights/my-insight',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markAccepted(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markAccepted(
params?: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
markAccepted(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markAccepted(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
params: Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markAccepted').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
}
export interface Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Get
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
}
export interface Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$List
extends StandardParameters {
/**
* Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
*/
parent?: string;
}
export interface Params$Resource$Billingaccounts$Locations$Insighttypes$Insights$Markaccepted
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkInsightAcceptedRequest;
}
export class Resource$Billingaccounts$Locations$Recommenders {
context: APIRequestContext;
recommendations: Resource$Billingaccounts$Locations$Recommenders$Recommendations;
constructor(context: APIRequestContext) {
this.context = context;
this.recommendations =
new Resource$Billingaccounts$Locations$Recommenders$Recommendations(
this.context
);
}
}
export class Resource$Billingaccounts$Locations$Recommenders$Recommendations {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.recommenders.recommendations.get(
* {
* // Required. Name of the recommendation.
* name: 'billingAccounts/my-billingAccount/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
get(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.recommenders.recommendations.list(
* {
* // Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
* parent:
* 'billingAccounts/my-billingAccount/locations/my-location/recommenders/my-recommender',
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "recommendations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>;
list(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/recommendations').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.recommenders.recommendations.markClaimed(
* {
* // Required. Name of the recommendation.
* name: 'billingAccounts/my-billingAccount/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markClaimed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markClaimed(
params?: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markClaimed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markClaimed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markClaimed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.recommenders.recommendations.markFailed(
* {
* // Required. Name of the recommendation.
* name: 'billingAccounts/my-billingAccount/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markFailed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markFailed(
params?: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markFailed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markFailed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markFailed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded(
* {
* // Required. Name of the recommendation.
* name: 'billingAccounts/my-billingAccount/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markSucceeded(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markSucceeded(
params?: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markSucceeded(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markSucceeded(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
params: Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
paramsOrCallback?:
| Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markSucceeded').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
}
export interface Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Get
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
}
export interface Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$List
extends StandardParameters {
/**
* Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
*/
parent?: string;
}
export interface Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markclaimed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationClaimedRequest;
}
export interface Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Markfailed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationFailedRequest;
}
export interface Params$Resource$Billingaccounts$Locations$Recommenders$Recommendations$Marksucceeded
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationSucceededRequest;
}
export class Resource$Folders {
context: APIRequestContext;
locations: Resource$Folders$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Folders$Locations(this.context);
}
}
export class Resource$Folders$Locations {
context: APIRequestContext;
insightTypes: Resource$Folders$Locations$Insighttypes;
recommenders: Resource$Folders$Locations$Recommenders;
constructor(context: APIRequestContext) {
this.context = context;
this.insightTypes = new Resource$Folders$Locations$Insighttypes(
this.context
);
this.recommenders = new Resource$Folders$Locations$Recommenders(
this.context
);
}
}
export class Resource$Folders$Locations$Insighttypes {
context: APIRequestContext;
insights: Resource$Folders$Locations$Insighttypes$Insights;
constructor(context: APIRequestContext) {
this.context = context;
this.insights = new Resource$Folders$Locations$Insighttypes$Insights(
this.context
);
}
}
export class Resource$Folders$Locations$Insighttypes$Insights {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await recommender.folders.locations.insightTypes.insights.get({
* // Required. Name of the insight.
* name: 'folders/my-folder/locations/my-location/insightTypes/my-insightType/insights/my-insight',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Folders$Locations$Insighttypes$Insights$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
get(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Insighttypes$Insights$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Insighttypes$Insights$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Insighttypes$Insights$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
/**
* Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await recommender.folders.locations.insightTypes.insights.list({
* // Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
* parent:
* 'folders/my-folder/locations/my-location/insightTypes/my-insightType',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "insights": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Folders$Locations$Insighttypes$Insights$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>;
list(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Insighttypes$Insights$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Insighttypes$Insights$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Insighttypes$Insights$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/insights').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.folders.locations.insightTypes.insights.markAccepted({
* // Required. Name of the insight.
* name: 'folders/my-folder/locations/my-location/insightTypes/my-insightType/insights/my-insight',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markAccepted(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markAccepted(
params?: Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
markAccepted(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markAccepted(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
params: Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markAccepted').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
}
export interface Params$Resource$Folders$Locations$Insighttypes$Insights$Get
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
}
export interface Params$Resource$Folders$Locations$Insighttypes$Insights$List
extends StandardParameters {
/**
* Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
*/
parent?: string;
}
export interface Params$Resource$Folders$Locations$Insighttypes$Insights$Markaccepted
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkInsightAcceptedRequest;
}
export class Resource$Folders$Locations$Recommenders {
context: APIRequestContext;
recommendations: Resource$Folders$Locations$Recommenders$Recommendations;
constructor(context: APIRequestContext) {
this.context = context;
this.recommendations =
new Resource$Folders$Locations$Recommenders$Recommendations(
this.context
);
}
}
export class Resource$Folders$Locations$Recommenders$Recommendations {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.folders.locations.recommenders.recommendations.get({
* // Required. Name of the recommendation.
* name: 'folders/my-folder/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Folders$Locations$Recommenders$Recommendations$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
get(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Recommenders$Recommendations$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Recommenders$Recommendations$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Recommenders$Recommendations$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.folders.locations.recommenders.recommendations.list({
* // Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
* parent:
* 'folders/my-folder/locations/my-location/recommenders/my-recommender',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "recommendations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Folders$Locations$Recommenders$Recommendations$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>;
list(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Recommenders$Recommendations$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Recommenders$Recommendations$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Recommenders$Recommendations$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/recommendations').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.folders.locations.recommenders.recommendations.markClaimed(
* {
* // Required. Name of the recommendation.
* name: 'folders/my-folder/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markClaimed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markClaimed(
params?: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markClaimed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markClaimed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markClaimed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.folders.locations.recommenders.recommendations.markFailed(
* {
* // Required. Name of the recommendation.
* name: 'folders/my-folder/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markFailed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markFailed(
params?: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markFailed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markFailed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markFailed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.folders.locations.recommenders.recommendations.markSucceeded(
* {
* // Required. Name of the recommendation.
* name: 'folders/my-folder/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markSucceeded(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markSucceeded(
params?: Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markSucceeded(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markSucceeded(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
params: Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
paramsOrCallback?:
| Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markSucceeded').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
}
export interface Params$Resource$Folders$Locations$Recommenders$Recommendations$Get
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
}
export interface Params$Resource$Folders$Locations$Recommenders$Recommendations$List
extends StandardParameters {
/**
* Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
*/
parent?: string;
}
export interface Params$Resource$Folders$Locations$Recommenders$Recommendations$Markclaimed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationClaimedRequest;
}
export interface Params$Resource$Folders$Locations$Recommenders$Recommendations$Markfailed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationFailedRequest;
}
export interface Params$Resource$Folders$Locations$Recommenders$Recommendations$Marksucceeded
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationSucceededRequest;
}
export class Resource$Organizations {
context: APIRequestContext;
locations: Resource$Organizations$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Organizations$Locations(this.context);
}
}
export class Resource$Organizations$Locations {
context: APIRequestContext;
insightTypes: Resource$Organizations$Locations$Insighttypes;
recommenders: Resource$Organizations$Locations$Recommenders;
constructor(context: APIRequestContext) {
this.context = context;
this.insightTypes = new Resource$Organizations$Locations$Insighttypes(
this.context
);
this.recommenders = new Resource$Organizations$Locations$Recommenders(
this.context
);
}
}
export class Resource$Organizations$Locations$Insighttypes {
context: APIRequestContext;
insights: Resource$Organizations$Locations$Insighttypes$Insights;
constructor(context: APIRequestContext) {
this.context = context;
this.insights =
new Resource$Organizations$Locations$Insighttypes$Insights(
this.context
);
}
}
export class Resource$Organizations$Locations$Insighttypes$Insights {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.insightTypes.insights.get({
* // Required. Name of the insight.
* name: 'organizations/my-organization/locations/my-location/insightTypes/my-insightType/insights/my-insight',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Organizations$Locations$Insighttypes$Insights$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
get(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Insighttypes$Insights$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Insighttypes$Insights$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Insighttypes$Insights$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
/**
* Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.insightTypes.insights.list({
* // Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
* parent:
* 'organizations/my-organization/locations/my-location/insightTypes/my-insightType',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "insights": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Organizations$Locations$Insighttypes$Insights$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>;
list(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Insighttypes$Insights$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Insighttypes$Insights$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Insighttypes$Insights$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/insights').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.insightTypes.insights.markAccepted(
* {
* // Required. Name of the insight.
* name: 'organizations/my-organization/locations/my-location/insightTypes/my-insightType/insights/my-insight',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markAccepted(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markAccepted(
params?: Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
markAccepted(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markAccepted(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
params: Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markAccepted').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
}
export interface Params$Resource$Organizations$Locations$Insighttypes$Insights$Get
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
}
export interface Params$Resource$Organizations$Locations$Insighttypes$Insights$List
extends StandardParameters {
/**
* Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
*/
parent?: string;
}
export interface Params$Resource$Organizations$Locations$Insighttypes$Insights$Markaccepted
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkInsightAcceptedRequest;
}
export class Resource$Organizations$Locations$Recommenders {
context: APIRequestContext;
recommendations: Resource$Organizations$Locations$Recommenders$Recommendations;
constructor(context: APIRequestContext) {
this.context = context;
this.recommendations =
new Resource$Organizations$Locations$Recommenders$Recommendations(
this.context
);
}
}
export class Resource$Organizations$Locations$Recommenders$Recommendations {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.recommenders.recommendations.get({
* // Required. Name of the recommendation.
* name: 'organizations/my-organization/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
get(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.recommenders.recommendations.list(
* {
* // Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
* parent:
* 'organizations/my-organization/locations/my-location/recommenders/my-recommender',
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "recommendations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Organizations$Locations$Recommenders$Recommendations$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>;
list(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Recommenders$Recommendations$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Recommenders$Recommendations$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Recommenders$Recommendations$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/recommendations').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.recommenders.recommendations.markClaimed(
* {
* // Required. Name of the recommendation.
* name: 'organizations/my-organization/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markClaimed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markClaimed(
params?: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markClaimed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markClaimed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markClaimed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.recommenders.recommendations.markFailed(
* {
* // Required. Name of the recommendation.
* name: 'organizations/my-organization/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markFailed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markFailed(
params?: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markFailed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markFailed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markFailed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.organizations.locations.recommenders.recommendations.markSucceeded(
* {
* // Required. Name of the recommendation.
* name: 'organizations/my-organization/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markSucceeded(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markSucceeded(
params?: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markSucceeded(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markSucceeded(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
params: Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
paramsOrCallback?:
| Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markSucceeded').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
}
export interface Params$Resource$Organizations$Locations$Recommenders$Recommendations$Get
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
}
export interface Params$Resource$Organizations$Locations$Recommenders$Recommendations$List
extends StandardParameters {
/**
* Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
*/
parent?: string;
}
export interface Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markclaimed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationClaimedRequest;
}
export interface Params$Resource$Organizations$Locations$Recommenders$Recommendations$Markfailed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationFailedRequest;
}
export interface Params$Resource$Organizations$Locations$Recommenders$Recommendations$Marksucceeded
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationSucceededRequest;
}
export class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Projects$Locations(this.context);
}
}
export class Resource$Projects$Locations {
context: APIRequestContext;
insightTypes: Resource$Projects$Locations$Insighttypes;
recommenders: Resource$Projects$Locations$Recommenders;
constructor(context: APIRequestContext) {
this.context = context;
this.insightTypes = new Resource$Projects$Locations$Insighttypes(
this.context
);
this.recommenders = new Resource$Projects$Locations$Recommenders(
this.context
);
}
}
export class Resource$Projects$Locations$Insighttypes {
context: APIRequestContext;
insights: Resource$Projects$Locations$Insighttypes$Insights;
constructor(context: APIRequestContext) {
this.context = context;
this.insights = new Resource$Projects$Locations$Insighttypes$Insights(
this.context
);
}
}
export class Resource$Projects$Locations$Insighttypes$Insights {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await recommender.projects.locations.insightTypes.insights.get({
* // Required. Name of the insight.
* name: 'projects/my-project/locations/my-location/insightTypes/my-insightType/insights/my-insight',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Projects$Locations$Insighttypes$Insights$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
get(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
get(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Insighttypes$Insights$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Insighttypes$Insights$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Insighttypes$Insights$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
/**
* Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await recommender.projects.locations.insightTypes.insights.list({
* // Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
* parent:
* 'projects/my-project/locations/my-location/insightTypes/my-insightType',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "insights": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Projects$Locations$Insighttypes$Insights$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>;
list(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Insighttypes$Insights$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListInsightsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Insighttypes$Insights$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Insighttypes$Insights$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/insights').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListInsightsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.projects.locations.insightTypes.insights.markAccepted({
* // Required. Name of the insight.
* name: 'projects/my-project/locations/my-location/insightTypes/my-insightType/insights/my-insight',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "associatedRecommendations": [],
* // "category": "my_category",
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "insightSubtype": "my_insightSubtype",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "observationPeriod": "my_observationPeriod",
* // "severity": "my_severity",
* // "stateInfo": {},
* // "targetResources": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markAccepted(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markAccepted(
params?: Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>;
markAccepted(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markAccepted(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
params: Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
): void;
markAccepted(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Insight>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Insight>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markAccepted').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Insight>(
parameters
);
}
}
}
export interface Params$Resource$Projects$Locations$Insighttypes$Insights$Get
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Insighttypes$Insights$List
extends StandardParameters {
/**
* Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Insighttypes$Insights$Markaccepted
extends StandardParameters {
/**
* Required. Name of the insight.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkInsightAcceptedRequest;
}
export class Resource$Projects$Locations$Recommenders {
context: APIRequestContext;
recommendations: Resource$Projects$Locations$Recommenders$Recommendations;
constructor(context: APIRequestContext) {
this.context = context;
this.recommendations =
new Resource$Projects$Locations$Recommenders$Recommendations(
this.context
);
}
}
export class Resource$Projects$Locations$Recommenders$Recommendations {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.projects.locations.recommenders.recommendations.get({
* // Required. Name of the recommendation.
* name: 'projects/my-project/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
get(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Get,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
get(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Recommenders$Recommendations$Get
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.projects.locations.recommenders.recommendations.list({
* // Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
* filter: 'placeholder-value',
* // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
* pageSize: 'placeholder-value',
* // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
* pageToken: 'placeholder-value',
* // Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
* parent:
* 'projects/my-project/locations/my-location/recommenders/my-recommender',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "recommendations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>;
list(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$List,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Recommenders$Recommendations$List
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Recommenders$Recommendations$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/recommendations').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1ListRecommendationsResponse>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.projects.locations.recommenders.recommendations.markClaimed(
* {
* // Required. Name of the recommendation.
* name: 'projects/my-project/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markClaimed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markClaimed(
params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markClaimed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markClaimed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markClaimed(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markClaimed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.projects.locations.recommenders.recommendations.markFailed(
* {
* // Required. Name of the recommendation.
* name: 'projects/my-project/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markFailed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markFailed(
params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markFailed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markFailed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markFailed(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markFailed').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/recommender.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const recommender = google.recommender('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await recommender.projects.locations.recommenders.recommendations.markSucceeded(
* {
* // Required. Name of the recommendation.
* name: 'projects/my-project/locations/my-location/recommenders/my-recommender/recommendations/my-recommendation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "etag": "my_etag",
* // "stateMetadata": {}
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "additionalImpact": [],
* // "associatedInsights": [],
* // "content": {},
* // "description": "my_description",
* // "etag": "my_etag",
* // "lastRefreshTime": "my_lastRefreshTime",
* // "name": "my_name",
* // "primaryImpact": {},
* // "priority": "my_priority",
* // "recommenderSubtype": "my_recommenderSubtype",
* // "stateInfo": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
markSucceeded(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
markSucceeded(
params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>;
markSucceeded(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
markSucceeded(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded,
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
callback: BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
): void;
markSucceeded(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudRecommenderV1Recommendation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudRecommenderV1Recommendation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:markSucceeded').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudRecommenderV1Recommendation>(
parameters
);
}
}
}
export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Get
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$List
extends StandardParameters {
/**
* Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
*/
filter?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
*/
pageSize?: number;
/**
* Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
*/
pageToken?: string;
/**
* Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationClaimedRequest;
}
export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationFailedRequest;
}
export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded
extends StandardParameters {
/**
* Required. Name of the recommendation.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudRecommenderV1MarkRecommendationSucceededRequest;
}
}