blob: 3ddb690c9a2558882138f616bdb6ed14ffdf517a [file] [log] [blame]
{
"clientLibrary": {
"name": "cloud.google.com/go/webrisk/apiv1",
"version": "1.9.7",
"language": "GO",
"apis": [
{
"id": "google.cloud.webrisk.v1",
"version": "v1"
}
]
},
"snippets": [
{
"regionTag": "webrisk_v1_generated_WebRiskService_CancelOperation_sync",
"title": "webrisk CancelOperation Sample",
"description": "CancelOperation is a utility method from google.longrunning.Operations.",
"file": "Client/CancelOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CancelOperation",
"fullName": "google.cloud.webrisk.v1.Client.CancelOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.CancelOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "CancelOperation",
"fullName": "google.longrunning.Operations.CancelOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_ComputeThreatListDiff_sync",
"title": "webrisk ComputeThreatListDiff Sample",
"description": "ComputeThreatListDiff gets the most recent threat list diffs. These diffs should be applied to\na local database of hashes to keep it up-to-date. If the local database is\nempty or excessively out-of-date, a complete snapshot of the database will\nbe returned. This Method only updates a single ThreatList at a time. To\nupdate multiple ThreatList databases, this method needs to be called once\nfor each list.",
"file": "Client/ComputeThreatListDiff/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ComputeThreatListDiff",
"fullName": "google.cloud.webrisk.v1.Client.ComputeThreatListDiff",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "webriskpb.ComputeThreatListDiffRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*webriskpb.ComputeThreatListDiffResponse",
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "ComputeThreatListDiff",
"fullName": "google.cloud.webrisk.v1.WebRiskService.ComputeThreatListDiff",
"service": {
"shortName": "WebRiskService",
"fullName": "google.cloud.webrisk.v1.WebRiskService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_CreateSubmission_sync",
"title": "webrisk CreateSubmission Sample",
"description": "CreateSubmission creates a Submission of a URI suspected of containing phishing content to\nbe reviewed. If the result verifies the existence of malicious phishing\ncontent, the site will be added to the [Google's Social Engineering\nlists](https: //support.google.com/webmasters/answer/6350487/) in order to\nprotect users that could get exposed to this threat in the future. Only\nallowlisted projects can use this method during Early Access. Please reach\nout to Sales or your customer engineer to obtain access.",
"file": "Client/CreateSubmission/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateSubmission",
"fullName": "google.cloud.webrisk.v1.Client.CreateSubmission",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "webriskpb.CreateSubmissionRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*webriskpb.Submission",
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "CreateSubmission",
"fullName": "google.cloud.webrisk.v1.WebRiskService.CreateSubmission",
"service": {
"shortName": "WebRiskService",
"fullName": "google.cloud.webrisk.v1.WebRiskService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_DeleteOperation_sync",
"title": "webrisk DeleteOperation Sample",
"description": "DeleteOperation is a utility method from google.longrunning.Operations.",
"file": "Client/DeleteOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteOperation",
"fullName": "google.cloud.webrisk.v1.Client.DeleteOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.DeleteOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "DeleteOperation",
"fullName": "google.longrunning.Operations.DeleteOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_GetOperation_sync",
"title": "webrisk GetOperation Sample",
"description": "GetOperation is a utility method from google.longrunning.Operations.",
"file": "Client/GetOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetOperation",
"fullName": "google.cloud.webrisk.v1.Client.GetOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.GetOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*longrunningpb.Operation",
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "GetOperation",
"fullName": "google.longrunning.Operations.GetOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_ListOperations_sync",
"title": "webrisk ListOperations Sample",
"description": "ListOperations is a utility method from google.longrunning.Operations.",
"file": "Client/ListOperations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListOperations",
"fullName": "google.cloud.webrisk.v1.Client.ListOperations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.ListOperationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "OperationIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "ListOperations",
"fullName": "google.longrunning.Operations.ListOperations",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 66,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_SearchHashes_sync",
"title": "webrisk SearchHashes Sample",
"description": "SearchHashes gets the full hashes that match the requested hash prefix.\nThis is used after a hash prefix is looked up in a threatList\nand there is a match. The client side threatList only holds partial hashes\nso the client must query this method to determine if there is a full\nhash match of a threat.",
"file": "Client/SearchHashes/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SearchHashes",
"fullName": "google.cloud.webrisk.v1.Client.SearchHashes",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "webriskpb.SearchHashesRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*webriskpb.SearchHashesResponse",
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "SearchHashes",
"fullName": "google.cloud.webrisk.v1.WebRiskService.SearchHashes",
"service": {
"shortName": "WebRiskService",
"fullName": "google.cloud.webrisk.v1.WebRiskService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_SearchUris_sync",
"title": "webrisk SearchUris Sample",
"description": "SearchUris this method is used to check whether a URI is on a given threatList.\nMultiple threatLists may be searched in a single query.\nThe response will list all requested threatLists the URI was found to\nmatch. If the URI is not found on any of the requested ThreatList an\nempty response will be returned.",
"file": "Client/SearchUris/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SearchUris",
"fullName": "google.cloud.webrisk.v1.Client.SearchUris",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "webriskpb.SearchUrisRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*webriskpb.SearchUrisResponse",
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "SearchUris",
"fullName": "google.cloud.webrisk.v1.WebRiskService.SearchUris",
"service": {
"shortName": "WebRiskService",
"fullName": "google.cloud.webrisk.v1.WebRiskService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "webrisk_v1_generated_WebRiskService_SubmitUri_sync",
"title": "webrisk SubmitUri Sample",
"description": "SubmitUri submits a URI suspected of containing malicious content to be reviewed.\nReturns a google.longrunning.Operation which, once the review is complete,\nis updated with its result. You can use the [Pub/Sub API]\n(https: //cloud.google.com/pubsub) to receive notifications for the returned\nOperation. If the result verifies the existence of malicious content, the\nsite will be added to the [Google's Social Engineering lists]\n(https: //support.google.com/webmasters/answer/6350487/) in order to\nprotect users that could get exposed to this threat in the future. Only\nallowlisted projects can use this method during Early Access. Please reach\nout to Sales or your customer engineer to obtain access.",
"file": "Client/SubmitUri/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SubmitUri",
"fullName": "google.cloud.webrisk.v1.Client.SubmitUri",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "webriskpb.SubmitUriRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "SubmitUriOperation",
"client": {
"shortName": "Client",
"fullName": "google.cloud.webrisk.v1.Client"
},
"method": {
"shortName": "SubmitUri",
"fullName": "google.cloud.webrisk.v1.WebRiskService.SubmitUri",
"service": {
"shortName": "WebRiskService",
"fullName": "google.cloud.webrisk.v1.WebRiskService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
}
]
}