- 0.121.6 (latest)
- 0.121.5
- 0.120.1
- 0.119.0
- 0.118.3
- 0.117.0
- 0.116.0
- 0.115.1
- 0.114.0
- 0.113.0
- 0.112.2
- 0.111.0
- 0.110.10
- 0.109.0
- 0.108.0
- 0.107.0
- 0.106.0
- 0.105.0
- 0.104.0
- 0.103.0
- 0.102.1
- 0.101.1
- 0.100.2
- 0.99.0
- 0.98.0
- 0.97.0
- 0.96.0
- 0.95.0
- 0.94.1
- 0.93.3
- 0.92.3
- 0.91.1
- 0.90.0
- 0.89.0
- 0.88.0
- 0.87.0
- 0.86.0
- 0.85.0
- 0.84.0
- 0.83.0
- 0.82.0
- 0.81.0
- 0.80.0
- 0.79.0
- 0.78.0
- 0.77.0
- 0.76.0
- 0.75.0
Package recommender is an auto-generated package for the Recommender API.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
Use of Context
The ctx passed to NewClient is used for authentication requests and for 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.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
ListInsights
[]
gax
.
CallOption
GetInsight
[]
gax
.
CallOption
MarkInsightAccepted
[]
gax
.
CallOption
ListRecommendations
[]
gax
.
CallOption
GetRecommendation
[]
gax
.
CallOption
MarkRecommendationClaimed
[]
gax
.
CallOption
MarkRecommendationSucceeded
[]
gax
.
CallOption
MarkRecommendationFailed
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// 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 various categories like performance optimization, cost savings, reliability, feature discovery, etc. Insights and recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.
func NewClient
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 various categories like performance optimization, cost savings, reliability, feature discovery, etc. Insights and recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) GetInsight
func
(
c
*
Client
)
GetInsight
(
ctx
context
.
Context
,
req
*
recommenderpb
.
GetInsightRequest
,
opts
...
gax
.
CallOption
)
(
*
recommenderpb
.
Insight
,
error
)
GetInsight gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
GetInsightRequest
{
// TODO: Fill request struct fields.
}
resp
,
err
:=
c
.
GetInsight
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetRecommendation
func
(
c
*
Client
)
GetRecommendation
(
ctx
context
.
Context
,
req
*
recommenderpb
.
GetRecommendationRequest
,
opts
...
gax
.
CallOption
)
(
*
recommenderpb
.
Recommendation
,
error
)
GetRecommendation gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
GetRecommendationRequest
{
// TODO: Fill request struct fields.
}
resp
,
err
:=
c
.
GetRecommendation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListInsights
func
(
c
*
Client
)
ListInsights
(
ctx
context
.
Context
,
req
*
recommenderpb
.
ListInsightsRequest
,
opts
...
gax
.
CallOption
)
*
InsightIterator
ListInsights lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
"google.golang.org/api/iterator"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
ListInsightsRequest
{
// TODO: Fill request struct fields.
}
it
:=
c
.
ListInsights
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListRecommendations
func
(
c
*
Client
)
ListRecommendations
(
ctx
context
.
Context
,
req
*
recommenderpb
.
ListRecommendationsRequest
,
opts
...
gax
.
CallOption
)
*
RecommendationIterator
ListRecommendations lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
"google.golang.org/api/iterator"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
ListRecommendationsRequest
{
// TODO: Fill request struct fields.
}
it
:=
c
.
ListRecommendations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) MarkInsightAccepted
func
(
c
*
Client
)
MarkInsightAccepted
(
ctx
context
.
Context
,
req
*
recommenderpb
.
MarkInsightAcceptedRequest
,
opts
...
gax
.
CallOption
)
(
*
recommenderpb
.
Insight
,
error
)
MarkInsightAccepted marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated.
MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
MarkInsightAcceptedRequest
{
// TODO: Fill request struct fields.
}
resp
,
err
:=
c
.
MarkInsightAccepted
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) MarkRecommendationClaimed
func
(
c
*
Client
)
MarkRecommendationClaimed
(
ctx
context
.
Context
,
req
*
recommenderpb
.
MarkRecommendationClaimedRequest
,
opts
...
gax
.
CallOption
)
(
*
recommenderpb
.
Recommendation
,
error
)
MarkRecommendationClaimed marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.
MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state.
Requires the recommender.*.update IAM permission for the specified recommender.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
MarkRecommendationClaimedRequest
{
// TODO: Fill request struct fields.
}
resp
,
err
:=
c
.
MarkRecommendationClaimed
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) MarkRecommendationFailed
func
(
c
*
Client
)
MarkRecommendationFailed
(
ctx
context
.
Context
,
req
*
recommenderpb
.
MarkRecommendationFailedRequest
,
opts
...
gax
.
CallOption
)
(
*
recommenderpb
.
Recommendation
,
error
)
MarkRecommendationFailed marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.
MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.
Requires the recommender.*.update IAM permission for the specified recommender.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
MarkRecommendationFailedRequest
{
// TODO: Fill request struct fields.
}
resp
,
err
:=
c
.
MarkRecommendationFailed
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) MarkRecommendationSucceeded
func
(
c
*
Client
)
MarkRecommendationSucceeded
(
ctx
context
.
Context
,
req
*
recommenderpb
.
MarkRecommendationSucceededRequest
,
opts
...
gax
.
CallOption
)
(
*
recommenderpb
.
Recommendation
,
error
)
MarkRecommendationSucceeded marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.
MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.
Requires the recommender.*.update IAM permission for the specified recommender.
Example
package
main
import
(
"context"
recommender
"cloud.google.com/go/recommender/apiv1beta1"
recommenderpb
"google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
recommender
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& recommenderpb
.
MarkRecommendationSucceededRequest
{
// TODO: Fill request struct fields.
}
resp
,
err
:=
c
.
MarkRecommendationSucceeded
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
InsightIterator
type
InsightIterator
struct
{
// 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.
Response
interface
{}
// 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.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
recommenderpb
.
Insight
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
InsightIterator manages a stream of *recommenderpb.Insight.
func (*InsightIterator) Next
func
(
it
*
InsightIterator
)
Next
()
(
*
recommenderpb
.
Insight
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. 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
type
RecommendationIterator
struct
{
// 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.
Response
interface
{}
// 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.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
recommenderpb
.
Recommendation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
RecommendationIterator manages a stream of *recommenderpb.Recommendation.
func (*RecommendationIterator) Next
func
(
it
*
RecommendationIterator
)
Next
()
(
*
recommenderpb
.
Recommendation
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. 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.
