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

package recaptchaenterprise

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

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

Index

Examples

Package Files

doc.go recaptcha_enterprise_service_v1_beta1_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

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

type KeyIterator Uses

type KeyIterator struct {

    // 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 Uses

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 Uses

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

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

type RecaptchaEnterpriseServiceV1Beta1CallOptions Uses

type RecaptchaEnterpriseServiceV1Beta1CallOptions struct {
    CreateAssessment   []gax.CallOption
    AnnotateAssessment []gax.CallOption
    CreateKey          []gax.CallOption
    ListKeys           []gax.CallOption
    GetKey             []gax.CallOption
    UpdateKey          []gax.CallOption
    DeleteKey          []gax.CallOption
}

RecaptchaEnterpriseServiceV1Beta1CallOptions contains the retry settings for each method of RecaptchaEnterpriseServiceV1Beta1Client.

type RecaptchaEnterpriseServiceV1Beta1Client Uses

type RecaptchaEnterpriseServiceV1Beta1Client struct {

    // The call options for this service.
    CallOptions *RecaptchaEnterpriseServiceV1Beta1CallOptions
    // contains filtered or unexported fields
}

RecaptchaEnterpriseServiceV1Beta1Client 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 NewRecaptchaEnterpriseServiceV1Beta1Client Uses

func NewRecaptchaEnterpriseServiceV1Beta1Client(ctx context.Context, opts ...option.ClientOption) (*RecaptchaEnterpriseServiceV1Beta1Client, error)

NewRecaptchaEnterpriseServiceV1Beta1Client creates a new recaptcha enterprise service v1 beta1 client.

Service to determine the likelihood an event is legitimate.

Code:

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

func (*RecaptchaEnterpriseServiceV1Beta1Client) AnnotateAssessment Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) 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.

Code:

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

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 (*RecaptchaEnterpriseServiceV1Beta1Client) Close Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) Close() error

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

func (*RecaptchaEnterpriseServiceV1Beta1Client) Connection Uses

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

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

func (*RecaptchaEnterpriseServiceV1Beta1Client) CreateAssessment Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) CreateAssessment(ctx context.Context, req *recaptchaenterprisepb.CreateAssessmentRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Assessment, error)

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

Code:

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

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 (*RecaptchaEnterpriseServiceV1Beta1Client) CreateKey Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) CreateKey(ctx context.Context, req *recaptchaenterprisepb.CreateKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Key, error)

CreateKey creates a new reCAPTCHA Enterprise key.

Code:

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

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 (*RecaptchaEnterpriseServiceV1Beta1Client) DeleteKey Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) DeleteKey(ctx context.Context, req *recaptchaenterprisepb.DeleteKeyRequest, opts ...gax.CallOption) error

DeleteKey deletes the specified key.

Code:

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

req := &recaptchaenterprisepb.DeleteKeyRequest{
    // TODO: Fill request struct fields.
}
err = c.DeleteKey(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*RecaptchaEnterpriseServiceV1Beta1Client) GetKey Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) GetKey(ctx context.Context, req *recaptchaenterprisepb.GetKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Key, error)

GetKey returns the specified key.

Code:

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

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 (*RecaptchaEnterpriseServiceV1Beta1Client) ListKeys Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) ListKeys(ctx context.Context, req *recaptchaenterprisepb.ListKeysRequest, opts ...gax.CallOption) *KeyIterator

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

Code:

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

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 (*RecaptchaEnterpriseServiceV1Beta1Client) UpdateKey Uses

func (c *RecaptchaEnterpriseServiceV1Beta1Client) UpdateKey(ctx context.Context, req *recaptchaenterprisepb.UpdateKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Key, error)

UpdateKey updates the specified key.

Code:

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

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

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