src/apis/webrisk/v1.ts
Web Risk API
const {google} = require('googleapis');
const webrisk = google.webrisk('v1');
Properties |
constructor(options: GlobalOptions, google?: GoogleConfigurable)
|
|||||||||
|
Defined in src/apis/webrisk/v1.ts:119
|
|||||||||
|
Parameters :
|
| context |
Type : APIRequestContext
|
|
Defined in src/apis/webrisk/v1.ts:115
|
| hashes |
Type : Resource$Hashes
|
|
Defined in src/apis/webrisk/v1.ts:116
|
| projects |
Type : Resource$Projects
|
|
Defined in src/apis/webrisk/v1.ts:117
|
| threatLists |
Type : Resource$Threatlists
|
|
Defined in src/apis/webrisk/v1.ts:118
|
| uris |
Type : Resource$Uris
|
|
Defined in src/apis/webrisk/v1.ts:119
|
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosPromise,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace webrisk_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Web Risk API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
* ```
*/
export class Webrisk {
context: APIRequestContext;
hashes: Resource$Hashes;
projects: Resource$Projects;
threatLists: Resource$Threatlists;
uris: Resource$Uris;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.hashes = new Resource$Hashes(this.context);
this.projects = new Resource$Projects(this.context);
this.threatLists = new Resource$Threatlists(this.context);
this.uris = new Resource$Uris(this.context);
}
}
export interface Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse {
/**
* A set of entries to add to a local threat type's list.
*/
additions?: Schema$GoogleCloudWebriskV1ThreatEntryAdditions;
/**
* 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?: Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum;
/**
* 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?: string | null;
/**
* 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?: string | null;
/**
* A set of entries to remove from a local threat type's list. This field may be empty.
*/
removals?: Schema$GoogleCloudWebriskV1ThreatEntryRemovals;
/**
* The type of response. This may indicate that an action must be taken by the client when the response is received.
*/
responseType?: string | null;
}
/**
* The expected state of a client's local database.
*/
export interface Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum {
/**
* The SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database.
*/
sha256?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleCloudWebriskV1RawHashes {
/**
* 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?: number | null;
/**
* 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?: string | null;
}
/**
* A set of raw indices to remove from a local list.
*/
export interface Schema$GoogleCloudWebriskV1RawIndices {
/**
* The indices to remove from a lexicographically-sorted local list.
*/
indices?: number[] | null;
}
/**
* The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.
*/
export interface Schema$GoogleCloudWebriskV1RiceDeltaEncoding {
/**
* The encoded deltas that are encoded using the Golomb-Rice coder.
*/
encodedData?: string | null;
/**
* 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?: number | null;
/**
* 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?: string | null;
/**
* 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?: number | null;
}
export interface Schema$GoogleCloudWebriskV1SearchHashesResponse {
/**
* For requested entities that did not match the threat list, how long to cache the response until.
*/
negativeExpireTime?: string | null;
/**
* The full hashes that matched the requested prefixes. The hash will be populated in the key.
*/
threats?: Schema$GoogleCloudWebriskV1SearchHashesResponseThreatHash[];
}
/**
* Contains threat information on a matching hash.
*/
export interface Schema$GoogleCloudWebriskV1SearchHashesResponseThreatHash {
/**
* The cache lifetime for the returned match. Clients must not cache this response past this timestamp to avoid false positives.
*/
expireTime?: string | null;
/**
* A 32 byte SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
*/
hash?: string | null;
/**
* The ThreatList this threat belongs to. This must contain at least one entry.
*/
threatTypes?: string[] | null;
}
export interface Schema$GoogleCloudWebriskV1SearchUrisResponse {
/**
* The threat list matches. This may be empty if the URI is on no list.
*/
threat?: Schema$GoogleCloudWebriskV1SearchUrisResponseThreatUri;
}
/**
* Contains threat information on a matching uri.
*/
export interface Schema$GoogleCloudWebriskV1SearchUrisResponseThreatUri {
/**
* The cache lifetime for the returned match. Clients must not cache this response past this timestamp to avoid false positives.
*/
expireTime?: string | null;
/**
* The ThreatList this threat belongs to.
*/
threatTypes?: string[] | null;
}
/**
* Wraps a URI that might be displaying malicious content.
*/
export interface Schema$GoogleCloudWebriskV1Submission {
/**
* ThreatTypes found to be associated with the submitted URI after reviewing it. This may be empty if the URI was not added to any list.
*/
threatTypes?: string[] | null;
/**
* Required. The URI that is being reported for malicious content to be analyzed.
*/
uri?: string | null;
}
/**
* Metadata for the Submit URI long-running operation.
*/
export interface Schema$GoogleCloudWebriskV1SubmitUriMetadata {
/**
* Creation time of the operation.
*/
createTime?: string | null;
/**
* The state of the operation.
*/
state?: string | null;
/**
* Latest update time of the operation.
*/
updateTime?: string | null;
}
/**
* Request to send a potentially malicious URI to WebRisk.
*/
export interface Schema$GoogleCloudWebriskV1SubmitUriRequest {
/**
* Required. The submission that contains the URI to be scanned.
*/
submission?: Schema$GoogleCloudWebriskV1Submission;
}
/**
* Contains the set of entries to add to a local database. May contain a combination of compressed and raw data in a single response.
*/
export interface Schema$GoogleCloudWebriskV1ThreatEntryAdditions {
/**
* The raw SHA256-formatted entries. Repeated to allow returning sets of hashes with different prefix sizes.
*/
rawHashes?: Schema$GoogleCloudWebriskV1RawHashes[];
/**
* 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?: Schema$GoogleCloudWebriskV1RiceDeltaEncoding;
}
/**
* Contains the set of entries to remove from a local database.
*/
export interface Schema$GoogleCloudWebriskV1ThreatEntryRemovals {
/**
* The raw removal indices for a local list.
*/
rawIndices?: Schema$GoogleCloudWebriskV1RawIndices;
/**
* 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?: Schema$GoogleCloudWebriskV1RiceDeltaEncoding;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$GoogleLongrunningCancelOperationRequest {}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$GoogleLongrunningListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$GoogleLongrunningOperation[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$GoogleLongrunningOperation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$GoogleRpcStatus;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {[key: string]: any} | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$GoogleProtobufEmpty {}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$GoogleRpcStatus {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{[key: string]: any}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
export class Resource$Hashes {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.hashes.search({
* // 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: 'placeholder-value',
* // Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
* threatTypes: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "negativeExpireTime": "my_negativeExpireTime",
* // "threats": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
search(
params: Params$Resource$Hashes$Search,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
search(
params?: Params$Resource$Hashes$Search,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudWebriskV1SearchHashesResponse>;
search(
params: Params$Resource$Hashes$Search,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
search(
params: Params$Resource$Hashes$Search,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchHashesResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchHashesResponse>
): void;
search(
params: Params$Resource$Hashes$Search,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchHashesResponse>
): void;
search(
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchHashesResponse>
): void;
search(
paramsOrCallback?:
| Params$Resource$Hashes$Search
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchHashesResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchHashesResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchHashesResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudWebriskV1SearchHashesResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Hashes$Search;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Hashes$Search;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/hashes:search').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudWebriskV1SearchHashesResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudWebriskV1SearchHashesResponse>(
parameters
);
}
}
}
export interface Params$Resource$Hashes$Search extends StandardParameters {
/**
* 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?: string;
/**
* Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
*/
threatTypes?: string[];
}
export class Resource$Projects {
context: APIRequestContext;
operations: Resource$Projects$Operations;
submissions: Resource$Projects$Submissions;
uris: Resource$Projects$Uris;
constructor(context: APIRequestContext) {
this.context = context;
this.operations = new Resource$Projects$Operations(this.context);
this.submissions = new Resource$Projects$Submissions(this.context);
this.uris = new Resource$Projects$Uris(this.context);
}
}
export class Resource$Projects$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.projects.operations.cancel({
* // The name of the operation resource to be cancelled.
* name: 'projects/my-project/operations/my-operation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(
params: Params$Resource$Projects$Operations$Cancel,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
cancel(
params?: Params$Resource$Projects$Operations$Cancel,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleProtobufEmpty>;
cancel(
params: Params$Resource$Projects$Operations$Cancel,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
cancel(
params: Params$Resource$Projects$Operations$Cancel,
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
): void;
cancel(
params: Params$Resource$Projects$Operations$Cancel,
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
): void;
cancel(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
cancel(
paramsOrCallback?:
| Params$Resource$Projects$Operations$Cancel
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleProtobufEmpty>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Operations$Cancel;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Operations$Cancel;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleProtobufEmpty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
}
}
/**
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.projects.operations.delete({
* // The name of the operation resource to be deleted.
* name: 'projects/my-project/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Projects$Operations$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Projects$Operations$Delete,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(
params: Params$Resource$Projects$Operations$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
delete(
params: Params$Resource$Projects$Operations$Delete,
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
): void;
delete(
params: Params$Resource$Projects$Operations$Delete,
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(
paramsOrCallback?:
| Params$Resource$Projects$Operations$Delete
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleProtobufEmpty>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Operations$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Operations$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleProtobufEmpty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
}
}
/**
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.projects.operations.get({
* // The name of the operation resource.
* name: 'projects/my-project/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Projects$Operations$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Projects$Operations$Get,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
get(
params: Params$Resource$Projects$Operations$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$Projects$Operations$Get,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
): void;
get(
params: Params$Resource$Projects$Operations$Get,
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
): void;
get(
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
): void;
get(
paramsOrCallback?:
| Params$Resource$Projects$Operations$Get
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleLongrunningOperation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Operations$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Operations$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleLongrunningOperation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
}
}
/**
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x\}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.projects.operations.list({
* // The standard list filter.
* filter: 'placeholder-value',
* // The name of the operation's parent resource.
* name: 'projects/my-project',
* // The standard list page size.
* pageSize: 'placeholder-value',
* // The standard list page token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "operations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Projects$Operations$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Projects$Operations$List,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
list(
params: Params$Resource$Projects$Operations$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Projects$Operations$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>,
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
): void;
list(
params: Params$Resource$Projects$Operations$List,
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Projects$Operations$List
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Operations$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Operations$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+name}/operations').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
parameters
);
}
}
}
export interface Params$Resource$Projects$Operations$Cancel
extends StandardParameters {
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleLongrunningCancelOperationRequest;
}
export interface Params$Resource$Projects$Operations$Delete
extends StandardParameters {
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
export interface Params$Resource$Projects$Operations$Get
extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export interface Params$Resource$Projects$Operations$List
extends StandardParameters {
/**
* The standard list filter.
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
export class Resource$Projects$Submissions {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.projects.submissions.create({
* // Required. The name of the project that is making the submission. This string is in the format "projects/{project_number\}".
* parent: 'projects/my-project',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "threatTypes": [],
* // "uri": "my_uri"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "threatTypes": [],
* // "uri": "my_uri"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(
params: Params$Resource$Projects$Submissions$Create,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
create(
params?: Params$Resource$Projects$Submissions$Create,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudWebriskV1Submission>;
create(
params: Params$Resource$Projects$Submissions$Create,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
create(
params: Params$Resource$Projects$Submissions$Create,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1Submission>,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1Submission>
): void;
create(
params: Params$Resource$Projects$Submissions$Create,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1Submission>
): void;
create(
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1Submission>
): void;
create(
paramsOrCallback?:
| Params$Resource$Projects$Submissions$Create
| BodyResponseCallback<Schema$GoogleCloudWebriskV1Submission>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1Submission>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudWebriskV1Submission>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudWebriskV1Submission>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Submissions$Create;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Submissions$Create;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/submissions').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudWebriskV1Submission>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudWebriskV1Submission>(
parameters
);
}
}
}
export interface Params$Resource$Projects$Submissions$Create
extends StandardParameters {
/**
* Required. The name of the project that is making the submission. This string is in the format "projects/{project_number\}".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudWebriskV1Submission;
}
export class Resource$Projects$Uris {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.projects.uris.submit({
* // Required. The name of the project that is making the submission. This string is in the format "projects/{project_number\}".
* parent: 'projects/my-project',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "submission": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
submit(
params: Params$Resource$Projects$Uris$Submit,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
submit(
params?: Params$Resource$Projects$Uris$Submit,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
submit(
params: Params$Resource$Projects$Uris$Submit,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
submit(
params: Params$Resource$Projects$Uris$Submit,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
): void;
submit(
params: Params$Resource$Projects$Uris$Submit,
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
): void;
submit(
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
): void;
submit(
paramsOrCallback?:
| Params$Resource$Projects$Uris$Submit
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleLongrunningOperation>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Uris$Submit;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Uris$Submit;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+parent}/uris:submit').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleLongrunningOperation>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
}
}
}
export interface Params$Resource$Projects$Uris$Submit
extends StandardParameters {
/**
* Required. The name of the project that is making the submission. This string is in the format "projects/{project_number\}".
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudWebriskV1SubmitUriRequest;
}
export class Resource$Threatlists {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.threatLists.computeDiff({
* // 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.
* 'constraints.maxDatabaseEntries': 'placeholder-value',
* // 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.
* 'constraints.maxDiffEntries': 'placeholder-value',
* // The compression types supported by the client.
* 'constraints.supportedCompressions': 'placeholder-value',
* // 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: 'placeholder-value',
* // 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: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "additions": {},
* // "checksum": {},
* // "newVersionToken": "my_newVersionToken",
* // "recommendedNextDiff": "my_recommendedNextDiff",
* // "removals": {},
* // "responseType": "my_responseType"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
computeDiff(
params: Params$Resource$Threatlists$Computediff,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
computeDiff(
params?: Params$Resource$Threatlists$Computediff,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>;
computeDiff(
params: Params$Resource$Threatlists$Computediff,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
computeDiff(
params: Params$Resource$Threatlists$Computediff,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>
): void;
computeDiff(
params: Params$Resource$Threatlists$Computediff,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>
): void;
computeDiff(
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>
): void;
computeDiff(
paramsOrCallback?:
| Params$Resource$Threatlists$Computediff
| BodyResponseCallback<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Threatlists$Computediff;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Threatlists$Computediff;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/threatLists:computeDiff').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudWebriskV1ComputeThreatListDiffResponse>(
parameters
);
}
}
}
export interface Params$Resource$Threatlists$Computediff
extends StandardParameters {
/**
* 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.
*/
'constraints.maxDatabaseEntries'?: number;
/**
* 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.
*/
'constraints.maxDiffEntries'?: number;
/**
* The compression types supported by the client.
*/
'constraints.supportedCompressions'?: string[];
/**
* 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?: string;
/**
* 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?: string;
}
export class Resource$Uris {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/webrisk.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const webrisk = google.webrisk('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await webrisk.uris.search({
* // Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
* threatTypes: 'placeholder-value',
* // Required. The URI to be checked for matches.
* uri: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "threat": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
search(
params: Params$Resource$Uris$Search,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
search(
params?: Params$Resource$Uris$Search,
options?: MethodOptions
): GaxiosPromise<Schema$GoogleCloudWebriskV1SearchUrisResponse>;
search(
params: Params$Resource$Uris$Search,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
search(
params: Params$Resource$Uris$Search,
options:
| MethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchUrisResponse>,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchUrisResponse>
): void;
search(
params: Params$Resource$Uris$Search,
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchUrisResponse>
): void;
search(
callback: BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchUrisResponse>
): void;
search(
paramsOrCallback?:
| Params$Resource$Uris$Search
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchUrisResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchUrisResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GoogleCloudWebriskV1SearchUrisResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GoogleCloudWebriskV1SearchUrisResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$Uris$Search;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Uris$Search;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://webrisk.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/uris:search').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GoogleCloudWebriskV1SearchUrisResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GoogleCloudWebriskV1SearchUrisResponse>(
parameters
);
}
}
}
export interface Params$Resource$Uris$Search extends StandardParameters {
/**
* Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
*/
threatTypes?: string[];
/**
* Required. The URI to be checked for matches.
*/
uri?: string;
}
}