Constants
WebRiskService_ComputeThreatListDiff_FullMethodName, WebRiskService_SearchUris_FullMethodName, WebRiskService_SearchHashes_FullMethodName, WebRiskService_CreateSubmission_FullMethodName, WebRiskService_SubmitUri_FullMethodName
const (
WebRiskService_ComputeThreatListDiff_FullMethodName = "/google.cloud.webrisk.v1.WebRiskService/ComputeThreatListDiff"
WebRiskService_SearchUris_FullMethodName = "/google.cloud.webrisk.v1.WebRiskService/SearchUris"
WebRiskService_SearchHashes_FullMethodName = "/google.cloud.webrisk.v1.WebRiskService/SearchHashes"
WebRiskService_CreateSubmission_FullMethodName = "/google.cloud.webrisk.v1.WebRiskService/CreateSubmission"
WebRiskService_SubmitUri_FullMethodName = "/google.cloud.webrisk.v1.WebRiskService/SubmitUri"
)Variables
ThreatType_name, ThreatType_value
var (
ThreatType_name = map[int32]string{
0: "THREAT_TYPE_UNSPECIFIED",
1: "MALWARE",
2: "SOCIAL_ENGINEERING",
3: "UNWANTED_SOFTWARE",
4: "SOCIAL_ENGINEERING_EXTENDED_COVERAGE",
}
ThreatType_value = map[string]int32{
"THREAT_TYPE_UNSPECIFIED": 0,
"MALWARE": 1,
"SOCIAL_ENGINEERING": 2,
"UNWANTED_SOFTWARE": 3,
"SOCIAL_ENGINEERING_EXTENDED_COVERAGE": 4,
}
)Enum value maps for ThreatType.
CompressionType_name, CompressionType_value
var (
CompressionType_name = map[int32]string{
0: "COMPRESSION_TYPE_UNSPECIFIED",
1: "RAW",
2: "RICE",
}
CompressionType_value = map[string]int32{
"COMPRESSION_TYPE_UNSPECIFIED": 0,
"RAW": 1,
"RICE": 2,
}
)Enum value maps for CompressionType.
ComputeThreatListDiffResponse_ResponseType_name, ComputeThreatListDiffResponse_ResponseType_value
var (
ComputeThreatListDiffResponse_ResponseType_name = map[int32]string{
0: "RESPONSE_TYPE_UNSPECIFIED",
1: "DIFF",
2: "RESET",
}
ComputeThreatListDiffResponse_ResponseType_value = map[string]int32{
"RESPONSE_TYPE_UNSPECIFIED": 0,
"DIFF": 1,
"RESET": 2,
}
)Enum value maps for ComputeThreatListDiffResponse_ResponseType.
ThreatInfo_AbuseType_name, ThreatInfo_AbuseType_value
var (
ThreatInfo_AbuseType_name = map[int32]string{
0: "ABUSE_TYPE_UNSPECIFIED",
1: "MALWARE",
2: "SOCIAL_ENGINEERING",
3: "UNWANTED_SOFTWARE",
}
ThreatInfo_AbuseType_value = map[string]int32{
"ABUSE_TYPE_UNSPECIFIED": 0,
"MALWARE": 1,
"SOCIAL_ENGINEERING": 2,
"UNWANTED_SOFTWARE": 3,
}
)Enum value maps for ThreatInfo_AbuseType.
ThreatInfo_Confidence_ConfidenceLevel_name, ThreatInfo_Confidence_ConfidenceLevel_value
var (
ThreatInfo_Confidence_ConfidenceLevel_name = map[int32]string{
0: "CONFIDENCE_LEVEL_UNSPECIFIED",
1: "LOW",
2: "MEDIUM",
3: "HIGH",
}
ThreatInfo_Confidence_ConfidenceLevel_value = map[string]int32{
"CONFIDENCE_LEVEL_UNSPECIFIED": 0,
"LOW": 1,
"MEDIUM": 2,
"HIGH": 3,
}
)Enum value maps for ThreatInfo_Confidence_ConfidenceLevel.
ThreatInfo_ThreatJustification_JustificationLabel_name, ThreatInfo_ThreatJustification_JustificationLabel_value
var (
ThreatInfo_ThreatJustification_JustificationLabel_name = map[int32]string{
0: "JUSTIFICATION_LABEL_UNSPECIFIED",
1: "MANUAL_VERIFICATION",
2: "USER_REPORT",
3: "AUTOMATED_REPORT",
}
ThreatInfo_ThreatJustification_JustificationLabel_value = map[string]int32{
"JUSTIFICATION_LABEL_UNSPECIFIED": 0,
"MANUAL_VERIFICATION": 1,
"USER_REPORT": 2,
"AUTOMATED_REPORT": 3,
}
)Enum value maps for ThreatInfo_ThreatJustification_JustificationLabel.
ThreatDiscovery_Platform_name, ThreatDiscovery_Platform_value
var (
ThreatDiscovery_Platform_name = map[int32]string{
0: "PLATFORM_UNSPECIFIED",
1: "ANDROID",
2: "IOS",
3: "MACOS",
4: "WINDOWS",
}
ThreatDiscovery_Platform_value = map[string]int32{
"PLATFORM_UNSPECIFIED": 0,
"ANDROID": 1,
"IOS": 2,
"MACOS": 3,
"WINDOWS": 4,
}
)Enum value maps for ThreatDiscovery_Platform.
SubmitUriMetadata_State_name, SubmitUriMetadata_State_value
var (
SubmitUriMetadata_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "RUNNING",
2: "SUCCEEDED",
3: "CANCELLED",
4: "FAILED",
5: "CLOSED",
}
SubmitUriMetadata_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"RUNNING": 1,
"SUCCEEDED": 2,
"CANCELLED": 3,
"FAILED": 4,
"CLOSED": 5,
}
)Enum value maps for SubmitUriMetadata_State.
File_google_cloud_webrisk_v1_webrisk_proto
var File_google_cloud_webrisk_v1_webrisk_proto protoreflect.FileDescriptorWebRiskService_ServiceDesc
var WebRiskService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.webrisk.v1.WebRiskService",
HandlerType: (*WebRiskServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ComputeThreatListDiff",
Handler: _WebRiskService_ComputeThreatListDiff_Handler,
},
{
MethodName: "SearchUris",
Handler: _WebRiskService_SearchUris_Handler,
},
{
MethodName: "SearchHashes",
Handler: _WebRiskService_SearchHashes_Handler,
},
{
MethodName: "CreateSubmission",
Handler: _WebRiskService_CreateSubmission_Handler,
},
{
MethodName: "SubmitUri",
Handler: _WebRiskService_SubmitUri_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/webrisk/v1/webrisk.proto",
}WebRiskService_ServiceDesc is the grpc.ServiceDesc for WebRiskService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterWebRiskServiceServer
func RegisterWebRiskServiceServer(s grpc.ServiceRegistrar, srv WebRiskServiceServer)CompressionType
type CompressionType int32The ways in which threat entry sets can be compressed.
CompressionType_COMPRESSION_TYPE_UNSPECIFIED, CompressionType_RAW, CompressionType_RICE
const (
// Unknown.
CompressionType_COMPRESSION_TYPE_UNSPECIFIED CompressionType = 0
// Raw, uncompressed data.
CompressionType_RAW CompressionType = 1
// Rice-Golomb encoded data.
CompressionType_RICE CompressionType = 2
)func (CompressionType) Descriptor
func (CompressionType) Descriptor() protoreflect.EnumDescriptorfunc (CompressionType) Enum
func (x CompressionType) Enum() *CompressionTypefunc (CompressionType) EnumDescriptor
func (CompressionType) EnumDescriptor() ([]byte, []int)Deprecated: Use CompressionType.Descriptor instead.
func (CompressionType) Number
func (x CompressionType) Number() protoreflect.EnumNumberfunc (CompressionType) String
func (x CompressionType) String() stringfunc (CompressionType) Type
func (CompressionType) Type() protoreflect.EnumTypeComputeThreatListDiffRequest
type ComputeThreatListDiffRequest struct {
// Required. The threat list to update. Only a single ThreatType should be
// specified per request. If you want to handle multiple ThreatTypes, you must
// make one request per ThreatType.
ThreatType ThreatType `protobuf:"varint,1,opt,name=threat_type,json=threatType,proto3,enum=google.cloud.webrisk.v1.ThreatType" json:"threat_type,omitempty"`
// The current version token of the client for the requested list (the
// client version that was received from the last successful diff).
// If the client does not have a version token (this is the first time calling
// ComputeThreatListDiff), this may be left empty and a full database
// snapshot will be returned.
VersionToken []byte `protobuf:"bytes,2,opt,name=version_token,json=versionToken,proto3" json:"version_token,omitempty"`
// Required. The constraints associated with this request.
Constraints *ComputeThreatListDiffRequest_Constraints `protobuf:"bytes,3,opt,name=constraints,proto3" json:"constraints,omitempty"`
// contains filtered or unexported fields
}Describes an API diff request.
func (*ComputeThreatListDiffRequest) Descriptor
func (*ComputeThreatListDiffRequest) Descriptor() ([]byte, []int)Deprecated: Use ComputeThreatListDiffRequest.ProtoReflect.Descriptor instead.
func (*ComputeThreatListDiffRequest) GetConstraints
func (x *ComputeThreatListDiffRequest) GetConstraints() *ComputeThreatListDiffRequest_Constraintsfunc (*ComputeThreatListDiffRequest) GetThreatType
func (x *ComputeThreatListDiffRequest) GetThreatType() ThreatTypefunc (*ComputeThreatListDiffRequest) GetVersionToken
func (x *ComputeThreatListDiffRequest) GetVersionToken() []bytefunc (*ComputeThreatListDiffRequest) ProtoMessage
func (*ComputeThreatListDiffRequest) ProtoMessage()func (*ComputeThreatListDiffRequest) ProtoReflect
func (x *ComputeThreatListDiffRequest) ProtoReflect() protoreflect.Messagefunc (*ComputeThreatListDiffRequest) Reset
func (x *ComputeThreatListDiffRequest) Reset()func (*ComputeThreatListDiffRequest) String
func (x *ComputeThreatListDiffRequest) String() stringComputeThreatListDiffRequest_Constraints
type ComputeThreatListDiffRequest_Constraints struct {
// The maximum size in number of entries. The diff will not contain more
// entries than this value. This should be a power of 2 between 2**10 and
// 2**20. If zero, no diff size limit is set.
MaxDiffEntries int32 `protobuf:"varint,1,opt,name=max_diff_entries,json=maxDiffEntries,proto3" json:"max_diff_entries,omitempty"`
// Sets the maximum number of entries that the client is willing to have
// in the local database. This should be a power of 2 between 2**10 and
// 2**20. If zero, no database size limit is set.
MaxDatabaseEntries int32 `protobuf:"varint,2,opt,name=max_database_entries,json=maxDatabaseEntries,proto3" json:"max_database_entries,omitempty"`
// The compression types supported by the client.
SupportedCompressions []CompressionType `protobuf:"varint,3,rep,packed,name=supported_compressions,json=supportedCompressions,proto3,enum=google.cloud.webrisk.v1.CompressionType" json:"supported_compressions,omitempty"`
// contains filtered or unexported fields
}The constraints for this diff.
func (*ComputeThreatListDiffRequest_Constraints) Descriptor
func (*ComputeThreatListDiffRequest_Constraints) Descriptor() ([]byte, []int)Deprecated: Use ComputeThreatListDiffRequest_Constraints.ProtoReflect.Descriptor instead.
func (*ComputeThreatListDiffRequest_Constraints) GetMaxDatabaseEntries
func (x *ComputeThreatListDiffRequest_Constraints) GetMaxDatabaseEntries() int32func (*ComputeThreatListDiffRequest_Constraints) GetMaxDiffEntries
func (x *ComputeThreatListDiffRequest_Constraints) GetMaxDiffEntries() int32func (*ComputeThreatListDiffRequest_Constraints) GetSupportedCompressions
func (x *ComputeThreatListDiffRequest_Constraints) GetSupportedCompressions() []CompressionTypefunc (*ComputeThreatListDiffRequest_Constraints) ProtoMessage
func (*ComputeThreatListDiffRequest_Constraints) ProtoMessage()func (*ComputeThreatListDiffRequest_Constraints) ProtoReflect
func (x *ComputeThreatListDiffRequest_Constraints) ProtoReflect() protoreflect.Messagefunc (*ComputeThreatListDiffRequest_Constraints) Reset
func (x *ComputeThreatListDiffRequest_Constraints) Reset()func (*ComputeThreatListDiffRequest_Constraints) String
func (x *ComputeThreatListDiffRequest_Constraints) String() stringComputeThreatListDiffResponse
type ComputeThreatListDiffResponse struct {
// The type of response. This may indicate that an action must be taken by the
// client when the response is received.
ResponseType ComputeThreatListDiffResponse_ResponseType `protobuf:"varint,4,opt,name=response_type,json=responseType,proto3,enum=google.cloud.webrisk.v1.ComputeThreatListDiffResponse_ResponseType" json:"response_type,omitempty"`
// A set of entries to add to a local threat type's list.
Additions *ThreatEntryAdditions `protobuf:"bytes,5,opt,name=additions,proto3" json:"additions,omitempty"`
// A set of entries to remove from a local threat type's list.
// This field may be empty.
Removals *ThreatEntryRemovals `protobuf:"bytes,6,opt,name=removals,proto3" json:"removals,omitempty"`
// The new opaque client version token. This should be retained by the client
// and passed into the next call of ComputeThreatListDiff as 'version_token'.
// A separate version token should be stored and used for each threatList.
NewVersionToken []byte `protobuf:"bytes,7,opt,name=new_version_token,json=newVersionToken,proto3" json:"new_version_token,omitempty"`
// The expected SHA256 hash of the client state; that is, of the sorted list
// of all hashes present in the database after applying the provided diff.
// If the client state doesn't match the expected state, the client must
// discard this diff and retry later.
Checksum *ComputeThreatListDiffResponse_Checksum `protobuf:"bytes,8,opt,name=checksum,proto3" json:"checksum,omitempty"`
// The soonest the client should wait before issuing any diff
// request. Querying sooner is unlikely to produce a meaningful diff.
// Waiting longer is acceptable considering the use case.
// If this field is not set clients may update as soon as they want.
RecommendedNextDiff *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=recommended_next_diff,json=recommendedNextDiff,proto3" json:"recommended_next_diff,omitempty"`
// contains filtered or unexported fields
}func (*ComputeThreatListDiffResponse) Descriptor
func (*ComputeThreatListDiffResponse) Descriptor() ([]byte, []int)Deprecated: Use ComputeThreatListDiffResponse.ProtoReflect.Descriptor instead.
func (*ComputeThreatListDiffResponse) GetAdditions
func (x *ComputeThreatListDiffResponse) GetAdditions() *ThreatEntryAdditionsfunc (*ComputeThreatListDiffResponse) GetChecksum
func (x *ComputeThreatListDiffResponse) GetChecksum() *ComputeThreatListDiffResponse_Checksumfunc (*ComputeThreatListDiffResponse) GetNewVersionToken
func (x *ComputeThreatListDiffResponse) GetNewVersionToken() []bytefunc (*ComputeThreatListDiffResponse) GetRecommendedNextDiff
func (x *ComputeThreatListDiffResponse) GetRecommendedNextDiff() *timestamppb.Timestampfunc (*ComputeThreatListDiffResponse) GetRemovals
func (x *ComputeThreatListDiffResponse) GetRemovals() *ThreatEntryRemovalsfunc (*ComputeThreatListDiffResponse) GetResponseType
func (x *ComputeThreatListDiffResponse) GetResponseType() ComputeThreatListDiffResponse_ResponseTypefunc (*ComputeThreatListDiffResponse) ProtoMessage
func (*ComputeThreatListDiffResponse) ProtoMessage()func (*ComputeThreatListDiffResponse) ProtoReflect
func (x *ComputeThreatListDiffResponse) ProtoReflect() protoreflect.Messagefunc (*ComputeThreatListDiffResponse) Reset
func (x *ComputeThreatListDiffResponse) Reset()func (*ComputeThreatListDiffResponse) String
func (x *ComputeThreatListDiffResponse) String() stringComputeThreatListDiffResponse_Checksum
type ComputeThreatListDiffResponse_Checksum struct {
// The SHA256 hash of the client state; that is, of the sorted list of all
// hashes present in the database.
Sha256 []byte `protobuf:"bytes,1,opt,name=sha256,proto3" json:"sha256,omitempty"`
// contains filtered or unexported fields
}The expected state of a client's local database.
func (*ComputeThreatListDiffResponse_Checksum) Descriptor
func (*ComputeThreatListDiffResponse_Checksum) Descriptor() ([]byte, []int)Deprecated: Use ComputeThreatListDiffResponse_Checksum.ProtoReflect.Descriptor instead.
func (*ComputeThreatListDiffResponse_Checksum) GetSha256
func (x *ComputeThreatListDiffResponse_Checksum) GetSha256() []bytefunc (*ComputeThreatListDiffResponse_Checksum) ProtoMessage
func (*ComputeThreatListDiffResponse_Checksum) ProtoMessage()func (*ComputeThreatListDiffResponse_Checksum) ProtoReflect
func (x *ComputeThreatListDiffResponse_Checksum) ProtoReflect() protoreflect.Messagefunc (*ComputeThreatListDiffResponse_Checksum) Reset
func (x *ComputeThreatListDiffResponse_Checksum) Reset()func (*ComputeThreatListDiffResponse_Checksum) String
func (x *ComputeThreatListDiffResponse_Checksum) String() stringComputeThreatListDiffResponse_ResponseType
type ComputeThreatListDiffResponse_ResponseType int32The type of response sent to the client.
ComputeThreatListDiffResponse_RESPONSE_TYPE_UNSPECIFIED, ComputeThreatListDiffResponse_DIFF, ComputeThreatListDiffResponse_RESET
const (
// Unknown.
ComputeThreatListDiffResponse_RESPONSE_TYPE_UNSPECIFIED ComputeThreatListDiffResponse_ResponseType = 0
// Partial updates are applied to the client's existing local database.
ComputeThreatListDiffResponse_DIFF ComputeThreatListDiffResponse_ResponseType = 1
// Full updates resets the client's entire local database. This means
// that either the client had no state, was seriously out-of-date,
// or the client is believed to be corrupt.
ComputeThreatListDiffResponse_RESET ComputeThreatListDiffResponse_ResponseType = 2
)func (ComputeThreatListDiffResponse_ResponseType) Descriptor
func (ComputeThreatListDiffResponse_ResponseType) Descriptor() protoreflect.EnumDescriptorfunc (ComputeThreatListDiffResponse_ResponseType) Enum
func (x ComputeThreatListDiffResponse_ResponseType) Enum() *ComputeThreatListDiffResponse_ResponseTypefunc (ComputeThreatListDiffResponse_ResponseType) EnumDescriptor
func (ComputeThreatListDiffResponse_ResponseType) EnumDescriptor() ([]byte, []int)Deprecated: Use ComputeThreatListDiffResponse_ResponseType.Descriptor instead.
func (ComputeThreatListDiffResponse_ResponseType) Number
func (x ComputeThreatListDiffResponse_ResponseType) Number() protoreflect.EnumNumberfunc (ComputeThreatListDiffResponse_ResponseType) String
func (x ComputeThreatListDiffResponse_ResponseType) String() stringfunc (ComputeThreatListDiffResponse_ResponseType) Type
func (ComputeThreatListDiffResponse_ResponseType) Type() protoreflect.EnumTypeCreateSubmissionRequest
type CreateSubmissionRequest struct {
// Required. The name of the project that is making the submission. This
// string is in the format "projects/{project_number}".
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The submission that contains the content of the phishing report.
Submission *Submission `protobuf:"bytes,2,opt,name=submission,proto3" json:"submission,omitempty"`
// contains filtered or unexported fields
}Request to send a potentially phishy URI to WebRisk.
func (*CreateSubmissionRequest) Descriptor
func (*CreateSubmissionRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSubmissionRequest.ProtoReflect.Descriptor instead.
func (*CreateSubmissionRequest) GetParent
func (x *CreateSubmissionRequest) GetParent() stringfunc (*CreateSubmissionRequest) GetSubmission
func (x *CreateSubmissionRequest) GetSubmission() *Submissionfunc (*CreateSubmissionRequest) ProtoMessage
func (*CreateSubmissionRequest) ProtoMessage()func (*CreateSubmissionRequest) ProtoReflect
func (x *CreateSubmissionRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSubmissionRequest) Reset
func (x *CreateSubmissionRequest) Reset()func (*CreateSubmissionRequest) String
func (x *CreateSubmissionRequest) String() stringRawHashes
type RawHashes struct {
// The number of bytes for each prefix encoded below. This field can be
// anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
// In practice this is almost always 4, except in exceptional circumstances.
PrefixSize int32 `protobuf:"varint,1,opt,name=prefix_size,json=prefixSize,proto3" json:"prefix_size,omitempty"`
// The hashes, in binary format, concatenated into one long string. Hashes are
// sorted in lexicographic order. For JSON API users, hashes are
// base64-encoded.
RawHashes []byte `protobuf:"bytes,2,opt,name=raw_hashes,json=rawHashes,proto3" json:"raw_hashes,omitempty"`
// contains filtered or unexported fields
}The uncompressed threat entries in hash format. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URI.
Used for sending ThreatEntryAdditons to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression.
func (*RawHashes) Descriptor
Deprecated: Use RawHashes.ProtoReflect.Descriptor instead.
func (*RawHashes) GetPrefixSize
func (*RawHashes) GetRawHashes
func (*RawHashes) ProtoMessage
func (*RawHashes) ProtoMessage()func (*RawHashes) ProtoReflect
func (x *RawHashes) ProtoReflect() protoreflect.Messagefunc (*RawHashes) Reset
func (x *RawHashes) Reset()func (*RawHashes) String
RawIndices
type RawIndices struct {
// The indices to remove from a lexicographically-sorted local list.
Indices []int32 `protobuf:"varint,1,rep,packed,name=indices,proto3" json:"indices,omitempty"`
// contains filtered or unexported fields
}A set of raw indices to remove from a local list.
func (*RawIndices) Descriptor
func (*RawIndices) Descriptor() ([]byte, []int)Deprecated: Use RawIndices.ProtoReflect.Descriptor instead.
func (*RawIndices) GetIndices
func (x *RawIndices) GetIndices() []int32func (*RawIndices) ProtoMessage
func (*RawIndices) ProtoMessage()func (*RawIndices) ProtoReflect
func (x *RawIndices) ProtoReflect() protoreflect.Messagefunc (*RawIndices) Reset
func (x *RawIndices) Reset()func (*RawIndices) String
func (x *RawIndices) String() stringRiceDeltaEncoding
type RiceDeltaEncoding struct {
// The offset of the first entry in the encoded data, or, if only a single
// integer was encoded, that single integer's value. If the field is empty or
// missing, assume zero.
FirstValue int64 `protobuf:"varint,1,opt,name=first_value,json=firstValue,proto3" json:"first_value,omitempty"`
// The Golomb-Rice parameter, which is a number between 2 and 28. This field
// is missing (that is, zero) if `num_entries` is zero.
RiceParameter int32 `protobuf:"varint,2,opt,name=rice_parameter,json=riceParameter,proto3" json:"rice_parameter,omitempty"`
// The number of entries that are delta encoded in the encoded data. If only a
// single integer was encoded, this will be zero and the single value will be
// stored in `first_value`.
EntryCount int32 `protobuf:"varint,3,opt,name=entry_count,json=entryCount,proto3" json:"entry_count,omitempty"`
// The encoded deltas that are encoded using the Golomb-Rice coder.
EncodedData []byte `protobuf:"bytes,4,opt,name=encoded_data,json=encodedData,proto3" json:"encoded_data,omitempty"`
// contains filtered or unexported fields
}The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.
func (*RiceDeltaEncoding) Descriptor
func (*RiceDeltaEncoding) Descriptor() ([]byte, []int)Deprecated: Use RiceDeltaEncoding.ProtoReflect.Descriptor instead.
func (*RiceDeltaEncoding) GetEncodedData
func (x *RiceDeltaEncoding) GetEncodedData() []bytefunc (*RiceDeltaEncoding) GetEntryCount
func (x *RiceDeltaEncoding) GetEntryCount() int32func (*RiceDeltaEncoding) GetFirstValue
func (x *RiceDeltaEncoding) GetFirstValue() int64func (*RiceDeltaEncoding) GetRiceParameter
func (x *RiceDeltaEncoding) GetRiceParameter() int32func (*RiceDeltaEncoding) ProtoMessage
func (*RiceDeltaEncoding) ProtoMessage()func (*RiceDeltaEncoding) ProtoReflect
func (x *RiceDeltaEncoding) ProtoReflect() protoreflect.Messagefunc (*RiceDeltaEncoding) Reset
func (x *RiceDeltaEncoding) Reset()func (*RiceDeltaEncoding) String
func (x *RiceDeltaEncoding) String() stringSearchHashesRequest
type SearchHashesRequest struct {
// A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
// hash. For JSON requests, this field is base64-encoded.
// Note that if this parameter is provided by a URI, it must be encoded using
// the web safe base64 variant (RFC 4648).
HashPrefix []byte `protobuf:"bytes,1,opt,name=hash_prefix,json=hashPrefix,proto3" json:"hash_prefix,omitempty"`
// Required. The ThreatLists to search in. Multiple ThreatLists may be
// specified.
ThreatTypes []ThreatType `protobuf:"varint,2,rep,packed,name=threat_types,json=threatTypes,proto3,enum=google.cloud.webrisk.v1.ThreatType" json:"threat_types,omitempty"`
// contains filtered or unexported fields
}Request to return full hashes matched by the provided hash prefixes.
func (*SearchHashesRequest) Descriptor
func (*SearchHashesRequest) Descriptor() ([]byte, []int)Deprecated: Use SearchHashesRequest.ProtoReflect.Descriptor instead.
func (*SearchHashesRequest) GetHashPrefix
func (x *SearchHashesRequest) GetHashPrefix() []bytefunc (*SearchHashesRequest) GetThreatTypes
func (x *SearchHashesRequest) GetThreatTypes() []ThreatTypefunc (*SearchHashesRequest) ProtoMessage
func (*SearchHashesRequest) ProtoMessage()func (*SearchHashesRequest) ProtoReflect
func (x *SearchHashesRequest) ProtoReflect() protoreflect.Messagefunc (*SearchHashesRequest) Reset
func (x *SearchHashesRequest) Reset()func (*SearchHashesRequest) String
func (x *SearchHashesRequest) String() stringSearchHashesResponse
type SearchHashesResponse struct {
// The full hashes that matched the requested prefixes.
// The hash will be populated in the key.
Threats []*SearchHashesResponse_ThreatHash `protobuf:"bytes,1,rep,name=threats,proto3" json:"threats,omitempty"`
// For requested entities that did not match the threat list, how long to
// cache the response until.
NegativeExpireTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=negative_expire_time,json=negativeExpireTime,proto3" json:"negative_expire_time,omitempty"`
// contains filtered or unexported fields
}func (*SearchHashesResponse) Descriptor
func (*SearchHashesResponse) Descriptor() ([]byte, []int)Deprecated: Use SearchHashesResponse.ProtoReflect.Descriptor instead.
func (*SearchHashesResponse) GetNegativeExpireTime
func (x *SearchHashesResponse) GetNegativeExpireTime() *timestamppb.Timestampfunc (*SearchHashesResponse) GetThreats
func (x *SearchHashesResponse) GetThreats() []*SearchHashesResponse_ThreatHashfunc (*SearchHashesResponse) ProtoMessage
func (*SearchHashesResponse) ProtoMessage()func (*SearchHashesResponse) ProtoReflect
func (x *SearchHashesResponse) ProtoReflect() protoreflect.Messagefunc (*SearchHashesResponse) Reset
func (x *SearchHashesResponse) Reset()func (*SearchHashesResponse) String
func (x *SearchHashesResponse) String() stringSearchHashesResponse_ThreatHash
type SearchHashesResponse_ThreatHash struct {
// The ThreatList this threat belongs to.
// This must contain at least one entry.
ThreatTypes []ThreatType `protobuf:"varint,1,rep,packed,name=threat_types,json=threatTypes,proto3,enum=google.cloud.webrisk.v1.ThreatType" json:"threat_types,omitempty"`
// A 32 byte SHA256 hash. This field is in binary format. For JSON
// requests, hashes are base64-encoded.
Hash []byte `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"`
// The cache lifetime for the returned match. Clients must not cache this
// response past this timestamp to avoid false positives.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}Contains threat information on a matching hash.
func (*SearchHashesResponse_ThreatHash) Descriptor
func (*SearchHashesResponse_ThreatHash) Descriptor() ([]byte, []int)Deprecated: Use SearchHashesResponse_ThreatHash.ProtoReflect.Descriptor instead.
func (*SearchHashesResponse_ThreatHash) GetExpireTime
func (x *SearchHashesResponse_ThreatHash) GetExpireTime() *timestamppb.Timestampfunc (*SearchHashesResponse_ThreatHash) GetHash
func (x *SearchHashesResponse_ThreatHash) GetHash() []bytefunc (*SearchHashesResponse_ThreatHash) GetThreatTypes
func (x *SearchHashesResponse_ThreatHash) GetThreatTypes() []ThreatTypefunc (*SearchHashesResponse_ThreatHash) ProtoMessage
func (*SearchHashesResponse_ThreatHash) ProtoMessage()func (*SearchHashesResponse_ThreatHash) ProtoReflect
func (x *SearchHashesResponse_ThreatHash) ProtoReflect() protoreflect.Messagefunc (*SearchHashesResponse_ThreatHash) Reset
func (x *SearchHashesResponse_ThreatHash) Reset()func (*SearchHashesResponse_ThreatHash) String
func (x *SearchHashesResponse_ThreatHash) String() stringSearchUrisRequest
type SearchUrisRequest struct {
// Required. The URI to be checked for matches.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Required. The ThreatLists to search in. Multiple ThreatLists may be
// specified.
ThreatTypes []ThreatType `protobuf:"varint,2,rep,packed,name=threat_types,json=threatTypes,proto3,enum=google.cloud.webrisk.v1.ThreatType" json:"threat_types,omitempty"`
// contains filtered or unexported fields
}Request to check URI entries against threatLists.
func (*SearchUrisRequest) Descriptor
func (*SearchUrisRequest) Descriptor() ([]byte, []int)Deprecated: Use SearchUrisRequest.ProtoReflect.Descriptor instead.
func (*SearchUrisRequest) GetThreatTypes
func (x *SearchUrisRequest) GetThreatTypes() []ThreatTypefunc (*SearchUrisRequest) GetUri
func (x *SearchUrisRequest) GetUri() stringfunc (*SearchUrisRequest) ProtoMessage
func (*SearchUrisRequest) ProtoMessage()func (*SearchUrisRequest) ProtoReflect
func (x *SearchUrisRequest) ProtoReflect() protoreflect.Messagefunc (*SearchUrisRequest) Reset
func (x *SearchUrisRequest) Reset()func (*SearchUrisRequest) String
func (x *SearchUrisRequest) String() stringSearchUrisResponse
type SearchUrisResponse struct {
// The threat list matches. This might be empty if the URI is on no list.
Threat *SearchUrisResponse_ThreatUri `protobuf:"bytes,1,opt,name=threat,proto3" json:"threat,omitempty"`
// contains filtered or unexported fields
}func (*SearchUrisResponse) Descriptor
func (*SearchUrisResponse) Descriptor() ([]byte, []int)Deprecated: Use SearchUrisResponse.ProtoReflect.Descriptor instead.
func (*SearchUrisResponse) GetThreat
func (x *SearchUrisResponse) GetThreat() *SearchUrisResponse_ThreatUrifunc (*SearchUrisResponse) ProtoMessage
func (*SearchUrisResponse) ProtoMessage()func (*SearchUrisResponse) ProtoReflect
func (x *SearchUrisResponse) ProtoReflect() protoreflect.Messagefunc (*SearchUrisResponse) Reset
func (x *SearchUrisResponse) Reset()func (*SearchUrisResponse) String
func (x *SearchUrisResponse) String() stringSearchUrisResponse_ThreatUri
type SearchUrisResponse_ThreatUri struct {
// The ThreatList this threat belongs to.
ThreatTypes []ThreatType `protobuf:"varint,1,rep,packed,name=threat_types,json=threatTypes,proto3,enum=google.cloud.webrisk.v1.ThreatType" json:"threat_types,omitempty"`
// The cache lifetime for the returned match. Clients must not cache this
// response past this timestamp to avoid false positives.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}Contains threat information on a matching uri.
func (*SearchUrisResponse_ThreatUri) Descriptor
func (*SearchUrisResponse_ThreatUri) Descriptor() ([]byte, []int)Deprecated: Use SearchUrisResponse_ThreatUri.ProtoReflect.Descriptor instead.
func (*SearchUrisResponse_ThreatUri) GetExpireTime
func (x *SearchUrisResponse_ThreatUri) GetExpireTime() *timestamppb.Timestampfunc (*SearchUrisResponse_ThreatUri) GetThreatTypes
func (x *SearchUrisResponse_ThreatUri) GetThreatTypes() []ThreatTypefunc (*SearchUrisResponse_ThreatUri) ProtoMessage
func (*SearchUrisResponse_ThreatUri) ProtoMessage()func (*SearchUrisResponse_ThreatUri) ProtoReflect
func (x *SearchUrisResponse_ThreatUri) ProtoReflect() protoreflect.Messagefunc (*SearchUrisResponse_ThreatUri) Reset
func (x *SearchUrisResponse_ThreatUri) Reset()func (*SearchUrisResponse_ThreatUri) String
func (x *SearchUrisResponse_ThreatUri) String() stringSubmission
type Submission struct {
// Required. The URI that is being reported for malicious content to be
// analyzed.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Output only. ThreatTypes found to be associated with the submitted URI
// after reviewing it. This might be empty if the URI was not added to any
// list.
ThreatTypes []ThreatType `protobuf:"varint,2,rep,packed,name=threat_types,json=threatTypes,proto3,enum=google.cloud.webrisk.v1.ThreatType" json:"threat_types,omitempty"`
// contains filtered or unexported fields
}Wraps a URI that might be displaying malicious content.
func (*Submission) Descriptor
func (*Submission) Descriptor() ([]byte, []int)Deprecated: Use Submission.ProtoReflect.Descriptor instead.
func (*Submission) GetThreatTypes
func (x *Submission) GetThreatTypes() []ThreatTypefunc (*Submission) GetUri
func (x *Submission) GetUri() stringfunc (*Submission) ProtoMessage
func (*Submission) ProtoMessage()func (*Submission) ProtoReflect
func (x *Submission) ProtoReflect() protoreflect.Messagefunc (*Submission) Reset
func (x *Submission) Reset()func (*Submission) String
func (x *Submission) String() stringSubmitUriMetadata
type SubmitUriMetadata struct {
// The state of the operation.
State SubmitUriMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.webrisk.v1.SubmitUriMetadata_State" json:"state,omitempty"`
// Creation time of the operation.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Latest update time of the operation.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata for the Submit URI long-running operation.
func (*SubmitUriMetadata) Descriptor
func (*SubmitUriMetadata) Descriptor() ([]byte, []int)Deprecated: Use SubmitUriMetadata.ProtoReflect.Descriptor instead.
func (*SubmitUriMetadata) GetCreateTime
func (x *SubmitUriMetadata) GetCreateTime() *timestamppb.Timestampfunc (*SubmitUriMetadata) GetState
func (x *SubmitUriMetadata) GetState() SubmitUriMetadata_Statefunc (*SubmitUriMetadata) GetUpdateTime
func (x *SubmitUriMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*SubmitUriMetadata) ProtoMessage
func (*SubmitUriMetadata) ProtoMessage()func (*SubmitUriMetadata) ProtoReflect
func (x *SubmitUriMetadata) ProtoReflect() protoreflect.Messagefunc (*SubmitUriMetadata) Reset
func (x *SubmitUriMetadata) Reset()func (*SubmitUriMetadata) String
func (x *SubmitUriMetadata) String() stringSubmitUriMetadata_State
type SubmitUriMetadata_State int32Enum that represents the state of the long-running operation.
SubmitUriMetadata_STATE_UNSPECIFIED, SubmitUriMetadata_RUNNING, SubmitUriMetadata_SUCCEEDED, SubmitUriMetadata_CANCELLED, SubmitUriMetadata_FAILED, SubmitUriMetadata_CLOSED
const (
// Default unspecified state.
SubmitUriMetadata_STATE_UNSPECIFIED SubmitUriMetadata_State = 0
// The operation is currently running.
SubmitUriMetadata_RUNNING SubmitUriMetadata_State = 1
// The operation finished with a success status.
SubmitUriMetadata_SUCCEEDED SubmitUriMetadata_State = 2
// The operation was cancelled.
SubmitUriMetadata_CANCELLED SubmitUriMetadata_State = 3
// The operation finished with a failure status.
SubmitUriMetadata_FAILED SubmitUriMetadata_State = 4
// The operation was closed with no action taken.
SubmitUriMetadata_CLOSED SubmitUriMetadata_State = 5
)func (SubmitUriMetadata_State) Descriptor
func (SubmitUriMetadata_State) Descriptor() protoreflect.EnumDescriptorfunc (SubmitUriMetadata_State) Enum
func (x SubmitUriMetadata_State) Enum() *SubmitUriMetadata_Statefunc (SubmitUriMetadata_State) EnumDescriptor
func (SubmitUriMetadata_State) EnumDescriptor() ([]byte, []int)Deprecated: Use SubmitUriMetadata_State.Descriptor instead.
func (SubmitUriMetadata_State) Number
func (x SubmitUriMetadata_State) Number() protoreflect.EnumNumberfunc (SubmitUriMetadata_State) String
func (x SubmitUriMetadata_State) String() stringfunc (SubmitUriMetadata_State) Type
func (SubmitUriMetadata_State) Type() protoreflect.EnumTypeSubmitUriRequest
type SubmitUriRequest struct {
// Required. The name of the project that is making the submission. This
// string is in the format "projects/{project_number}".
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The submission that contains the URI to be scanned.
Submission *Submission `protobuf:"bytes,2,opt,name=submission,proto3" json:"submission,omitempty"`
// Provides additional information about the submission.
ThreatInfo *ThreatInfo `protobuf:"bytes,3,opt,name=threat_info,json=threatInfo,proto3" json:"threat_info,omitempty"`
// Provides additional information about how the submission was discovered.
ThreatDiscovery *ThreatDiscovery `protobuf:"bytes,4,opt,name=threat_discovery,json=threatDiscovery,proto3" json:"threat_discovery,omitempty"`
// contains filtered or unexported fields
}Request to send a potentially malicious URI to WebRisk.
func (*SubmitUriRequest) Descriptor
func (*SubmitUriRequest) Descriptor() ([]byte, []int)Deprecated: Use SubmitUriRequest.ProtoReflect.Descriptor instead.
func (*SubmitUriRequest) GetParent
func (x *SubmitUriRequest) GetParent() stringfunc (*SubmitUriRequest) GetSubmission
func (x *SubmitUriRequest) GetSubmission() *Submissionfunc (*SubmitUriRequest) GetThreatDiscovery
func (x *SubmitUriRequest) GetThreatDiscovery() *ThreatDiscoveryfunc (*SubmitUriRequest) GetThreatInfo
func (x *SubmitUriRequest) GetThreatInfo() *ThreatInfofunc (*SubmitUriRequest) ProtoMessage
func (*SubmitUriRequest) ProtoMessage()func (*SubmitUriRequest) ProtoReflect
func (x *SubmitUriRequest) ProtoReflect() protoreflect.Messagefunc (*SubmitUriRequest) Reset
func (x *SubmitUriRequest) Reset()func (*SubmitUriRequest) String
func (x *SubmitUriRequest) String() stringThreatDiscovery
type ThreatDiscovery struct {
// Platform on which the threat was discovered.
Platform ThreatDiscovery_Platform `protobuf:"varint,1,opt,name=platform,proto3,enum=google.cloud.webrisk.v1.ThreatDiscovery_Platform" json:"platform,omitempty"`
// CLDR region code of the countries/regions the URI poses a threat ordered
// from most impact to least impact. Example: "US" for United States.
RegionCodes []string `protobuf:"bytes,2,rep,name=region_codes,json=regionCodes,proto3" json:"region_codes,omitempty"`
// contains filtered or unexported fields
}Details about how the threat was discovered.
func (*ThreatDiscovery) Descriptor
func (*ThreatDiscovery) Descriptor() ([]byte, []int)Deprecated: Use ThreatDiscovery.ProtoReflect.Descriptor instead.
func (*ThreatDiscovery) GetPlatform
func (x *ThreatDiscovery) GetPlatform() ThreatDiscovery_Platformfunc (*ThreatDiscovery) GetRegionCodes
func (x *ThreatDiscovery) GetRegionCodes() []stringfunc (*ThreatDiscovery) ProtoMessage
func (*ThreatDiscovery) ProtoMessage()func (*ThreatDiscovery) ProtoReflect
func (x *ThreatDiscovery) ProtoReflect() protoreflect.Messagefunc (*ThreatDiscovery) Reset
func (x *ThreatDiscovery) Reset()func (*ThreatDiscovery) String
func (x *ThreatDiscovery) String() stringThreatDiscovery_Platform
type ThreatDiscovery_Platform int32Platform types.
ThreatDiscovery_PLATFORM_UNSPECIFIED, ThreatDiscovery_ANDROID, ThreatDiscovery_IOS, ThreatDiscovery_MACOS, ThreatDiscovery_WINDOWS
const (
// Default.
ThreatDiscovery_PLATFORM_UNSPECIFIED ThreatDiscovery_Platform = 0
// General Android platform.
ThreatDiscovery_ANDROID ThreatDiscovery_Platform = 1
// General iOS platform.
ThreatDiscovery_IOS ThreatDiscovery_Platform = 2
// General macOS platform.
ThreatDiscovery_MACOS ThreatDiscovery_Platform = 3
// General Windows platform.
ThreatDiscovery_WINDOWS ThreatDiscovery_Platform = 4
)func (ThreatDiscovery_Platform) Descriptor
func (ThreatDiscovery_Platform) Descriptor() protoreflect.EnumDescriptorfunc (ThreatDiscovery_Platform) Enum
func (x ThreatDiscovery_Platform) Enum() *ThreatDiscovery_Platformfunc (ThreatDiscovery_Platform) EnumDescriptor
func (ThreatDiscovery_Platform) EnumDescriptor() ([]byte, []int)Deprecated: Use ThreatDiscovery_Platform.Descriptor instead.
func (ThreatDiscovery_Platform) Number
func (x ThreatDiscovery_Platform) Number() protoreflect.EnumNumberfunc (ThreatDiscovery_Platform) String
func (x ThreatDiscovery_Platform) String() stringfunc (ThreatDiscovery_Platform) Type
func (ThreatDiscovery_Platform) Type() protoreflect.EnumTypeThreatEntryAdditions
type ThreatEntryAdditions struct {
// The raw SHA256-formatted entries.
// Repeated to allow returning sets of hashes with different prefix sizes.
RawHashes []*RawHashes `protobuf:"bytes,1,rep,name=raw_hashes,json=rawHashes,proto3" json:"raw_hashes,omitempty"`
// The encoded 4-byte prefixes of SHA256-formatted entries, using a
// Golomb-Rice encoding. The hashes are converted to uint32, sorted in
// ascending order, then delta encoded and stored as encoded_data.
RiceHashes *RiceDeltaEncoding `protobuf:"bytes,2,opt,name=rice_hashes,json=riceHashes,proto3" json:"rice_hashes,omitempty"`
// contains filtered or unexported fields
}Contains the set of entries to add to a local database. May contain a combination of compressed and raw data in a single response.
func (*ThreatEntryAdditions) Descriptor
func (*ThreatEntryAdditions) Descriptor() ([]byte, []int)Deprecated: Use ThreatEntryAdditions.ProtoReflect.Descriptor instead.
func (*ThreatEntryAdditions) GetRawHashes
func (x *ThreatEntryAdditions) GetRawHashes() []*RawHashesfunc (*ThreatEntryAdditions) GetRiceHashes
func (x *ThreatEntryAdditions) GetRiceHashes() *RiceDeltaEncodingfunc (*ThreatEntryAdditions) ProtoMessage
func (*ThreatEntryAdditions) ProtoMessage()func (*ThreatEntryAdditions) ProtoReflect
func (x *ThreatEntryAdditions) ProtoReflect() protoreflect.Messagefunc (*ThreatEntryAdditions) Reset
func (x *ThreatEntryAdditions) Reset()func (*ThreatEntryAdditions) String
func (x *ThreatEntryAdditions) String() stringThreatEntryRemovals
type ThreatEntryRemovals struct {
// The raw removal indices for a local list.
RawIndices *RawIndices `protobuf:"bytes,1,opt,name=raw_indices,json=rawIndices,proto3" json:"raw_indices,omitempty"`
// The encoded local, lexicographically-sorted list indices, using a
// Golomb-Rice encoding. Used for sending compressed removal indices. The
// removal indices (uint32) are sorted in ascending order, then delta encoded
// and stored as encoded_data.
RiceIndices *RiceDeltaEncoding `protobuf:"bytes,2,opt,name=rice_indices,json=riceIndices,proto3" json:"rice_indices,omitempty"`
// contains filtered or unexported fields
}Contains the set of entries to remove from a local database.
func (*ThreatEntryRemovals) Descriptor
func (*ThreatEntryRemovals) Descriptor() ([]byte, []int)Deprecated: Use ThreatEntryRemovals.ProtoReflect.Descriptor instead.
func (*ThreatEntryRemovals) GetRawIndices
func (x *ThreatEntryRemovals) GetRawIndices() *RawIndicesfunc (*ThreatEntryRemovals) GetRiceIndices
func (x *ThreatEntryRemovals) GetRiceIndices() *RiceDeltaEncodingfunc (*ThreatEntryRemovals) ProtoMessage
func (*ThreatEntryRemovals) ProtoMessage()func (*ThreatEntryRemovals) ProtoReflect
func (x *ThreatEntryRemovals) ProtoReflect() protoreflect.Messagefunc (*ThreatEntryRemovals) Reset
func (x *ThreatEntryRemovals) Reset()func (*ThreatEntryRemovals) String
func (x *ThreatEntryRemovals) String() stringThreatInfo
type ThreatInfo struct {
// The type of abuse.
AbuseType ThreatInfo_AbuseType `protobuf:"varint,1,opt,name=abuse_type,json=abuseType,proto3,enum=google.cloud.webrisk.v1.ThreatInfo_AbuseType" json:"abuse_type,omitempty"`
// Confidence that the URI is unsafe.
ThreatConfidence *ThreatInfo_Confidence `protobuf:"bytes,2,opt,name=threat_confidence,json=threatConfidence,proto3" json:"threat_confidence,omitempty"`
// Context about why the URI is unsafe.
ThreatJustification *ThreatInfo_ThreatJustification `protobuf:"bytes,3,opt,name=threat_justification,json=threatJustification,proto3" json:"threat_justification,omitempty"`
// contains filtered or unexported fields
}Context about the submission including the type of abuse found on the URI and supporting details.
func (*ThreatInfo) Descriptor
func (*ThreatInfo) Descriptor() ([]byte, []int)Deprecated: Use ThreatInfo.ProtoReflect.Descriptor instead.
func (*ThreatInfo) GetAbuseType
func (x *ThreatInfo) GetAbuseType() ThreatInfo_AbuseTypefunc (*ThreatInfo) GetThreatConfidence
func (x *ThreatInfo) GetThreatConfidence() *ThreatInfo_Confidencefunc (*ThreatInfo) GetThreatJustification
func (x *ThreatInfo) GetThreatJustification() *ThreatInfo_ThreatJustificationfunc (*ThreatInfo) ProtoMessage
func (*ThreatInfo) ProtoMessage()func (*ThreatInfo) ProtoReflect
func (x *ThreatInfo) ProtoReflect() protoreflect.Messagefunc (*ThreatInfo) Reset
func (x *ThreatInfo) Reset()func (*ThreatInfo) String
func (x *ThreatInfo) String() stringThreatInfo_AbuseType
type ThreatInfo_AbuseType int32The abuse type found on the URI.
ThreatInfo_ABUSE_TYPE_UNSPECIFIED, ThreatInfo_MALWARE, ThreatInfo_SOCIAL_ENGINEERING, ThreatInfo_UNWANTED_SOFTWARE
const (
// Default.
ThreatInfo_ABUSE_TYPE_UNSPECIFIED ThreatInfo_AbuseType = 0
// The URI contains malware.
ThreatInfo_MALWARE ThreatInfo_AbuseType = 1
// The URI contains social engineering.
ThreatInfo_SOCIAL_ENGINEERING ThreatInfo_AbuseType = 2
// The URI contains unwanted software.
ThreatInfo_UNWANTED_SOFTWARE ThreatInfo_AbuseType = 3
)func (ThreatInfo_AbuseType) Descriptor
func (ThreatInfo_AbuseType) Descriptor() protoreflect.EnumDescriptorfunc (ThreatInfo_AbuseType) Enum
func (x ThreatInfo_AbuseType) Enum() *ThreatInfo_AbuseTypefunc (ThreatInfo_AbuseType) EnumDescriptor
func (ThreatInfo_AbuseType) EnumDescriptor() ([]byte, []int)Deprecated: Use ThreatInfo_AbuseType.Descriptor instead.
func (ThreatInfo_AbuseType) Number
func (x ThreatInfo_AbuseType) Number() protoreflect.EnumNumberfunc (ThreatInfo_AbuseType) String
func (x ThreatInfo_AbuseType) String() stringfunc (ThreatInfo_AbuseType) Type
func (ThreatInfo_AbuseType) Type() protoreflect.EnumTypeThreatInfo_Confidence
type ThreatInfo_Confidence struct {
// Types that are valid to be assigned to Value:
//
// *ThreatInfo_Confidence_Score
// *ThreatInfo_Confidence_Level
Value isThreatInfo_Confidence_Value `protobuf_oneof:"value"`
// contains filtered or unexported fields
}Confidence that a URI is unsafe.
func (*ThreatInfo_Confidence) Descriptor
func (*ThreatInfo_Confidence) Descriptor() ([]byte, []int)Deprecated: Use ThreatInfo_Confidence.ProtoReflect.Descriptor instead.
func (*ThreatInfo_Confidence) GetLevel
func (x *ThreatInfo_Confidence) GetLevel() ThreatInfo_Confidence_ConfidenceLevelfunc (*ThreatInfo_Confidence) GetScore
func (x *ThreatInfo_Confidence) GetScore() float32func (*ThreatInfo_Confidence) GetValue
func (x *ThreatInfo_Confidence) GetValue() isThreatInfo_Confidence_Valuefunc (*ThreatInfo_Confidence) ProtoMessage
func (*ThreatInfo_Confidence) ProtoMessage()func (*ThreatInfo_Confidence) ProtoReflect
func (x *ThreatInfo_Confidence) ProtoReflect() protoreflect.Messagefunc (*ThreatInfo_Confidence) Reset
func (x *ThreatInfo_Confidence) Reset()func (*ThreatInfo_Confidence) String
func (x *ThreatInfo_Confidence) String() stringThreatInfo_Confidence_ConfidenceLevel
type ThreatInfo_Confidence_ConfidenceLevel int32Enum representation of confidence.
ThreatInfo_Confidence_CONFIDENCE_LEVEL_UNSPECIFIED, ThreatInfo_Confidence_LOW, ThreatInfo_Confidence_MEDIUM, ThreatInfo_Confidence_HIGH
const (
// Default.
ThreatInfo_Confidence_CONFIDENCE_LEVEL_UNSPECIFIED ThreatInfo_Confidence_ConfidenceLevel = 0
// Less than 60% confidence that the URI is unsafe.
ThreatInfo_Confidence_LOW ThreatInfo_Confidence_ConfidenceLevel = 1
// Between 60% and 80% confidence that the URI is unsafe.
ThreatInfo_Confidence_MEDIUM ThreatInfo_Confidence_ConfidenceLevel = 2
// Greater than 80% confidence that the URI is unsafe.
ThreatInfo_Confidence_HIGH ThreatInfo_Confidence_ConfidenceLevel = 3
)func (ThreatInfo_Confidence_ConfidenceLevel) Descriptor
func (ThreatInfo_Confidence_ConfidenceLevel) Descriptor() protoreflect.EnumDescriptorfunc (ThreatInfo_Confidence_ConfidenceLevel) Enum
func (ThreatInfo_Confidence_ConfidenceLevel) EnumDescriptor
func (ThreatInfo_Confidence_ConfidenceLevel) EnumDescriptor() ([]byte, []int)Deprecated: Use ThreatInfo_Confidence_ConfidenceLevel.Descriptor instead.
func (ThreatInfo_Confidence_ConfidenceLevel) Number
func (x ThreatInfo_Confidence_ConfidenceLevel) Number() protoreflect.EnumNumberfunc (ThreatInfo_Confidence_ConfidenceLevel) String
func (x ThreatInfo_Confidence_ConfidenceLevel) String() stringfunc (ThreatInfo_Confidence_ConfidenceLevel) Type
func (ThreatInfo_Confidence_ConfidenceLevel) Type() protoreflect.EnumTypeThreatInfo_Confidence_Level
type ThreatInfo_Confidence_Level struct {
// Enum representation of confidence.
Level ThreatInfo_Confidence_ConfidenceLevel `protobuf:"varint,2,opt,name=level,proto3,enum=google.cloud.webrisk.v1.ThreatInfo_Confidence_ConfidenceLevel,oneof"`
}ThreatInfo_Confidence_Score
type ThreatInfo_Confidence_Score struct {
// A decimal representation of confidence in the range of 0
// to 1 where 0 indicates no confidence and 1 indicates
// complete confidence.
Score float32 `protobuf:"fixed32,1,opt,name=score,proto3,oneof"`
}ThreatInfo_ThreatJustification
type ThreatInfo_ThreatJustification struct {
// Labels associated with this URI that explain how it was classified.
Labels []ThreatInfo_ThreatJustification_JustificationLabel `protobuf:"varint,1,rep,packed,name=labels,proto3,enum=google.cloud.webrisk.v1.ThreatInfo_ThreatJustification_JustificationLabel" json:"labels,omitempty"`
// Free-form context on why this URI is unsafe.
Comments []string `protobuf:"bytes,2,rep,name=comments,proto3" json:"comments,omitempty"`
// contains filtered or unexported fields
}Context about why the URI is unsafe.
func (*ThreatInfo_ThreatJustification) Descriptor
func (*ThreatInfo_ThreatJustification) Descriptor() ([]byte, []int)Deprecated: Use ThreatInfo_ThreatJustification.ProtoReflect.Descriptor instead.
func (*ThreatInfo_ThreatJustification) GetComments
func (x *ThreatInfo_ThreatJustification) GetComments() []stringfunc (*ThreatInfo_ThreatJustification) GetLabels
func (x *ThreatInfo_ThreatJustification) GetLabels() []ThreatInfo_ThreatJustification_JustificationLabelfunc (*ThreatInfo_ThreatJustification) ProtoMessage
func (*ThreatInfo_ThreatJustification) ProtoMessage()func (*ThreatInfo_ThreatJustification) ProtoReflect
func (x *ThreatInfo_ThreatJustification) ProtoReflect() protoreflect.Messagefunc (*ThreatInfo_ThreatJustification) Reset
func (x *ThreatInfo_ThreatJustification) Reset()func (*ThreatInfo_ThreatJustification) String
func (x *ThreatInfo_ThreatJustification) String() stringThreatInfo_ThreatJustification_JustificationLabel
type ThreatInfo_ThreatJustification_JustificationLabel int32Labels that explain how the URI was classified.
ThreatInfo_ThreatJustification_JUSTIFICATION_LABEL_UNSPECIFIED, ThreatInfo_ThreatJustification_MANUAL_VERIFICATION, ThreatInfo_ThreatJustification_USER_REPORT, ThreatInfo_ThreatJustification_AUTOMATED_REPORT
const (
// Default.
ThreatInfo_ThreatJustification_JUSTIFICATION_LABEL_UNSPECIFIED ThreatInfo_ThreatJustification_JustificationLabel = 0
// The submitter manually verified that the submission is unsafe.
ThreatInfo_ThreatJustification_MANUAL_VERIFICATION ThreatInfo_ThreatJustification_JustificationLabel = 1
// The submitter received the submission from an end user.
ThreatInfo_ThreatJustification_USER_REPORT ThreatInfo_ThreatJustification_JustificationLabel = 2
// The submitter received the submission from an automated system.
ThreatInfo_ThreatJustification_AUTOMATED_REPORT ThreatInfo_ThreatJustification_JustificationLabel = 3
)func (ThreatInfo_ThreatJustification_JustificationLabel) Descriptor
func (ThreatInfo_ThreatJustification_JustificationLabel) Descriptor() protoreflect.EnumDescriptorfunc (ThreatInfo_ThreatJustification_JustificationLabel) Enum
func (x ThreatInfo_ThreatJustification_JustificationLabel) Enum() *ThreatInfo_ThreatJustification_JustificationLabelfunc (ThreatInfo_ThreatJustification_JustificationLabel) EnumDescriptor
func (ThreatInfo_ThreatJustification_JustificationLabel) EnumDescriptor() ([]byte, []int)Deprecated: Use ThreatInfo_ThreatJustification_JustificationLabel.Descriptor instead.
func (ThreatInfo_ThreatJustification_JustificationLabel) Number
func (x ThreatInfo_ThreatJustification_JustificationLabel) Number() protoreflect.EnumNumberfunc (ThreatInfo_ThreatJustification_JustificationLabel) String
func (x ThreatInfo_ThreatJustification_JustificationLabel) String() stringfunc (ThreatInfo_ThreatJustification_JustificationLabel) Type
ThreatType
type ThreatType int32The type of threat. This maps directly to the threat list a threat may belong to.
ThreatType_THREAT_TYPE_UNSPECIFIED, ThreatType_MALWARE, ThreatType_SOCIAL_ENGINEERING, ThreatType_UNWANTED_SOFTWARE, ThreatType_SOCIAL_ENGINEERING_EXTENDED_COVERAGE
const (
// No entries should match this threat type. This threat type is unused.
ThreatType_THREAT_TYPE_UNSPECIFIED ThreatType = 0
// Malware targeting any platform.
ThreatType_MALWARE ThreatType = 1
// Social engineering targeting any platform.
ThreatType_SOCIAL_ENGINEERING ThreatType = 2
// Unwanted software targeting any platform.
ThreatType_UNWANTED_SOFTWARE ThreatType = 3
// A list of extended coverage social engineering URIs targeting any
// platform.
ThreatType_SOCIAL_ENGINEERING_EXTENDED_COVERAGE ThreatType = 4
)func (ThreatType) Descriptor
func (ThreatType) Descriptor() protoreflect.EnumDescriptorfunc (ThreatType) Enum
func (x ThreatType) Enum() *ThreatTypefunc (ThreatType) EnumDescriptor
func (ThreatType) EnumDescriptor() ([]byte, []int)Deprecated: Use ThreatType.Descriptor instead.
func (ThreatType) Number
func (x ThreatType) Number() protoreflect.EnumNumberfunc (ThreatType) String
func (x ThreatType) String() stringfunc (ThreatType) Type
func (ThreatType) Type() protoreflect.EnumTypeUnimplementedWebRiskServiceServer
type UnimplementedWebRiskServiceServer struct {
}UnimplementedWebRiskServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedWebRiskServiceServer) ComputeThreatListDiff
func (UnimplementedWebRiskServiceServer) ComputeThreatListDiff(context.Context, *ComputeThreatListDiffRequest) (*ComputeThreatListDiffResponse, error)func (UnimplementedWebRiskServiceServer) CreateSubmission
func (UnimplementedWebRiskServiceServer) CreateSubmission(context.Context, *CreateSubmissionRequest) (*Submission, error)func (UnimplementedWebRiskServiceServer) SearchHashes
func (UnimplementedWebRiskServiceServer) SearchHashes(context.Context, *SearchHashesRequest) (*SearchHashesResponse, error)func (UnimplementedWebRiskServiceServer) SearchUris
func (UnimplementedWebRiskServiceServer) SearchUris(context.Context, *SearchUrisRequest) (*SearchUrisResponse, error)func (UnimplementedWebRiskServiceServer) SubmitUri
func (UnimplementedWebRiskServiceServer) SubmitUri(context.Context, *SubmitUriRequest) (*longrunningpb.Operation, error)UnsafeWebRiskServiceServer
type UnsafeWebRiskServiceServer interface {
// contains filtered or unexported methods
}UnsafeWebRiskServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WebRiskServiceServer will result in compilation errors.
WebRiskServiceClient
type WebRiskServiceClient interface {
// Gets the most recent threat list diffs. These diffs should be applied to
// a local database of hashes to keep it up-to-date. If the local database is
// empty or excessively out-of-date, a complete snapshot of the database will
// be returned. This Method only updates a single ThreatList at a time. To
// update multiple ThreatList databases, this method needs to be called once
// for each list.
ComputeThreatListDiff(ctx context.Context, in *ComputeThreatListDiffRequest, opts ...grpc.CallOption) (*ComputeThreatListDiffResponse, error)
// This method is used to check whether a URI is on a given threatList.
// Multiple threatLists may be searched in a single query.
// The response will list all requested threatLists the URI was found to
// match. If the URI is not found on any of the requested ThreatList an
// empty response will be returned.
SearchUris(ctx context.Context, in *SearchUrisRequest, opts ...grpc.CallOption) (*SearchUrisResponse, error)
// Gets the full hashes that match the requested hash prefix.
// This is used after a hash prefix is looked up in a threatList
// and there is a match. The client side threatList only holds partial hashes
// so the client must query this method to determine if there is a full
// hash match of a threat.
SearchHashes(ctx context.Context, in *SearchHashesRequest, opts ...grpc.CallOption) (*SearchHashesResponse, error)
// Creates a Submission of a URI suspected of containing phishing content to
// be reviewed. If the result verifies the existence of malicious phishing
// content, the site will be added to the [Google's Social Engineering
// lists](https://support.google.com/webmasters/answer/6350487/) in order to
// protect users that could get exposed to this threat in the future. Only
// allowlisted projects can use this method during Early Access. Please reach
// out to Sales or your customer engineer to obtain access.
CreateSubmission(ctx context.Context, in *CreateSubmissionRequest, opts ...grpc.CallOption) (*Submission, error)
// Submits a URI suspected of containing malicious content to be reviewed.
// Returns a google.longrunning.Operation which, once the review is complete,
// is updated with its result. You can use the [Pub/Sub API]
// (https://cloud.google.com/pubsub) to receive notifications for the returned
// Operation. If the result verifies the existence of malicious content, the
// site will be added to the [Google's Social Engineering lists]
// (https://support.google.com/webmasters/answer/6350487/) in order to
// protect users that could get exposed to this threat in the future. Only
// allowlisted projects can use this method during Early Access. Please reach
// out to Sales or your customer engineer to obtain access.
SubmitUri(ctx context.Context, in *SubmitUriRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}WebRiskServiceClient is the client API for WebRiskService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewWebRiskServiceClient
func NewWebRiskServiceClient(cc grpc.ClientConnInterface) WebRiskServiceClientWebRiskServiceServer
type WebRiskServiceServer interface {
// Gets the most recent threat list diffs. These diffs should be applied to
// a local database of hashes to keep it up-to-date. If the local database is
// empty or excessively out-of-date, a complete snapshot of the database will
// be returned. This Method only updates a single ThreatList at a time. To
// update multiple ThreatList databases, this method needs to be called once
// for each list.
ComputeThreatListDiff(context.Context, *ComputeThreatListDiffRequest) (*ComputeThreatListDiffResponse, error)
// This method is used to check whether a URI is on a given threatList.
// Multiple threatLists may be searched in a single query.
// The response will list all requested threatLists the URI was found to
// match. If the URI is not found on any of the requested ThreatList an
// empty response will be returned.
SearchUris(context.Context, *SearchUrisRequest) (*SearchUrisResponse, error)
// Gets the full hashes that match the requested hash prefix.
// This is used after a hash prefix is looked up in a threatList
// and there is a match. The client side threatList only holds partial hashes
// so the client must query this method to determine if there is a full
// hash match of a threat.
SearchHashes(context.Context, *SearchHashesRequest) (*SearchHashesResponse, error)
// Creates a Submission of a URI suspected of containing phishing content to
// be reviewed. If the result verifies the existence of malicious phishing
// content, the site will be added to the [Google's Social Engineering
// lists](https://support.google.com/webmasters/answer/6350487/) in order to
// protect users that could get exposed to this threat in the future. Only
// allowlisted projects can use this method during Early Access. Please reach
// out to Sales or your customer engineer to obtain access.
CreateSubmission(context.Context, *CreateSubmissionRequest) (*Submission, error)
// Submits a URI suspected of containing malicious content to be reviewed.
// Returns a google.longrunning.Operation which, once the review is complete,
// is updated with its result. You can use the [Pub/Sub API]
// (https://cloud.google.com/pubsub) to receive notifications for the returned
// Operation. If the result verifies the existence of malicious content, the
// site will be added to the [Google's Social Engineering lists]
// (https://support.google.com/webmasters/answer/6350487/) in order to
// protect users that could get exposed to this threat in the future. Only
// allowlisted projects can use this method during Early Access. Please reach
// out to Sales or your customer engineer to obtain access.
SubmitUri(context.Context, *SubmitUriRequest) (*longrunningpb.Operation, error)
}WebRiskServiceServer is the server API for WebRiskService service. All implementations should embed UnimplementedWebRiskServiceServer for forward compatibility