Documentation ¶
Index ¶
- func DefaultAuthScopes() []string
- type KeyIterator
- type RecaptchaEnterpriseServiceV1Beta1CallOptions
- type RecaptchaEnterpriseServiceV1Beta1Client
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) AnnotateAssessment(ctx context.Context, req *recaptchaenterprisepb.AnnotateAssessmentRequest, ...) (*recaptchaenterprisepb.AnnotateAssessmentResponse, error)
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) Close() error
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) Connection() *grpc.ClientConn
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) CreateAssessment(ctx context.Context, req *recaptchaenterprisepb.CreateAssessmentRequest, ...) (*recaptchaenterprisepb.Assessment, error)
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) CreateKey(ctx context.Context, req *recaptchaenterprisepb.CreateKeyRequest, ...) (*recaptchaenterprisepb.Key, error)
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) DeleteKey(ctx context.Context, req *recaptchaenterprisepb.DeleteKeyRequest, ...) error
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) GetKey(ctx context.Context, req *recaptchaenterprisepb.GetKeyRequest, ...) (*recaptchaenterprisepb.Key, error)
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) ListKeys(ctx context.Context, req *recaptchaenterprisepb.ListKeysRequest, ...) *KeyIterator
- func (c *RecaptchaEnterpriseServiceV1Beta1Client) UpdateKey(ctx context.Context, req *recaptchaenterprisepb.UpdateKeyRequest, ...) (*recaptchaenterprisepb.Key, error)
Examples ¶
- NewRecaptchaEnterpriseServiceV1Beta1Client
- RecaptchaEnterpriseServiceV1Beta1Client.AnnotateAssessment
- RecaptchaEnterpriseServiceV1Beta1Client.CreateAssessment
- RecaptchaEnterpriseServiceV1Beta1Client.CreateKey
- RecaptchaEnterpriseServiceV1Beta1Client.DeleteKey
- RecaptchaEnterpriseServiceV1Beta1Client.GetKey
- RecaptchaEnterpriseServiceV1Beta1Client.ListKeys
- RecaptchaEnterpriseServiceV1Beta1Client.UpdateKey
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 KeyIterator ¶ added in v0.50.0
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 ¶ added in v0.50.0
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 ¶ added in v0.50.0
func (it *KeyIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RecaptchaEnterpriseServiceV1Beta1CallOptions ¶
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 ¶
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 ¶
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.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" ) func main() { ctx := context.Background() c, err := recaptchaenterprise.NewRecaptchaEnterpriseServiceV1Beta1Client(ctx) if err != nil { // TODO: Handle error. } // TODO: Use client. _ = c }
Output:
func (*RecaptchaEnterpriseServiceV1Beta1Client) AnnotateAssessment ¶
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.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" ) func main() { // import recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" 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 }
Output:
func (*RecaptchaEnterpriseServiceV1Beta1Client) Close ¶
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 ¶
func (c *RecaptchaEnterpriseServiceV1Beta1Client) Connection() *grpc.ClientConn
Connection returns the client's connection to the API service.
func (*RecaptchaEnterpriseServiceV1Beta1Client) CreateAssessment ¶
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.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" ) func main() { // import recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" 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 }
Output:
func (*RecaptchaEnterpriseServiceV1Beta1Client) CreateKey ¶ added in v0.50.0
func (c *RecaptchaEnterpriseServiceV1Beta1Client) CreateKey(ctx context.Context, req *recaptchaenterprisepb.CreateKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Key, error)
CreateKey creates a new reCAPTCHA Enterprise key.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" ) func main() { // import recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" 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 }
Output:
func (*RecaptchaEnterpriseServiceV1Beta1Client) DeleteKey ¶ added in v0.50.0
func (c *RecaptchaEnterpriseServiceV1Beta1Client) DeleteKey(ctx context.Context, req *recaptchaenterprisepb.DeleteKeyRequest, opts ...gax.CallOption) error
DeleteKey deletes the specified key.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" ) func main() { 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. } }
Output:
func (*RecaptchaEnterpriseServiceV1Beta1Client) GetKey ¶ added in v0.50.0
func (c *RecaptchaEnterpriseServiceV1Beta1Client) GetKey(ctx context.Context, req *recaptchaenterprisepb.GetKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Key, error)
GetKey returns the specified key.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" ) func main() { // import recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" 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 }
Output:
func (*RecaptchaEnterpriseServiceV1Beta1Client) ListKeys ¶ added in v0.50.0
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.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" "google.golang.org/api/iterator" recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" ) func main() { // import recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" // import "google.golang.org/api/iterator" 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 } }
Output:
func (*RecaptchaEnterpriseServiceV1Beta1Client) UpdateKey ¶ added in v0.50.0
func (c *RecaptchaEnterpriseServiceV1Beta1Client) UpdateKey(ctx context.Context, req *recaptchaenterprisepb.UpdateKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Key, error)
UpdateKey updates the specified key.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/apiv1beta1" recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" ) func main() { // import recaptchaenterprisepb "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1" 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 }
Output: