Recommender API v1 - Package cloud.google.com/go/recommender/apiv1 (v1.13.6)

Note: To get more information about this package, such as access to older versions, viewthis package on pkg.go.dev.

Package recommender is an auto-generated package for theRecommender API.

General documentation

For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/recommender/apiv1@latestctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req:=&recommenderpb.GetInsightRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#GetInsightRequest.}resp,err:=c.GetInsight(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp

Use of Context

The ctx passed to NewClient is used for authentication requests andfor creating the underlying connection, but is not used for subsequent calls.Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

funcDefaultAuthScopes()[]string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

CallOptions

typeCallOptionsstruct{ListInsights[]gax.CallOptionGetInsight[]gax.CallOptionMarkInsightAccepted[]gax.CallOptionListRecommendations[]gax.CallOptionGetRecommendation[]gax.CallOptionMarkRecommendationDismissed[]gax.CallOptionMarkRecommendationClaimed[]gax.CallOptionMarkRecommendationSucceeded[]gax.CallOptionMarkRecommendationFailed[]gax.CallOptionGetRecommenderConfig[]gax.CallOptionUpdateRecommenderConfig[]gax.CallOptionGetInsightTypeConfig[]gax.CallOptionUpdateInsightTypeConfig[]gax.CallOption}

CallOptions contains the retry settings for each method of Client.

Client

typeClientstruct{// The call options for this service.CallOptions*CallOptions// contains filtered or unexported fields}

Client is a client for interacting with Recommender API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Provides insights and recommendations for cloud customers for variouscategories like performance optimization, cost savings, reliability, featurediscovery, etc. Insights and recommendations are generated automaticallybased on analysis of user resources, configuration and monitoring metrics.

func NewClient

funcNewClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewClient creates a new recommender client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.

Provides insights and recommendations for cloud customers for variouscategories like performance optimization, cost savings, reliability, featurediscovery, etc. Insights and recommendations are generated automaticallybased on analysis of user resources, configuration and monitoring metrics.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func NewRESTClient

funcNewRESTClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewRESTClient creates a new recommender rest client.

Provides insights and recommendations for cloud customers for variouscategories like performance optimization, cost savings, reliability, featurediscovery, etc. Insights and recommendations are generated automaticallybased on analysis of user resources, configuration and monitoring metrics.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func (*Client) Close

func(c*Client)Close()error

Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.

func (*Client) Connection (deprecated)

func(c*Client)Connection()*grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*Client) GetInsight

GetInsight gets the requested insight. Requires the recommender.*.get IAM permissionfor the specified insight type.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.GetInsightRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#GetInsightRequest.}resp,err:=c.GetInsight(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetInsightTypeConfig

GetInsightTypeConfig gets the requested InsightTypeConfig. There is only one instance of theconfig for each InsightType.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.GetInsightTypeConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#GetInsightTypeConfigRequest.}resp,err:=c.GetInsightTypeConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetRecommendation

GetRecommendation gets the requested recommendation. Requires the recommender.*.getIAM permission for the specified recommender.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.GetRecommendationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#GetRecommendationRequest.}resp,err:=c.GetRecommendation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetRecommenderConfig

GetRecommenderConfig gets the requested Recommender Config. There is only one instance of theconfig for each Recommender.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.GetRecommenderConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#GetRecommenderConfigRequest.}resp,err:=c.GetRecommenderConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ListInsights

ListInsights lists insights for the specified Cloud Resource. Requires therecommender.*.list IAM permission for the specified insight type.

Examples

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.ListInsightsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#ListInsightsRequest.}it:=c.ListInsights(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*recommenderpb.ListInsightsResponse)}}
all
packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.ListInsightsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#ListInsightsRequest.}forresp,err:=rangec.ListInsights(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListRecommendations

ListRecommendations lists recommendations for the specified Cloud Resource. Requires therecommender.*.list IAM permission for the specified recommender.

Examples

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.ListRecommendationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#ListRecommendationsRequest.}it:=c.ListRecommendations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*recommenderpb.ListRecommendationsResponse)}}
all
packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.ListRecommendationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#ListRecommendationsRequest.}forresp,err:=rangec.ListRecommendations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) MarkInsightAccepted

MarkInsightAccepted marks the Insight State as Accepted. Users can use this method toindicate to the Recommender API that they have applied some action basedon the insight. This stops the insight content from being updated.

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

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.MarkInsightAcceptedRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#MarkInsightAcceptedRequest.}resp,err:=c.MarkInsightAccepted(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) MarkRecommendationClaimed

MarkRecommendationClaimed marks the Recommendation State as Claimed. Users can use this method toindicate to the Recommender API that they are starting to apply therecommendation themselves. This stops the recommendation content from beingupdated. 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 specifiedrecommender.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.MarkRecommendationClaimedRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#MarkRecommendationClaimedRequest.}resp,err:=c.MarkRecommendationClaimed(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) MarkRecommendationDismissed

MarkRecommendationDismissed mark the Recommendation State as Dismissed. Users can use this method toindicate to the Recommender API that an ACTIVE recommendation has tobe marked back as DISMISSED.

MarkRecommendationDismissed can be applied to recommendations in ACTIVEstate.

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

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.MarkRecommendationDismissedRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#MarkRecommendationDismissedRequest.}resp,err:=c.MarkRecommendationDismissed(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) MarkRecommendationFailed

MarkRecommendationFailed marks the Recommendation State as Failed. Users can use this method toindicate to the Recommender API that they have applied the recommendationthemselves, and the operation failed. This stops the recommendation contentfrom being updated. Associated insights are frozen and placed in theACCEPTED state.

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

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

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.MarkRecommendationFailedRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#MarkRecommendationFailedRequest.}resp,err:=c.MarkRecommendationFailed(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) MarkRecommendationSucceeded

MarkRecommendationSucceeded marks the Recommendation State as Succeeded. Users can use this method toindicate to the Recommender API that they have applied the recommendationthemselves, and the operation was successful. This stops the recommendationcontent from being updated. Associated insights are frozen and placed inthe ACCEPTED state.

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

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

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.MarkRecommendationSucceededRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#MarkRecommendationSucceededRequest.}resp,err:=c.MarkRecommendationSucceeded(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) UpdateInsightTypeConfig

UpdateInsightTypeConfig updates an InsightTypeConfig change. This will create a new revision of theconfig.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.UpdateInsightTypeConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#UpdateInsightTypeConfigRequest.}resp,err:=c.UpdateInsightTypeConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) UpdateRecommenderConfig

UpdateRecommenderConfig updates a Recommender Config. This will create a new revision of theconfig.

Example

packagemainimport("context"recommender"cloud.google.com/go/recommender/apiv1"recommenderpb"cloud.google.com/go/recommender/apiv1/recommenderpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=recommender.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&recommenderpb.UpdateRecommenderConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/recommender/apiv1/recommenderpb#UpdateRecommenderConfigRequest.}resp,err:=c.UpdateRecommenderConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

InsightIterator

typeInsightIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*recommenderpb.Insight,nextPageTokenstring,errerror)// contains filtered or unexported fields}

InsightIterator manages a stream of *recommenderpb.Insight.

func (*InsightIterator) All

func(it*InsightIterator)All()iter.Seq2[*recommenderpb.Insight,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*InsightIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*InsightIterator) PageInfo

func(it*InsightIterator)PageInfo()*iterator.PageInfo

PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.

RecommendationIterator

typeRecommendationIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*recommenderpb.Recommendation,nextPageTokenstring,errerror)// contains filtered or unexported fields}

RecommendationIterator manages a stream of *recommenderpb.Recommendation.

func (*RecommendationIterator) All

func(it*RecommendationIterator)All()iter.Seq2[*recommenderpb.Recommendation,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*RecommendationIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*RecommendationIterator) PageInfo

func(it*RecommendationIterator)PageInfo()*iterator.PageInfo

PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.