recaptchaenterprise

package
v0.0.0-...-e9cf271 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2021 License: Apache-2.0 Imports: 12 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	AnnotateAssessmentRequest_Annotation_name = map[int32]string{
		0: "ANNOTATION_UNSPECIFIED",
		1: "LEGITIMATE",
		2: "FRAUDULENT",
		3: "PASSWORD_CORRECT",
		4: "PASSWORD_INCORRECT",
	}
	AnnotateAssessmentRequest_Annotation_value = map[string]int32{
		"ANNOTATION_UNSPECIFIED": 0,
		"LEGITIMATE":             1,
		"FRAUDULENT":             2,
		"PASSWORD_CORRECT":       3,
		"PASSWORD_INCORRECT":     4,
	}
)

Enum value maps for AnnotateAssessmentRequest_Annotation.

View Source 
var (
	AnnotateAssessmentRequest_Reason_name = map[int32]string{
		0: "REASON_UNSPECIFIED",
		1: "CHARGEBACK",
		2: "PAYMENT_HEURISTICS",
		7: "INITIATED_TWO_FACTOR",
		3: "PASSED_TWO_FACTOR",
		4: "FAILED_TWO_FACTOR",
		5: "CORRECT_PASSWORD",
		6: "INCORRECT_PASSWORD",
	}
	AnnotateAssessmentRequest_Reason_value = map[string]int32{
		"REASON_UNSPECIFIED":   0,
		"CHARGEBACK":           1,
		"PAYMENT_HEURISTICS":   2,
		"INITIATED_TWO_FACTOR": 7,
		"PASSED_TWO_FACTOR":    3,
		"FAILED_TWO_FACTOR":    4,
		"CORRECT_PASSWORD":     5,
		"INCORRECT_PASSWORD":   6,
	}
)

Enum value maps for AnnotateAssessmentRequest_Reason.

View Source 
var (
	RiskAnalysis_ClassificationReason_name = map[int32]string{
		0: "CLASSIFICATION_REASON_UNSPECIFIED",
		1: "AUTOMATION",
		2: "UNEXPECTED_ENVIRONMENT",
		3: "TOO_MUCH_TRAFFIC",
		4: "UNEXPECTED_USAGE_PATTERNS",
		5: "LOW_CONFIDENCE_SCORE",
	}
	RiskAnalysis_ClassificationReason_value = map[string]int32{
		"CLASSIFICATION_REASON_UNSPECIFIED": 0,
		"AUTOMATION":                        1,
		"UNEXPECTED_ENVIRONMENT":            2,
		"TOO_MUCH_TRAFFIC":                  3,
		"UNEXPECTED_USAGE_PATTERNS":         4,
		"LOW_CONFIDENCE_SCORE":              5,
	}
)

Enum value maps for RiskAnalysis_ClassificationReason.

View Source 
var (
	TokenProperties_InvalidReason_name = map[int32]string{
		0: "INVALID_REASON_UNSPECIFIED",
		1: "UNKNOWN_INVALID_REASON",
		2: "MALFORMED",
		3: "EXPIRED",
		4: "DUPE",
		5: "MISSING",
		6: "BROWSER_ERROR",
	}
	TokenProperties_InvalidReason_value = map[string]int32{
		"INVALID_REASON_UNSPECIFIED": 0,
		"UNKNOWN_INVALID_REASON":     1,
		"MALFORMED":                  2,
		"EXPIRED":                    3,
		"DUPE":                       4,
		"MISSING":                    5,
		"BROWSER_ERROR":              6,
	}
)

Enum value maps for TokenProperties_InvalidReason.

View Source 
var (
	AccountDefenderAssessment_AccountDefenderLabel_name = map[int32]string{
		0: "ACCOUNT_DEFENDER_LABEL_UNSPECIFIED",
		1: "PROFILE_MATCH",
		2: "SUSPICIOUS_LOGIN_ACTIVITY",
		3: "SUSPICIOUS_ACCOUNT_CREATION",
		4: "RELATED_ACCOUNTS_NUMBER_HIGH",
	}
	AccountDefenderAssessment_AccountDefenderLabel_value = map[string]int32{
		"ACCOUNT_DEFENDER_LABEL_UNSPECIFIED": 0,
		"PROFILE_MATCH":                      1,
		"SUSPICIOUS_LOGIN_ACTIVITY":          2,
		"SUSPICIOUS_ACCOUNT_CREATION":        3,
		"RELATED_ACCOUNTS_NUMBER_HIGH":       4,
	}
)

Enum value maps for AccountDefenderAssessment_AccountDefenderLabel.

View Source 
var (
	TestingOptions_TestingChallenge_name = map[int32]string{
		0: "TESTING_CHALLENGE_UNSPECIFIED",
		1: "NOCAPTCHA",
		2: "UNSOLVABLE_CHALLENGE",
	}
	TestingOptions_TestingChallenge_value = map[string]int32{
		"TESTING_CHALLENGE_UNSPECIFIED": 0,
		"NOCAPTCHA":                     1,
		"UNSOLVABLE_CHALLENGE":          2,
	}
)

Enum value maps for TestingOptions_TestingChallenge.

View Source 
var (
	WebKeySettings_IntegrationType_name = map[int32]string{
		0: "INTEGRATION_TYPE_UNSPECIFIED",
		1: "SCORE",
		2: "CHECKBOX",
		3: "INVISIBLE",
	}
	WebKeySettings_IntegrationType_value = map[string]int32{
		"INTEGRATION_TYPE_UNSPECIFIED": 0,
		"SCORE":                        1,
		"CHECKBOX":                     2,
		"INVISIBLE":                    3,
	}
)

Enum value maps for WebKeySettings_IntegrationType.

View Source 
var (
	WebKeySettings_ChallengeSecurityPreference_name = map[int32]string{
		0: "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED",
		1: "USABILITY",
		2: "BALANCE",
		3: "SECURITY",
	}
	WebKeySettings_ChallengeSecurityPreference_value = map[string]int32{
		"CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED": 0,
		"USABILITY": 1,
		"BALANCE":   2,
		"SECURITY":  3,
	}
)

Enum value maps for WebKeySettings_ChallengeSecurityPreference.

View Source 
var File_google_cloud_recaptchaenterprise_v1_recaptchaenterprise_proto protoreflect.FileDescriptor

Functions

func RegisterRecaptchaEnterpriseServiceServer 

func RegisterRecaptchaEnterpriseServiceServer(s *grpc.Server, srv RecaptchaEnterpriseServiceServer)

Types

type AccountDefenderAssessment 

type AccountDefenderAssessment struct {

	// Labels for this request.
	Labels []AccountDefenderAssessment_AccountDefenderLabel `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Account Defender risk assessment.

func (*AccountDefenderAssessment) Descriptor deprecated 

func (*AccountDefenderAssessment) Descriptor() ([]byte, []int)

Deprecated: Use AccountDefenderAssessment.ProtoReflect.Descriptor instead.

func (*AccountDefenderAssessment) GetLabels 

func (x *AccountDefenderAssessment) GetLabels() []AccountDefenderAssessment_AccountDefenderLabel

func (*AccountDefenderAssessment) ProtoMessage 

func (*AccountDefenderAssessment) ProtoMessage()

func (*AccountDefenderAssessment) ProtoReflect 

func (x *AccountDefenderAssessment) ProtoReflect() protoreflect.Message

func (*AccountDefenderAssessment) Reset 

func (x *AccountDefenderAssessment) Reset()

func (*AccountDefenderAssessment) String 

func (x *AccountDefenderAssessment) String() string

type AccountDefenderAssessment_AccountDefenderLabel 

type AccountDefenderAssessment_AccountDefenderLabel int32

Labels returned by Account Defender for this request. 

const (
	// Default unspecified type.
	AccountDefenderAssessment_ACCOUNT_DEFENDER_LABEL_UNSPECIFIED AccountDefenderAssessment_AccountDefenderLabel = 0
	// The request matches a known good profile for the user.
	AccountDefenderAssessment_PROFILE_MATCH AccountDefenderAssessment_AccountDefenderLabel = 1
	// The request is potentially a suspicious login event and should be further
	// verified either via multi-factor authentication or another system.
	AccountDefenderAssessment_SUSPICIOUS_LOGIN_ACTIVITY AccountDefenderAssessment_AccountDefenderLabel = 2
	// The request matched a profile that previously had suspicious account
	// creation behavior. This could mean this is a fake account.
	AccountDefenderAssessment_SUSPICIOUS_ACCOUNT_CREATION AccountDefenderAssessment_AccountDefenderLabel = 3
	// The account in the request has a high number of related accounts. It does
	// not necessarily imply that the account is bad but could require
	// investigating.
	AccountDefenderAssessment_RELATED_ACCOUNTS_NUMBER_HIGH AccountDefenderAssessment_AccountDefenderLabel = 4
)

func (AccountDefenderAssessment_AccountDefenderLabel) Descriptor 

func (AccountDefenderAssessment_AccountDefenderLabel) Descriptor() protoreflect.EnumDescriptor

func (AccountDefenderAssessment_AccountDefenderLabel) Enum 

func (x AccountDefenderAssessment_AccountDefenderLabel) Enum() *AccountDefenderAssessment_AccountDefenderLabel

func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor deprecated 

func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor() ([]byte, []int)

Deprecated: Use AccountDefenderAssessment_AccountDefenderLabel.Descriptor instead.

func (AccountDefenderAssessment_AccountDefenderLabel) Number 

func (x AccountDefenderAssessment_AccountDefenderLabel) Number() protoreflect.EnumNumber

func (AccountDefenderAssessment_AccountDefenderLabel) String 

func (x AccountDefenderAssessment_AccountDefenderLabel) String() string

func (AccountDefenderAssessment_AccountDefenderLabel) Type 

func (AccountDefenderAssessment_AccountDefenderLabel) Type() protoreflect.EnumType

type AndroidKeySettings 

type AndroidKeySettings struct {

	// If set to true, allowed_package_names are not enforced.
	AllowAllPackageNames bool `` /* 126-byte string literal not displayed */
	// Android package names of apps allowed to use the key.
	// Example: 'com.companyname.appname'
	AllowedPackageNames []string `protobuf:"bytes,1,rep,name=allowed_package_names,json=allowedPackageNames,proto3" json:"allowed_package_names,omitempty"`
	// contains filtered or unexported fields
}

Settings specific to keys that can be used by Android apps.

func (*AndroidKeySettings) Descriptor deprecated 

func (*AndroidKeySettings) Descriptor() ([]byte, []int)

Deprecated: Use AndroidKeySettings.ProtoReflect.Descriptor instead.

func (*AndroidKeySettings) GetAllowAllPackageNames 

func (x *AndroidKeySettings) GetAllowAllPackageNames() bool

func (*AndroidKeySettings) GetAllowedPackageNames 

func (x *AndroidKeySettings) GetAllowedPackageNames() []string

func (*AndroidKeySettings) ProtoMessage 

func (*AndroidKeySettings) ProtoMessage()

func (*AndroidKeySettings) ProtoReflect 

func (x *AndroidKeySettings) ProtoReflect() protoreflect.Message

func (*AndroidKeySettings) Reset 

func (x *AndroidKeySettings) Reset()

func (*AndroidKeySettings) String 

func (x *AndroidKeySettings) String() string

type AnnotateAssessmentRequest 

type AnnotateAssessmentRequest struct {

	// Required. The resource name of the Assessment, in the format
	// "projects/{project}/assessments/{assessment}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The annotation that will be assigned to the Event. This field can be left
	// empty to provide reasons that apply to an event without concluding whether
	// the event is legitimate or fraudulent.
	Annotation AnnotateAssessmentRequest_Annotation `` /* 152-byte string literal not displayed */
	// Optional. Optional reasons for the annotation that will be assigned to the Event.
	Reasons []AnnotateAssessmentRequest_Reason `` /* 149-byte string literal not displayed */
	// Optional. Optional unique stable hashed user identifier to apply to the assessment.
	// This is an alternative to setting the hashed_account_id in
	// CreateAssessment, for example when the account identifier is not yet known
	// in the initial request. It is recommended that the identifier is hashed
	// using hmac-sha256 with stable secret.
	HashedAccountId []byte `protobuf:"bytes,4,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// contains filtered or unexported fields
}

The request message to annotate an Assessment.

func (*AnnotateAssessmentRequest) Descriptor deprecated 

func (*AnnotateAssessmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentRequest.ProtoReflect.Descriptor instead.

func (*AnnotateAssessmentRequest) GetAnnotation 

func (x *AnnotateAssessmentRequest) GetAnnotation() AnnotateAssessmentRequest_Annotation

func (*AnnotateAssessmentRequest) GetHashedAccountId 

func (x *AnnotateAssessmentRequest) GetHashedAccountId() []byte

func (*AnnotateAssessmentRequest) GetName 

func (x *AnnotateAssessmentRequest) GetName() string

func (*AnnotateAssessmentRequest) GetReasons 

func (x *AnnotateAssessmentRequest) GetReasons() []AnnotateAssessmentRequest_Reason

func (*AnnotateAssessmentRequest) ProtoMessage 

func (*AnnotateAssessmentRequest) ProtoMessage()

func (*AnnotateAssessmentRequest) ProtoReflect 

func (x *AnnotateAssessmentRequest) ProtoReflect() protoreflect.Message

func (*AnnotateAssessmentRequest) Reset 

func (x *AnnotateAssessmentRequest) Reset()

func (*AnnotateAssessmentRequest) String 

func (x *AnnotateAssessmentRequest) String() string

type AnnotateAssessmentRequest_Annotation 

type AnnotateAssessmentRequest_Annotation int32

Enum that represents the types of annotations. 

const (
	// Default unspecified type.
	AnnotateAssessmentRequest_ANNOTATION_UNSPECIFIED AnnotateAssessmentRequest_Annotation = 0
	// Provides information that the event turned out to be legitimate.
	AnnotateAssessmentRequest_LEGITIMATE AnnotateAssessmentRequest_Annotation = 1
	// Provides information that the event turned out to be fraudulent.
	AnnotateAssessmentRequest_FRAUDULENT AnnotateAssessmentRequest_Annotation = 2
	// Provides information that the event was related to a login event in which
	// the user typed the correct password. Deprecated, prefer indicating
	// CORRECT_PASSWORD through the reasons field instead.
	//
	// Deprecated: Do not use.
	AnnotateAssessmentRequest_PASSWORD_CORRECT AnnotateAssessmentRequest_Annotation = 3
	// Provides information that the event was related to a login event in which
	// the user typed the incorrect password. Deprecated, prefer indicating
	// INCORRECT_PASSWORD through the reasons field instead.
	//
	// Deprecated: Do not use.
	AnnotateAssessmentRequest_PASSWORD_INCORRECT AnnotateAssessmentRequest_Annotation = 4
)

func (AnnotateAssessmentRequest_Annotation) Descriptor 

func (AnnotateAssessmentRequest_Annotation) Descriptor() protoreflect.EnumDescriptor

func (AnnotateAssessmentRequest_Annotation) Enum 

func (x AnnotateAssessmentRequest_Annotation) Enum() *AnnotateAssessmentRequest_Annotation

func (AnnotateAssessmentRequest_Annotation) EnumDescriptor deprecated 

func (AnnotateAssessmentRequest_Annotation) EnumDescriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentRequest_Annotation.Descriptor instead.

func (AnnotateAssessmentRequest_Annotation) Number 

func (x AnnotateAssessmentRequest_Annotation) Number() protoreflect.EnumNumber

func (AnnotateAssessmentRequest_Annotation) String 

func (x AnnotateAssessmentRequest_Annotation) String() string

func (AnnotateAssessmentRequest_Annotation) Type 

func (AnnotateAssessmentRequest_Annotation) Type() protoreflect.EnumType

type AnnotateAssessmentRequest_Reason 

type AnnotateAssessmentRequest_Reason int32

Enum that represents potential reasons for annotating an assessment. 

const (
	// Default unspecified reason.
	AnnotateAssessmentRequest_REASON_UNSPECIFIED AnnotateAssessmentRequest_Reason = 0
	// Indicates a chargeback for fraud was issued for the transaction
	// associated with the assessment.
	AnnotateAssessmentRequest_CHARGEBACK AnnotateAssessmentRequest_Reason = 1
	// Indicates the transaction associated with the assessment is suspected of
	// being fraudulent based on the payment method, billing details, shipping
	// address or other transaction information.
	AnnotateAssessmentRequest_PAYMENT_HEURISTICS AnnotateAssessmentRequest_Reason = 2
	// Indicates that the user was served a 2FA challenge. An old assessment
	// with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
	// overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
	// This is equivalent to `FAILED_TWO_FACTOR`.
	AnnotateAssessmentRequest_INITIATED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 7
	// Indicates that the user passed a 2FA challenge.
	AnnotateAssessmentRequest_PASSED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 3
	// Indicates that the user failed a 2FA challenge.
	AnnotateAssessmentRequest_FAILED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 4
	// Indicates the user provided the correct password.
	AnnotateAssessmentRequest_CORRECT_PASSWORD AnnotateAssessmentRequest_Reason = 5
	// Indicates the user provided an incorrect password.
	AnnotateAssessmentRequest_INCORRECT_PASSWORD AnnotateAssessmentRequest_Reason = 6
)

func (AnnotateAssessmentRequest_Reason) Descriptor 

func (AnnotateAssessmentRequest_Reason) Descriptor() protoreflect.EnumDescriptor

func (AnnotateAssessmentRequest_Reason) Enum 

func (x AnnotateAssessmentRequest_Reason) Enum() *AnnotateAssessmentRequest_Reason

func (AnnotateAssessmentRequest_Reason) EnumDescriptor deprecated 

func (AnnotateAssessmentRequest_Reason) EnumDescriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentRequest_Reason.Descriptor instead.

func (AnnotateAssessmentRequest_Reason) Number 

func (x AnnotateAssessmentRequest_Reason) Number() protoreflect.EnumNumber

func (AnnotateAssessmentRequest_Reason) String 

func (x AnnotateAssessmentRequest_Reason) String() string

func (AnnotateAssessmentRequest_Reason) Type 

func (AnnotateAssessmentRequest_Reason) Type() protoreflect.EnumType

type AnnotateAssessmentResponse 

type AnnotateAssessmentResponse struct {
	// contains filtered or unexported fields
}

Empty response for AnnotateAssessment.

func (*AnnotateAssessmentResponse) Descriptor deprecated 

func (*AnnotateAssessmentResponse) Descriptor() ([]byte, []int)

Deprecated: Use AnnotateAssessmentResponse.ProtoReflect.Descriptor instead.

func (*AnnotateAssessmentResponse) ProtoMessage 

func (*AnnotateAssessmentResponse) ProtoMessage()

func (*AnnotateAssessmentResponse) ProtoReflect 

func (x *AnnotateAssessmentResponse) ProtoReflect() protoreflect.Message

func (*AnnotateAssessmentResponse) Reset 

func (x *AnnotateAssessmentResponse) Reset()

func (*AnnotateAssessmentResponse) String 

func (x *AnnotateAssessmentResponse) String() string

type Assessment 

type Assessment struct {

	// Output only. The resource name for the Assessment in the format
	// "projects/{project}/assessments/{assessment}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The event being assessed.
	Event *Event `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// Output only. The risk analysis result for the event being assessed.
	RiskAnalysis *RiskAnalysis `protobuf:"bytes,3,opt,name=risk_analysis,json=riskAnalysis,proto3" json:"risk_analysis,omitempty"`
	// Output only. Properties of the provided event token.
	TokenProperties *TokenProperties `protobuf:"bytes,4,opt,name=token_properties,json=tokenProperties,proto3" json:"token_properties,omitempty"`
	// Assessment returned by Account Defender when a hashed_account_id is
	// provided.
	AccountDefenderAssessment *AccountDefenderAssessment `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

A recaptcha assessment resource.

func (*Assessment) Descriptor deprecated 

func (*Assessment) Descriptor() ([]byte, []int)

Deprecated: Use Assessment.ProtoReflect.Descriptor instead.

func (*Assessment) GetAccountDefenderAssessment 

func (x *Assessment) GetAccountDefenderAssessment() *AccountDefenderAssessment

func (*Assessment) GetEvent 

func (x *Assessment) GetEvent() *Event

func (*Assessment) GetName 

func (x *Assessment) GetName() string

func (*Assessment) GetRiskAnalysis 

func (x *Assessment) GetRiskAnalysis() *RiskAnalysis

func (*Assessment) GetTokenProperties 

func (x *Assessment) GetTokenProperties() *TokenProperties

func (*Assessment) ProtoMessage 

func (*Assessment) ProtoMessage()

func (*Assessment) ProtoReflect 

func (x *Assessment) ProtoReflect() protoreflect.Message

func (*Assessment) Reset 

func (x *Assessment) Reset()

func (*Assessment) String 

func (x *Assessment) String() string

type ChallengeMetrics 

type ChallengeMetrics struct {

	// Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent
	// to a count of pageloads for pages that include reCAPTCHA.
	PageloadCount int64 `protobuf:"varint,1,opt,name=pageload_count,json=pageloadCount,proto3" json:"pageload_count,omitempty"`
	// Count of nocaptchas (successful verification without a challenge) issued.
	NocaptchaCount int64 `protobuf:"varint,2,opt,name=nocaptcha_count,json=nocaptchaCount,proto3" json:"nocaptcha_count,omitempty"`
	// Count of submitted challenge solutions that were incorrect or otherwise
	// deemed suspicious such that a subsequent challenge was triggered.
	FailedCount int64 `protobuf:"varint,3,opt,name=failed_count,json=failedCount,proto3" json:"failed_count,omitempty"`
	// Count of nocaptchas (successful verification without a challenge) plus
	// submitted challenge solutions that were correct and resulted in
	// verification.
	PassedCount int64 `protobuf:"varint,4,opt,name=passed_count,json=passedCount,proto3" json:"passed_count,omitempty"`
	// contains filtered or unexported fields
}

Metrics related to challenges.

func (*ChallengeMetrics) Descriptor deprecated 

func (*ChallengeMetrics) Descriptor() ([]byte, []int)

Deprecated: Use ChallengeMetrics.ProtoReflect.Descriptor instead.

func (*ChallengeMetrics) GetFailedCount 

func (x *ChallengeMetrics) GetFailedCount() int64

func (*ChallengeMetrics) GetNocaptchaCount 

func (x *ChallengeMetrics) GetNocaptchaCount() int64

func (*ChallengeMetrics) GetPageloadCount 

func (x *ChallengeMetrics) GetPageloadCount() int64

func (*ChallengeMetrics) GetPassedCount 

func (x *ChallengeMetrics) GetPassedCount() int64

func (*ChallengeMetrics) ProtoMessage 

func (*ChallengeMetrics) ProtoMessage()

func (*ChallengeMetrics) ProtoReflect 

func (x *ChallengeMetrics) ProtoReflect() protoreflect.Message

func (*ChallengeMetrics) Reset 

func (x *ChallengeMetrics) Reset()

func (*ChallengeMetrics) String 

func (x *ChallengeMetrics) String() string

type CreateAssessmentRequest 

type CreateAssessmentRequest struct {

	// Required. The name of the project in which the assessment will be created,
	// in the format "projects/{project}".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The assessment details.
	Assessment *Assessment `protobuf:"bytes,2,opt,name=assessment,proto3" json:"assessment,omitempty"`
	// contains filtered or unexported fields
}

The create assessment request message.

func (*CreateAssessmentRequest) Descriptor deprecated 

func (*CreateAssessmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateAssessmentRequest.ProtoReflect.Descriptor instead.

func (*CreateAssessmentRequest) GetAssessment 

func (x *CreateAssessmentRequest) GetAssessment() *Assessment

func (*CreateAssessmentRequest) GetParent 

func (x *CreateAssessmentRequest) GetParent() string

func (*CreateAssessmentRequest) ProtoMessage 

func (*CreateAssessmentRequest) ProtoMessage()

func (*CreateAssessmentRequest) ProtoReflect 

func (x *CreateAssessmentRequest) ProtoReflect() protoreflect.Message

func (*CreateAssessmentRequest) Reset 

func (x *CreateAssessmentRequest) Reset()

func (*CreateAssessmentRequest) String 

func (x *CreateAssessmentRequest) String() string

type CreateKeyRequest 

type CreateKeyRequest struct {

	// Required. The name of the project in which the key will be created, in the
	// format "projects/{project}".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Information to create a reCAPTCHA Enterprise key.
	Key *Key `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

The create key request message.

func (*CreateKeyRequest) Descriptor deprecated 

func (*CreateKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateKeyRequest) GetKey 

func (x *CreateKeyRequest) GetKey() *Key

func (*CreateKeyRequest) GetParent 

func (x *CreateKeyRequest) GetParent() string

func (*CreateKeyRequest) ProtoMessage 

func (*CreateKeyRequest) ProtoMessage()

func (*CreateKeyRequest) ProtoReflect 

func (x *CreateKeyRequest) ProtoReflect() protoreflect.Message

func (*CreateKeyRequest) Reset 

func (x *CreateKeyRequest) Reset()

func (*CreateKeyRequest) String 

func (x *CreateKeyRequest) String() string

type DeleteKeyRequest 

type DeleteKeyRequest struct {

	// Required. The name of the key to be deleted, in the format
	// "projects/{project}/keys/{key}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The delete key request message.

func (*DeleteKeyRequest) Descriptor deprecated 

func (*DeleteKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteKeyRequest) GetName 

func (x *DeleteKeyRequest) GetName() string

func (*DeleteKeyRequest) ProtoMessage 

func (*DeleteKeyRequest) ProtoMessage()

func (*DeleteKeyRequest) ProtoReflect 

func (x *DeleteKeyRequest) ProtoReflect() protoreflect.Message

func (*DeleteKeyRequest) Reset 

func (x *DeleteKeyRequest) Reset()

func (*DeleteKeyRequest) String 

func (x *DeleteKeyRequest) String() string

type Event 

type Event struct {

	// Optional. The user response token provided by the reCAPTCHA client-side integration
	// on your site.
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// Optional. The site key that was used to invoke reCAPTCHA on your site and generate
	// the token.
	SiteKey string `protobuf:"bytes,2,opt,name=site_key,json=siteKey,proto3" json:"site_key,omitempty"`
	// Optional. The user agent present in the request from the user's device related to
	// this event.
	UserAgent string `protobuf:"bytes,3,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// Optional. The IP address in the request from the user's device related to this event.
	UserIpAddress string `protobuf:"bytes,4,opt,name=user_ip_address,json=userIpAddress,proto3" json:"user_ip_address,omitempty"`
	// Optional. The expected action for this type of event. This should be the same action
	// provided at token generation time on client-side platforms already
	// integrated with recaptcha enterprise.
	ExpectedAction string `protobuf:"bytes,5,opt,name=expected_action,json=expectedAction,proto3" json:"expected_action,omitempty"`
	// Optional. Optional unique stable hashed user identifier for the request. The
	// identifier should ideally be hashed using sha256 with stable secret.
	HashedAccountId []byte `protobuf:"bytes,6,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// contains filtered or unexported fields
}

func (*Event) Descriptor deprecated 

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetExpectedAction 

func (x *Event) GetExpectedAction() string

func (*Event) GetHashedAccountId 

func (x *Event) GetHashedAccountId() []byte

func (*Event) GetSiteKey 

func (x *Event) GetSiteKey() string

func (*Event) GetToken 

func (x *Event) GetToken() string

func (*Event) GetUserAgent 

func (x *Event) GetUserAgent() string

func (*Event) GetUserIpAddress 

func (x *Event) GetUserIpAddress() string

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) ProtoReflect 

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset 

func (x *Event) Reset()

func (*Event) String 

func (x *Event) String() string

type GetKeyRequest 

type GetKeyRequest struct {

	// Required. The name of the requested key, in the format
	// "projects/{project}/keys/{key}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The get key request message.

func (*GetKeyRequest) Descriptor deprecated 

func (*GetKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetKeyRequest.ProtoReflect.Descriptor instead.

func (*GetKeyRequest) GetName 

func (x *GetKeyRequest) GetName() string

func (*GetKeyRequest) ProtoMessage 

func (*GetKeyRequest) ProtoMessage()

func (*GetKeyRequest) ProtoReflect 

func (x *GetKeyRequest) ProtoReflect() protoreflect.Message

func (*GetKeyRequest) Reset 

func (x *GetKeyRequest) Reset()

func (*GetKeyRequest) String 

func (x *GetKeyRequest) String() string

type GetMetricsRequest 

type GetMetricsRequest struct {

	// Required. The name of the requested metrics, in the format
	// "projects/{project}/keys/{key}/metrics".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The get metrics request message.

func (*GetMetricsRequest) Descriptor deprecated 

func (*GetMetricsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMetricsRequest.ProtoReflect.Descriptor instead.

func (*GetMetricsRequest) GetName 

func (x *GetMetricsRequest) GetName() string

func (*GetMetricsRequest) ProtoMessage 

func (*GetMetricsRequest) ProtoMessage()

func (*GetMetricsRequest) ProtoReflect 

func (x *GetMetricsRequest) ProtoReflect() protoreflect.Message

func (*GetMetricsRequest) Reset 

func (x *GetMetricsRequest) Reset()

func (*GetMetricsRequest) String 

func (x *GetMetricsRequest) String() string

type IOSKeySettings 

type IOSKeySettings struct {

	// If set to true, allowed_bundle_ids are not enforced.
	AllowAllBundleIds bool `protobuf:"varint,2,opt,name=allow_all_bundle_ids,json=allowAllBundleIds,proto3" json:"allow_all_bundle_ids,omitempty"`
	// iOS bundle ids of apps allowed to use the key.
	// Example: 'com.companyname.productname.appname'
	AllowedBundleIds []string `protobuf:"bytes,1,rep,name=allowed_bundle_ids,json=allowedBundleIds,proto3" json:"allowed_bundle_ids,omitempty"`
	// contains filtered or unexported fields
}

Settings specific to keys that can be used by iOS apps.

func (*IOSKeySettings) Descriptor deprecated 

func (*IOSKeySettings) Descriptor() ([]byte, []int)

Deprecated: Use IOSKeySettings.ProtoReflect.Descriptor instead.

func (*IOSKeySettings) GetAllowAllBundleIds 

func (x *IOSKeySettings) GetAllowAllBundleIds() bool

func (*IOSKeySettings) GetAllowedBundleIds 

func (x *IOSKeySettings) GetAllowedBundleIds() []string

func (*IOSKeySettings) ProtoMessage 

func (*IOSKeySettings) ProtoMessage()

func (*IOSKeySettings) ProtoReflect 

func (x *IOSKeySettings) ProtoReflect() protoreflect.Message

func (*IOSKeySettings) Reset 

func (x *IOSKeySettings) Reset()

func (*IOSKeySettings) String 

func (x *IOSKeySettings) String() string

type Key 

type Key struct {

	// The resource name for the Key in the format
	// "projects/{project}/keys/{key}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Human-readable display name of this key. Modifiable by user.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Platform specific settings for this key. The key can only be used on one
	// platform, the one it has settings for.
	//
	// Types that are assignable to PlatformSettings:
	//	*Key_WebSettings
	//	*Key_AndroidSettings
	//	*Key_IosSettings
	PlatformSettings isKey_PlatformSettings `protobuf_oneof:"platform_settings"`
	// See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
	// Creating and managing labels</a>.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// The timestamp corresponding to the creation of this Key.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Options for user acceptance testing.
	TestingOptions *TestingOptions `protobuf:"bytes,9,opt,name=testing_options,json=testingOptions,proto3" json:"testing_options,omitempty"`
	// contains filtered or unexported fields
}

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

func (*Key) Descriptor deprecated 

func (*Key) Descriptor() ([]byte, []int)

Deprecated: Use Key.ProtoReflect.Descriptor instead.

func (*Key) GetAndroidSettings 

func (x *Key) GetAndroidSettings() *AndroidKeySettings

func (*Key) GetCreateTime 

func (x *Key) GetCreateTime() *timestamppb.Timestamp

func (*Key) GetDisplayName 

func (x *Key) GetDisplayName() string

func (*Key) GetIosSettings 

func (x *Key) GetIosSettings() *IOSKeySettings

func (*Key) GetLabels 

func (x *Key) GetLabels() map[string]string

func (*Key) GetName 

func (x *Key) GetName() string

func (*Key) GetPlatformSettings 

func (m *Key) GetPlatformSettings() isKey_PlatformSettings

func (*Key) GetTestingOptions 

func (x *Key) GetTestingOptions() *TestingOptions

func (*Key) GetWebSettings 

func (x *Key) GetWebSettings() *WebKeySettings

func (*Key) ProtoMessage 

func (*Key) ProtoMessage()

func (*Key) ProtoReflect 

func (x *Key) ProtoReflect() protoreflect.Message

func (*Key) Reset 

func (x *Key) Reset()

func (*Key) String 

func (x *Key) String() string

type Key_AndroidSettings 

type Key_AndroidSettings struct {
	// Settings for keys that can be used by Android apps.
	AndroidSettings *AndroidKeySettings `protobuf:"bytes,4,opt,name=android_settings,json=androidSettings,proto3,oneof"`
}

type Key_IosSettings 

type Key_IosSettings struct {
	// Settings for keys that can be used by iOS apps.
	IosSettings *IOSKeySettings `protobuf:"bytes,5,opt,name=ios_settings,json=iosSettings,proto3,oneof"`
}

type Key_WebSettings 

type Key_WebSettings struct {
	// Settings for keys that can be used by websites.
	WebSettings *WebKeySettings `protobuf:"bytes,3,opt,name=web_settings,json=webSettings,proto3,oneof"`
}

type ListKeysRequest 

type ListKeysRequest struct {

	// Required. The name of the project that contains the keys that will be
	// listed, in the format "projects/{project}".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of keys to return. Default is 10. Max limit is
	// 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The next_page_token value returned from a previous.
	// ListKeysRequest, if any.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The list keys request message.

func (*ListKeysRequest) Descriptor deprecated 

func (*ListKeysRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListKeysRequest.ProtoReflect.Descriptor instead.

func (*ListKeysRequest) GetPageSize 

func (x *ListKeysRequest) GetPageSize() int32

func (*ListKeysRequest) GetPageToken 

func (x *ListKeysRequest) GetPageToken() string

func (*ListKeysRequest) GetParent 

func (x *ListKeysRequest) GetParent() string

func (*ListKeysRequest) ProtoMessage 

func (*ListKeysRequest) ProtoMessage()

func (*ListKeysRequest) ProtoReflect 

func (x *ListKeysRequest) ProtoReflect() protoreflect.Message

func (*ListKeysRequest) Reset 

func (x *ListKeysRequest) Reset()

func (*ListKeysRequest) String 

func (x *ListKeysRequest) String() string

type ListKeysResponse 

type ListKeysResponse struct {

	// Key details.
	Keys []*Key `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
	// Token to retrieve the next page of results. It is set to empty if no keys
	// remain in results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response to request to list keys in a project.

func (*ListKeysResponse) Descriptor deprecated 

func (*ListKeysResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListKeysResponse.ProtoReflect.Descriptor instead.

func (*ListKeysResponse) GetKeys 

func (x *ListKeysResponse) GetKeys() []*Key

func (*ListKeysResponse) GetNextPageToken 

func (x *ListKeysResponse) GetNextPageToken() string

func (*ListKeysResponse) ProtoMessage 

func (*ListKeysResponse) ProtoMessage()

func (*ListKeysResponse) ProtoReflect 

func (x *ListKeysResponse) ProtoReflect() protoreflect.Message

func (*ListKeysResponse) Reset 

func (x *ListKeysResponse) Reset()

func (*ListKeysResponse) String 

func (x *ListKeysResponse) String() string

type ListRelatedAccountGroupMembershipsRequest 

type ListRelatedAccountGroupMembershipsRequest struct {

	// Required. The resource name for the related account group in the format
	// `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of accounts to return. The service may return fewer than
	// this value.
	// If unspecified, at most 50 accounts will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
	// call.
	//
	// When paginating, all other parameters provided to
	// `ListRelatedAccountGroupMemberships` must match the call that provided the
	// page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request message to list memberships in a related account group.

func (*ListRelatedAccountGroupMembershipsRequest) Descriptor deprecated 

func (*ListRelatedAccountGroupMembershipsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRelatedAccountGroupMembershipsRequest.ProtoReflect.Descriptor instead.

func (*ListRelatedAccountGroupMembershipsRequest) GetPageSize 

func (x *ListRelatedAccountGroupMembershipsRequest) GetPageSize() int32

func (*ListRelatedAccountGroupMembershipsRequest) GetPageToken 

func (x *ListRelatedAccountGroupMembershipsRequest) GetPageToken() string

func (*ListRelatedAccountGroupMembershipsRequest) GetParent 

func (x *ListRelatedAccountGroupMembershipsRequest) GetParent() string

func (*ListRelatedAccountGroupMembershipsRequest) ProtoMessage 

func (*ListRelatedAccountGroupMembershipsRequest) ProtoMessage()

func (*ListRelatedAccountGroupMembershipsRequest) ProtoReflect 

func (x *ListRelatedAccountGroupMembershipsRequest) ProtoReflect() protoreflect.Message

func (*ListRelatedAccountGroupMembershipsRequest) Reset 

func (x *ListRelatedAccountGroupMembershipsRequest) Reset()

func (*ListRelatedAccountGroupMembershipsRequest) String 

func (x *ListRelatedAccountGroupMembershipsRequest) String() string

type ListRelatedAccountGroupMembershipsResponse 

type ListRelatedAccountGroupMembershipsResponse struct {

	// The memberships listed by the query.
	RelatedAccountGroupMemberships []*RelatedAccountGroupMembership `` /* 155-byte string literal not displayed */
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response to a `ListRelatedAccountGroupMemberships` call.

func (*ListRelatedAccountGroupMembershipsResponse) Descriptor deprecated 

func (*ListRelatedAccountGroupMembershipsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListRelatedAccountGroupMembershipsResponse.ProtoReflect.Descriptor instead.

func (*ListRelatedAccountGroupMembershipsResponse) GetNextPageToken 

func (x *ListRelatedAccountGroupMembershipsResponse) GetNextPageToken() string

func (*ListRelatedAccountGroupMembershipsResponse) GetRelatedAccountGroupMemberships 

func (x *ListRelatedAccountGroupMembershipsResponse) GetRelatedAccountGroupMemberships() []*RelatedAccountGroupMembership

func (*ListRelatedAccountGroupMembershipsResponse) ProtoMessage 

func (*ListRelatedAccountGroupMembershipsResponse) ProtoMessage()

func (*ListRelatedAccountGroupMembershipsResponse) ProtoReflect 

func (x *ListRelatedAccountGroupMembershipsResponse) ProtoReflect() protoreflect.Message

func (*ListRelatedAccountGroupMembershipsResponse) Reset 

func (x *ListRelatedAccountGroupMembershipsResponse) Reset()

func (*ListRelatedAccountGroupMembershipsResponse) String 

func (x *ListRelatedAccountGroupMembershipsResponse) String() string

type ListRelatedAccountGroupsRequest 

type ListRelatedAccountGroupsRequest struct {

	// Required. The name of the project to list related account groups from, in the format
	// "projects/{project}".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of groups to return. The service may return fewer than
	// this value.
	// If unspecified, at most 50 groups will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `ListRelatedAccountGroups` must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request message to list related account groups.

func (*ListRelatedAccountGroupsRequest) Descriptor deprecated 

func (*ListRelatedAccountGroupsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRelatedAccountGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListRelatedAccountGroupsRequest) GetPageSize 

func (x *ListRelatedAccountGroupsRequest) GetPageSize() int32

func (*ListRelatedAccountGroupsRequest) GetPageToken 

func (x *ListRelatedAccountGroupsRequest) GetPageToken() string

func (*ListRelatedAccountGroupsRequest) GetParent 

func (x *ListRelatedAccountGroupsRequest) GetParent() string

func (*ListRelatedAccountGroupsRequest) ProtoMessage 

func (*ListRelatedAccountGroupsRequest) ProtoMessage()

func (*ListRelatedAccountGroupsRequest) ProtoReflect 

func (x *ListRelatedAccountGroupsRequest) ProtoReflect() protoreflect.Message

func (*ListRelatedAccountGroupsRequest) Reset 

func (x *ListRelatedAccountGroupsRequest) Reset()

func (*ListRelatedAccountGroupsRequest) String 

func (x *ListRelatedAccountGroupsRequest) String() string

type ListRelatedAccountGroupsResponse 

type ListRelatedAccountGroupsResponse struct {

	// The groups of related accounts listed by the query.
	RelatedAccountGroups []*RelatedAccountGroup `protobuf:"bytes,1,rep,name=related_account_groups,json=relatedAccountGroups,proto3" json:"related_account_groups,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response to a `ListRelatedAccountGroups` call.

func (*ListRelatedAccountGroupsResponse) Descriptor deprecated 

func (*ListRelatedAccountGroupsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListRelatedAccountGroupsResponse.ProtoReflect.Descriptor instead.

func (*ListRelatedAccountGroupsResponse) GetNextPageToken 

func (x *ListRelatedAccountGroupsResponse) GetNextPageToken() string

func (*ListRelatedAccountGroupsResponse) GetRelatedAccountGroups 

func (x *ListRelatedAccountGroupsResponse) GetRelatedAccountGroups() []*RelatedAccountGroup

func (*ListRelatedAccountGroupsResponse) ProtoMessage 

func (*ListRelatedAccountGroupsResponse) ProtoMessage()

func (*ListRelatedAccountGroupsResponse) ProtoReflect 

func (x *ListRelatedAccountGroupsResponse) ProtoReflect() protoreflect.Message

func (*ListRelatedAccountGroupsResponse) Reset 

func (x *ListRelatedAccountGroupsResponse) Reset()

func (*ListRelatedAccountGroupsResponse) String 

func (x *ListRelatedAccountGroupsResponse) String() string

type Metrics 

type Metrics struct {

	// Output only. The name of the metrics, in the format
	// "projects/{project}/keys/{key}/metrics".
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// Inclusive start time aligned to a day (UTC).
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Metrics will be continuous and in order by dates, and in the granularity
	// of day. All Key types should have score-based data.
	ScoreMetrics []*ScoreMetrics `protobuf:"bytes,2,rep,name=score_metrics,json=scoreMetrics,proto3" json:"score_metrics,omitempty"`
	// Metrics will be continuous and in order by dates, and in the granularity
	// of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have
	// challenge-based data.
	ChallengeMetrics []*ChallengeMetrics `protobuf:"bytes,3,rep,name=challenge_metrics,json=challengeMetrics,proto3" json:"challenge_metrics,omitempty"`
	// contains filtered or unexported fields
}

Metrics for a single Key.

func (*Metrics) Descriptor deprecated 

func (*Metrics) Descriptor() ([]byte, []int)

Deprecated: Use Metrics.ProtoReflect.Descriptor instead.

func (*Metrics) GetChallengeMetrics 

func (x *Metrics) GetChallengeMetrics() []*ChallengeMetrics

func (*Metrics) GetName 

func (x *Metrics) GetName() string

func (*Metrics) GetScoreMetrics 

func (x *Metrics) GetScoreMetrics() []*ScoreMetrics

func (*Metrics) GetStartTime 

func (x *Metrics) GetStartTime() *timestamppb.Timestamp

func (*Metrics) ProtoMessage 

func (*Metrics) ProtoMessage()

func (*Metrics) ProtoReflect 

func (x *Metrics) ProtoReflect() protoreflect.Message

func (*Metrics) Reset 

func (x *Metrics) Reset()

func (*Metrics) String 

func (x *Metrics) String() string

type MigrateKeyRequest 

type MigrateKeyRequest struct {

	// Required. The name of the key to be migrated, in the format
	// "projects/{project}/keys/{key}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The migrate key request message.

func (*MigrateKeyRequest) Descriptor deprecated 

func (*MigrateKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use MigrateKeyRequest.ProtoReflect.Descriptor instead.

func (*MigrateKeyRequest) GetName 

func (x *MigrateKeyRequest) GetName() string

func (*MigrateKeyRequest) ProtoMessage 

func (*MigrateKeyRequest) ProtoMessage()

func (*MigrateKeyRequest) ProtoReflect 

func (x *MigrateKeyRequest) ProtoReflect() protoreflect.Message

func (*MigrateKeyRequest) Reset 

func (x *MigrateKeyRequest) Reset()

func (*MigrateKeyRequest) String 

func (x *MigrateKeyRequest) String() string

type RecaptchaEnterpriseServiceClient 

type RecaptchaEnterpriseServiceClient interface {
	// Creates an Assessment of the likelihood an event is legitimate.
	CreateAssessment(ctx context.Context, in *CreateAssessmentRequest, opts ...grpc.CallOption) (*Assessment, error)
	// Annotates a previously created Assessment to provide additional information
	// on whether the event turned out to be authentic or fraudulent.
	AnnotateAssessment(ctx context.Context, in *AnnotateAssessmentRequest, opts ...grpc.CallOption) (*AnnotateAssessmentResponse, error)
	// Creates a new reCAPTCHA Enterprise key.
	CreateKey(ctx context.Context, in *CreateKeyRequest, opts ...grpc.CallOption) (*Key, error)
	// Returns the list of all keys that belong to a project.
	ListKeys(ctx context.Context, in *ListKeysRequest, opts ...grpc.CallOption) (*ListKeysResponse, error)
	// Returns the specified key.
	GetKey(ctx context.Context, in *GetKeyRequest, opts ...grpc.CallOption) (*Key, error)
	// Updates the specified key.
	UpdateKey(ctx context.Context, in *UpdateKeyRequest, opts ...grpc.CallOption) (*Key, error)
	// Deletes the specified key.
	DeleteKey(ctx context.Context, in *DeleteKeyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// 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 Site Key, and
	// your user must have the reCAPTCHA Enterprise Admin IAM role in the
	// destination project.
	MigrateKey(ctx context.Context, in *MigrateKeyRequest, opts ...grpc.CallOption) (*Key, error)
	// Get some aggregated metrics for a Key. This data can be used to build
	// dashboards.
	GetMetrics(ctx context.Context, in *GetMetricsRequest, opts ...grpc.CallOption) (*Metrics, error)
	// List groups of related accounts.
	ListRelatedAccountGroups(ctx context.Context, in *ListRelatedAccountGroupsRequest, opts ...grpc.CallOption) (*ListRelatedAccountGroupsResponse, error)
	// Get the memberships in a group of related accounts.
	ListRelatedAccountGroupMemberships(ctx context.Context, in *ListRelatedAccountGroupMembershipsRequest, opts ...grpc.CallOption) (*ListRelatedAccountGroupMembershipsResponse, error)
	// Search group memberships related to a given account.
	SearchRelatedAccountGroupMemberships(ctx context.Context, in *SearchRelatedAccountGroupMembershipsRequest, opts ...grpc.CallOption) (*SearchRelatedAccountGroupMembershipsResponse, error)
}

RecaptchaEnterpriseServiceClient is the client API for RecaptchaEnterpriseService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewRecaptchaEnterpriseServiceClient 

func NewRecaptchaEnterpriseServiceClient(cc grpc.ClientConnInterface) RecaptchaEnterpriseServiceClient

type RecaptchaEnterpriseServiceServer 

type RecaptchaEnterpriseServiceServer interface {
	// Creates an Assessment of the likelihood an event is legitimate.
	CreateAssessment(context.Context, *CreateAssessmentRequest) (*Assessment, error)
	// Annotates a previously created Assessment to provide additional information
	// on whether the event turned out to be authentic or fraudulent.
	AnnotateAssessment(context.Context, *AnnotateAssessmentRequest) (*AnnotateAssessmentResponse, error)
	// Creates a new reCAPTCHA Enterprise key.
	CreateKey(context.Context, *CreateKeyRequest) (*Key, error)
	// Returns the list of all keys that belong to a project.
	ListKeys(context.Context, *ListKeysRequest) (*ListKeysResponse, error)
	// Returns the specified key.
	GetKey(context.Context, *GetKeyRequest) (*Key, error)
	// Updates the specified key.
	UpdateKey(context.Context, *UpdateKeyRequest) (*Key, error)
	// Deletes the specified key.
	DeleteKey(context.Context, *DeleteKeyRequest) (*emptypb.Empty, error)
	// 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 Site Key, and
	// your user must have the reCAPTCHA Enterprise Admin IAM role in the
	// destination project.
	MigrateKey(context.Context, *MigrateKeyRequest) (*Key, error)
	// Get some aggregated metrics for a Key. This data can be used to build
	// dashboards.
	GetMetrics(context.Context, *GetMetricsRequest) (*Metrics, error)
	// List groups of related accounts.
	ListRelatedAccountGroups(context.Context, *ListRelatedAccountGroupsRequest) (*ListRelatedAccountGroupsResponse, error)
	// Get the memberships in a group of related accounts.
	ListRelatedAccountGroupMemberships(context.Context, *ListRelatedAccountGroupMembershipsRequest) (*ListRelatedAccountGroupMembershipsResponse, error)
	// Search group memberships related to a given account.
	SearchRelatedAccountGroupMemberships(context.Context, *SearchRelatedAccountGroupMembershipsRequest) (*SearchRelatedAccountGroupMembershipsResponse, error)
}

RecaptchaEnterpriseServiceServer is the server API for RecaptchaEnterpriseService service.

type RelatedAccountGroup 

type RelatedAccountGroup struct {

	// Required. The resource name for the related account group in the format
	// `projects/{project}/relatedaccountgroups/{related_account_group}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A group of related accounts.

func (*RelatedAccountGroup) Descriptor deprecated 

func (*RelatedAccountGroup) Descriptor() ([]byte, []int)

Deprecated: Use RelatedAccountGroup.ProtoReflect.Descriptor instead.

func (*RelatedAccountGroup) GetName 

func (x *RelatedAccountGroup) GetName() string

func (*RelatedAccountGroup) ProtoMessage 

func (*RelatedAccountGroup) ProtoMessage()

func (*RelatedAccountGroup) ProtoReflect 

func (x *RelatedAccountGroup) ProtoReflect() protoreflect.Message

func (*RelatedAccountGroup) Reset 

func (x *RelatedAccountGroup) Reset()

func (*RelatedAccountGroup) String 

func (x *RelatedAccountGroup) String() string

type RelatedAccountGroupMembership 

type RelatedAccountGroupMembership struct {

	// Required. The resource name for this membership in the format
	// `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The unique stable hashed user identifier of the member. The identifier
	// corresponds to a `hashed_account_id` provided in a previous
	// CreateAssessment or AnnotateAssessment call.
	HashedAccountId []byte `protobuf:"bytes,2,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// contains filtered or unexported fields
}

A membership in a group of related accounts.

func (*RelatedAccountGroupMembership) Descriptor deprecated 

func (*RelatedAccountGroupMembership) Descriptor() ([]byte, []int)

Deprecated: Use RelatedAccountGroupMembership.ProtoReflect.Descriptor instead.

func (*RelatedAccountGroupMembership) GetHashedAccountId 

func (x *RelatedAccountGroupMembership) GetHashedAccountId() []byte

func (*RelatedAccountGroupMembership) GetName 

func (x *RelatedAccountGroupMembership) GetName() string

func (*RelatedAccountGroupMembership) ProtoMessage 

func (*RelatedAccountGroupMembership) ProtoMessage()

func (*RelatedAccountGroupMembership) ProtoReflect 

func (x *RelatedAccountGroupMembership) ProtoReflect() protoreflect.Message

func (*RelatedAccountGroupMembership) Reset 

func (x *RelatedAccountGroupMembership) Reset()

func (*RelatedAccountGroupMembership) String 

func (x *RelatedAccountGroupMembership) String() string

type RiskAnalysis 

type RiskAnalysis struct {

	// Legitimate event score from 0.0 to 1.0.
	// (1.0 means very likely legitimate traffic while 0.0 means very likely
	// non-legitimate traffic).
	Score float32 `protobuf:"fixed32,1,opt,name=score,proto3" json:"score,omitempty"`
	// Reasons contributing to the risk analysis verdict.
	Reasons []RiskAnalysis_ClassificationReason `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

Risk analysis result for an event.

func (*RiskAnalysis) Descriptor deprecated 

func (*RiskAnalysis) Descriptor() ([]byte, []int)

Deprecated: Use RiskAnalysis.ProtoReflect.Descriptor instead.

func (*RiskAnalysis) GetReasons 

func (x *RiskAnalysis) GetReasons() []RiskAnalysis_ClassificationReason

func (*RiskAnalysis) GetScore 

func (x *RiskAnalysis) GetScore() float32

func (*RiskAnalysis) ProtoMessage 

func (*RiskAnalysis) ProtoMessage()

func (*RiskAnalysis) ProtoReflect 

func (x *RiskAnalysis) ProtoReflect() protoreflect.Message

func (*RiskAnalysis) Reset 

func (x *RiskAnalysis) Reset()

func (*RiskAnalysis) String 

func (x *RiskAnalysis) String() string

type RiskAnalysis_ClassificationReason 

type RiskAnalysis_ClassificationReason int32

Reasons contributing to the risk analysis verdict. 

const (
	// Default unspecified type.
	RiskAnalysis_CLASSIFICATION_REASON_UNSPECIFIED RiskAnalysis_ClassificationReason = 0
	// Interactions matched the behavior of an automated agent.
	RiskAnalysis_AUTOMATION RiskAnalysis_ClassificationReason = 1
	// The event originated from an illegitimate environment.
	RiskAnalysis_UNEXPECTED_ENVIRONMENT RiskAnalysis_ClassificationReason = 2
	// Traffic volume from the event source is higher than normal.
	RiskAnalysis_TOO_MUCH_TRAFFIC RiskAnalysis_ClassificationReason = 3
	// Interactions with the site were significantly different than expected
	// patterns.
	RiskAnalysis_UNEXPECTED_USAGE_PATTERNS RiskAnalysis_ClassificationReason = 4
	// Too little traffic has been received from this site thus far to generate
	// quality risk analysis.
	RiskAnalysis_LOW_CONFIDENCE_SCORE RiskAnalysis_ClassificationReason = 5
)

func (RiskAnalysis_ClassificationReason) Descriptor 

func (RiskAnalysis_ClassificationReason) Descriptor() protoreflect.EnumDescriptor

func (RiskAnalysis_ClassificationReason) Enum 

func (x RiskAnalysis_ClassificationReason) Enum() *RiskAnalysis_ClassificationReason

func (RiskAnalysis_ClassificationReason) EnumDescriptor deprecated 

func (RiskAnalysis_ClassificationReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use RiskAnalysis_ClassificationReason.Descriptor instead.

func (RiskAnalysis_ClassificationReason) Number 

func (x RiskAnalysis_ClassificationReason) Number() protoreflect.EnumNumber

func (RiskAnalysis_ClassificationReason) String 

func (x RiskAnalysis_ClassificationReason) String() string

func (RiskAnalysis_ClassificationReason) Type 

func (RiskAnalysis_ClassificationReason) Type() protoreflect.EnumType

type ScoreDistribution 

type ScoreDistribution struct {

	// Map key is score value multiplied by 100. The scores are discrete values
	// between [0, 1]. The maximum number of buckets is on order of a few dozen,
	// but typically much lower (ie. 10).
	ScoreBuckets map[int32]int64 `` /* 187-byte string literal not displayed */
	// contains filtered or unexported fields
}

Score distribution.

func (*ScoreDistribution) Descriptor deprecated 

func (*ScoreDistribution) Descriptor() ([]byte, []int)

Deprecated: Use ScoreDistribution.ProtoReflect.Descriptor instead.

func (*ScoreDistribution) GetScoreBuckets 

func (x *ScoreDistribution) GetScoreBuckets() map[int32]int64

func (*ScoreDistribution) ProtoMessage 

func (*ScoreDistribution) ProtoMessage()

func (*ScoreDistribution) ProtoReflect 

func (x *ScoreDistribution) ProtoReflect() protoreflect.Message

func (*ScoreDistribution) Reset 

func (x *ScoreDistribution) Reset()

func (*ScoreDistribution) String 

func (x *ScoreDistribution) String() string

type ScoreMetrics 

type ScoreMetrics struct {

	// Aggregated score metrics for all traffic.
	OverallMetrics *ScoreDistribution `protobuf:"bytes,1,opt,name=overall_metrics,json=overallMetrics,proto3" json:"overall_metrics,omitempty"`
	// Action-based metrics. The map key is the action name which specified by the
	// site owners at time of the "execute" client-side call.
	// Populated only for SCORE keys.
	ActionMetrics map[string]*ScoreDistribution `` /* 188-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metrics related to scoring.

func (*ScoreMetrics) Descriptor deprecated 

func (*ScoreMetrics) Descriptor() ([]byte, []int)

Deprecated: Use ScoreMetrics.ProtoReflect.Descriptor instead.

func (*ScoreMetrics) GetActionMetrics 

func (x *ScoreMetrics) GetActionMetrics() map[string]*ScoreDistribution

func (*ScoreMetrics) GetOverallMetrics 

func (x *ScoreMetrics) GetOverallMetrics() *ScoreDistribution

func (*ScoreMetrics) ProtoMessage 

func (*ScoreMetrics) ProtoMessage()

func (*ScoreMetrics) ProtoReflect 

func (x *ScoreMetrics) ProtoReflect() protoreflect.Message

func (*ScoreMetrics) Reset 

func (x *ScoreMetrics) Reset()

func (*ScoreMetrics) String 

func (x *ScoreMetrics) String() string

type SearchRelatedAccountGroupMembershipsRequest 

type SearchRelatedAccountGroupMembershipsRequest struct {

	// Required. The name of the project to search related account group memberships from,
	// in the format "projects/{project}".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The unique stable hashed user identifier we should search connections to.
	// The identifier should correspond to a `hashed_account_id` provided in a
	// previous CreateAssessment or AnnotateAssessment call.
	HashedAccountId []byte `protobuf:"bytes,2,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// Optional. The maximum number of groups to return. The service may return fewer than
	// this value.
	// If unspecified, at most 50 groups will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous
	// `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
	// subsequent page.
	//
	// When paginating, all other parameters provided to
	// `SearchRelatedAccountGroupMemberships` must match the call that provided
	// the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request message to search related account group memberships.

func (*SearchRelatedAccountGroupMembershipsRequest) Descriptor deprecated 

func (*SearchRelatedAccountGroupMembershipsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchRelatedAccountGroupMembershipsRequest.ProtoReflect.Descriptor instead.

func (*SearchRelatedAccountGroupMembershipsRequest) GetHashedAccountId 

func (x *SearchRelatedAccountGroupMembershipsRequest) GetHashedAccountId() []byte

func (*SearchRelatedAccountGroupMembershipsRequest) GetPageSize 

func (x *SearchRelatedAccountGroupMembershipsRequest) GetPageSize() int32

func (*SearchRelatedAccountGroupMembershipsRequest) GetPageToken 

func (x *SearchRelatedAccountGroupMembershipsRequest) GetPageToken() string

func (*SearchRelatedAccountGroupMembershipsRequest) GetParent 

func (x *SearchRelatedAccountGroupMembershipsRequest) GetParent() string

func (*SearchRelatedAccountGroupMembershipsRequest) ProtoMessage 

func (*SearchRelatedAccountGroupMembershipsRequest) ProtoMessage()

func (*SearchRelatedAccountGroupMembershipsRequest) ProtoReflect 

func (x *SearchRelatedAccountGroupMembershipsRequest) ProtoReflect() protoreflect.Message

func (*SearchRelatedAccountGroupMembershipsRequest) Reset 

func (x *SearchRelatedAccountGroupMembershipsRequest) Reset()

func (*SearchRelatedAccountGroupMembershipsRequest) String 

func (x *SearchRelatedAccountGroupMembershipsRequest) String() string

type SearchRelatedAccountGroupMembershipsResponse 

type SearchRelatedAccountGroupMembershipsResponse struct {

	// The queried memberships.
	RelatedAccountGroupMemberships []*RelatedAccountGroupMembership `` /* 155-byte string literal not displayed */
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response to a `SearchRelatedAccountGroupMemberships` call.

func (*SearchRelatedAccountGroupMembershipsResponse) Descriptor deprecated 

func (*SearchRelatedAccountGroupMembershipsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchRelatedAccountGroupMembershipsResponse.ProtoReflect.Descriptor instead.

func (*SearchRelatedAccountGroupMembershipsResponse) GetNextPageToken 

func (x *SearchRelatedAccountGroupMembershipsResponse) GetNextPageToken() string

func (*SearchRelatedAccountGroupMembershipsResponse) GetRelatedAccountGroupMemberships 

func (x *SearchRelatedAccountGroupMembershipsResponse) GetRelatedAccountGroupMemberships() []*RelatedAccountGroupMembership

func (*SearchRelatedAccountGroupMembershipsResponse) ProtoMessage 

func (*SearchRelatedAccountGroupMembershipsResponse) ProtoMessage()

func (*SearchRelatedAccountGroupMembershipsResponse) ProtoReflect 

func (x *SearchRelatedAccountGroupMembershipsResponse) ProtoReflect() protoreflect.Message

func (*SearchRelatedAccountGroupMembershipsResponse) Reset 

func (x *SearchRelatedAccountGroupMembershipsResponse) Reset()

func (*SearchRelatedAccountGroupMembershipsResponse) String 

func (x *SearchRelatedAccountGroupMembershipsResponse) String() string

type TestingOptions 

type TestingOptions struct {

	// All assessments for this Key will return this score. Must be between 0
	// (likely not legitimate) and 1 (likely legitimate) inclusive.
	TestingScore float32 `protobuf:"fixed32,1,opt,name=testing_score,json=testingScore,proto3" json:"testing_score,omitempty"`
	// For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests
	// for this site will return nocaptcha if NOCAPTCHA, or an unsolvable
	// challenge if CHALLENGE.
	TestingChallenge TestingOptions_TestingChallenge `` /* 183-byte string literal not displayed */
	// contains filtered or unexported fields
}

Options for user acceptance testing.

func (*TestingOptions) Descriptor deprecated 

func (*TestingOptions) Descriptor() ([]byte, []int)

Deprecated: Use TestingOptions.ProtoReflect.Descriptor instead.

func (*TestingOptions) GetTestingChallenge 

func (x *TestingOptions) GetTestingChallenge() TestingOptions_TestingChallenge

func (*TestingOptions) GetTestingScore 

func (x *TestingOptions) GetTestingScore() float32

func (*TestingOptions) ProtoMessage 

func (*TestingOptions) ProtoMessage()

func (*TestingOptions) ProtoReflect 

func (x *TestingOptions) ProtoReflect() protoreflect.Message

func (*TestingOptions) Reset 

func (x *TestingOptions) Reset()

func (*TestingOptions) String 

func (x *TestingOptions) String() string

type TestingOptions_TestingChallenge 

type TestingOptions_TestingChallenge int32

Enum that represents the challenge option for challenge-based (CHECKBOX, INVISIBLE) testing keys. 

const (
	// Perform the normal risk analysis and return either nocaptcha or a
	// challenge depending on risk and trust factors.
	TestingOptions_TESTING_CHALLENGE_UNSPECIFIED TestingOptions_TestingChallenge = 0
	// Challenge requests for this key always return a nocaptcha, which
	// does not require a solution.
	TestingOptions_NOCAPTCHA TestingOptions_TestingChallenge = 1
	// Challenge requests for this key always return an unsolvable
	// challenge.
	TestingOptions_UNSOLVABLE_CHALLENGE TestingOptions_TestingChallenge = 2
)

func (TestingOptions_TestingChallenge) Descriptor 

func (TestingOptions_TestingChallenge) Descriptor() protoreflect.EnumDescriptor

func (TestingOptions_TestingChallenge) Enum 

func (x TestingOptions_TestingChallenge) Enum() *TestingOptions_TestingChallenge

func (TestingOptions_TestingChallenge) EnumDescriptor deprecated 

func (TestingOptions_TestingChallenge) EnumDescriptor() ([]byte, []int)

Deprecated: Use TestingOptions_TestingChallenge.Descriptor instead.

func (TestingOptions_TestingChallenge) Number 

func (x TestingOptions_TestingChallenge) Number() protoreflect.EnumNumber

func (TestingOptions_TestingChallenge) String 

func (x TestingOptions_TestingChallenge) String() string

func (TestingOptions_TestingChallenge) Type 

func (TestingOptions_TestingChallenge) Type() protoreflect.EnumType

type TokenProperties 

type TokenProperties struct {

	// Whether the provided user response token is valid. When valid = false, the
	// reason could be specified in invalid_reason or it could also be due to
	// a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey
	// used to generate the token was different than the one specified in the
	// assessment).
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// Reason associated with the response when valid = false.
	InvalidReason TokenProperties_InvalidReason `` /* 172-byte string literal not displayed */
	// The timestamp corresponding to the generation of the token.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The hostname of the page on which the token was generated.
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Action name provided at token generation.
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// contains filtered or unexported fields
}

func (*TokenProperties) Descriptor deprecated 

func (*TokenProperties) Descriptor() ([]byte, []int)

Deprecated: Use TokenProperties.ProtoReflect.Descriptor instead.

func (*TokenProperties) GetAction 

func (x *TokenProperties) GetAction() string

func (*TokenProperties) GetCreateTime 

func (x *TokenProperties) GetCreateTime() *timestamppb.Timestamp

func (*TokenProperties) GetHostname 

func (x *TokenProperties) GetHostname() string

func (*TokenProperties) GetInvalidReason 

func (x *TokenProperties) GetInvalidReason() TokenProperties_InvalidReason

func (*TokenProperties) GetValid 

func (x *TokenProperties) GetValid() bool

func (*TokenProperties) ProtoMessage 

func (*TokenProperties) ProtoMessage()

func (*TokenProperties) ProtoReflect 

func (x *TokenProperties) ProtoReflect() protoreflect.Message

func (*TokenProperties) Reset 

func (x *TokenProperties) Reset()

func (*TokenProperties) String 

func (x *TokenProperties) String() string

type TokenProperties_InvalidReason 

type TokenProperties_InvalidReason int32

Enum that represents the types of invalid token reasons. 

const (
	// Default unspecified type.
	TokenProperties_INVALID_REASON_UNSPECIFIED TokenProperties_InvalidReason = 0
	// If the failure reason was not accounted for.
	TokenProperties_UNKNOWN_INVALID_REASON TokenProperties_InvalidReason = 1
	// The provided user verification token was malformed.
	TokenProperties_MALFORMED TokenProperties_InvalidReason = 2
	// The user verification token had expired.
	TokenProperties_EXPIRED TokenProperties_InvalidReason = 3
	// The user verification had already been seen.
	TokenProperties_DUPE TokenProperties_InvalidReason = 4
	// The user verification token was not present.
	TokenProperties_MISSING TokenProperties_InvalidReason = 5
	// A retriable error (such as network failure) occurred on the browser.
	// Could easily be simulated by an attacker.
	TokenProperties_BROWSER_ERROR TokenProperties_InvalidReason = 6
)

func (TokenProperties_InvalidReason) Descriptor 

func (TokenProperties_InvalidReason) Descriptor() protoreflect.EnumDescriptor

func (TokenProperties_InvalidReason) Enum 

func (x TokenProperties_InvalidReason) Enum() *TokenProperties_InvalidReason

func (TokenProperties_InvalidReason) EnumDescriptor deprecated 

func (TokenProperties_InvalidReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use TokenProperties_InvalidReason.Descriptor instead.

func (TokenProperties_InvalidReason) Number 

func (x TokenProperties_InvalidReason) Number() protoreflect.EnumNumber

func (TokenProperties_InvalidReason) String 

func (x TokenProperties_InvalidReason) String() string

func (TokenProperties_InvalidReason) Type 

func (TokenProperties_InvalidReason) Type() protoreflect.EnumType

type UnimplementedRecaptchaEnterpriseServiceServer 

type UnimplementedRecaptchaEnterpriseServiceServer struct {
}

UnimplementedRecaptchaEnterpriseServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRecaptchaEnterpriseServiceServer) AnnotateAssessment 

func (*UnimplementedRecaptchaEnterpriseServiceServer) AnnotateAssessment(context.Context, *AnnotateAssessmentRequest) (*AnnotateAssessmentResponse, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) CreateAssessment 

func (*UnimplementedRecaptchaEnterpriseServiceServer) CreateAssessment(context.Context, *CreateAssessmentRequest) (*Assessment, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) CreateKey 

func (*UnimplementedRecaptchaEnterpriseServiceServer) CreateKey(context.Context, *CreateKeyRequest) (*Key, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) DeleteKey 

func (*UnimplementedRecaptchaEnterpriseServiceServer) DeleteKey(context.Context, *DeleteKeyRequest) (*emptypb.Empty, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) GetKey 

func (*UnimplementedRecaptchaEnterpriseServiceServer) GetKey(context.Context, *GetKeyRequest) (*Key, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) GetMetrics 

func (*UnimplementedRecaptchaEnterpriseServiceServer) GetMetrics(context.Context, *GetMetricsRequest) (*Metrics, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListKeys 

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListKeys(context.Context, *ListKeysRequest) (*ListKeysResponse, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListRelatedAccountGroupMemberships 

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListRelatedAccountGroupMemberships(context.Context, *ListRelatedAccountGroupMembershipsRequest) (*ListRelatedAccountGroupMembershipsResponse, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListRelatedAccountGroups 

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListRelatedAccountGroups(context.Context, *ListRelatedAccountGroupsRequest) (*ListRelatedAccountGroupsResponse, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) MigrateKey 

func (*UnimplementedRecaptchaEnterpriseServiceServer) MigrateKey(context.Context, *MigrateKeyRequest) (*Key, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) SearchRelatedAccountGroupMemberships 

func (*UnimplementedRecaptchaEnterpriseServiceServer) SearchRelatedAccountGroupMemberships(context.Context, *SearchRelatedAccountGroupMembershipsRequest) (*SearchRelatedAccountGroupMembershipsResponse, error)

func (*UnimplementedRecaptchaEnterpriseServiceServer) UpdateKey 

func (*UnimplementedRecaptchaEnterpriseServiceServer) UpdateKey(context.Context, *UpdateKeyRequest) (*Key, error)

type UpdateKeyRequest 

type UpdateKeyRequest struct {

	// Required. The key to update.
	Key *Key `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Optional. The mask to control which fields of the key get updated. If the mask is not
	// present, all fields will be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The update key request message.

func (*UpdateKeyRequest) Descriptor deprecated 

func (*UpdateKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateKeyRequest.ProtoReflect.Descriptor instead.

func (*UpdateKeyRequest) GetKey 

func (x *UpdateKeyRequest) GetKey() *Key

func (*UpdateKeyRequest) GetUpdateMask 

func (x *UpdateKeyRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateKeyRequest) ProtoMessage 

func (*UpdateKeyRequest) ProtoMessage()

func (*UpdateKeyRequest) ProtoReflect 

func (x *UpdateKeyRequest) ProtoReflect() protoreflect.Message

func (*UpdateKeyRequest) Reset 

func (x *UpdateKeyRequest) Reset()

func (*UpdateKeyRequest) String 

func (x *UpdateKeyRequest) String() string

type WebKeySettings 

type WebKeySettings struct {

	// If set to true, it means allowed_domains will not be enforced.
	AllowAllDomains bool `protobuf:"varint,3,opt,name=allow_all_domains,json=allowAllDomains,proto3" json:"allow_all_domains,omitempty"`
	// Domains or subdomains of websites allowed to use the key. All subdomains
	// of an allowed domain are automatically allowed. A valid domain requires a
	// host and must not include any path, port, query or fragment.
	// Examples: 'example.com' or 'subdomain.example.com'
	AllowedDomains []string `protobuf:"bytes,1,rep,name=allowed_domains,json=allowedDomains,proto3" json:"allowed_domains,omitempty"`
	// If set to true, the key can be used on AMP (Accelerated Mobile Pages)
	// websites. This is supported only for the SCORE integration type.
	AllowAmpTraffic bool `protobuf:"varint,2,opt,name=allow_amp_traffic,json=allowAmpTraffic,proto3" json:"allow_amp_traffic,omitempty"`
	// Required. Describes how this key is integrated with the website.
	IntegrationType WebKeySettings_IntegrationType `` /* 179-byte string literal not displayed */
	// Settings for the frequency and difficulty at which this key triggers
	// captcha challenges. This should only be specified for IntegrationTypes
	// CHECKBOX and INVISIBLE.
	ChallengeSecurityPreference WebKeySettings_ChallengeSecurityPreference `` /* 229-byte string literal not displayed */
	// contains filtered or unexported fields
}

Settings specific to keys that can be used by websites.

func (*WebKeySettings) Descriptor deprecated 

func (*WebKeySettings) Descriptor() ([]byte, []int)

Deprecated: Use WebKeySettings.ProtoReflect.Descriptor instead.

func (*WebKeySettings) GetAllowAllDomains 

func (x *WebKeySettings) GetAllowAllDomains() bool

func (*WebKeySettings) GetAllowAmpTraffic 

func (x *WebKeySettings) GetAllowAmpTraffic() bool

func (*WebKeySettings) GetAllowedDomains 

func (x *WebKeySettings) GetAllowedDomains() []string

func (*WebKeySettings) GetChallengeSecurityPreference 

func (x *WebKeySettings) GetChallengeSecurityPreference() WebKeySettings_ChallengeSecurityPreference

func (*WebKeySettings) GetIntegrationType 

func (x *WebKeySettings) GetIntegrationType() WebKeySettings_IntegrationType

func (*WebKeySettings) ProtoMessage 

func (*WebKeySettings) ProtoMessage()

func (*WebKeySettings) ProtoReflect 

func (x *WebKeySettings) ProtoReflect() protoreflect.Message

func (*WebKeySettings) Reset 

func (x *WebKeySettings) Reset()

func (*WebKeySettings) String 

func (x *WebKeySettings) String() string

type WebKeySettings_ChallengeSecurityPreference 

type WebKeySettings_ChallengeSecurityPreference int32

Enum that represents the possible challenge frequency and difficulty configurations for a web key. 

const (
	// Default type that indicates this enum hasn't been specified.
	WebKeySettings_CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED WebKeySettings_ChallengeSecurityPreference = 0
	// Key tends to show fewer and easier challenges.
	WebKeySettings_USABILITY WebKeySettings_ChallengeSecurityPreference = 1
	// Key tends to show balanced (in amount and difficulty) challenges.
	WebKeySettings_BALANCE WebKeySettings_ChallengeSecurityPreference = 2
	// Key tends to show more and harder challenges.
	WebKeySettings_SECURITY WebKeySettings_ChallengeSecurityPreference = 3
)

func (WebKeySettings_ChallengeSecurityPreference) Descriptor 

func (WebKeySettings_ChallengeSecurityPreference) Descriptor() protoreflect.EnumDescriptor

func (WebKeySettings_ChallengeSecurityPreference) Enum 

func (x WebKeySettings_ChallengeSecurityPreference) Enum() *WebKeySettings_ChallengeSecurityPreference

func (WebKeySettings_ChallengeSecurityPreference) EnumDescriptor deprecated 

func (WebKeySettings_ChallengeSecurityPreference) EnumDescriptor() ([]byte, []int)

Deprecated: Use WebKeySettings_ChallengeSecurityPreference.Descriptor instead.

func (WebKeySettings_ChallengeSecurityPreference) Number 

func (x WebKeySettings_ChallengeSecurityPreference) Number() protoreflect.EnumNumber

func (WebKeySettings_ChallengeSecurityPreference) String 

func (x WebKeySettings_ChallengeSecurityPreference) String() string

func (WebKeySettings_ChallengeSecurityPreference) Type 

func (WebKeySettings_ChallengeSecurityPreference) Type() protoreflect.EnumType

type WebKeySettings_IntegrationType 

type WebKeySettings_IntegrationType int32

Enum that represents the integration types for web keys. 

const (
	// Default type that indicates this enum hasn't been specified. This is not
	// a valid IntegrationType, one of the other types must be specified
	// instead.
	WebKeySettings_INTEGRATION_TYPE_UNSPECIFIED WebKeySettings_IntegrationType = 0
	// Only used to produce scores. It doesn't display the "I'm not a robot"
	// checkbox and never shows captcha challenges.
	WebKeySettings_SCORE WebKeySettings_IntegrationType = 1
	// Displays the "I'm not a robot" checkbox and may show captcha challenges
	// after it is checked.
	WebKeySettings_CHECKBOX WebKeySettings_IntegrationType = 2
	// Doesn't display the "I'm not a robot" checkbox, but may show captcha
	// challenges after risk analysis.
	WebKeySettings_INVISIBLE WebKeySettings_IntegrationType = 3
)

func (WebKeySettings_IntegrationType) Descriptor 

func (WebKeySettings_IntegrationType) Descriptor() protoreflect.EnumDescriptor

func (WebKeySettings_IntegrationType) Enum 

func (x WebKeySettings_IntegrationType) Enum() *WebKeySettings_IntegrationType

func (WebKeySettings_IntegrationType) EnumDescriptor deprecated 

func (WebKeySettings_IntegrationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use WebKeySettings_IntegrationType.Descriptor instead.

func (WebKeySettings_IntegrationType) Number 

func (x WebKeySettings_IntegrationType) Number() protoreflect.EnumNumber

func (WebKeySettings_IntegrationType) String 

func (x WebKeySettings_IntegrationType) String() string

func (WebKeySettings_IntegrationType) Type 

func (WebKeySettings_IntegrationType) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.