recaptchaenterprisepb

package
v2.12.0 Latest Latest
Warning

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

Go to latest
Published: Mar 25, 2024 License: Apache-2.0 Imports: 13 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	TransactionEvent_TransactionEventType_name = map[int32]string{
		0:  "TRANSACTION_EVENT_TYPE_UNSPECIFIED",
		1:  "MERCHANT_APPROVE",
		2:  "MERCHANT_DENY",
		3:  "MANUAL_REVIEW",
		4:  "AUTHORIZATION",
		5:  "AUTHORIZATION_DECLINE",
		6:  "PAYMENT_CAPTURE",
		7:  "PAYMENT_CAPTURE_DECLINE",
		8:  "CANCEL",
		9:  "CHARGEBACK_INQUIRY",
		10: "CHARGEBACK_ALERT",
		11: "FRAUD_NOTIFICATION",
		12: "CHARGEBACK",
		13: "CHARGEBACK_REPRESENTMENT",
		14: "CHARGEBACK_REVERSE",
		15: "REFUND_REQUEST",
		16: "REFUND_DECLINE",
		17: "REFUND",
		18: "REFUND_REVERSE",
	}
	TransactionEvent_TransactionEventType_value = map[string]int32{
		"TRANSACTION_EVENT_TYPE_UNSPECIFIED": 0,
		"MERCHANT_APPROVE":                   1,
		"MERCHANT_DENY":                      2,
		"MANUAL_REVIEW":                      3,
		"AUTHORIZATION":                      4,
		"AUTHORIZATION_DECLINE":              5,
		"PAYMENT_CAPTURE":                    6,
		"PAYMENT_CAPTURE_DECLINE":            7,
		"CANCEL":                             8,
		"CHARGEBACK_INQUIRY":                 9,
		"CHARGEBACK_ALERT":                   10,
		"FRAUD_NOTIFICATION":                 11,
		"CHARGEBACK":                         12,
		"CHARGEBACK_REPRESENTMENT":           13,
		"CHARGEBACK_REVERSE":                 14,
		"REFUND_REQUEST":                     15,
		"REFUND_DECLINE":                     16,
		"REFUND":                             17,
		"REFUND_REVERSE":                     18,
	}
)

Enum value maps for TransactionEvent_TransactionEventType.

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",
		8:  "CHARGEBACK_FRAUD",
		9:  "CHARGEBACK_DISPUTE",
		10: "REFUND",
		11: "REFUND_FRAUD",
		12: "TRANSACTION_ACCEPTED",
		13: "TRANSACTION_DECLINED",
		2:  "PAYMENT_HEURISTICS",
		7:  "INITIATED_TWO_FACTOR",
		3:  "PASSED_TWO_FACTOR",
		4:  "FAILED_TWO_FACTOR",
		5:  "CORRECT_PASSWORD",
		6:  "INCORRECT_PASSWORD",
		14: "SOCIAL_SPAM",
	}
	AnnotateAssessmentRequest_Reason_value = map[string]int32{
		"REASON_UNSPECIFIED":   0,
		"CHARGEBACK":           1,
		"CHARGEBACK_FRAUD":     8,
		"CHARGEBACK_DISPUTE":   9,
		"REFUND":               10,
		"REFUND_FRAUD":         11,
		"TRANSACTION_ACCEPTED": 12,
		"TRANSACTION_DECLINED": 13,
		"PAYMENT_HEURISTICS":   2,
		"INITIATED_TWO_FACTOR": 7,
		"PASSED_TWO_FACTOR":    3,
		"FAILED_TWO_FACTOR":    4,
		"CORRECT_PASSWORD":     5,
		"INCORRECT_PASSWORD":   6,
		"SOCIAL_SPAM":          14,
	}
)

Enum value maps for AnnotateAssessmentRequest_Reason.

View Source
var (
	AccountVerificationInfo_Result_name = map[int32]string{
		0: "RESULT_UNSPECIFIED",
		1: "SUCCESS_USER_VERIFIED",
		2: "ERROR_USER_NOT_VERIFIED",
		3: "ERROR_SITE_ONBOARDING_INCOMPLETE",
		4: "ERROR_RECIPIENT_NOT_ALLOWED",
		5: "ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED",
		6: "ERROR_CRITICAL_INTERNAL",
		7: "ERROR_CUSTOMER_QUOTA_EXHAUSTED",
		8: "ERROR_VERIFICATION_BYPASSED",
		9: "ERROR_VERDICT_MISMATCH",
	}
	AccountVerificationInfo_Result_value = map[string]int32{
		"RESULT_UNSPECIFIED":                    0,
		"SUCCESS_USER_VERIFIED":                 1,
		"ERROR_USER_NOT_VERIFIED":               2,
		"ERROR_SITE_ONBOARDING_INCOMPLETE":      3,
		"ERROR_RECIPIENT_NOT_ALLOWED":           4,
		"ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED": 5,
		"ERROR_CRITICAL_INTERNAL":               6,
		"ERROR_CUSTOMER_QUOTA_EXHAUSTED":        7,
		"ERROR_VERIFICATION_BYPASSED":           8,
		"ERROR_VERDICT_MISMATCH":                9,
	}
)

Enum value maps for AccountVerificationInfo_Result.

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",
		6: "SUSPECTED_CARDING",
		7: "SUSPECTED_CHARGEBACK",
	}
	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,
		"SUSPECTED_CARDING":                 6,
		"SUSPECTED_CHARGEBACK":              7,
	}
)

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 (
	FraudSignals_CardSignals_CardLabel_name = map[int32]string{
		0: "CARD_LABEL_UNSPECIFIED",
		1: "PREPAID",
		2: "VIRTUAL",
		3: "UNEXPECTED_LOCATION",
	}
	FraudSignals_CardSignals_CardLabel_value = map[string]int32{
		"CARD_LABEL_UNSPECIFIED": 0,
		"PREPAID":                1,
		"VIRTUAL":                2,
		"UNEXPECTED_LOCATION":    3,
	}
)

Enum value maps for FraudSignals_CardSignals_CardLabel.

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 (
	WafSettings_WafFeature_name = map[int32]string{
		0: "WAF_FEATURE_UNSPECIFIED",
		1: "CHALLENGE_PAGE",
		2: "SESSION_TOKEN",
		3: "ACTION_TOKEN",
		5: "EXPRESS",
	}
	WafSettings_WafFeature_value = map[string]int32{
		"WAF_FEATURE_UNSPECIFIED": 0,
		"CHALLENGE_PAGE":          1,
		"SESSION_TOKEN":           2,
		"ACTION_TOKEN":            3,
		"EXPRESS":                 5,
	}
)

Enum value maps for WafSettings_WafFeature.

View Source
var (
	WafSettings_WafService_name = map[int32]string{
		0: "WAF_SERVICE_UNSPECIFIED",
		1: "CA",
		3: "FASTLY",
		4: "CLOUDFLARE",
	}
	WafSettings_WafService_value = map[string]int32{
		"WAF_SERVICE_UNSPECIFIED": 0,
		"CA":                      1,
		"FASTLY":                  3,
		"CLOUDFLARE":              4,
	}
)

Enum value maps for WafSettings_WafService.

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 {

	// Output only. 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 (*AccountDefenderAssessment) ProtoMessage

func (*AccountDefenderAssessment) ProtoMessage()

func (*AccountDefenderAssessment) ProtoReflect

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 must be further
	// verified either through 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 can mean that 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 can require further
	// investigation.
	AccountDefenderAssessment_RELATED_ACCOUNTS_NUMBER_HIGH AccountDefenderAssessment_AccountDefenderLabel = 4
)

func (AccountDefenderAssessment_AccountDefenderLabel) Descriptor

func (AccountDefenderAssessment_AccountDefenderLabel) Enum

func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor deprecated

Deprecated: Use AccountDefenderAssessment_AccountDefenderLabel.Descriptor instead.

func (AccountDefenderAssessment_AccountDefenderLabel) Number

func (AccountDefenderAssessment_AccountDefenderLabel) String

func (AccountDefenderAssessment_AccountDefenderLabel) Type

type AccountVerificationInfo added in v2.6.0

type AccountVerificationInfo struct {

	// Optional. Endpoints that can be used for identity verification.
	Endpoints []*EndpointVerificationInfo `protobuf:"bytes,1,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	// Optional. Language code preference for the verification message, set as a
	// IETF BCP 47 language code.
	LanguageCode string `protobuf:"bytes,3,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// Output only. Result of the latest account verification challenge.
	LatestVerificationResult AccountVerificationInfo_Result `` /* 208-byte string literal not displayed */
	// Username of the account that is being verified. Deprecated. Customers
	// should now provide the `account_id` field in `event.user_info`.
	//
	// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// contains filtered or unexported fields
}

Information about account verification, used for identity verification.

func (*AccountVerificationInfo) Descriptor deprecated added in v2.6.0

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

Deprecated: Use AccountVerificationInfo.ProtoReflect.Descriptor instead.

func (*AccountVerificationInfo) GetEndpoints added in v2.6.0

func (*AccountVerificationInfo) GetLanguageCode added in v2.6.0

func (x *AccountVerificationInfo) GetLanguageCode() string

func (*AccountVerificationInfo) GetLatestVerificationResult added in v2.6.0

func (x *AccountVerificationInfo) GetLatestVerificationResult() AccountVerificationInfo_Result

func (*AccountVerificationInfo) GetUsername deprecated added in v2.6.0

func (x *AccountVerificationInfo) GetUsername() string

Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.

func (*AccountVerificationInfo) ProtoMessage added in v2.6.0

func (*AccountVerificationInfo) ProtoMessage()

func (*AccountVerificationInfo) ProtoReflect added in v2.6.0

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

func (*AccountVerificationInfo) Reset added in v2.6.0

func (x *AccountVerificationInfo) Reset()

func (*AccountVerificationInfo) String added in v2.6.0

func (x *AccountVerificationInfo) String() string

type AccountVerificationInfo_Result added in v2.6.0

type AccountVerificationInfo_Result int32

Result of the account verification as contained in the verdict token issued at the end of the verification flow.

const (
	// No information about the latest account verification.
	AccountVerificationInfo_RESULT_UNSPECIFIED AccountVerificationInfo_Result = 0
	// The user was successfully verified. This means the account verification
	// challenge was successfully completed.
	AccountVerificationInfo_SUCCESS_USER_VERIFIED AccountVerificationInfo_Result = 1
	// The user failed the verification challenge.
	AccountVerificationInfo_ERROR_USER_NOT_VERIFIED AccountVerificationInfo_Result = 2
	// The site is not properly onboarded to use the account verification
	// feature.
	AccountVerificationInfo_ERROR_SITE_ONBOARDING_INCOMPLETE AccountVerificationInfo_Result = 3
	// The recipient is not allowed for account verification. This can occur
	// during integration but should not occur in production.
	AccountVerificationInfo_ERROR_RECIPIENT_NOT_ALLOWED AccountVerificationInfo_Result = 4
	// The recipient has already been sent too many verification codes in a
	// short amount of time.
	AccountVerificationInfo_ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED AccountVerificationInfo_Result = 5
	// The verification flow could not be completed due to a critical internal
	// error.
	AccountVerificationInfo_ERROR_CRITICAL_INTERNAL AccountVerificationInfo_Result = 6
	// The client has exceeded their two factor request quota for this period of
	// time.
	AccountVerificationInfo_ERROR_CUSTOMER_QUOTA_EXHAUSTED AccountVerificationInfo_Result = 7
	// The request cannot be processed at the time because of an incident. This
	// bypass can be restricted to a problematic destination email domain, a
	// customer, or could affect the entire service.
	AccountVerificationInfo_ERROR_VERIFICATION_BYPASSED AccountVerificationInfo_Result = 8
	// The request parameters do not match with the token provided and cannot be
	// processed.
	AccountVerificationInfo_ERROR_VERDICT_MISMATCH AccountVerificationInfo_Result = 9
)

func (AccountVerificationInfo_Result) Descriptor added in v2.6.0

func (AccountVerificationInfo_Result) Enum added in v2.6.0

func (AccountVerificationInfo_Result) EnumDescriptor deprecated added in v2.6.0

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

Deprecated: Use AccountVerificationInfo_Result.Descriptor instead.

func (AccountVerificationInfo_Result) Number added in v2.6.0

func (AccountVerificationInfo_Result) String added in v2.6.0

func (AccountVerificationInfo_Result) Type added in v2.6.0

type AndroidKeySettings

type AndroidKeySettings struct {

	// Optional. If set to true, allowed_package_names are not enforced.
	AllowAllPackageNames bool `` /* 126-byte string literal not displayed */
	// Optional. 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"`
	// Optional. Set to true for keys that are used in an Android application that
	// is available for download in app stores in addition to the Google Play
	// Store.
	SupportNonGoogleAppStoreDistribution bool `` /* 178-byte string literal not displayed */
	// 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) GetSupportNonGoogleAppStoreDistribution added in v2.8.0

func (x *AndroidKeySettings) GetSupportNonGoogleAppStoreDistribution() bool

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. Reasons for the annotation that are assigned to the event.
	Reasons []AnnotateAssessmentRequest_Reason `` /* 149-byte string literal not displayed */
	// Optional. A stable account identifier to apply to the assessment. This is
	// an alternative to setting `account_id` in `CreateAssessment`, for example
	// when a stable account identifier is not yet known in the initial request.
	AccountId string `protobuf:"bytes,7,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// Optional. A stable hashed account identifier to apply to the assessment.
	// This is an alternative to setting `hashed_account_id` in
	// `CreateAssessment`, for example when a stable account identifier is not yet
	// known in the initial request.
	HashedAccountId []byte `protobuf:"bytes,4,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// Optional. If the assessment is part of a payment transaction, provide
	// details on payment lifecycle events that occur in the transaction.
	TransactionEvent *TransactionEvent `protobuf:"bytes,5,opt,name=transaction_event,json=transactionEvent,proto3" json:"transaction_event,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) GetAccountId added in v2.9.0

func (x *AnnotateAssessmentRequest) GetAccountId() string

func (*AnnotateAssessmentRequest) GetAnnotation

func (*AnnotateAssessmentRequest) GetHashedAccountId

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

func (*AnnotateAssessmentRequest) GetName

func (x *AnnotateAssessmentRequest) GetName() string

func (*AnnotateAssessmentRequest) GetReasons

func (*AnnotateAssessmentRequest) GetTransactionEvent added in v2.7.0

func (x *AnnotateAssessmentRequest) GetTransactionEvent() *TransactionEvent

func (*AnnotateAssessmentRequest) ProtoMessage

func (*AnnotateAssessmentRequest) ProtoMessage()

func (*AnnotateAssessmentRequest) ProtoReflect

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: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
	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: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
	AnnotateAssessmentRequest_PASSWORD_INCORRECT AnnotateAssessmentRequest_Annotation = 4
)

func (AnnotateAssessmentRequest_Annotation) Descriptor

func (AnnotateAssessmentRequest_Annotation) Enum

func (AnnotateAssessmentRequest_Annotation) EnumDescriptor deprecated

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

Deprecated: Use AnnotateAssessmentRequest_Annotation.Descriptor instead.

func (AnnotateAssessmentRequest_Annotation) Number

func (AnnotateAssessmentRequest_Annotation) String

func (AnnotateAssessmentRequest_Annotation) Type

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 that the transaction had a chargeback issued with no other
	// details. When possible, specify the type by using CHARGEBACK_FRAUD or
	// CHARGEBACK_DISPUTE instead.
	AnnotateAssessmentRequest_CHARGEBACK AnnotateAssessmentRequest_Reason = 1
	// Indicates that the transaction had a chargeback issued related to an
	// alleged unauthorized transaction from the cardholder's perspective (for
	// example, the card number was stolen).
	AnnotateAssessmentRequest_CHARGEBACK_FRAUD AnnotateAssessmentRequest_Reason = 8
	// Indicates that the transaction had a chargeback issued related to the
	// cardholder having provided their card details but allegedly not being
	// satisfied with the purchase (for example, misrepresentation, attempted
	// cancellation).
	AnnotateAssessmentRequest_CHARGEBACK_DISPUTE AnnotateAssessmentRequest_Reason = 9
	// Indicates that the completed payment transaction was refunded by the
	// seller.
	AnnotateAssessmentRequest_REFUND AnnotateAssessmentRequest_Reason = 10
	// Indicates that the completed payment transaction was determined to be
	// fraudulent by the seller, and was cancelled and refunded as a result.
	AnnotateAssessmentRequest_REFUND_FRAUD AnnotateAssessmentRequest_Reason = 11
	// Indicates that the payment transaction was accepted, and the user was
	// charged.
	AnnotateAssessmentRequest_TRANSACTION_ACCEPTED AnnotateAssessmentRequest_Reason = 12
	// Indicates that the payment transaction was declined, for example due to
	// invalid card details.
	AnnotateAssessmentRequest_TRANSACTION_DECLINED AnnotateAssessmentRequest_Reason = 13
	// 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
	// Indicates that the user sent unwanted and abusive messages to other users
	// of the platform, such as spam, scams, phishing, or social engineering.
	AnnotateAssessmentRequest_SOCIAL_SPAM AnnotateAssessmentRequest_Reason = 14
)

func (AnnotateAssessmentRequest_Reason) Descriptor

func (AnnotateAssessmentRequest_Reason) Enum

func (AnnotateAssessmentRequest_Reason) EnumDescriptor deprecated

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

Deprecated: Use AnnotateAssessmentRequest_Reason.Descriptor instead.

func (AnnotateAssessmentRequest_Reason) Number

func (AnnotateAssessmentRequest_Reason) String

func (AnnotateAssessmentRequest_Reason) Type

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 (*AnnotateAssessmentResponse) Reset

func (x *AnnotateAssessmentResponse) Reset()

func (*AnnotateAssessmentResponse) String

func (x *AnnotateAssessmentResponse) String() string

type AppleDeveloperId added in v2.8.0

type AppleDeveloperId struct {

	// Required. Input only. A private key (downloaded as a text file with a .p8
	// file extension) generated for your Apple Developer account. Ensure that
	// Apple DeviceCheck is enabled for the private key.
	PrivateKey string `protobuf:"bytes,1,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	// Required. The Apple developer key ID (10-character string).
	KeyId string `protobuf:"bytes,2,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// Required. The Apple team ID (10-character string) owning the provisioning
	// profile used to build your application.
	TeamId string `protobuf:"bytes,3,opt,name=team_id,json=teamId,proto3" json:"team_id,omitempty"`
	// contains filtered or unexported fields
}

Contains fields that are required to perform Apple-specific integrity checks.

func (*AppleDeveloperId) Descriptor deprecated added in v2.8.0

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

Deprecated: Use AppleDeveloperId.ProtoReflect.Descriptor instead.

func (*AppleDeveloperId) GetKeyId added in v2.8.0

func (x *AppleDeveloperId) GetKeyId() string

func (*AppleDeveloperId) GetPrivateKey added in v2.8.0

func (x *AppleDeveloperId) GetPrivateKey() string

func (*AppleDeveloperId) GetTeamId added in v2.8.0

func (x *AppleDeveloperId) GetTeamId() string

func (*AppleDeveloperId) ProtoMessage added in v2.8.0

func (*AppleDeveloperId) ProtoMessage()

func (*AppleDeveloperId) ProtoReflect added in v2.8.0

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

func (*AppleDeveloperId) Reset added in v2.8.0

func (x *AppleDeveloperId) Reset()

func (*AppleDeveloperId) String added in v2.8.0

func (x *AppleDeveloperId) String() string

type Assessment

type Assessment struct {

	// Output only. Identifier. 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"`
	// Optional. 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"`
	// Optional. Account verification information for identity verification. The
	// assessment event must include a token and site key to use this feature.
	AccountVerification *AccountVerificationInfo `protobuf:"bytes,5,opt,name=account_verification,json=accountVerification,proto3" json:"account_verification,omitempty"`
	// Output only. Assessment returned by account defender when an account
	// identifier is provided.
	AccountDefenderAssessment *AccountDefenderAssessment `` /* 138-byte string literal not displayed */
	// Optional. The private password leak verification field contains the
	// parameters that are used to to check for leaks privately without sharing
	// user credentials.
	PrivatePasswordLeakVerification *PrivatePasswordLeakVerification `` /* 158-byte string literal not displayed */
	// Output only. Assessment returned when firewall policies belonging to the
	// project are evaluated using the field firewall_policy_evaluation.
	FirewallPolicyAssessment *FirewallPolicyAssessment `` /* 136-byte string literal not displayed */
	// Output only. Assessment returned by Fraud Prevention when TransactionData
	// is provided.
	FraudPreventionAssessment *FraudPreventionAssessment `` /* 139-byte string literal not displayed */
	// Output only. Fraud Signals specific to the users involved in a payment
	// transaction.
	FraudSignals *FraudSignals `protobuf:"bytes,13,opt,name=fraud_signals,json=fraudSignals,proto3" json:"fraud_signals,omitempty"`
	// contains filtered or unexported fields
}

A reCAPTCHA Enterprise 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) GetAccountVerification added in v2.6.0

func (x *Assessment) GetAccountVerification() *AccountVerificationInfo

func (*Assessment) GetEvent

func (x *Assessment) GetEvent() *Event

func (*Assessment) GetFirewallPolicyAssessment added in v2.8.0

func (x *Assessment) GetFirewallPolicyAssessment() *FirewallPolicyAssessment

func (*Assessment) GetFraudPreventionAssessment added in v2.7.0

func (x *Assessment) GetFraudPreventionAssessment() *FraudPreventionAssessment

func (*Assessment) GetFraudSignals added in v2.8.0

func (x *Assessment) GetFraudSignals() *FraudSignals

func (*Assessment) GetName

func (x *Assessment) GetName() string

func (*Assessment) GetPrivatePasswordLeakVerification

func (x *Assessment) GetPrivatePasswordLeakVerification() *PrivatePasswordLeakVerification

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 CreateFirewallPolicyRequest added in v2.8.0

type CreateFirewallPolicyRequest struct {

	// Required. The name of the project this policy will apply to, in the format
	// `projects/{project}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Information to create the policy.
	FirewallPolicy *FirewallPolicy `protobuf:"bytes,2,opt,name=firewall_policy,json=firewallPolicy,proto3" json:"firewall_policy,omitempty"`
	// contains filtered or unexported fields
}

The create firewall policy request message.

func (*CreateFirewallPolicyRequest) Descriptor deprecated added in v2.8.0

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

Deprecated: Use CreateFirewallPolicyRequest.ProtoReflect.Descriptor instead.

func (*CreateFirewallPolicyRequest) GetFirewallPolicy added in v2.8.0

func (x *CreateFirewallPolicyRequest) GetFirewallPolicy() *FirewallPolicy

func (*CreateFirewallPolicyRequest) GetParent added in v2.8.0

func (x *CreateFirewallPolicyRequest) GetParent() string

func (*CreateFirewallPolicyRequest) ProtoMessage added in v2.8.0

func (*CreateFirewallPolicyRequest) ProtoMessage()

func (*CreateFirewallPolicyRequest) ProtoReflect added in v2.8.0

func (*CreateFirewallPolicyRequest) Reset added in v2.8.0

func (x *CreateFirewallPolicyRequest) Reset()

func (*CreateFirewallPolicyRequest) String added in v2.8.0

func (x *CreateFirewallPolicyRequest) 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 DeleteFirewallPolicyRequest added in v2.8.0

type DeleteFirewallPolicyRequest struct {

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

The delete firewall policy request message.

func (*DeleteFirewallPolicyRequest) Descriptor deprecated added in v2.8.0

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

Deprecated: Use DeleteFirewallPolicyRequest.ProtoReflect.Descriptor instead.

func (*DeleteFirewallPolicyRequest) GetName added in v2.8.0

func (x *DeleteFirewallPolicyRequest) GetName() string

func (*DeleteFirewallPolicyRequest) ProtoMessage added in v2.8.0

func (*DeleteFirewallPolicyRequest) ProtoMessage()

func (*DeleteFirewallPolicyRequest) ProtoReflect added in v2.8.0

func (*DeleteFirewallPolicyRequest) Reset added in v2.8.0

func (x *DeleteFirewallPolicyRequest) Reset()

func (*DeleteFirewallPolicyRequest) String added in v2.8.0

func (x *DeleteFirewallPolicyRequest) 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 EndpointVerificationInfo added in v2.6.0

type EndpointVerificationInfo struct {

	// Types that are assignable to Endpoint:
	//
	//	*EndpointVerificationInfo_EmailAddress
	//	*EndpointVerificationInfo_PhoneNumber
	Endpoint isEndpointVerificationInfo_Endpoint `protobuf_oneof:"endpoint"`
	// Output only. Token to provide to the client to trigger endpoint
	// verification. It must be used within 15 minutes.
	RequestToken string `protobuf:"bytes,3,opt,name=request_token,json=requestToken,proto3" json:"request_token,omitempty"`
	// Output only. Timestamp of the last successful verification for the
	// endpoint, if any.
	LastVerificationTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_verification_time,json=lastVerificationTime,proto3" json:"last_verification_time,omitempty"`
	// contains filtered or unexported fields
}

Information about a verification endpoint that can be used for 2FA.

func (*EndpointVerificationInfo) Descriptor deprecated added in v2.6.0

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

Deprecated: Use EndpointVerificationInfo.ProtoReflect.Descriptor instead.

func (*EndpointVerificationInfo) GetEmailAddress added in v2.6.0

func (x *EndpointVerificationInfo) GetEmailAddress() string

func (*EndpointVerificationInfo) GetEndpoint added in v2.6.0

func (m *EndpointVerificationInfo) GetEndpoint() isEndpointVerificationInfo_Endpoint

func (*EndpointVerificationInfo) GetLastVerificationTime added in v2.6.0

func (x *EndpointVerificationInfo) GetLastVerificationTime() *timestamppb.Timestamp

func (*EndpointVerificationInfo) GetPhoneNumber added in v2.6.0

func (x *EndpointVerificationInfo) GetPhoneNumber() string

func (*EndpointVerificationInfo) GetRequestToken added in v2.6.0

func (x *EndpointVerificationInfo) GetRequestToken() string

func (*EndpointVerificationInfo) ProtoMessage added in v2.6.0

func (*EndpointVerificationInfo) ProtoMessage()

func (*EndpointVerificationInfo) ProtoReflect added in v2.6.0

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

func (*EndpointVerificationInfo) Reset added in v2.6.0

func (x *EndpointVerificationInfo) Reset()

func (*EndpointVerificationInfo) String added in v2.6.0

func (x *EndpointVerificationInfo) String() string

type EndpointVerificationInfo_EmailAddress added in v2.6.0

type EndpointVerificationInfo_EmailAddress struct {
	// Email address for which to trigger a verification request.
	EmailAddress string `protobuf:"bytes,1,opt,name=email_address,json=emailAddress,proto3,oneof"`
}

type EndpointVerificationInfo_PhoneNumber added in v2.6.0

type EndpointVerificationInfo_PhoneNumber struct {
	// Phone number for which to trigger a verification request. Should be given
	// in E.164 format.
	PhoneNumber string `protobuf:"bytes,2,opt,name=phone_number,json=phoneNumber,proto3,oneof"`
}

type Event

type Event struct {

	// Optional. The user response token provided by the reCAPTCHA Enterprise
	// 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 Enterprise 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. Deprecated: use `user_info.account_id` instead.
	// Unique stable hashed user identifier for the request. The identifier must
	// be hashed using hmac-sha256 with stable secret.
	//
	// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
	HashedAccountId []byte `protobuf:"bytes,6,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// Optional. Flag for a reCAPTCHA express request for an assessment without a
	// token. If enabled, `site_key` must reference a SCORE key with WAF feature
	// set to EXPRESS.
	Express bool `protobuf:"varint,14,opt,name=express,proto3" json:"express,omitempty"`
	// Optional. The URI resource the user requested that triggered an assessment.
	RequestedUri string `protobuf:"bytes,8,opt,name=requested_uri,json=requestedUri,proto3" json:"requested_uri,omitempty"`
	// Optional. Flag for running WAF token assessment.
	// If enabled, the token must be specified, and have been created by a
	// WAF-enabled key.
	WafTokenAssessment bool `protobuf:"varint,9,opt,name=waf_token_assessment,json=wafTokenAssessment,proto3" json:"waf_token_assessment,omitempty"`
	// Optional. JA3 fingerprint for SSL clients.
	Ja3 string `protobuf:"bytes,10,opt,name=ja3,proto3" json:"ja3,omitempty"`
	// Optional. HTTP header information about the request.
	Headers []string `protobuf:"bytes,11,rep,name=headers,proto3" json:"headers,omitempty"`
	// Optional. Flag for enabling firewall policy config assessment.
	// If this flag is enabled, the firewall policy will be evaluated and a
	// suggested firewall action will be returned in the response.
	FirewallPolicyEvaluation bool `` /* 137-byte string literal not displayed */
	// Optional. Data describing a payment transaction to be assessed. Sending
	// this data enables reCAPTCHA Enterprise Fraud Prevention and the
	// FraudPreventionAssessment component in the response.
	TransactionData *TransactionData `protobuf:"bytes,13,opt,name=transaction_data,json=transactionData,proto3" json:"transaction_data,omitempty"`
	// Optional. Information about the user that generates this event, when they
	// can be identified. They are often identified through the use of an account
	// for logged-in requests or login/registration requests, or by providing user
	// identifiers for guest actions like checkout.
	UserInfo *UserInfo `protobuf:"bytes,15,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// contains filtered or unexported fields
}

The event being assessed.

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) GetExpress added in v2.8.0

func (x *Event) GetExpress() bool

func (*Event) GetFirewallPolicyEvaluation added in v2.8.0

func (x *Event) GetFirewallPolicyEvaluation() bool

func (*Event) GetHashedAccountId deprecated

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

Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.

func (*Event) GetHeaders added in v2.8.0

func (x *Event) GetHeaders() []string

func (*Event) GetJa3 added in v2.8.0

func (x *Event) GetJa3() string

func (*Event) GetRequestedUri added in v2.8.0

func (x *Event) GetRequestedUri() string

func (*Event) GetSiteKey

func (x *Event) GetSiteKey() string

func (*Event) GetToken

func (x *Event) GetToken() string

func (*Event) GetTransactionData added in v2.7.0

func (x *Event) GetTransactionData() *TransactionData

func (*Event) GetUserAgent

func (x *Event) GetUserAgent() string

func (*Event) GetUserInfo added in v2.9.0

func (x *Event) GetUserInfo() *UserInfo

func (*Event) GetUserIpAddress

func (x *Event) GetUserIpAddress() string

func (*Event) GetWafTokenAssessment added in v2.8.0

func (x *Event) GetWafTokenAssessment() bool

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 FirewallAction added in v2.8.0

type FirewallAction struct {

	// Types that are assignable to FirewallActionOneof:
	//
	//	*FirewallAction_Allow
	//	*FirewallAction_Block
	//	*FirewallAction_IncludeRecaptchaScript
	//	*FirewallAction_Redirect
	//	*FirewallAction_Substitute
	//	*FirewallAction_SetHeader
	FirewallActionOneof isFirewallAction_FirewallActionOneof `protobuf_oneof:"firewall_action_oneof"`
	// contains filtered or unexported fields
}

An individual action. Each action represents what to do if a policy matches.

func (*FirewallAction) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallAction.ProtoReflect.Descriptor instead.

func (*FirewallAction) GetAllow added in v2.8.0

func (*FirewallAction) GetBlock added in v2.8.0

func (*FirewallAction) GetFirewallActionOneof added in v2.8.0

func (m *FirewallAction) GetFirewallActionOneof() isFirewallAction_FirewallActionOneof

func (*FirewallAction) GetIncludeRecaptchaScript added in v2.11.0

func (x *FirewallAction) GetIncludeRecaptchaScript() *FirewallAction_IncludeRecaptchaScriptAction

func (*FirewallAction) GetRedirect added in v2.8.0

func (*FirewallAction) GetSetHeader added in v2.8.0

func (*FirewallAction) GetSubstitute added in v2.8.0

func (x *FirewallAction) GetSubstitute() *FirewallAction_SubstituteAction

func (*FirewallAction) ProtoMessage added in v2.8.0

func (*FirewallAction) ProtoMessage()

func (*FirewallAction) ProtoReflect added in v2.8.0

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

func (*FirewallAction) Reset added in v2.8.0

func (x *FirewallAction) Reset()

func (*FirewallAction) String added in v2.8.0

func (x *FirewallAction) String() string

type FirewallAction_Allow added in v2.8.0

type FirewallAction_Allow struct {
	// The user request did not match any policy and should be allowed
	// access to the requested resource.
	Allow *FirewallAction_AllowAction `protobuf:"bytes,1,opt,name=allow,proto3,oneof"`
}

type FirewallAction_AllowAction added in v2.8.0

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

An allow action continues processing a request unimpeded.

func (*FirewallAction_AllowAction) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallAction_AllowAction.ProtoReflect.Descriptor instead.

func (*FirewallAction_AllowAction) ProtoMessage added in v2.8.0

func (*FirewallAction_AllowAction) ProtoMessage()

func (*FirewallAction_AllowAction) ProtoReflect added in v2.8.0

func (*FirewallAction_AllowAction) Reset added in v2.8.0

func (x *FirewallAction_AllowAction) Reset()

func (*FirewallAction_AllowAction) String added in v2.8.0

func (x *FirewallAction_AllowAction) String() string

type FirewallAction_Block added in v2.8.0

type FirewallAction_Block struct {
	// This action will deny access to a given page. The user will get an HTTP
	// error code.
	Block *FirewallAction_BlockAction `protobuf:"bytes,2,opt,name=block,proto3,oneof"`
}

type FirewallAction_BlockAction added in v2.8.0

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

A block action serves an HTTP error code a prevents the request from hitting the backend.

func (*FirewallAction_BlockAction) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallAction_BlockAction.ProtoReflect.Descriptor instead.

func (*FirewallAction_BlockAction) ProtoMessage added in v2.8.0

func (*FirewallAction_BlockAction) ProtoMessage()

func (*FirewallAction_BlockAction) ProtoReflect added in v2.8.0

func (*FirewallAction_BlockAction) Reset added in v2.8.0

func (x *FirewallAction_BlockAction) Reset()

func (*FirewallAction_BlockAction) String added in v2.8.0

func (x *FirewallAction_BlockAction) String() string

type FirewallAction_IncludeRecaptchaScript added in v2.11.0

type FirewallAction_IncludeRecaptchaScript struct {
	// This action will inject reCAPTCHA JavaScript code into the HTML page
	// returned by the site backend.
	IncludeRecaptchaScript *FirewallAction_IncludeRecaptchaScriptAction `protobuf:"bytes,6,opt,name=include_recaptcha_script,json=includeRecaptchaScript,proto3,oneof"`
}

type FirewallAction_IncludeRecaptchaScriptAction added in v2.11.0

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

An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests.

func (*FirewallAction_IncludeRecaptchaScriptAction) Descriptor deprecated added in v2.11.0

Deprecated: Use FirewallAction_IncludeRecaptchaScriptAction.ProtoReflect.Descriptor instead.

func (*FirewallAction_IncludeRecaptchaScriptAction) ProtoMessage added in v2.11.0

func (*FirewallAction_IncludeRecaptchaScriptAction) ProtoReflect added in v2.11.0

func (*FirewallAction_IncludeRecaptchaScriptAction) Reset added in v2.11.0

func (*FirewallAction_IncludeRecaptchaScriptAction) String added in v2.11.0

type FirewallAction_Redirect added in v2.8.0

type FirewallAction_Redirect struct {
	// This action will redirect the request to a ReCaptcha interstitial to
	// attach a token.
	Redirect *FirewallAction_RedirectAction `protobuf:"bytes,5,opt,name=redirect,proto3,oneof"`
}

type FirewallAction_RedirectAction added in v2.8.0

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

A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token.

func (*FirewallAction_RedirectAction) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallAction_RedirectAction.ProtoReflect.Descriptor instead.

func (*FirewallAction_RedirectAction) ProtoMessage added in v2.8.0

func (*FirewallAction_RedirectAction) ProtoMessage()

func (*FirewallAction_RedirectAction) ProtoReflect added in v2.8.0

func (*FirewallAction_RedirectAction) Reset added in v2.8.0

func (x *FirewallAction_RedirectAction) Reset()

func (*FirewallAction_RedirectAction) String added in v2.8.0

type FirewallAction_SetHeader added in v2.8.0

type FirewallAction_SetHeader struct {
	// This action will set a custom header but allow the request to continue
	// to the customer backend.
	SetHeader *FirewallAction_SetHeaderAction `protobuf:"bytes,4,opt,name=set_header,json=setHeader,proto3,oneof"`
}

type FirewallAction_SetHeaderAction added in v2.8.0

type FirewallAction_SetHeaderAction struct {

	// Optional. The header key to set in the request to the backend server.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Optional. The header value to set in the request to the backend server.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend.

func (*FirewallAction_SetHeaderAction) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallAction_SetHeaderAction.ProtoReflect.Descriptor instead.

func (*FirewallAction_SetHeaderAction) GetKey added in v2.8.0

func (*FirewallAction_SetHeaderAction) GetValue added in v2.8.0

func (x *FirewallAction_SetHeaderAction) GetValue() string

func (*FirewallAction_SetHeaderAction) ProtoMessage added in v2.8.0

func (*FirewallAction_SetHeaderAction) ProtoMessage()

func (*FirewallAction_SetHeaderAction) ProtoReflect added in v2.8.0

func (*FirewallAction_SetHeaderAction) Reset added in v2.8.0

func (x *FirewallAction_SetHeaderAction) Reset()

func (*FirewallAction_SetHeaderAction) String added in v2.8.0

type FirewallAction_Substitute added in v2.8.0

type FirewallAction_Substitute struct {
	// This action will transparently serve a different page to an offending
	// user.
	Substitute *FirewallAction_SubstituteAction `protobuf:"bytes,3,opt,name=substitute,proto3,oneof"`
}

type FirewallAction_SubstituteAction added in v2.8.0

type FirewallAction_SubstituteAction struct {

	// Optional. The address to redirect to. The target is a relative path in
	// the current host. Example: "/blog/404.html".
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

A substitute action transparently serves a different page than the one requested.

func (*FirewallAction_SubstituteAction) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallAction_SubstituteAction.ProtoReflect.Descriptor instead.

func (*FirewallAction_SubstituteAction) GetPath added in v2.8.0

func (*FirewallAction_SubstituteAction) ProtoMessage added in v2.8.0

func (*FirewallAction_SubstituteAction) ProtoMessage()

func (*FirewallAction_SubstituteAction) ProtoReflect added in v2.8.0

func (*FirewallAction_SubstituteAction) Reset added in v2.8.0

func (*FirewallAction_SubstituteAction) String added in v2.8.0

type FirewallPolicy added in v2.8.0

type FirewallPolicy struct {

	// Identifier. The resource name for the FirewallPolicy in the format
	// `projects/{project}/firewallpolicies/{firewallpolicy}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. A description of what this policy aims to achieve, for
	// convenience purposes. The description can at most include 256 UTF-8
	// characters.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. The path for which this policy applies, specified as a glob
	// pattern. For more information on glob, see the [manual
	// page](https://man7.org/linux/man-pages/man7/glob.7.html).
	// A path has a max length of 200 characters.
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
	// Optional. A CEL (Common Expression Language) conditional expression that
	// specifies if this policy applies to an incoming user request. If this
	// condition evaluates to true and the requested path matched the path
	// pattern, the associated actions should be executed by the caller. The
	// condition string is checked for CEL syntax correctness on creation. For
	// more information, see the [CEL spec](https://github.com/google/cel-spec)
	// and its [language
	// definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md).
	// A condition has a max length of 500 characters.
	Condition string `protobuf:"bytes,5,opt,name=condition,proto3" json:"condition,omitempty"`
	// Optional. The actions that the caller should take regarding user access.
	// There should be at most one terminal action. A terminal action is any
	// action that forces a response, such as `AllowAction`,
	// `BlockAction` or `SubstituteAction`.
	// Zero or more non-terminal actions such as `SetHeader` might be
	// specified. A single policy can contain up to 16 actions.
	Actions []*FirewallAction `protobuf:"bytes,6,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

A FirewallPolicy represents a single matching pattern and resulting actions to take.

func (*FirewallPolicy) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallPolicy.ProtoReflect.Descriptor instead.

func (*FirewallPolicy) GetActions added in v2.8.0

func (x *FirewallPolicy) GetActions() []*FirewallAction

func (*FirewallPolicy) GetCondition added in v2.8.0

func (x *FirewallPolicy) GetCondition() string

func (*FirewallPolicy) GetDescription added in v2.8.0

func (x *FirewallPolicy) GetDescription() string

func (*FirewallPolicy) GetName added in v2.8.0

func (x *FirewallPolicy) GetName() string

func (*FirewallPolicy) GetPath added in v2.8.0

func (x *FirewallPolicy) GetPath() string

func (*FirewallPolicy) ProtoMessage added in v2.8.0

func (*FirewallPolicy) ProtoMessage()

func (*FirewallPolicy) ProtoReflect added in v2.8.0

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

func (*FirewallPolicy) Reset added in v2.8.0

func (x *FirewallPolicy) Reset()

func (*FirewallPolicy) String added in v2.8.0

func (x *FirewallPolicy) String() string

type FirewallPolicyAssessment added in v2.8.0

type FirewallPolicyAssessment struct {

	// Output only. If the processing of a policy config fails, an error will be
	// populated and the firewall_policy will be left empty.
	Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// Output only. The policy that matched the request. If more than one policy
	// may match, this is the first match. If no policy matches the incoming
	// request, the policy field will be left empty.
	FirewallPolicy *FirewallPolicy `protobuf:"bytes,8,opt,name=firewall_policy,json=firewallPolicy,proto3" json:"firewall_policy,omitempty"`
	// contains filtered or unexported fields
}

Policy config assessment.

func (*FirewallPolicyAssessment) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FirewallPolicyAssessment.ProtoReflect.Descriptor instead.

func (*FirewallPolicyAssessment) GetError added in v2.8.0

func (x *FirewallPolicyAssessment) GetError() *status.Status

func (*FirewallPolicyAssessment) GetFirewallPolicy added in v2.8.0

func (x *FirewallPolicyAssessment) GetFirewallPolicy() *FirewallPolicy

func (*FirewallPolicyAssessment) ProtoMessage added in v2.8.0

func (*FirewallPolicyAssessment) ProtoMessage()

func (*FirewallPolicyAssessment) ProtoReflect added in v2.8.0

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

func (*FirewallPolicyAssessment) Reset added in v2.8.0

func (x *FirewallPolicyAssessment) Reset()

func (*FirewallPolicyAssessment) String added in v2.8.0

func (x *FirewallPolicyAssessment) String() string

type FraudPreventionAssessment added in v2.7.0

type FraudPreventionAssessment struct {

	// Output only. Probability of this transaction being fraudulent. Summarizes
	// the combined risk of attack vectors below. Values are from 0.0 (lowest)
	// to 1.0 (highest).
	TransactionRisk float32 `protobuf:"fixed32,1,opt,name=transaction_risk,json=transactionRisk,proto3" json:"transaction_risk,omitempty"`
	// Output only. Assessment of this transaction for risk of a stolen
	// instrument.
	StolenInstrumentVerdict *FraudPreventionAssessment_StolenInstrumentVerdict `` /* 132-byte string literal not displayed */
	// Output only. Assessment of this transaction for risk of being part of a
	// card testing attack.
	CardTestingVerdict *FraudPreventionAssessment_CardTestingVerdict `protobuf:"bytes,3,opt,name=card_testing_verdict,json=cardTestingVerdict,proto3" json:"card_testing_verdict,omitempty"`
	// Output only. Assessment of this transaction for behavioral trust.
	BehavioralTrustVerdict *FraudPreventionAssessment_BehavioralTrustVerdict `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Assessment for Fraud Prevention.

func (*FraudPreventionAssessment) Descriptor deprecated added in v2.7.0

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

Deprecated: Use FraudPreventionAssessment.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment) GetBehavioralTrustVerdict added in v2.8.0

func (*FraudPreventionAssessment) GetCardTestingVerdict added in v2.7.0

func (*FraudPreventionAssessment) GetStolenInstrumentVerdict added in v2.7.0

func (*FraudPreventionAssessment) GetTransactionRisk added in v2.7.0

func (x *FraudPreventionAssessment) GetTransactionRisk() float32

func (*FraudPreventionAssessment) ProtoMessage added in v2.7.0

func (*FraudPreventionAssessment) ProtoMessage()

func (*FraudPreventionAssessment) ProtoReflect added in v2.7.0

func (*FraudPreventionAssessment) Reset added in v2.7.0

func (x *FraudPreventionAssessment) Reset()

func (*FraudPreventionAssessment) String added in v2.7.0

func (x *FraudPreventionAssessment) String() string

type FraudPreventionAssessment_BehavioralTrustVerdict added in v2.8.0

type FraudPreventionAssessment_BehavioralTrustVerdict struct {

	// Output only. Probability of this transaction attempt being executed in a
	// behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0
	// (highest).
	Trust float32 `protobuf:"fixed32,1,opt,name=trust,proto3" json:"trust,omitempty"`
	// contains filtered or unexported fields
}

Information about behavioral trust of the transaction.

func (*FraudPreventionAssessment_BehavioralTrustVerdict) Descriptor deprecated added in v2.8.0

Deprecated: Use FraudPreventionAssessment_BehavioralTrustVerdict.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment_BehavioralTrustVerdict) GetTrust added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) ProtoMessage added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) ProtoReflect added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) Reset added in v2.8.0

func (*FraudPreventionAssessment_BehavioralTrustVerdict) String added in v2.8.0

type FraudPreventionAssessment_CardTestingVerdict added in v2.7.0

type FraudPreventionAssessment_CardTestingVerdict struct {

	// Output only. Probability of this transaction attempt being part of a card
	// testing attack. Values are from 0.0 (lowest) to 1.0 (highest).
	Risk float32 `protobuf:"fixed32,1,opt,name=risk,proto3" json:"risk,omitempty"`
	// contains filtered or unexported fields
}

Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details.

func (*FraudPreventionAssessment_CardTestingVerdict) Descriptor deprecated added in v2.7.0

Deprecated: Use FraudPreventionAssessment_CardTestingVerdict.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment_CardTestingVerdict) GetRisk added in v2.7.0

func (*FraudPreventionAssessment_CardTestingVerdict) ProtoMessage added in v2.7.0

func (*FraudPreventionAssessment_CardTestingVerdict) ProtoReflect added in v2.7.0

func (*FraudPreventionAssessment_CardTestingVerdict) Reset added in v2.7.0

func (*FraudPreventionAssessment_CardTestingVerdict) String added in v2.7.0

type FraudPreventionAssessment_StolenInstrumentVerdict added in v2.7.0

type FraudPreventionAssessment_StolenInstrumentVerdict struct {

	// Output only. Probability of this transaction being executed with a stolen
	// instrument. Values are from 0.0 (lowest) to 1.0 (highest).
	Risk float32 `protobuf:"fixed32,1,opt,name=risk,proto3" json:"risk,omitempty"`
	// contains filtered or unexported fields
}

Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase.

func (*FraudPreventionAssessment_StolenInstrumentVerdict) Descriptor deprecated added in v2.7.0

Deprecated: Use FraudPreventionAssessment_StolenInstrumentVerdict.ProtoReflect.Descriptor instead.

func (*FraudPreventionAssessment_StolenInstrumentVerdict) GetRisk added in v2.7.0

func (*FraudPreventionAssessment_StolenInstrumentVerdict) ProtoMessage added in v2.7.0

func (*FraudPreventionAssessment_StolenInstrumentVerdict) ProtoReflect added in v2.7.0

func (*FraudPreventionAssessment_StolenInstrumentVerdict) Reset added in v2.7.0

func (*FraudPreventionAssessment_StolenInstrumentVerdict) String added in v2.7.0

type FraudSignals added in v2.8.0

type FraudSignals struct {

	// Output only. Signals describing the end user in this transaction.
	UserSignals *FraudSignals_UserSignals `protobuf:"bytes,1,opt,name=user_signals,json=userSignals,proto3" json:"user_signals,omitempty"`
	// Output only. Signals describing the payment card or cards used in this
	// transaction.
	CardSignals *FraudSignals_CardSignals `protobuf:"bytes,2,opt,name=card_signals,json=cardSignals,proto3" json:"card_signals,omitempty"`
	// contains filtered or unexported fields
}

Fraud signals describing users and cards involved in the transaction.

func (*FraudSignals) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FraudSignals.ProtoReflect.Descriptor instead.

func (*FraudSignals) GetCardSignals added in v2.8.0

func (x *FraudSignals) GetCardSignals() *FraudSignals_CardSignals

func (*FraudSignals) GetUserSignals added in v2.8.0

func (x *FraudSignals) GetUserSignals() *FraudSignals_UserSignals

func (*FraudSignals) ProtoMessage added in v2.8.0

func (*FraudSignals) ProtoMessage()

func (*FraudSignals) ProtoReflect added in v2.8.0

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

func (*FraudSignals) Reset added in v2.8.0

func (x *FraudSignals) Reset()

func (*FraudSignals) String added in v2.8.0

func (x *FraudSignals) String() string

type FraudSignals_CardSignals added in v2.8.0

type FraudSignals_CardSignals struct {

	// Output only. The labels for the payment card in this transaction.
	CardLabels []FraudSignals_CardSignals_CardLabel `` /* 175-byte string literal not displayed */
	// contains filtered or unexported fields
}

Signals describing the payment card used in this transaction.

func (*FraudSignals_CardSignals) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FraudSignals_CardSignals.ProtoReflect.Descriptor instead.

func (*FraudSignals_CardSignals) GetCardLabels added in v2.8.0

func (*FraudSignals_CardSignals) ProtoMessage added in v2.8.0

func (*FraudSignals_CardSignals) ProtoMessage()

func (*FraudSignals_CardSignals) ProtoReflect added in v2.8.0

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

func (*FraudSignals_CardSignals) Reset added in v2.8.0

func (x *FraudSignals_CardSignals) Reset()

func (*FraudSignals_CardSignals) String added in v2.8.0

func (x *FraudSignals_CardSignals) String() string

type FraudSignals_CardSignals_CardLabel added in v2.8.0

type FraudSignals_CardSignals_CardLabel int32

Risk labels describing the card being assessed, such as its funding mechanism.

const (
	// No label specified.
	FraudSignals_CardSignals_CARD_LABEL_UNSPECIFIED FraudSignals_CardSignals_CardLabel = 0
	// This card has been detected as prepaid.
	FraudSignals_CardSignals_PREPAID FraudSignals_CardSignals_CardLabel = 1
	// This card has been detected as virtual, such as a card number generated
	// for a single transaction or merchant.
	FraudSignals_CardSignals_VIRTUAL FraudSignals_CardSignals_CardLabel = 2
	// This card has been detected as being used in an unexpected geographic
	// location.
	FraudSignals_CardSignals_UNEXPECTED_LOCATION FraudSignals_CardSignals_CardLabel = 3
)

func (FraudSignals_CardSignals_CardLabel) Descriptor added in v2.8.0

func (FraudSignals_CardSignals_CardLabel) Enum added in v2.8.0

func (FraudSignals_CardSignals_CardLabel) EnumDescriptor deprecated added in v2.8.0

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

Deprecated: Use FraudSignals_CardSignals_CardLabel.Descriptor instead.

func (FraudSignals_CardSignals_CardLabel) Number added in v2.8.0

func (FraudSignals_CardSignals_CardLabel) String added in v2.8.0

func (FraudSignals_CardSignals_CardLabel) Type added in v2.8.0

type FraudSignals_UserSignals added in v2.8.0

type FraudSignals_UserSignals struct {

	// Output only. This user (based on email, phone, and other identifiers) has
	// been seen on the internet for at least this number of days.
	ActiveDaysLowerBound int32 `` /* 126-byte string literal not displayed */
	// Output only. Likelihood (from 0.0 to 1.0) this user includes synthetic
	// components in their identity, such as a randomly generated email address,
	// temporary phone number, or fake shipping address.
	SyntheticRisk float32 `protobuf:"fixed32,2,opt,name=synthetic_risk,json=syntheticRisk,proto3" json:"synthetic_risk,omitempty"`
	// contains filtered or unexported fields
}

Signals describing the user involved in this transaction.

func (*FraudSignals_UserSignals) Descriptor deprecated added in v2.8.0

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

Deprecated: Use FraudSignals_UserSignals.ProtoReflect.Descriptor instead.

func (*FraudSignals_UserSignals) GetActiveDaysLowerBound added in v2.8.0

func (x *FraudSignals_UserSignals) GetActiveDaysLowerBound() int32

func (*FraudSignals_UserSignals) GetSyntheticRisk added in v2.8.0

func (x *FraudSignals_UserSignals) GetSyntheticRisk() float32

func (*FraudSignals_UserSignals) ProtoMessage added in v2.8.0

func (*FraudSignals_UserSignals) ProtoMessage()

func (*FraudSignals_UserSignals) ProtoReflect added in v2.8.0

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

func (*FraudSignals_UserSignals) Reset added in v2.8.0

func (x *FraudSignals_UserSignals) Reset()

func (*FraudSignals_UserSignals) String added in v2.8.0

func (x *FraudSignals_UserSignals) String() string

type GetFirewallPolicyRequest added in v2.8.0

type GetFirewallPolicyRequest struct {

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

The get firewall policy request message.

func (*GetFirewallPolicyRequest) Descriptor deprecated added in v2.8.0

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

Deprecated: Use GetFirewallPolicyRequest.ProtoReflect.Descriptor instead.

func (*GetFirewallPolicyRequest) GetName added in v2.8.0

func (x *GetFirewallPolicyRequest) GetName() string

func (*GetFirewallPolicyRequest) ProtoMessage added in v2.8.0

func (*GetFirewallPolicyRequest) ProtoMessage()

func (*GetFirewallPolicyRequest) ProtoReflect added in v2.8.0

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

func (*GetFirewallPolicyRequest) Reset added in v2.8.0

func (x *GetFirewallPolicyRequest) Reset()

func (*GetFirewallPolicyRequest) String added in v2.8.0

func (x *GetFirewallPolicyRequest) 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 {

	// Optional. 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"`
	// Optional. 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"`
	// Optional. Apple Developer account details for the app that is protected by
	// the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks
	// like Apple App Attest and Apple DeviceCheck to protect your app from abuse.
	// Providing these fields allows reCAPTCHA Enterprise to get a better
	// assessment of the integrity of your app.
	AppleDeveloperId *AppleDeveloperId `protobuf:"bytes,3,opt,name=apple_developer_id,json=appleDeveloperId,proto3" json:"apple_developer_id,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) GetAppleDeveloperId added in v2.8.0

func (x *IOSKeySettings) GetAppleDeveloperId() *AppleDeveloperId

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 {

	// Identifier. 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"`
	// Required. 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 a
	// platform for which the settings are enabled.
	//
	// Types that are assignable to PlatformSettings:
	//
	//	*Key_WebSettings
	//	*Key_AndroidSettings
	//	*Key_IosSettings
	PlatformSettings isKey_PlatformSettings `protobuf_oneof:"platform_settings"`
	// Optional. See [Creating and managing labels]
	// (https://cloud.google.com/recaptcha-enterprise/docs/labels).
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. 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"`
	// Optional. Options for user acceptance testing.
	TestingOptions *TestingOptions `protobuf:"bytes,9,opt,name=testing_options,json=testingOptions,proto3" json:"testing_options,omitempty"`
	// Optional. Settings for WAF
	WafSettings *WafSettings `protobuf:"bytes,10,opt,name=waf_settings,json=wafSettings,proto3" json:"waf_settings,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) GetWafSettings

func (x *Key) GetWafSettings() *WafSettings

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 ListFirewallPoliciesRequest added in v2.8.0

type ListFirewallPoliciesRequest struct {

	// Required. The name of the project to list the policies for, in the format
	// `projects/{project}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of policies 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.
	// ListFirewallPoliciesRequest, 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 firewall policies request message.

func (*ListFirewallPoliciesRequest) Descriptor deprecated added in v2.8.0

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

Deprecated: Use ListFirewallPoliciesRequest.ProtoReflect.Descriptor instead.

func (*ListFirewallPoliciesRequest) GetPageSize added in v2.8.0

func (x *ListFirewallPoliciesRequest) GetPageSize() int32

func (*ListFirewallPoliciesRequest) GetPageToken added in v2.8.0

func (x *ListFirewallPoliciesRequest) GetPageToken() string

func (*ListFirewallPoliciesRequest) GetParent added in v2.8.0

func (x *ListFirewallPoliciesRequest) GetParent() string

func (*ListFirewallPoliciesRequest) ProtoMessage added in v2.8.0

func (*ListFirewallPoliciesRequest) ProtoMessage()

func (*ListFirewallPoliciesRequest) ProtoReflect added in v2.8.0

func (*ListFirewallPoliciesRequest) Reset added in v2.8.0

func (x *ListFirewallPoliciesRequest) Reset()

func (*ListFirewallPoliciesRequest) String added in v2.8.0

func (x *ListFirewallPoliciesRequest) String() string

type ListFirewallPoliciesResponse added in v2.8.0

type ListFirewallPoliciesResponse struct {

	// Policy details.
	FirewallPolicies []*FirewallPolicy `protobuf:"bytes,1,rep,name=firewall_policies,json=firewallPolicies,proto3" json:"firewall_policies,omitempty"`
	// Token to retrieve the next page of results. It is set to empty if no
	// policies 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 firewall policies belonging to a key.

func (*ListFirewallPoliciesResponse) Descriptor deprecated added in v2.8.0

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

Deprecated: Use ListFirewallPoliciesResponse.ProtoReflect.Descriptor instead.

func (*ListFirewallPoliciesResponse) GetFirewallPolicies added in v2.8.0

func (x *ListFirewallPoliciesResponse) GetFirewallPolicies() []*FirewallPolicy

func (*ListFirewallPoliciesResponse) GetNextPageToken added in v2.8.0

func (x *ListFirewallPoliciesResponse) GetNextPageToken() string

func (*ListFirewallPoliciesResponse) ProtoMessage added in v2.8.0

func (*ListFirewallPoliciesResponse) ProtoMessage()

func (*ListFirewallPoliciesResponse) ProtoReflect added in v2.8.0

func (*ListFirewallPoliciesResponse) Reset added in v2.8.0

func (x *ListFirewallPoliciesResponse) Reset()

func (*ListFirewallPoliciesResponse) String added in v2.8.0

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 might
	// return fewer than this value. If unspecified, at most 50 accounts are
	// returned. The maximum value is 1000; values above 1000 are 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 (*ListRelatedAccountGroupMembershipsRequest) GetPageToken

func (*ListRelatedAccountGroupMembershipsRequest) GetParent

func (*ListRelatedAccountGroupMembershipsRequest) ProtoMessage

func (*ListRelatedAccountGroupMembershipsRequest) ProtoReflect

func (*ListRelatedAccountGroupMembershipsRequest) Reset

func (*ListRelatedAccountGroupMembershipsRequest) 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

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) ProtoReflect

func (*ListRelatedAccountGroupMembershipsResponse) Reset

func (*ListRelatedAccountGroupMembershipsResponse) 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 might return
	// fewer than this value. If unspecified, at most 50 groups are returned. The
	// maximum value is 1000; values above 1000 are 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 (*ListRelatedAccountGroupsRequest) Reset

func (*ListRelatedAccountGroupsRequest) 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 (*ListRelatedAccountGroupsResponse) Reset

func (*ListRelatedAccountGroupsResponse) String

type Metrics

type Metrics struct {

	// Output only. Identifier. 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"`
	// Optional. If true, skips the billing check.
	// A reCAPTCHA Enterprise key or migrated key behaves differently than a
	// reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see
	// https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid
	// any disruption of your usage, we check that a billing account is present.
	// If your usage of reCAPTCHA is under the free quota, you can safely skip the
	// billing check and proceed with the migration. See
	// https://cloud.google.com/recaptcha-enterprise/docs/billing-information.
	SkipBillingCheck bool `protobuf:"varint,2,opt,name=skip_billing_check,json=skipBillingCheck,proto3" json:"skip_billing_check,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) GetSkipBillingCheck added in v2.6.0

func (x *MigrateKeyRequest) GetSkipBillingCheck() bool

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 PrivatePasswordLeakVerification

type PrivatePasswordLeakVerification struct {

	// Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
	// username. It is used to look up password leaks associated with that hash
	// prefix.
	LookupHashPrefix []byte `protobuf:"bytes,1,opt,name=lookup_hash_prefix,json=lookupHashPrefix,proto3" json:"lookup_hash_prefix,omitempty"`
	// Optional. Encrypted Scrypt hash of the canonicalized username+password. It
	// is re-encrypted by the server and returned through
	// `reencrypted_user_credentials_hash`.
	EncryptedUserCredentialsHash []byte `` /* 149-byte string literal not displayed */
	// Output only. List of prefixes of the encrypted potential password leaks
	// that matched the given parameters. They must be compared with the
	// client-side decryption prefix of `reencrypted_user_credentials_hash`
	EncryptedLeakMatchPrefixes [][]byte `` /* 143-byte string literal not displayed */
	// Output only. Corresponds to the re-encryption of the
	// `encrypted_user_credentials_hash` field. It is used to match potential
	// password leaks within `encrypted_leak_match_prefixes`.
	ReencryptedUserCredentialsHash []byte `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

Private password leak verification info.

func (*PrivatePasswordLeakVerification) Descriptor deprecated

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

Deprecated: Use PrivatePasswordLeakVerification.ProtoReflect.Descriptor instead.

func (*PrivatePasswordLeakVerification) GetEncryptedLeakMatchPrefixes

func (x *PrivatePasswordLeakVerification) GetEncryptedLeakMatchPrefixes() [][]byte

func (*PrivatePasswordLeakVerification) GetEncryptedUserCredentialsHash

func (x *PrivatePasswordLeakVerification) GetEncryptedUserCredentialsHash() []byte

func (*PrivatePasswordLeakVerification) GetLookupHashPrefix

func (x *PrivatePasswordLeakVerification) GetLookupHashPrefix() []byte

func (*PrivatePasswordLeakVerification) GetReencryptedUserCredentialsHash

func (x *PrivatePasswordLeakVerification) GetReencryptedUserCredentialsHash() []byte

func (*PrivatePasswordLeakVerification) ProtoMessage

func (*PrivatePasswordLeakVerification) ProtoMessage()

func (*PrivatePasswordLeakVerification) ProtoReflect

func (*PrivatePasswordLeakVerification) Reset

func (*PrivatePasswordLeakVerification) 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 secret key related to the specified public key.
	// You must use the legacy secret key only in a 3rd party integration with
	// legacy reCAPTCHA.
	RetrieveLegacySecretKey(ctx context.Context, in *RetrieveLegacySecretKeyRequest, opts ...grpc.CallOption) (*RetrieveLegacySecretKeyResponse, 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 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)
	// Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA
	// Enterprise actions can be executed.
	// A project may have a maximum of 1000 policies.
	CreateFirewallPolicy(ctx context.Context, in *CreateFirewallPolicyRequest, opts ...grpc.CallOption) (*FirewallPolicy, error)
	// Returns the list of all firewall policies that belong to a project.
	ListFirewallPolicies(ctx context.Context, in *ListFirewallPoliciesRequest, opts ...grpc.CallOption) (*ListFirewallPoliciesResponse, error)
	// Returns the specified firewall policy.
	GetFirewallPolicy(ctx context.Context, in *GetFirewallPolicyRequest, opts ...grpc.CallOption) (*FirewallPolicy, error)
	// Updates the specified firewall policy.
	UpdateFirewallPolicy(ctx context.Context, in *UpdateFirewallPolicyRequest, opts ...grpc.CallOption) (*FirewallPolicy, error)
	// Deletes the specified firewall policy.
	DeleteFirewallPolicy(ctx context.Context, in *DeleteFirewallPolicyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Reorders all firewall policies.
	ReorderFirewallPolicies(ctx context.Context, in *ReorderFirewallPoliciesRequest, opts ...grpc.CallOption) (*ReorderFirewallPoliciesResponse, error)
	// List groups of related accounts.
	ListRelatedAccountGroups(ctx context.Context, in *ListRelatedAccountGroupsRequest, opts ...grpc.CallOption) (*ListRelatedAccountGroupsResponse, error)
	// Get 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.

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 secret key related to the specified public key.
	// You must use the legacy secret key only in a 3rd party integration with
	// legacy reCAPTCHA.
	RetrieveLegacySecretKey(context.Context, *RetrieveLegacySecretKeyRequest) (*RetrieveLegacySecretKeyResponse, 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 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)
	// Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA
	// Enterprise actions can be executed.
	// A project may have a maximum of 1000 policies.
	CreateFirewallPolicy(context.Context, *CreateFirewallPolicyRequest) (*FirewallPolicy, error)
	// Returns the list of all firewall policies that belong to a project.
	ListFirewallPolicies(context.Context, *ListFirewallPoliciesRequest) (*ListFirewallPoliciesResponse, error)
	// Returns the specified firewall policy.
	GetFirewallPolicy(context.Context, *GetFirewallPolicyRequest) (*FirewallPolicy, error)
	// Updates the specified firewall policy.
	UpdateFirewallPolicy(context.Context, *UpdateFirewallPolicyRequest) (*FirewallPolicy, error)
	// Deletes the specified firewall policy.
	DeleteFirewallPolicy(context.Context, *DeleteFirewallPolicyRequest) (*emptypb.Empty, error)
	// Reorders all firewall policies.
	ReorderFirewallPolicies(context.Context, *ReorderFirewallPoliciesRequest) (*ReorderFirewallPoliciesResponse, error)
	// List groups of related accounts.
	ListRelatedAccountGroups(context.Context, *ListRelatedAccountGroupsRequest) (*ListRelatedAccountGroupsResponse, error)
	// Get 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. Identifier. 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. Identifier. 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 account identifier of the member. The identifier
	// corresponds to an `account_id` provided in a previous `CreateAssessment` or
	// `AnnotateAssessment` call.
	AccountId string `protobuf:"bytes,4,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// Deprecated: use `account_id` instead.
	// The unique stable hashed account identifier of the member. The identifier
	// corresponds to a `hashed_account_id` provided in a previous
	// `CreateAssessment` or `AnnotateAssessment` call.
	//
	// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
	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) GetAccountId added in v2.9.1

func (x *RelatedAccountGroupMembership) GetAccountId() string

func (*RelatedAccountGroupMembership) GetHashedAccountId deprecated

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

Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.

func (*RelatedAccountGroupMembership) GetName

func (*RelatedAccountGroupMembership) ProtoMessage

func (*RelatedAccountGroupMembership) ProtoMessage()

func (*RelatedAccountGroupMembership) ProtoReflect

func (*RelatedAccountGroupMembership) Reset

func (x *RelatedAccountGroupMembership) Reset()

func (*RelatedAccountGroupMembership) String

type ReorderFirewallPoliciesRequest added in v2.10.0

type ReorderFirewallPoliciesRequest struct {

	// Required. The name of the project to list the policies for, in the format
	// `projects/{project}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. A list containing all policy names, in the new order. Each name
	// is in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
	Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"`
	// contains filtered or unexported fields
}

The reorder firewall policies request message.

func (*ReorderFirewallPoliciesRequest) Descriptor deprecated added in v2.10.0

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

Deprecated: Use ReorderFirewallPoliciesRequest.ProtoReflect.Descriptor instead.

func (*ReorderFirewallPoliciesRequest) GetNames added in v2.10.0

func (x *ReorderFirewallPoliciesRequest) GetNames() []string

func (*ReorderFirewallPoliciesRequest) GetParent added in v2.10.0

func (x *ReorderFirewallPoliciesRequest) GetParent() string

func (*ReorderFirewallPoliciesRequest) ProtoMessage added in v2.10.0

func (*ReorderFirewallPoliciesRequest) ProtoMessage()

func (*ReorderFirewallPoliciesRequest) ProtoReflect added in v2.10.0

func (*ReorderFirewallPoliciesRequest) Reset added in v2.10.0

func (x *ReorderFirewallPoliciesRequest) Reset()

func (*ReorderFirewallPoliciesRequest) String added in v2.10.0

type ReorderFirewallPoliciesResponse added in v2.10.0

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

The reorder firewall policies response message.

func (*ReorderFirewallPoliciesResponse) Descriptor deprecated added in v2.10.0

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

Deprecated: Use ReorderFirewallPoliciesResponse.ProtoReflect.Descriptor instead.

func (*ReorderFirewallPoliciesResponse) ProtoMessage added in v2.10.0

func (*ReorderFirewallPoliciesResponse) ProtoMessage()

func (*ReorderFirewallPoliciesResponse) ProtoReflect added in v2.10.0

func (*ReorderFirewallPoliciesResponse) Reset added in v2.10.0

func (*ReorderFirewallPoliciesResponse) String added in v2.10.0

type RetrieveLegacySecretKeyRequest

type RetrieveLegacySecretKeyRequest struct {

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

The retrieve legacy secret key request message.

func (*RetrieveLegacySecretKeyRequest) Descriptor deprecated

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

Deprecated: Use RetrieveLegacySecretKeyRequest.ProtoReflect.Descriptor instead.

func (*RetrieveLegacySecretKeyRequest) GetKey

func (*RetrieveLegacySecretKeyRequest) ProtoMessage

func (*RetrieveLegacySecretKeyRequest) ProtoMessage()

func (*RetrieveLegacySecretKeyRequest) ProtoReflect

func (*RetrieveLegacySecretKeyRequest) Reset

func (x *RetrieveLegacySecretKeyRequest) Reset()

func (*RetrieveLegacySecretKeyRequest) String

type RetrieveLegacySecretKeyResponse

type RetrieveLegacySecretKeyResponse struct {

	// The secret key (also known as shared secret) authorizes communication
	// between your application backend and the reCAPTCHA Enterprise server to
	// create an assessment.
	// The secret key needs to be kept safe for security purposes.
	LegacySecretKey string `protobuf:"bytes,1,opt,name=legacy_secret_key,json=legacySecretKey,proto3" json:"legacy_secret_key,omitempty"`
	// contains filtered or unexported fields
}

Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA.

func (*RetrieveLegacySecretKeyResponse) Descriptor deprecated

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

Deprecated: Use RetrieveLegacySecretKeyResponse.ProtoReflect.Descriptor instead.

func (*RetrieveLegacySecretKeyResponse) GetLegacySecretKey

func (x *RetrieveLegacySecretKeyResponse) GetLegacySecretKey() string

func (*RetrieveLegacySecretKeyResponse) ProtoMessage

func (*RetrieveLegacySecretKeyResponse) ProtoMessage()

func (*RetrieveLegacySecretKeyResponse) ProtoReflect

func (*RetrieveLegacySecretKeyResponse) Reset

func (*RetrieveLegacySecretKeyResponse) String

type RiskAnalysis

type RiskAnalysis struct {

	// Output only. 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"`
	// Output only. Reasons contributing to the risk analysis verdict.
	Reasons []RiskAnalysis_ClassificationReason `` /* 150-byte string literal not displayed */
	// Output only. Extended verdict reasons to be used for experimentation only.
	// The set of possible reasons is subject to change.
	ExtendedVerdictReasons []string `` /* 129-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) GetExtendedVerdictReasons added in v2.8.0

func (x *RiskAnalysis) GetExtendedVerdictReasons() []string

func (*RiskAnalysis) GetReasons

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
	// The request matches behavioral characteristics of a carding attack.
	RiskAnalysis_SUSPECTED_CARDING RiskAnalysis_ClassificationReason = 6
	// The request matches behavioral characteristics of chargebacks for fraud.
	RiskAnalysis_SUSPECTED_CHARGEBACK RiskAnalysis_ClassificationReason = 7
)

func (RiskAnalysis_ClassificationReason) Descriptor

func (RiskAnalysis_ClassificationReason) Enum

func (RiskAnalysis_ClassificationReason) EnumDescriptor deprecated

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

Deprecated: Use RiskAnalysis_ClassificationReason.Descriptor instead.

func (RiskAnalysis_ClassificationReason) Number

func (RiskAnalysis_ClassificationReason) String

func (RiskAnalysis_ClassificationReason) Type

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.
	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. Specify the project name in the following format:
	// `projects/{project}`.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Optional. The unique stable account identifier used to search connections.
	// The identifier should correspond to an `account_id` provided in a previous
	// `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id
	// or account_id must be set, but not both.
	AccountId string `protobuf:"bytes,5,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// Optional. Deprecated: use `account_id` instead.
	// The unique stable hashed account identifier used to search connections. The
	// identifier should correspond to a `hashed_account_id` provided in a
	// previous `CreateAssessment` or `AnnotateAssessment` call. Either
	// hashed_account_id or account_id must be set, but not both.
	//
	// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
	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 might return
	// fewer than this value. If unspecified, at most 50 groups are returned. The
	// maximum value is 1000; values above 1000 are 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

Deprecated: Use SearchRelatedAccountGroupMembershipsRequest.ProtoReflect.Descriptor instead.

func (*SearchRelatedAccountGroupMembershipsRequest) GetAccountId added in v2.9.1

func (*SearchRelatedAccountGroupMembershipsRequest) GetHashedAccountId deprecated

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

Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.

func (*SearchRelatedAccountGroupMembershipsRequest) GetPageSize

func (*SearchRelatedAccountGroupMembershipsRequest) GetPageToken

func (*SearchRelatedAccountGroupMembershipsRequest) GetProject

func (*SearchRelatedAccountGroupMembershipsRequest) ProtoMessage

func (*SearchRelatedAccountGroupMembershipsRequest) ProtoReflect

func (*SearchRelatedAccountGroupMembershipsRequest) Reset

func (*SearchRelatedAccountGroupMembershipsRequest) 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

Deprecated: Use SearchRelatedAccountGroupMembershipsResponse.ProtoReflect.Descriptor instead.

func (*SearchRelatedAccountGroupMembershipsResponse) GetNextPageToken

func (*SearchRelatedAccountGroupMembershipsResponse) GetRelatedAccountGroupMemberships

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

func (*SearchRelatedAccountGroupMembershipsResponse) ProtoMessage

func (*SearchRelatedAccountGroupMembershipsResponse) ProtoReflect

func (*SearchRelatedAccountGroupMembershipsResponse) Reset

func (*SearchRelatedAccountGroupMembershipsResponse) String

type TestingOptions

type TestingOptions struct {

	// Optional. 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"`
	// Optional. 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) Enum

func (TestingOptions_TestingChallenge) EnumDescriptor deprecated

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

Deprecated: Use TestingOptions_TestingChallenge.Descriptor instead.

func (TestingOptions_TestingChallenge) Number

func (TestingOptions_TestingChallenge) String

func (TestingOptions_TestingChallenge) Type

type TokenProperties

type TokenProperties struct {

	// Output only. 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"`
	// Output only. Reason associated with the response when valid = false.
	InvalidReason TokenProperties_InvalidReason `` /* 172-byte string literal not displayed */
	// Output only. 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"`
	// Output only. The hostname of the page on which the token was generated (Web
	// keys only).
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Output only. The name of the Android package with which the token was
	// generated (Android keys only).
	AndroidPackageName string `protobuf:"bytes,8,opt,name=android_package_name,json=androidPackageName,proto3" json:"android_package_name,omitempty"`
	// Output only. The ID of the iOS bundle with which the token was generated
	// (iOS keys only).
	IosBundleId string `protobuf:"bytes,9,opt,name=ios_bundle_id,json=iosBundleId,proto3" json:"ios_bundle_id,omitempty"`
	// Output only. Action name provided at token generation.
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// contains filtered or unexported fields
}

Properties of the provided event token.

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) GetAndroidPackageName added in v2.6.0

func (x *TokenProperties) GetAndroidPackageName() 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) GetIosBundleId added in v2.6.0

func (x *TokenProperties) GetIosBundleId() string

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) Enum

func (TokenProperties_InvalidReason) EnumDescriptor deprecated

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

Deprecated: Use TokenProperties_InvalidReason.Descriptor instead.

func (TokenProperties_InvalidReason) Number

func (TokenProperties_InvalidReason) String

func (TokenProperties_InvalidReason) Type

type TransactionData added in v2.7.0

type TransactionData struct {

	// Unique identifier for the transaction. This custom identifier can be used
	// to reference this transaction in the future, for example, labeling a refund
	// or chargeback event. Two attempts at the same transaction should use the
	// same transaction id.
	TransactionId *string `protobuf:"bytes,11,opt,name=transaction_id,json=transactionId,proto3,oneof" json:"transaction_id,omitempty"`
	// Optional. The payment method for the transaction. The allowed values are:
	//
	// * credit-card
	// * debit-card
	// * gift-card
	// * processor-{name} (If a third-party is used, for example,
	// processor-paypal)
	// * custom-{name} (If an alternative method is used, for example,
	// custom-crypto)
	PaymentMethod string `protobuf:"bytes,1,opt,name=payment_method,json=paymentMethod,proto3" json:"payment_method,omitempty"`
	// Optional. The Bank Identification Number - generally the first 6 or 8
	// digits of the card.
	CardBin string `protobuf:"bytes,2,opt,name=card_bin,json=cardBin,proto3" json:"card_bin,omitempty"`
	// Optional. The last four digits of the card.
	CardLastFour string `protobuf:"bytes,3,opt,name=card_last_four,json=cardLastFour,proto3" json:"card_last_four,omitempty"`
	// Optional. The currency code in ISO-4217 format.
	CurrencyCode string `protobuf:"bytes,4,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Optional. The decimal value of the transaction in the specified currency.
	Value float64 `protobuf:"fixed64,5,opt,name=value,proto3" json:"value,omitempty"`
	// Optional. The value of shipping in the specified currency. 0 for free or no
	// shipping.
	ShippingValue float64 `protobuf:"fixed64,12,opt,name=shipping_value,json=shippingValue,proto3" json:"shipping_value,omitempty"`
	// Optional. Destination address if this transaction involves shipping a
	// physical item.
	ShippingAddress *TransactionData_Address `protobuf:"bytes,6,opt,name=shipping_address,json=shippingAddress,proto3" json:"shipping_address,omitempty"`
	// Optional. Address associated with the payment method when applicable.
	BillingAddress *TransactionData_Address `protobuf:"bytes,7,opt,name=billing_address,json=billingAddress,proto3" json:"billing_address,omitempty"`
	// Optional. Information about the user paying/initiating the transaction.
	User *TransactionData_User `protobuf:"bytes,8,opt,name=user,proto3" json:"user,omitempty"`
	// Optional. Information about the user or users fulfilling the transaction.
	Merchants []*TransactionData_User `protobuf:"bytes,13,rep,name=merchants,proto3" json:"merchants,omitempty"`
	// Optional. Items purchased in this transaction.
	Items []*TransactionData_Item `protobuf:"bytes,14,rep,name=items,proto3" json:"items,omitempty"`
	// Optional. Information about the payment gateway's response to the
	// transaction.
	GatewayInfo *TransactionData_GatewayInfo `protobuf:"bytes,10,opt,name=gateway_info,json=gatewayInfo,proto3" json:"gateway_info,omitempty"`
	// contains filtered or unexported fields
}

Transaction data associated with a payment protected by reCAPTCHA Enterprise.

func (*TransactionData) Descriptor deprecated added in v2.7.0

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

Deprecated: Use TransactionData.ProtoReflect.Descriptor instead.

func (*TransactionData) GetBillingAddress added in v2.7.0

func (x *TransactionData) GetBillingAddress() *TransactionData_Address

func (*TransactionData) GetCardBin added in v2.7.0

func (x *TransactionData) GetCardBin() string

func (*TransactionData) GetCardLastFour added in v2.7.0

func (x *TransactionData) GetCardLastFour() string

func (*TransactionData) GetCurrencyCode added in v2.7.0

func (x *TransactionData) GetCurrencyCode() string

func (*TransactionData) GetGatewayInfo added in v2.7.0

func (x *TransactionData) GetGatewayInfo() *TransactionData_GatewayInfo

func (*TransactionData) GetItems added in v2.7.0

func (x *TransactionData) GetItems() []*TransactionData_Item

func (*TransactionData) GetMerchants added in v2.7.0

func (x *TransactionData) GetMerchants() []*TransactionData_User

func (*TransactionData) GetPaymentMethod added in v2.7.0

func (x *TransactionData) GetPaymentMethod() string

func (*TransactionData) GetShippingAddress added in v2.7.0

func (x *TransactionData) GetShippingAddress() *TransactionData_Address

func (*TransactionData) GetShippingValue added in v2.7.0

func (x *TransactionData) GetShippingValue() float64

func (*TransactionData) GetTransactionId added in v2.7.0

func (x *TransactionData) GetTransactionId() string

func (*TransactionData) GetUser added in v2.7.0

func (x *TransactionData) GetUser() *TransactionData_User

func (*TransactionData) GetValue added in v2.7.0

func (x *TransactionData) GetValue() float64

func (*TransactionData) ProtoMessage added in v2.7.0

func (*TransactionData) ProtoMessage()

func (*TransactionData) ProtoReflect added in v2.7.0

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

func (*TransactionData) Reset added in v2.7.0

func (x *TransactionData) Reset()

func (*TransactionData) String added in v2.7.0

func (x *TransactionData) String() string

type TransactionData_Address added in v2.7.0

type TransactionData_Address struct {

	// Optional. The recipient name, potentially including information such as
	// "care of".
	Recipient string `protobuf:"bytes,1,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// Optional. The first lines of the address. The first line generally
	// contains the street name and number, and further lines may include
	// information such as an apartment number.
	Address []string `protobuf:"bytes,2,rep,name=address,proto3" json:"address,omitempty"`
	// Optional. The town/city of the address.
	Locality string `protobuf:"bytes,3,opt,name=locality,proto3" json:"locality,omitempty"`
	// Optional. The state, province, or otherwise administrative area of the
	// address.
	AdministrativeArea string `protobuf:"bytes,4,opt,name=administrative_area,json=administrativeArea,proto3" json:"administrative_area,omitempty"`
	// Optional. The CLDR country/region of the address.
	RegionCode string `protobuf:"bytes,5,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"`
	// Optional. The postal or ZIP code of the address.
	PostalCode string `protobuf:"bytes,6,opt,name=postal_code,json=postalCode,proto3" json:"postal_code,omitempty"`
	// contains filtered or unexported fields
}

Structured address format for billing and shipping addresses.

func (*TransactionData_Address) Descriptor deprecated added in v2.7.0

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

Deprecated: Use TransactionData_Address.ProtoReflect.Descriptor instead.

func (*TransactionData_Address) GetAddress added in v2.7.0

func (x *TransactionData_Address) GetAddress() []string

func (*TransactionData_Address) GetAdministrativeArea added in v2.7.0

func (x *TransactionData_Address) GetAdministrativeArea() string

func (*TransactionData_Address) GetLocality added in v2.7.0

func (x *TransactionData_Address) GetLocality() string

func (*TransactionData_Address) GetPostalCode added in v2.7.0

func (x *TransactionData_Address) GetPostalCode() string

func (*TransactionData_Address) GetRecipient added in v2.7.0

func (x *TransactionData_Address) GetRecipient() string

func (*TransactionData_Address) GetRegionCode added in v2.7.0

func (x *TransactionData_Address) GetRegionCode() string

func (*TransactionData_Address) ProtoMessage added in v2.7.0

func (*TransactionData_Address) ProtoMessage()

func (*TransactionData_Address) ProtoReflect added in v2.7.0

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

func (*TransactionData_Address) Reset added in v2.7.0

func (x *TransactionData_Address) Reset()

func (*TransactionData_Address) String added in v2.7.0

func (x *TransactionData_Address) String() string

type TransactionData_GatewayInfo added in v2.7.0

type TransactionData_GatewayInfo struct {

	// Optional. Name of the gateway service (for example, stripe, square,
	// paypal).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Gateway response code describing the state of the transaction.
	GatewayResponseCode string `protobuf:"bytes,2,opt,name=gateway_response_code,json=gatewayResponseCode,proto3" json:"gateway_response_code,omitempty"`
	// Optional. AVS response code from the gateway
	// (available only when reCAPTCHA Enterprise is called after authorization).
	AvsResponseCode string `protobuf:"bytes,3,opt,name=avs_response_code,json=avsResponseCode,proto3" json:"avs_response_code,omitempty"`
	// Optional. CVV response code from the gateway
	// (available only when reCAPTCHA Enterprise is called after authorization).
	CvvResponseCode string `protobuf:"bytes,4,opt,name=cvv_response_code,json=cvvResponseCode,proto3" json:"cvv_response_code,omitempty"`
	// contains filtered or unexported fields
}

Details about the transaction from the gateway.

func (*TransactionData_GatewayInfo) Descriptor deprecated added in v2.7.0

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

Deprecated: Use TransactionData_GatewayInfo.ProtoReflect.Descriptor instead.

func (*TransactionData_GatewayInfo) GetAvsResponseCode added in v2.7.0

func (x *TransactionData_GatewayInfo) GetAvsResponseCode() string

func (*TransactionData_GatewayInfo) GetCvvResponseCode added in v2.7.0

func (x *TransactionData_GatewayInfo) GetCvvResponseCode() string

func (*TransactionData_GatewayInfo) GetGatewayResponseCode added in v2.7.0

func (x *TransactionData_GatewayInfo) GetGatewayResponseCode() string

func (*TransactionData_GatewayInfo) GetName added in v2.7.0

func (x *TransactionData_GatewayInfo) GetName() string

func (*TransactionData_GatewayInfo) ProtoMessage added in v2.7.0

func (*TransactionData_GatewayInfo) ProtoMessage()

func (*TransactionData_GatewayInfo) ProtoReflect added in v2.7.0

func (*TransactionData_GatewayInfo) Reset added in v2.7.0

func (x *TransactionData_GatewayInfo) Reset()

func (*TransactionData_GatewayInfo) String added in v2.7.0

func (x *TransactionData_GatewayInfo) String() string

type TransactionData_Item added in v2.7.0

type TransactionData_Item struct {

	// Optional. The full name of the item.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The value per item that the user is paying, in the transaction
	// currency, after discounts.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	// Optional. The quantity of this item that is being purchased.
	Quantity int64 `protobuf:"varint,3,opt,name=quantity,proto3" json:"quantity,omitempty"`
	// Optional. When a merchant is specified, its corresponding account_id.
	// Necessary to populate marketplace-style transactions.
	MerchantAccountId string `protobuf:"bytes,4,opt,name=merchant_account_id,json=merchantAccountId,proto3" json:"merchant_account_id,omitempty"`
	// contains filtered or unexported fields
}

Line items being purchased in this transaction.

func (*TransactionData_Item) Descriptor deprecated added in v2.7.0

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

Deprecated: Use TransactionData_Item.ProtoReflect.Descriptor instead.

func (*TransactionData_Item) GetMerchantAccountId added in v2.7.0

func (x *TransactionData_Item) GetMerchantAccountId() string

func (*TransactionData_Item) GetName added in v2.7.0

func (x *TransactionData_Item) GetName() string

func (*TransactionData_Item) GetQuantity added in v2.7.0

func (x *TransactionData_Item) GetQuantity() int64

func (*TransactionData_Item) GetValue added in v2.7.0

func (x *TransactionData_Item) GetValue() float64

func (*TransactionData_Item) ProtoMessage added in v2.7.0

func (*TransactionData_Item) ProtoMessage()

func (*TransactionData_Item) ProtoReflect added in v2.7.0

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

func (*TransactionData_Item) Reset added in v2.7.0

func (x *TransactionData_Item) Reset()

func (*TransactionData_Item) String added in v2.7.0

func (x *TransactionData_Item) String() string

type TransactionData_User added in v2.7.0

type TransactionData_User struct {

	// Optional. Unique account identifier for this user. If using account
	// defender, this should match the hashed_account_id field. Otherwise, a
	// unique and persistent identifier for this account.
	AccountId string `protobuf:"bytes,6,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// Optional. The epoch milliseconds of the user's account creation.
	CreationMs int64 `protobuf:"varint,1,opt,name=creation_ms,json=creationMs,proto3" json:"creation_ms,omitempty"`
	// Optional. The email address of the user.
	Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// Optional. Whether the email has been verified to be accessible by the
	// user (OTP or similar).
	EmailVerified bool `protobuf:"varint,3,opt,name=email_verified,json=emailVerified,proto3" json:"email_verified,omitempty"`
	// Optional. The phone number of the user, with country code.
	PhoneNumber string `protobuf:"bytes,4,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
	// Optional. Whether the phone number has been verified to be accessible by
	// the user (OTP or similar).
	PhoneVerified bool `protobuf:"varint,5,opt,name=phone_verified,json=phoneVerified,proto3" json:"phone_verified,omitempty"`
	// contains filtered or unexported fields
}

Details about a user's account involved in the transaction.

func (*TransactionData_User) Descriptor deprecated added in v2.7.0

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

Deprecated: Use TransactionData_User.ProtoReflect.Descriptor instead.

func (*TransactionData_User) GetAccountId added in v2.7.0

func (x *TransactionData_User) GetAccountId() string

func (*TransactionData_User) GetCreationMs added in v2.7.0

func (x *TransactionData_User) GetCreationMs() int64

func (*TransactionData_User) GetEmail added in v2.7.0

func (x *TransactionData_User) GetEmail() string

func (*TransactionData_User) GetEmailVerified added in v2.7.0

func (x *TransactionData_User) GetEmailVerified() bool

func (*TransactionData_User) GetPhoneNumber added in v2.7.0

func (x *TransactionData_User) GetPhoneNumber() string

func (*TransactionData_User) GetPhoneVerified added in v2.7.0

func (x *TransactionData_User) GetPhoneVerified() bool

func (*TransactionData_User) ProtoMessage added in v2.7.0

func (*TransactionData_User) ProtoMessage()

func (*TransactionData_User) ProtoReflect added in v2.7.0

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

func (*TransactionData_User) Reset added in v2.7.0

func (x *TransactionData_User) Reset()

func (*TransactionData_User) String added in v2.7.0

func (x *TransactionData_User) String() string

type TransactionEvent added in v2.7.0

type TransactionEvent struct {

	// Optional. The type of this transaction event.
	EventType TransactionEvent_TransactionEventType `` /* 168-byte string literal not displayed */
	// Optional. The reason or standardized code that corresponds with this
	// transaction event, if one exists. For example, a CHARGEBACK event with code
	// 6005.
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// Optional. The value that corresponds with this transaction event, if one
	// exists. For example, a refund event where $5.00 was refunded. Currency is
	// obtained from the original transaction data.
	Value float64 `protobuf:"fixed64,3,opt,name=value,proto3" json:"value,omitempty"`
	// Optional. Timestamp when this transaction event occurred; otherwise assumed
	// to be the time of the API call.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// contains filtered or unexported fields
}

Describes an event in the lifecycle of a payment transaction.

func (*TransactionEvent) Descriptor deprecated added in v2.7.0

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

Deprecated: Use TransactionEvent.ProtoReflect.Descriptor instead.

func (*TransactionEvent) GetEventTime added in v2.7.0

func (x *TransactionEvent) GetEventTime() *timestamppb.Timestamp

func (*TransactionEvent) GetEventType added in v2.7.0

func (*TransactionEvent) GetReason added in v2.7.0

func (x *TransactionEvent) GetReason() string

func (*TransactionEvent) GetValue added in v2.7.0

func (x *TransactionEvent) GetValue() float64

func (*TransactionEvent) ProtoMessage added in v2.7.0

func (*TransactionEvent) ProtoMessage()

func (*TransactionEvent) ProtoReflect added in v2.7.0

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

func (*TransactionEvent) Reset added in v2.7.0

func (x *TransactionEvent) Reset()

func (*TransactionEvent) String added in v2.7.0

func (x *TransactionEvent) String() string

type TransactionEvent_TransactionEventType added in v2.7.0

type TransactionEvent_TransactionEventType int32

Enum that represents an event in the payment transaction lifecycle.

const (
	// Default, unspecified event type.
	TransactionEvent_TRANSACTION_EVENT_TYPE_UNSPECIFIED TransactionEvent_TransactionEventType = 0
	// Indicates that the transaction is approved by the merchant. The
	// accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
	// 'CYBERSOURCE', or 'MANUAL_REVIEW'.
	TransactionEvent_MERCHANT_APPROVE TransactionEvent_TransactionEventType = 1
	// Indicates that the transaction is denied and concluded due to risks
	// detected by the merchant. The accompanying reasons can include terms such
	// as 'INHOUSE',  'ACCERTIFY',  'CYBERSOURCE', or 'MANUAL_REVIEW'.
	TransactionEvent_MERCHANT_DENY TransactionEvent_TransactionEventType = 2
	// Indicates that the transaction is being evaluated by a human, due to
	// suspicion or risk.
	TransactionEvent_MANUAL_REVIEW TransactionEvent_TransactionEventType = 3
	// Indicates that the authorization attempt with the card issuer succeeded.
	TransactionEvent_AUTHORIZATION TransactionEvent_TransactionEventType = 4
	// Indicates that the authorization attempt with the card issuer failed.
	// The accompanying reasons can include Visa's '54' indicating that the card
	// is expired, or '82' indicating that the CVV is incorrect.
	TransactionEvent_AUTHORIZATION_DECLINE TransactionEvent_TransactionEventType = 5
	// Indicates that the transaction is completed because the funds were
	// settled.
	TransactionEvent_PAYMENT_CAPTURE TransactionEvent_TransactionEventType = 6
	// Indicates that the transaction could not be completed because the funds
	// were not settled.
	TransactionEvent_PAYMENT_CAPTURE_DECLINE TransactionEvent_TransactionEventType = 7
	// Indicates that the transaction has been canceled. Specify the reason
	// for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
	TransactionEvent_CANCEL TransactionEvent_TransactionEventType = 8
	// Indicates that the merchant has received a chargeback inquiry due to
	// fraud for the transaction, requesting additional information before a
	// fraud chargeback is officially issued and a formal chargeback
	// notification is sent.
	TransactionEvent_CHARGEBACK_INQUIRY TransactionEvent_TransactionEventType = 9
	// Indicates that the merchant has received a chargeback alert due to fraud
	// for the transaction. The process of resolving the dispute without
	// involving the payment network is started.
	TransactionEvent_CHARGEBACK_ALERT TransactionEvent_TransactionEventType = 10
	// Indicates that a fraud notification is issued for the transaction, sent
	// by the payment instrument's issuing bank because the transaction appears
	// to be fraudulent. We recommend including TC40 or SAFE data in the
	// `reason` field for this event type. For partial chargebacks, we recommend
	// that you include an amount in the `value` field.
	TransactionEvent_FRAUD_NOTIFICATION TransactionEvent_TransactionEventType = 11
	// Indicates that the merchant is informed by the payment network that the
	// transaction has entered the chargeback process due to fraud. Reason code
	// examples include Discover's '6005' and '6041'. For partial chargebacks,
	// we recommend that you include an amount in the `value` field.
	TransactionEvent_CHARGEBACK TransactionEvent_TransactionEventType = 12
	// Indicates that the transaction has entered the chargeback process due to
	// fraud, and that the merchant has chosen to enter representment. Reason
	// examples include Discover's '6005' and '6041'. For partial chargebacks,
	// we recommend that you include an amount in the `value` field.
	TransactionEvent_CHARGEBACK_REPRESENTMENT TransactionEvent_TransactionEventType = 13
	// Indicates that the transaction has had a fraud chargeback which was
	// illegitimate and was reversed as a result. For partial chargebacks, we
	// recommend that you include an amount in the `value` field.
	TransactionEvent_CHARGEBACK_REVERSE TransactionEvent_TransactionEventType = 14
	// Indicates that the merchant has received a refund for a completed
	// transaction. For partial refunds, we recommend that you include an amount
	// in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
	// exempt tax)
	TransactionEvent_REFUND_REQUEST TransactionEvent_TransactionEventType = 15
	// Indicates that the merchant has received a refund request for this
	// transaction, but that they have declined it. For partial refunds, we
	// recommend that you include an amount in the `value` field. Reason
	// example: 'TAX_EXEMPT' (partial refund of exempt tax)
	TransactionEvent_REFUND_DECLINE TransactionEvent_TransactionEventType = 16
	// Indicates that the completed transaction was refunded by the merchant.
	// For partial refunds, we recommend that you include an amount in the
	// `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
	// tax)
	TransactionEvent_REFUND TransactionEvent_TransactionEventType = 17
	// Indicates that the completed transaction was refunded by the merchant,
	// and that this refund was reversed. For partial refunds, we recommend that
	// you include an amount in the `value` field.
	TransactionEvent_REFUND_REVERSE TransactionEvent_TransactionEventType = 18
)

func (TransactionEvent_TransactionEventType) Descriptor added in v2.7.0

func (TransactionEvent_TransactionEventType) Enum added in v2.7.0

func (TransactionEvent_TransactionEventType) EnumDescriptor deprecated added in v2.7.0

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

Deprecated: Use TransactionEvent_TransactionEventType.Descriptor instead.

func (TransactionEvent_TransactionEventType) Number added in v2.7.0

func (TransactionEvent_TransactionEventType) String added in v2.7.0

func (TransactionEvent_TransactionEventType) Type added in v2.7.0

type UnimplementedRecaptchaEnterpriseServiceServer

type UnimplementedRecaptchaEnterpriseServiceServer struct {
}

UnimplementedRecaptchaEnterpriseServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRecaptchaEnterpriseServiceServer) AnnotateAssessment

func (*UnimplementedRecaptchaEnterpriseServiceServer) CreateAssessment

func (*UnimplementedRecaptchaEnterpriseServiceServer) CreateFirewallPolicy added in v2.8.0

func (*UnimplementedRecaptchaEnterpriseServiceServer) CreateKey

func (*UnimplementedRecaptchaEnterpriseServiceServer) DeleteFirewallPolicy added in v2.8.0

func (*UnimplementedRecaptchaEnterpriseServiceServer) DeleteKey

func (*UnimplementedRecaptchaEnterpriseServiceServer) GetFirewallPolicy added in v2.8.0

func (*UnimplementedRecaptchaEnterpriseServiceServer) GetKey

func (*UnimplementedRecaptchaEnterpriseServiceServer) GetMetrics

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListFirewallPolicies added in v2.8.0

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListKeys

func (*UnimplementedRecaptchaEnterpriseServiceServer) ListRelatedAccountGroups

func (*UnimplementedRecaptchaEnterpriseServiceServer) MigrateKey

func (*UnimplementedRecaptchaEnterpriseServiceServer) ReorderFirewallPolicies added in v2.10.0

func (*UnimplementedRecaptchaEnterpriseServiceServer) RetrieveLegacySecretKey

func (*UnimplementedRecaptchaEnterpriseServiceServer) UpdateFirewallPolicy added in v2.8.0

func (*UnimplementedRecaptchaEnterpriseServiceServer) UpdateKey

type UpdateFirewallPolicyRequest added in v2.8.0

type UpdateFirewallPolicyRequest struct {

	// Required. The policy to update.
	FirewallPolicy *FirewallPolicy `protobuf:"bytes,1,opt,name=firewall_policy,json=firewallPolicy,proto3" json:"firewall_policy,omitempty"`
	// Optional. The mask to control which fields of the policy 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 firewall policy request message.

func (*UpdateFirewallPolicyRequest) Descriptor deprecated added in v2.8.0

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

Deprecated: Use UpdateFirewallPolicyRequest.ProtoReflect.Descriptor instead.

func (*UpdateFirewallPolicyRequest) GetFirewallPolicy added in v2.8.0

func (x *UpdateFirewallPolicyRequest) GetFirewallPolicy() *FirewallPolicy

func (*UpdateFirewallPolicyRequest) GetUpdateMask added in v2.8.0

func (*UpdateFirewallPolicyRequest) ProtoMessage added in v2.8.0

func (*UpdateFirewallPolicyRequest) ProtoMessage()

func (*UpdateFirewallPolicyRequest) ProtoReflect added in v2.8.0

func (*UpdateFirewallPolicyRequest) Reset added in v2.8.0

func (x *UpdateFirewallPolicyRequest) Reset()

func (*UpdateFirewallPolicyRequest) String added in v2.8.0

func (x *UpdateFirewallPolicyRequest) String() string

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 UserId added in v2.9.0

type UserId struct {

	// Types that are assignable to IdOneof:
	//
	//	*UserId_Email
	//	*UserId_PhoneNumber
	//	*UserId_Username
	IdOneof isUserId_IdOneof `protobuf_oneof:"id_oneof"`
	// contains filtered or unexported fields
}

An identifier associated with a user.

func (*UserId) Descriptor deprecated added in v2.9.0

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

Deprecated: Use UserId.ProtoReflect.Descriptor instead.

func (*UserId) GetEmail added in v2.9.0

func (x *UserId) GetEmail() string

func (*UserId) GetIdOneof added in v2.9.0

func (m *UserId) GetIdOneof() isUserId_IdOneof

func (*UserId) GetPhoneNumber added in v2.9.0

func (x *UserId) GetPhoneNumber() string

func (*UserId) GetUsername added in v2.9.0

func (x *UserId) GetUsername() string

func (*UserId) ProtoMessage added in v2.9.0

func (*UserId) ProtoMessage()

func (*UserId) ProtoReflect added in v2.9.0

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

func (*UserId) Reset added in v2.9.0

func (x *UserId) Reset()

func (*UserId) String added in v2.9.0

func (x *UserId) String() string

type UserId_Email added in v2.9.0

type UserId_Email struct {
	// Optional. An email address.
	Email string `protobuf:"bytes,1,opt,name=email,proto3,oneof"`
}

type UserId_PhoneNumber added in v2.9.0

type UserId_PhoneNumber struct {
	// Optional. A phone number. Should use the E.164 format.
	PhoneNumber string `protobuf:"bytes,2,opt,name=phone_number,json=phoneNumber,proto3,oneof"`
}

type UserId_Username added in v2.9.0

type UserId_Username struct {
	// Optional. A unique username, if different from all the other identifiers
	// and `account_id` that are provided. Can be a unique login handle or
	// display name for a user.
	Username string `protobuf:"bytes,3,opt,name=username,proto3,oneof"`
}

type UserInfo added in v2.9.0

type UserInfo struct {

	// Optional. Creation time for this account associated with this user. Leave
	// blank for non logged-in actions, guest checkout, or when there is no
	// account associated with the current user.
	CreateAccountTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_account_time,json=createAccountTime,proto3" json:"create_account_time,omitempty"`
	// Optional. For logged-in requests or login/registration requests, the unique
	// account identifier associated with this user. You can use the username if
	// it is stable (meaning it is the same for every request associated with the
	// same user), or any stable user ID of your choice. Leave blank for non
	// logged-in actions or guest checkout.
	AccountId string `protobuf:"bytes,2,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// Optional. Identifiers associated with this user or request.
	UserIds []*UserId `protobuf:"bytes,3,rep,name=user_ids,json=userIds,proto3" json:"user_ids,omitempty"`
	// contains filtered or unexported fields
}

User information associated with a request protected by reCAPTCHA Enterprise.

func (*UserInfo) Descriptor deprecated added in v2.9.0

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

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetAccountId added in v2.9.0

func (x *UserInfo) GetAccountId() string

func (*UserInfo) GetCreateAccountTime added in v2.9.0

func (x *UserInfo) GetCreateAccountTime() *timestamppb.Timestamp

func (*UserInfo) GetUserIds added in v2.9.0

func (x *UserInfo) GetUserIds() []*UserId

func (*UserInfo) ProtoMessage added in v2.9.0

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect added in v2.9.0

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

func (*UserInfo) Reset added in v2.9.0

func (x *UserInfo) Reset()

func (*UserInfo) String added in v2.9.0

func (x *UserInfo) String() string

type WafSettings

type WafSettings struct {

	// Required. The WAF service that uses this key.
	WafService WafSettings_WafService `` /* 156-byte string literal not displayed */
	// Required. The WAF feature for which this key is enabled.
	WafFeature WafSettings_WafFeature `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

Settings specific to keys that can be used for WAF (Web Application Firewall).

func (*WafSettings) Descriptor deprecated

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

Deprecated: Use WafSettings.ProtoReflect.Descriptor instead.

func (*WafSettings) GetWafFeature

func (x *WafSettings) GetWafFeature() WafSettings_WafFeature

func (*WafSettings) GetWafService

func (x *WafSettings) GetWafService() WafSettings_WafService

func (*WafSettings) ProtoMessage

func (*WafSettings) ProtoMessage()

func (*WafSettings) ProtoReflect

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

func (*WafSettings) Reset

func (x *WafSettings) Reset()

func (*WafSettings) String

func (x *WafSettings) String() string

type WafSettings_WafFeature

type WafSettings_WafFeature int32

Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features.

const (
	// Undefined feature.
	WafSettings_WAF_FEATURE_UNSPECIFIED WafSettings_WafFeature = 0
	// Redirects suspicious traffic to reCAPTCHA.
	WafSettings_CHALLENGE_PAGE WafSettings_WafFeature = 1
	// Use reCAPTCHA session-tokens to protect the whole user session on the
	// site's domain.
	WafSettings_SESSION_TOKEN WafSettings_WafFeature = 2
	// Use reCAPTCHA action-tokens to protect user actions.
	WafSettings_ACTION_TOKEN WafSettings_WafFeature = 3
	// Use reCAPTCHA WAF express protection to protect any content other than
	// web pages, like APIs and IoT devices.
	WafSettings_EXPRESS WafSettings_WafFeature = 5
)

func (WafSettings_WafFeature) Descriptor

func (WafSettings_WafFeature) Enum

func (WafSettings_WafFeature) EnumDescriptor deprecated

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

Deprecated: Use WafSettings_WafFeature.Descriptor instead.

func (WafSettings_WafFeature) Number

func (WafSettings_WafFeature) String

func (x WafSettings_WafFeature) String() string

func (WafSettings_WafFeature) Type

type WafSettings_WafService

type WafSettings_WafService int32

Web Application Firewalls supported by reCAPTCHA Enterprise.

const (
	// Undefined WAF
	WafSettings_WAF_SERVICE_UNSPECIFIED WafSettings_WafService = 0
	// Cloud Armor
	WafSettings_CA WafSettings_WafService = 1
	// Fastly
	WafSettings_FASTLY WafSettings_WafService = 3
	// Cloudflare
	WafSettings_CLOUDFLARE WafSettings_WafService = 4
)

func (WafSettings_WafService) Descriptor

func (WafSettings_WafService) Enum

func (WafSettings_WafService) EnumDescriptor deprecated

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

Deprecated: Use WafSettings_WafService.Descriptor instead.

func (WafSettings_WafService) Number

func (WafSettings_WafService) String

func (x WafSettings_WafService) String() string

func (WafSettings_WafService) Type

type WebKeySettings

type WebKeySettings struct {

	// Optional. 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"`
	// Optional. 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"`
	// Optional. 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 */
	// Optional. 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) Enum

func (WebKeySettings_ChallengeSecurityPreference) EnumDescriptor deprecated

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

Deprecated: Use WebKeySettings_ChallengeSecurityPreference.Descriptor instead.

func (WebKeySettings_ChallengeSecurityPreference) Number

func (WebKeySettings_ChallengeSecurityPreference) String

func (WebKeySettings_ChallengeSecurityPreference) Type

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) Enum

func (WebKeySettings_IntegrationType) EnumDescriptor deprecated

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

Deprecated: Use WebKeySettings_IntegrationType.Descriptor instead.

func (WebKeySettings_IntegrationType) Number

func (WebKeySettings_IntegrationType) String

func (WebKeySettings_IntegrationType) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL