Documentation ¶
Overview ¶
Package recaptchaenterprise is an auto-generated package for the reCAPTCHA Enterprise API.
Help protect your website from fraudulent activity, spam, and abuse without creating friction.
General documentation ¶
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage ¶
To get started with this package, create a client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client ¶
The following is an example of making an API call with the newly created client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.AddIpOverrideRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#AddIpOverrideRequest. } resp, err := c.AddIpOverride(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
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.
Index ¶
- func DefaultAuthScopes() []string
- type CallOptions
- type Client
- func (c *Client) AddIpOverride(ctx context.Context, req *recaptchaenterprisepb.AddIpOverrideRequest, ...) (*recaptchaenterprisepb.AddIpOverrideResponse, error)
- func (c *Client) AnnotateAssessment(ctx context.Context, req *recaptchaenterprisepb.AnnotateAssessmentRequest, ...) (*recaptchaenterprisepb.AnnotateAssessmentResponse, error)
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreateAssessment(ctx context.Context, req *recaptchaenterprisepb.CreateAssessmentRequest, ...) (*recaptchaenterprisepb.Assessment, error)
- func (c *Client) CreateFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.CreateFirewallPolicyRequest, ...) (*recaptchaenterprisepb.FirewallPolicy, error)
- func (c *Client) CreateKey(ctx context.Context, req *recaptchaenterprisepb.CreateKeyRequest, ...) (*recaptchaenterprisepb.Key, error)
- func (c *Client) DeleteFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.DeleteFirewallPolicyRequest, ...) error
- func (c *Client) DeleteKey(ctx context.Context, req *recaptchaenterprisepb.DeleteKeyRequest, ...) error
- func (c *Client) GetFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.GetFirewallPolicyRequest, ...) (*recaptchaenterprisepb.FirewallPolicy, error)
- func (c *Client) GetKey(ctx context.Context, req *recaptchaenterprisepb.GetKeyRequest, ...) (*recaptchaenterprisepb.Key, error)
- func (c *Client) GetMetrics(ctx context.Context, req *recaptchaenterprisepb.GetMetricsRequest, ...) (*recaptchaenterprisepb.Metrics, error)
- func (c *Client) ListFirewallPolicies(ctx context.Context, req *recaptchaenterprisepb.ListFirewallPoliciesRequest, ...) *FirewallPolicyIterator
- func (c *Client) ListKeys(ctx context.Context, req *recaptchaenterprisepb.ListKeysRequest, ...) *KeyIterator
- func (c *Client) ListRelatedAccountGroupMemberships(ctx context.Context, ...) *RelatedAccountGroupMembershipIterator
- func (c *Client) ListRelatedAccountGroups(ctx context.Context, ...) *RelatedAccountGroupIterator
- func (c *Client) MigrateKey(ctx context.Context, req *recaptchaenterprisepb.MigrateKeyRequest, ...) (*recaptchaenterprisepb.Key, error)
- func (c *Client) ReorderFirewallPolicies(ctx context.Context, req *recaptchaenterprisepb.ReorderFirewallPoliciesRequest, ...) (*recaptchaenterprisepb.ReorderFirewallPoliciesResponse, error)
- func (c *Client) RetrieveLegacySecretKey(ctx context.Context, req *recaptchaenterprisepb.RetrieveLegacySecretKeyRequest, ...) (*recaptchaenterprisepb.RetrieveLegacySecretKeyResponse, error)
- func (c *Client) SearchRelatedAccountGroupMemberships(ctx context.Context, ...) *RelatedAccountGroupMembershipIterator
- func (c *Client) UpdateFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.UpdateFirewallPolicyRequest, ...) (*recaptchaenterprisepb.FirewallPolicy, error)
- func (c *Client) UpdateKey(ctx context.Context, req *recaptchaenterprisepb.UpdateKeyRequest, ...) (*recaptchaenterprisepb.Key, error)
- type FirewallPolicyIterator
- type KeyIterator
- type RelatedAccountGroupIterator
- type RelatedAccountGroupMembershipIterator
- func (it *RelatedAccountGroupMembershipIterator) All() iter.Seq2[*recaptchaenterprisepb.RelatedAccountGroupMembership, error]
- func (it *RelatedAccountGroupMembershipIterator) Next() (*recaptchaenterprisepb.RelatedAccountGroupMembership, error)
- func (it *RelatedAccountGroupMembershipIterator) PageInfo() *iterator.PageInfo
Examples ¶
- Client.AddIpOverride
- Client.AnnotateAssessment
- Client.CreateAssessment
- Client.CreateFirewallPolicy
- Client.CreateKey
- Client.DeleteFirewallPolicy
- Client.DeleteKey
- Client.GetFirewallPolicy
- Client.GetKey
- Client.GetMetrics
- Client.ListFirewallPolicies
- Client.ListFirewallPolicies (All)
- Client.ListKeys
- Client.ListKeys (All)
- Client.ListRelatedAccountGroupMemberships
- Client.ListRelatedAccountGroupMemberships (All)
- Client.ListRelatedAccountGroups
- Client.ListRelatedAccountGroups (All)
- Client.MigrateKey
- Client.ReorderFirewallPolicies
- Client.RetrieveLegacySecretKey
- Client.SearchRelatedAccountGroupMemberships
- Client.SearchRelatedAccountGroupMemberships (All)
- Client.UpdateFirewallPolicy
- Client.UpdateKey
- NewClient
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 RetrieveLegacySecretKey []gax.CallOption GetKey []gax.CallOption UpdateKey []gax.CallOption DeleteKey []gax.CallOption MigrateKey []gax.CallOption AddIpOverride []gax.CallOption GetMetrics []gax.CallOption CreateFirewallPolicy []gax.CallOption ListFirewallPolicies []gax.CallOption GetFirewallPolicy []gax.CallOption UpdateFirewallPolicy []gax.CallOption DeleteFirewallPolicy []gax.CallOption ReorderFirewallPolicies []gax.CallOption ListRelatedAccountGroups []gax.CallOption ListRelatedAccountGroupMemberships []gax.CallOption SearchRelatedAccountGroupMemberships []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.
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 ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*Client) AddIpOverride ¶ added in v2.16.0
func (c *Client) AddIpOverride(ctx context.Context, req *recaptchaenterprisepb.AddIpOverrideRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.AddIpOverrideResponse, error)
AddIpOverride adds an IP override to a key. The following restrictions hold:
The maximum number of IP overrides per key is 100. For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.AddIpOverrideRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#AddIpOverrideRequest. } resp, err := c.AddIpOverride(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 fraudulent.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.AnnotateAssessmentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#AnnotateAssessmentRequest. } resp, err := c.AnnotateAssessment(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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
deprecated
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
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 ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.CreateAssessmentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#CreateAssessmentRequest. } resp, err := c.CreateAssessment(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateFirewallPolicy ¶ added in v2.8.0
func (c *Client) CreateFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.CreateFirewallPolicyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.FirewallPolicy, error)
CreateFirewallPolicy creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.CreateFirewallPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#CreateFirewallPolicyRequest. } resp, err := c.CreateFirewallPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.CreateKeyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#CreateKeyRequest. } resp, err := c.CreateKey(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) DeleteFirewallPolicy ¶ added in v2.8.0
func (c *Client) DeleteFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.DeleteFirewallPolicyRequest, opts ...gax.CallOption) error
DeleteFirewallPolicy deletes the specified firewall policy.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.DeleteFirewallPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#DeleteFirewallPolicyRequest. } err = c.DeleteFirewallPolicy(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
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 ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.DeleteKeyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#DeleteKeyRequest. } err = c.DeleteKey(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) GetFirewallPolicy ¶ added in v2.8.0
func (c *Client) GetFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.GetFirewallPolicyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.FirewallPolicy, error)
GetFirewallPolicy returns the specified firewall policy.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.GetFirewallPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#GetFirewallPolicyRequest. } resp, err := c.GetFirewallPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.GetKeyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#GetKeyRequest. } resp, err := c.GetKey(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetMetrics ¶
func (c *Client) GetMetrics(ctx context.Context, req *recaptchaenterprisepb.GetMetricsRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Metrics, error)
GetMetrics get some aggregated metrics for a Key. This data can be used to build dashboards.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.GetMetricsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#GetMetricsRequest. } resp, err := c.GetMetrics(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListFirewallPolicies ¶ added in v2.8.0
func (c *Client) ListFirewallPolicies(ctx context.Context, req *recaptchaenterprisepb.ListFirewallPoliciesRequest, opts ...gax.CallOption) *FirewallPolicyIterator
ListFirewallPolicies returns the list of all firewall policies that belong to a project.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListFirewallPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListFirewallPoliciesRequest. } it := c.ListFirewallPolicies(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*recaptchaenterprisepb.ListFirewallPoliciesResponse) } }
Output:
Example (All) ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListFirewallPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListFirewallPoliciesRequest. } for resp, err := range c.ListFirewallPolicies(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
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 ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListKeysRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListKeysRequest. } 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 // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*recaptchaenterprisepb.ListKeysResponse) } }
Output:
Example (All) ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListKeysRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListKeysRequest. } for resp, err := range c.ListKeys(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListRelatedAccountGroupMemberships ¶
func (c *Client) ListRelatedAccountGroupMemberships(ctx context.Context, req *recaptchaenterprisepb.ListRelatedAccountGroupMembershipsRequest, opts ...gax.CallOption) *RelatedAccountGroupMembershipIterator
ListRelatedAccountGroupMemberships get memberships in a group of related accounts.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListRelatedAccountGroupMembershipsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListRelatedAccountGroupMembershipsRequest. } it := c.ListRelatedAccountGroupMemberships(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*recaptchaenterprisepb.ListRelatedAccountGroupMembershipsResponse) } }
Output:
Example (All) ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListRelatedAccountGroupMembershipsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListRelatedAccountGroupMembershipsRequest. } for resp, err := range c.ListRelatedAccountGroupMemberships(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListRelatedAccountGroups ¶
func (c *Client) ListRelatedAccountGroups(ctx context.Context, req *recaptchaenterprisepb.ListRelatedAccountGroupsRequest, opts ...gax.CallOption) *RelatedAccountGroupIterator
ListRelatedAccountGroups list groups of related accounts.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListRelatedAccountGroupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListRelatedAccountGroupsRequest. } it := c.ListRelatedAccountGroups(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*recaptchaenterprisepb.ListRelatedAccountGroupsResponse) } }
Output:
Example (All) ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ListRelatedAccountGroupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ListRelatedAccountGroupsRequest. } for resp, err := range c.ListRelatedAccountGroups(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) MigrateKey ¶
func (c *Client) MigrateKey(ctx context.Context, req *recaptchaenterprisepb.MigrateKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.Key, error)
MigrateKey migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.MigrateKeyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#MigrateKeyRequest. } resp, err := c.MigrateKey(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ReorderFirewallPolicies ¶ added in v2.10.0
func (c *Client) ReorderFirewallPolicies(ctx context.Context, req *recaptchaenterprisepb.ReorderFirewallPoliciesRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.ReorderFirewallPoliciesResponse, error)
ReorderFirewallPolicies reorders all firewall policies.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.ReorderFirewallPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#ReorderFirewallPoliciesRequest. } resp, err := c.ReorderFirewallPolicies(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) RetrieveLegacySecretKey ¶ added in v2.3.0
func (c *Client) RetrieveLegacySecretKey(ctx context.Context, req *recaptchaenterprisepb.RetrieveLegacySecretKeyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.RetrieveLegacySecretKeyResponse, error)
RetrieveLegacySecretKey returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.RetrieveLegacySecretKeyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#RetrieveLegacySecretKeyRequest. } resp, err := c.RetrieveLegacySecretKey(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) SearchRelatedAccountGroupMemberships ¶
func (c *Client) SearchRelatedAccountGroupMemberships(ctx context.Context, req *recaptchaenterprisepb.SearchRelatedAccountGroupMembershipsRequest, opts ...gax.CallOption) *RelatedAccountGroupMembershipIterator
SearchRelatedAccountGroupMemberships search group memberships related to a given account.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.SearchRelatedAccountGroupMembershipsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#SearchRelatedAccountGroupMembershipsRequest. } it := c.SearchRelatedAccountGroupMemberships(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*recaptchaenterprisepb.SearchRelatedAccountGroupMembershipsResponse) } }
Output:
Example (All) ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.SearchRelatedAccountGroupMembershipsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#SearchRelatedAccountGroupMembershipsRequest. } for resp, err := range c.SearchRelatedAccountGroupMemberships(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) UpdateFirewallPolicy ¶ added in v2.8.0
func (c *Client) UpdateFirewallPolicy(ctx context.Context, req *recaptchaenterprisepb.UpdateFirewallPolicyRequest, opts ...gax.CallOption) (*recaptchaenterprisepb.FirewallPolicy, error)
UpdateFirewallPolicy updates the specified firewall policy.
Example ¶
package main import ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.UpdateFirewallPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#UpdateFirewallPolicyRequest. } resp, err := c.UpdateFirewallPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ( "context" recaptchaenterprise "cloud.google.com/go/recaptchaenterprise/v2/apiv1" recaptchaenterprisepb "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := recaptchaenterprise.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &recaptchaenterprisepb.UpdateKeyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb#UpdateKeyRequest. } resp, err := c.UpdateKey(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
type FirewallPolicyIterator ¶ added in v2.8.0
type FirewallPolicyIterator 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.FirewallPolicy, nextPageToken string, err error) // contains filtered or unexported fields }
FirewallPolicyIterator manages a stream of *recaptchaenterprisepb.FirewallPolicy.
func (*FirewallPolicyIterator) All ¶ added in v2.16.0
func (it *FirewallPolicyIterator) All() iter.Seq2[*recaptchaenterprisepb.FirewallPolicy, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*FirewallPolicyIterator) Next ¶ added in v2.8.0
func (it *FirewallPolicyIterator) Next() (*recaptchaenterprisepb.FirewallPolicy, 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 (*FirewallPolicyIterator) PageInfo ¶ added in v2.8.0
func (it *FirewallPolicyIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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) All ¶ added in v2.16.0
func (it *KeyIterator) All() iter.Seq2[*recaptchaenterprisepb.Key, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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.
type RelatedAccountGroupIterator ¶
type RelatedAccountGroupIterator 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.RelatedAccountGroup, nextPageToken string, err error) // contains filtered or unexported fields }
RelatedAccountGroupIterator manages a stream of *recaptchaenterprisepb.RelatedAccountGroup.
func (*RelatedAccountGroupIterator) All ¶ added in v2.16.0
func (it *RelatedAccountGroupIterator) All() iter.Seq2[*recaptchaenterprisepb.RelatedAccountGroup, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*RelatedAccountGroupIterator) Next ¶
func (it *RelatedAccountGroupIterator) Next() (*recaptchaenterprisepb.RelatedAccountGroup, 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 (*RelatedAccountGroupIterator) PageInfo ¶
func (it *RelatedAccountGroupIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RelatedAccountGroupMembershipIterator ¶
type RelatedAccountGroupMembershipIterator 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.RelatedAccountGroupMembership, nextPageToken string, err error) // contains filtered or unexported fields }
RelatedAccountGroupMembershipIterator manages a stream of *recaptchaenterprisepb.RelatedAccountGroupMembership.
func (*RelatedAccountGroupMembershipIterator) All ¶ added in v2.16.0
func (it *RelatedAccountGroupMembershipIterator) All() iter.Seq2[*recaptchaenterprisepb.RelatedAccountGroupMembership, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*RelatedAccountGroupMembershipIterator) Next ¶
func (it *RelatedAccountGroupMembershipIterator) Next() (*recaptchaenterprisepb.RelatedAccountGroupMembership, 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 (*RelatedAccountGroupMembershipIterator) PageInfo ¶
func (it *RelatedAccountGroupMembershipIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.