recaptchaenterprise

package
v0.0.0-...-6cb3ea0 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2021 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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

Enum value maps for AnnotateAssessmentRequest_Annotation.

View Source 
var (
	Assessment_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",
	}
	Assessment_ClassificationReason_value = map[string]int32{
		"CLASSIFICATION_REASON_UNSPECIFIED": 0,
		"AUTOMATION":                        1,
		"UNEXPECTED_ENVIRONMENT":            2,
		"TOO_MUCH_TRAFFIC":                  3,
		"UNEXPECTED_USAGE_PATTERNS":         4,
		"LOW_CONFIDENCE_SCORE":              5,
	}
)

Enum value maps for Assessment_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: "SITE_MISMATCH",
		6: "MISSING",
	}
	TokenProperties_InvalidReason_value = map[string]int32{
		"INVALID_REASON_UNSPECIFIED": 0,
		"UNKNOWN_INVALID_REASON":     1,
		"MALFORMED":                  2,
		"EXPIRED":                    3,
		"DUPE":                       4,
		"SITE_MISMATCH":              5,
		"MISSING":                    6,
	}
)

Enum value maps for TokenProperties_InvalidReason.

View Source 
var (
	WebKeySettings_IntegrationType_name = map[int32]string{
		0: "INTEGRATION_TYPE_UNSPECIFIED",
		1: "SCORE_ONLY",
		2: "CHECKBOX_CHALLENGE",
		3: "INVISIBLE_CHALLENGE",
	}
	WebKeySettings_IntegrationType_value = map[string]int32{
		"INTEGRATION_TYPE_UNSPECIFIED": 0,
		"SCORE_ONLY":                   1,
		"CHECKBOX_CHALLENGE":           2,
		"INVISIBLE_CHALLENGE":          3,
	}
)

Enum value maps for WebKeySettings_IntegrationType.

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

Enum value maps for WebKeySettings_ChallengeSecurityPreference.

View Source 
var File_google_cloud_recaptchaenterprise_v1beta1_recaptchaenterprise_proto protoreflect.FileDescriptor

Functions

func RegisterRecaptchaEnterpriseServiceV1Beta1Server 

func RegisterRecaptchaEnterpriseServiceV1Beta1Server(s *grpc.Server, srv RecaptchaEnterpriseServiceV1Beta1Server)

Types

type AndroidKeySettings 

type AndroidKeySettings struct {

	// Android package names of apps allowed to use the key.
	// Example: 'com.companyname.appname'
	AllowedPackageNames []string `protobuf:"bytes,1,rep,name=allowed_package_names,json=allowedPackageNames,proto3" json:"allowed_package_names,omitempty"`
	// contains filtered or unexported fields
}

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

func (*AndroidKeySettings) Descriptor deprecated 

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

Deprecated: Use AndroidKeySettings.ProtoReflect.Descriptor instead.

func (*AndroidKeySettings) GetAllowedPackageNames 

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

func (*AndroidKeySettings) ProtoMessage 

func (*AndroidKeySettings) ProtoMessage()

func (*AndroidKeySettings) ProtoReflect 

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

func (*AndroidKeySettings) Reset 

func (x *AndroidKeySettings) Reset()

func (*AndroidKeySettings) String 

func (x *AndroidKeySettings) String() string

type AnnotateAssessmentRequest 

type AnnotateAssessmentRequest struct {

	// Required. The resource name of the Assessment, in the format
	// "projects/{project_number}/assessments/{assessment_id}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The annotation that will be assigned to the Event.
	Annotation AnnotateAssessmentRequest_Annotation `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

The request message to annotate an Assessment.

func (*AnnotateAssessmentRequest) Descriptor deprecated 

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

Deprecated: Use AnnotateAssessmentRequest.ProtoReflect.Descriptor instead.

func (*AnnotateAssessmentRequest) GetAnnotation 

func (x *AnnotateAssessmentRequest) GetAnnotation() AnnotateAssessmentRequest_Annotation

func (*AnnotateAssessmentRequest) GetName 

func (x *AnnotateAssessmentRequest) GetName() string

func (*AnnotateAssessmentRequest) ProtoMessage 

func (*AnnotateAssessmentRequest) ProtoMessage()

func (*AnnotateAssessmentRequest) ProtoReflect 

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

func (*AnnotateAssessmentRequest) Reset 

func (x *AnnotateAssessmentRequest) Reset()

func (*AnnotateAssessmentRequest) String 

func (x *AnnotateAssessmentRequest) String() string

type AnnotateAssessmentRequest_Annotation 

type AnnotateAssessmentRequest_Annotation int32

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

func (AnnotateAssessmentRequest_Annotation) Descriptor 

func (AnnotateAssessmentRequest_Annotation) Descriptor() protoreflect.EnumDescriptor

func (AnnotateAssessmentRequest_Annotation) Enum 

func (x AnnotateAssessmentRequest_Annotation) Enum() *AnnotateAssessmentRequest_Annotation

func (AnnotateAssessmentRequest_Annotation) EnumDescriptor deprecated 

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

Deprecated: Use AnnotateAssessmentRequest_Annotation.Descriptor instead.

func (AnnotateAssessmentRequest_Annotation) Number 

func (x AnnotateAssessmentRequest_Annotation) Number() protoreflect.EnumNumber

func (AnnotateAssessmentRequest_Annotation) String 

func (x AnnotateAssessmentRequest_Annotation) String() string

func (AnnotateAssessmentRequest_Annotation) Type 

func (AnnotateAssessmentRequest_Annotation) Type() protoreflect.EnumType

type AnnotateAssessmentResponse 

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

Empty response for AnnotateAssessment.

func (*AnnotateAssessmentResponse) Descriptor deprecated 

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

Deprecated: Use AnnotateAssessmentResponse.ProtoReflect.Descriptor instead.

func (*AnnotateAssessmentResponse) ProtoMessage 

func (*AnnotateAssessmentResponse) ProtoMessage()

func (*AnnotateAssessmentResponse) ProtoReflect 

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

func (*AnnotateAssessmentResponse) Reset 

func (x *AnnotateAssessmentResponse) Reset()

func (*AnnotateAssessmentResponse) String 

func (x *AnnotateAssessmentResponse) String() string

type Assessment 

type Assessment struct {

	// Output only. The resource name for the Assessment in the format
	// "projects/{project_number}/assessments/{assessment_id}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The event being assessed.
	Event *Event `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// Output only. 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,3,opt,name=score,proto3" json:"score,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"`
	// Output only. Reasons contributing to the risk analysis verdict.
	Reasons []Assessment_ClassificationReason `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

A recaptcha assessment resource.

func (*Assessment) Descriptor deprecated 

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

Deprecated: Use Assessment.ProtoReflect.Descriptor instead.

func (*Assessment) GetEvent 

func (x *Assessment) GetEvent() *Event

func (*Assessment) GetName 

func (x *Assessment) GetName() string

func (*Assessment) GetReasons 

func (x *Assessment) GetReasons() []Assessment_ClassificationReason

func (*Assessment) GetScore 

func (x *Assessment) GetScore() float32

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 Assessment_ClassificationReason 

type Assessment_ClassificationReason int32

LINT.IfChange(classification_reason) Reasons contributing to the risk analysis verdict. 

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

func (Assessment_ClassificationReason) Descriptor 

func (Assessment_ClassificationReason) Descriptor() protoreflect.EnumDescriptor

func (Assessment_ClassificationReason) Enum 

func (x Assessment_ClassificationReason) Enum() *Assessment_ClassificationReason

func (Assessment_ClassificationReason) EnumDescriptor deprecated 

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

Deprecated: Use Assessment_ClassificationReason.Descriptor instead.

func (Assessment_ClassificationReason) Number 

func (x Assessment_ClassificationReason) Number() protoreflect.EnumNumber

func (Assessment_ClassificationReason) String 

func (x Assessment_ClassificationReason) String() string

func (Assessment_ClassificationReason) Type 

func (Assessment_ClassificationReason) Type() protoreflect.EnumType

type CreateAssessmentRequest 

type CreateAssessmentRequest struct {

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

The create assessment request message.

func (*CreateAssessmentRequest) Descriptor deprecated 

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

Deprecated: Use CreateAssessmentRequest.ProtoReflect.Descriptor instead.

func (*CreateAssessmentRequest) GetAssessment 

func (x *CreateAssessmentRequest) GetAssessment() *Assessment

func (*CreateAssessmentRequest) GetParent 

func (x *CreateAssessmentRequest) GetParent() string

func (*CreateAssessmentRequest) ProtoMessage 

func (*CreateAssessmentRequest) ProtoMessage()

func (*CreateAssessmentRequest) ProtoReflect 

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

func (*CreateAssessmentRequest) Reset 

func (x *CreateAssessmentRequest) Reset()

func (*CreateAssessmentRequest) String 

func (x *CreateAssessmentRequest) String() string

type CreateKeyRequest 

type CreateKeyRequest struct {

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

The create key request message.

func (*CreateKeyRequest) Descriptor deprecated 

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

Deprecated: Use CreateKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateKeyRequest) GetKey 

func (x *CreateKeyRequest) GetKey() *Key

func (*CreateKeyRequest) GetParent 

func (x *CreateKeyRequest) GetParent() string

func (*CreateKeyRequest) ProtoMessage 

func (*CreateKeyRequest) ProtoMessage()

func (*CreateKeyRequest) ProtoReflect 

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

func (*CreateKeyRequest) Reset 

func (x *CreateKeyRequest) Reset()

func (*CreateKeyRequest) String 

func (x *CreateKeyRequest) String() string

type DeleteKeyRequest 

type DeleteKeyRequest struct {

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

The delete key request message.

func (*DeleteKeyRequest) Descriptor deprecated 

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

Deprecated: Use DeleteKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteKeyRequest) GetName 

func (x *DeleteKeyRequest) GetName() string

func (*DeleteKeyRequest) ProtoMessage 

func (*DeleteKeyRequest) ProtoMessage()

func (*DeleteKeyRequest) ProtoReflect 

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

func (*DeleteKeyRequest) Reset 

func (x *DeleteKeyRequest) Reset()

func (*DeleteKeyRequest) String 

func (x *DeleteKeyRequest) String() string

type Event 

type Event struct {

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

func (*Event) Descriptor deprecated 

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

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetExpectedAction 

func (x *Event) GetExpectedAction() string

func (*Event) GetSiteKey 

func (x *Event) GetSiteKey() string

func (*Event) GetToken 

func (x *Event) GetToken() string

func (*Event) GetUserAgent 

func (x *Event) GetUserAgent() string

func (*Event) GetUserIpAddress 

func (x *Event) GetUserIpAddress() string

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) ProtoReflect 

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

func (*Event) Reset 

func (x *Event) Reset()

func (*Event) String 

func (x *Event) String() string

type GetKeyRequest 

type GetKeyRequest struct {

	// Required. The name of the requested key, in the format
	// "projects/{project_number}/keys/{key_id}".
	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 IOSKeySettings 

type IOSKeySettings struct {

	// iOS bundle ids of apps allowed to use the key.
	// Example: 'com.companyname.productname.appname'
	AllowedBundleIds []string `protobuf:"bytes,1,rep,name=allowed_bundle_ids,json=allowedBundleIds,proto3" json:"allowed_bundle_ids,omitempty"`
	// contains filtered or unexported fields
}

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

func (*IOSKeySettings) Descriptor deprecated 

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

Deprecated: Use IOSKeySettings.ProtoReflect.Descriptor instead.

func (*IOSKeySettings) GetAllowedBundleIds 

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

func (*IOSKeySettings) ProtoMessage 

func (*IOSKeySettings) ProtoMessage()

func (*IOSKeySettings) ProtoReflect 

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

func (*IOSKeySettings) Reset 

func (x *IOSKeySettings) Reset()

func (*IOSKeySettings) String 

func (x *IOSKeySettings) String() string

type Key 

type Key struct {

	// The resource name for the Key in the format
	// "projects/{project_number}/keys/{key_id}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Human-readable display name of this key. Modifiable by user.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Platform specific settings for this key. The key can only be used on one
	// platform, the one it has settings for.
	//
	// Types that are assignable to PlatformSettings:
	//	*Key_WebSettings
	//	*Key_AndroidSettings
	//	*Key_IosSettings
	PlatformSettings isKey_PlatformSettings `protobuf_oneof:"platform_settings"`
	// 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) GetDisplayName 

func (x *Key) GetDisplayName() string

func (*Key) GetIosSettings 

func (x *Key) GetIosSettings() *IOSKeySettings

func (*Key) GetName 

func (x *Key) GetName() string

func (*Key) GetPlatformSettings 

func (m *Key) GetPlatformSettings() isKey_PlatformSettings

func (*Key) GetWebSettings 

func (x *Key) GetWebSettings() *WebKeySettings

func (*Key) ProtoMessage 

func (*Key) ProtoMessage()

func (*Key) ProtoReflect 

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

func (*Key) Reset 

func (x *Key) Reset()

func (*Key) String 

func (x *Key) String() string

type Key_AndroidSettings 

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

type Key_IosSettings 

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

type Key_WebSettings 

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

type ListKeysRequest 

type ListKeysRequest struct {

	// Required. The name of the project that contains the keys that will be
	// listed, in the format "projects/{project_number}".
	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 RecaptchaEnterpriseServiceV1Beta1Client 

type RecaptchaEnterpriseServiceV1Beta1Client 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 fradulent.
	AnnotateAssessment(ctx context.Context, in *AnnotateAssessmentRequest, opts ...grpc.CallOption) (*AnnotateAssessmentResponse, error)
	// Creates a new reCAPTCHA Enterprise key.
	CreateKey(ctx context.Context, in *CreateKeyRequest, opts ...grpc.CallOption) (*Key, error)
	// Returns the list of all keys that belong to a project.
	ListKeys(ctx context.Context, in *ListKeysRequest, opts ...grpc.CallOption) (*ListKeysResponse, error)
	// Returns the specified key.
	GetKey(ctx context.Context, in *GetKeyRequest, opts ...grpc.CallOption) (*Key, error)
	// Updates the specified key.
	UpdateKey(ctx context.Context, in *UpdateKeyRequest, opts ...grpc.CallOption) (*Key, error)
	// Deletes the specified key.
	DeleteKey(ctx context.Context, in *DeleteKeyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

RecaptchaEnterpriseServiceV1Beta1Client is the client API for RecaptchaEnterpriseServiceV1Beta1 service.

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

func NewRecaptchaEnterpriseServiceV1Beta1Client 

func NewRecaptchaEnterpriseServiceV1Beta1Client(cc grpc.ClientConnInterface) RecaptchaEnterpriseServiceV1Beta1Client

type RecaptchaEnterpriseServiceV1Beta1Server 

type RecaptchaEnterpriseServiceV1Beta1Server 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 fradulent.
	AnnotateAssessment(context.Context, *AnnotateAssessmentRequest) (*AnnotateAssessmentResponse, error)
	// Creates a new reCAPTCHA Enterprise key.
	CreateKey(context.Context, *CreateKeyRequest) (*Key, error)
	// Returns the list of all keys that belong to a project.
	ListKeys(context.Context, *ListKeysRequest) (*ListKeysResponse, error)
	// Returns the specified key.
	GetKey(context.Context, *GetKeyRequest) (*Key, error)
	// Updates the specified key.
	UpdateKey(context.Context, *UpdateKeyRequest) (*Key, error)
	// Deletes the specified key.
	DeleteKey(context.Context, *DeleteKeyRequest) (*emptypb.Empty, error)
}

RecaptchaEnterpriseServiceV1Beta1Server is the server API for RecaptchaEnterpriseServiceV1Beta1 service.

type TokenProperties 

type TokenProperties struct {

	// Whether the provided user response token is valid.
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// Reason associated with the response when valid = false.
	InvalidReason TokenProperties_InvalidReason `` /* 177-byte string literal not displayed */
	// The timestamp corresponding to the generation of the token.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The hostname of the page on which the token was generated.
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Action name provided at token generation.
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// contains filtered or unexported fields
}

func (*TokenProperties) Descriptor deprecated 

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

Deprecated: Use TokenProperties.ProtoReflect.Descriptor instead.

func (*TokenProperties) GetAction 

func (x *TokenProperties) GetAction() string

func (*TokenProperties) GetCreateTime 

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

func (*TokenProperties) GetHostname 

func (x *TokenProperties) GetHostname() string

func (*TokenProperties) GetInvalidReason 

func (x *TokenProperties) GetInvalidReason() TokenProperties_InvalidReason

func (*TokenProperties) GetValid 

func (x *TokenProperties) GetValid() bool

func (*TokenProperties) ProtoMessage 

func (*TokenProperties) ProtoMessage()

func (*TokenProperties) ProtoReflect 

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

func (*TokenProperties) Reset 

func (x *TokenProperties) Reset()

func (*TokenProperties) String 

func (x *TokenProperties) String() string

type TokenProperties_InvalidReason 

type TokenProperties_InvalidReason int32

LINT.IfChange 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 did not match the provided site key.
	// This may be a configuration error (e.g. development keys used in
	// production) or end users trying to use verification tokens from other
	// sites.
	TokenProperties_SITE_MISMATCH TokenProperties_InvalidReason = 5
	// The user verification token was not present.  It is a required input.
	TokenProperties_MISSING TokenProperties_InvalidReason = 6
)

func (TokenProperties_InvalidReason) Descriptor 

func (TokenProperties_InvalidReason) Descriptor() protoreflect.EnumDescriptor

func (TokenProperties_InvalidReason) Enum 

func (x TokenProperties_InvalidReason) Enum() *TokenProperties_InvalidReason

func (TokenProperties_InvalidReason) EnumDescriptor deprecated 

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

Deprecated: Use TokenProperties_InvalidReason.Descriptor instead.

func (TokenProperties_InvalidReason) Number 

func (x TokenProperties_InvalidReason) Number() protoreflect.EnumNumber

func (TokenProperties_InvalidReason) String 

func (x TokenProperties_InvalidReason) String() string

func (TokenProperties_InvalidReason) Type 

func (TokenProperties_InvalidReason) Type() protoreflect.EnumType

type UnimplementedRecaptchaEnterpriseServiceV1Beta1Server 

type UnimplementedRecaptchaEnterpriseServiceV1Beta1Server struct {
}

UnimplementedRecaptchaEnterpriseServiceV1Beta1Server can be embedded to have forward compatible implementations.

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) AnnotateAssessment 

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

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) CreateAssessment 

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

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) CreateKey 

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

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) DeleteKey 

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

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) GetKey 

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

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) ListKeys 

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

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) UpdateKey 

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

type UpdateKeyRequest 

type UpdateKeyRequest struct {

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

The update key request message.

func (*UpdateKeyRequest) Descriptor deprecated 

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

Deprecated: Use UpdateKeyRequest.ProtoReflect.Descriptor instead.

func (*UpdateKeyRequest) GetKey 

func (x *UpdateKeyRequest) GetKey() *Key

func (*UpdateKeyRequest) GetUpdateMask 

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

func (*UpdateKeyRequest) ProtoMessage 

func (*UpdateKeyRequest) ProtoMessage()

func (*UpdateKeyRequest) ProtoReflect 

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

func (*UpdateKeyRequest) Reset 

func (x *UpdateKeyRequest) Reset()

func (*UpdateKeyRequest) String 

func (x *UpdateKeyRequest) String() string

type WebKeySettings 

type WebKeySettings struct {

	// Whether allowed_domains is enforced or not.
	EnforceAllowedDomains bool `` /* 127-byte string literal not displayed */
	// 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"`
	// Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
	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 `` /* 184-byte string literal not displayed */
	// Settings for the frequency and difficulty at which this key triggers
	// captcha challenges. This should only be specified for IntegrationTypes
	// CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
	ChallengeSecurityPreference WebKeySettings_ChallengeSecurityPreference `` /* 234-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) 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) GetEnforceAllowedDomains 

func (x *WebKeySettings) GetEnforceAllowedDomains() bool

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_BALANCED WebKeySettings_ChallengeSecurityPreference = 2
	// Key tends to show more and harder challenges.
	WebKeySettings_SECURITY WebKeySettings_ChallengeSecurityPreference = 3
)

func (WebKeySettings_ChallengeSecurityPreference) Descriptor 

func (WebKeySettings_ChallengeSecurityPreference) Descriptor() protoreflect.EnumDescriptor

func (WebKeySettings_ChallengeSecurityPreference) Enum 

func (x WebKeySettings_ChallengeSecurityPreference) Enum() *WebKeySettings_ChallengeSecurityPreference

func (WebKeySettings_ChallengeSecurityPreference) EnumDescriptor deprecated 

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

Deprecated: Use WebKeySettings_ChallengeSecurityPreference.Descriptor instead.

func (WebKeySettings_ChallengeSecurityPreference) Number 

func (x WebKeySettings_ChallengeSecurityPreference) Number() protoreflect.EnumNumber

func (WebKeySettings_ChallengeSecurityPreference) String 

func (x WebKeySettings_ChallengeSecurityPreference) String() string

func (WebKeySettings_ChallengeSecurityPreference) Type 

func (WebKeySettings_ChallengeSecurityPreference) Type() protoreflect.EnumType

type WebKeySettings_IntegrationType 

type WebKeySettings_IntegrationType int32

Enum that represents the integration types for web keys. 

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

func (WebKeySettings_IntegrationType) Descriptor 

func (WebKeySettings_IntegrationType) Descriptor() protoreflect.EnumDescriptor

func (WebKeySettings_IntegrationType) Enum 

func (x WebKeySettings_IntegrationType) Enum() *WebKeySettings_IntegrationType

func (WebKeySettings_IntegrationType) EnumDescriptor deprecated 

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

Deprecated: Use WebKeySettings_IntegrationType.Descriptor instead.

func (WebKeySettings_IntegrationType) Number 

func (x WebKeySettings_IntegrationType) Number() protoreflect.EnumNumber

func (WebKeySettings_IntegrationType) String 

func (x WebKeySettings_IntegrationType) String() string

func (WebKeySettings_IntegrationType) Type 

func (WebKeySettings_IntegrationType) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

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