Documentation

Overview

Package recaptchaenterprise is an auto-generated package for the reCAPTCHA Enterprise 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 pkg.go.dev/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

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 {
    	CreateAssessment   []gax.CallOption
    	AnnotateAssessment []gax.CallOption
    	CreateKey          []gax.CallOption
    	ListKeys           []gax.CallOption
    	GetKey             []gax.CallOption
    	UpdateKey          []gax.CallOption
    	DeleteKey          []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 reCAPTCHA Enterprise 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 recaptcha enterprise service client.

          Service to determine the likelihood an event is legitimate.

          Example
          Output:
          
          

          func (*Client) AnnotateAssessment

            AnnotateAssessment annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

            Example
            Output:
            
            

            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) CreateAssessment

                  CreateAssessment creates an Assessment of the likelihood an event is legitimate.

                  Example
                  Output:
                  
                  

                  func (*Client) CreateKey

                    CreateKey creates a new reCAPTCHA Enterprise key.

                    Example
                    Output:
                    
                    

                    func (*Client) DeleteKey

                      DeleteKey deletes the specified key.

                      Example
                      Output:
                      
                      

                      func (*Client) GetKey

                        GetKey returns the specified key.

                        Example
                        Output:
                        
                        

                        func (*Client) ListKeys

                          ListKeys returns the list of all keys that belong to a project.

                          Example
                          Output:
                          
                          

                          func (*Client) UpdateKey

                            UpdateKey updates the specified key.

                            Example
                            Output:
                            
                            

                            type KeyIterator

                            type KeyIterator 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 []*recaptchaenterprisepb.Key, nextPageToken string, err error)
                            	// contains filtered or unexported fields
                            }

                              KeyIterator manages a stream of *recaptchaenterprisepb.Key.

                              func (*KeyIterator) Next

                              func (it *KeyIterator) Next() (*recaptchaenterprisepb.Key, 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 (*KeyIterator) PageInfo

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

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