recommender

Documentation

Overview

Package recommender is an auto-generated package for the Recommender API.

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 godoc.org/cloud.google.com/go.

Index

• func DefaultAuthScopes() []string
• type CallOptions
• type Client
  • func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Connection() *grpc.ClientConn
  • func (c *Client) GetRecommendation(ctx context.Context, req *recommenderpb.GetRecommendationRequest, ...) (*recommenderpb.Recommendation, error)
  • func (c *Client) ListRecommendations(ctx context.Context, req *recommenderpb.ListRecommendationsRequest, ...) *RecommendationIterator
  • func (c *Client) MarkRecommendationClaimed(ctx context.Context, req *recommenderpb.MarkRecommendationClaimedRequest, ...) (*recommenderpb.Recommendation, error)
  • func (c *Client) MarkRecommendationFailed(ctx context.Context, req *recommenderpb.MarkRecommendationFailedRequest, ...) (*recommenderpb.Recommendation, error)
  • func (c *Client) MarkRecommendationSucceeded(ctx context.Context, req *recommenderpb.MarkRecommendationSucceededRequest, ...) (*recommenderpb.Recommendation, error)
• type RecommendationIterator
  • func (it *RecommendationIterator) Next() (*recommenderpb.Recommendation, error)
  • func (it *RecommendationIterator) PageInfo() *iterator.PageInfo

Examples

• Client.GetRecommendation
• Client.ListRecommendations
• Client.MarkRecommendationClaimed
• Client.MarkRecommendationFailed
• Client.MarkRecommendationSucceeded
• NewClient

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

type CallOptions

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

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

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

NewClient creates a new recommender client.

Provides recommendations for cloud customers for various categories like performance optimization, cost savings, reliability, feature discovery, etc. These 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/apiv1"
)

func main() {
	ctx := context.Background()
	c, err := recommender.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// 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 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) 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/apiv1"

	recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"
)

func main() {
	// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"

	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

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/apiv1"
	"google.golang.org/api/iterator"

	recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"
)

func main() {
	// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"
	// 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

func (c *Client) MarkRecommendationClaimed(ctx context.Context, req *recommenderpb.MarkRecommendationClaimedRequest, opts ...gax.CallOption) (*recommenderpb.Recommendation, error)

MarkRecommendationClaimed mark 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.

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

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

Example

package main

import (
	"context"

	recommender "cloud.google.com/go/recommender/apiv1"

	recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"
)

func main() {
	// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"

	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

func (c *Client) MarkRecommendationFailed(ctx context.Context, req *recommenderpb.MarkRecommendationFailedRequest, opts ...gax.CallOption) (*recommenderpb.Recommendation, error)

MarkRecommendationFailed mark 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.

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/apiv1"

	recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"
)

func main() {
	// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"

	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

func (c *Client) MarkRecommendationSucceeded(ctx context.Context, req *recommenderpb.MarkRecommendationSucceededRequest, opts ...gax.CallOption) (*recommenderpb.Recommendation, error)

MarkRecommendationSucceeded mark 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.

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/apiv1"

	recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"
)

func main() {
	// import recommenderpb "google.golang.org/genproto/googleapis/cloud/recommender/v1"

	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

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.