go: cloud.google.com/go/recommender/apiv1beta1 Index | Examples | Files

package recommender

import "cloud.google.com/go/recommender/apiv1beta1"

Index

Examples

Package Files

doc.go recommender_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

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

type CallOptions Uses

type CallOptions struct {
    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.

type Client Uses

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.

func NewClient Uses

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new recommender client.

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.

Code:

ctx := context.Background()
c, err := recommender.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*Client) Close Uses

func (c *Client) Close() error

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

func (*Client) Connection Uses

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

Connection returns the client's connection to the API service.

func (*Client) GetRecommendation Uses

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.

Code:

// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"

ctx := context.Background()
c, err := recommender.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

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) ListRecommendations Uses

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.

Code:

// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"
// import "google.golang.org/api/iterator"

ctx := context.Background()
c, err := recommender.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

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) MarkRecommendationClaimed Uses

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.

Code:

// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"

ctx := context.Background()
c, err := recommender.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

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 Uses

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.

Code:

// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"

ctx := context.Background()
c, err := recommender.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

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 Uses

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.

Code:

// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1beta1"

ctx := context.Background()
c, err := recommender.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &recommenderpb.MarkRecommendationSucceededRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.MarkRecommendationSucceeded(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

type RecommendationIterator Uses

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 Uses

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 Uses

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

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

Package recommender imports 17 packages (graph). Updated 2019-12-14. Refresh now. Tools for package owners.