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 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 {
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.
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.
Service to determine the likelihood an event is legitimate.
func NewClient
NewClient creates a new recaptcha enterprise service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service to determine the likelihood an event is legitimate.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*Client) AnnotateAssessment
func (c * Client
) AnnotateAssessment(ctx context
. Context
, req * recaptchaenterprisepb
. AnnotateAssessmentRequest
, opts ... gax
. CallOption
) (* recaptchaenterprisepb
. AnnotateAssessmentResponse
, error
)
AnnotateAssessment annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &recaptchaenterprisepb.AnnotateAssessmentRequest{
// TODO: Fill request struct fields.
}
resp, err := c.AnnotateAssessment(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
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) CreateAssessment
func (c * Client
) CreateAssessment(ctx context
. Context
, req * recaptchaenterprisepb
. CreateAssessmentRequest
, opts ... gax
. CallOption
) (* recaptchaenterprisepb
. Assessment
, error
)
CreateAssessment creates an Assessment of the likelihood an event is legitimate.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &recaptchaenterprisepb.CreateAssessmentRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateAssessment(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) CreateKey
func (c * Client
) CreateKey(ctx context
. Context
, req * recaptchaenterprisepb
. CreateKeyRequest
, opts ... gax
. CallOption
) (* recaptchaenterprisepb
. Key
, error
)
CreateKey creates a new reCAPTCHA Enterprise key.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &recaptchaenterprisepb.CreateKeyRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateKey(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) DeleteKey
func (c * Client
) DeleteKey(ctx context
. Context
, req * recaptchaenterprisepb
. DeleteKeyRequest
, opts ... gax
. CallOption
) error
DeleteKey deletes the specified key.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &recaptchaenterprisepb.DeleteKeyRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteKey(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) GetKey
func (c * Client
) GetKey(ctx context
. Context
, req * recaptchaenterprisepb
. GetKeyRequest
, opts ... gax
. CallOption
) (* recaptchaenterprisepb
. Key
, error
)
GetKey returns the specified key.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &recaptchaenterprisepb.GetKeyRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetKey(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ListKeys
func (c * Client
) ListKeys(ctx context
. Context
, req * recaptchaenterprisepb
. ListKeysRequest
, opts ... gax
. CallOption
) * KeyIterator
ListKeys returns the list of all keys that belong to a project.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
"google.golang.org/api/iterator"
recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &recaptchaenterprisepb.ListKeysRequest{
// TODO: Fill request struct fields.
}
it := c.ListKeys(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) UpdateKey
func (c * Client
) UpdateKey(ctx context
. Context
, req * recaptchaenterprisepb
. UpdateKeyRequest
, opts ... gax
. CallOption
) (* recaptchaenterprisepb
. Key
, error
)
UpdateKey updates the specified key.
Example
package main
import (
recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1"
"context"
recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1"
)
func main() {
ctx := context.Background()
c, err := recaptchaenterprise.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &recaptchaenterprisepb.UpdateKeyRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateKey(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
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.
