OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
type GoogleCloudWebriskV1ComputeThreatListDiffResponse struct {
// Additions: A set of entries to add to a local threat type's list.
Additions *GoogleCloudWebriskV1ThreatEntryAdditions `json:"additions,omitempty"`
// Checksum: 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 *GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum `json:"checksum,omitempty"`
// NewVersionToken: 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 `json:"newVersionToken,omitempty"`
// RecommendedNextDiff: 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 `json:"recommendedNextDiff,omitempty"`
// Removals: A set of entries to remove from a local threat type's list. This
// field may be empty.
Removals *GoogleCloudWebriskV1ThreatEntryRemovals `json:"removals,omitempty"`
// ResponseType: The type of response. This may indicate that an action must be
// taken by the client when the response is received.
//
// Possible values:
// "RESPONSE_TYPE_UNSPECIFIED" - Unknown.
// "DIFF" - Partial updates are applied to the client's existing local
// database.
// "RESET" - 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.
ResponseType string `json:"responseType,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Additions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Additions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1ComputeThreatListDiffResponse) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: The expected state of a client's local database.
type GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum struct {
// Sha256: The SHA256 hash of the client state; that is, of the sorted list of
// all hashes present in the database.
Sha256 string `json:"sha256,omitempty"`
// ForceSendFields is a list of field names (e.g. "Sha256") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Sha256") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1RawHashes: 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.
type GoogleCloudWebriskV1RawHashes struct {
// PrefixSize: 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 int64 `json:"prefixSize,omitempty"`
// RawHashes: 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 `json:"rawHashes,omitempty"`
// ForceSendFields is a list of field names (e.g. "PrefixSize") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PrefixSize") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1RawHashes) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1RawIndices: A set of raw indices to remove from a local list.
type GoogleCloudWebriskV1RawIndices struct {
// Indices: The indices to remove from a lexicographically-sorted local list.
Indices []int64 `json:"indices,omitempty"`
// ForceSendFields is a list of field names (e.g. "Indices") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Indices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1RawIndices) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1RiceDeltaEncoding: The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.
type GoogleCloudWebriskV1RiceDeltaEncoding struct {
// EncodedData: The encoded deltas that are encoded using the Golomb-Rice
// coder.
EncodedData string `json:"encodedData,omitempty"`
// EntryCount: 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 int64 `json:"entryCount,omitempty"`
// FirstValue: 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 `json:"firstValue,omitempty,string"`
// RiceParameter: 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 int64 `json:"riceParameter,omitempty"`
// ForceSendFields is a list of field names (e.g. "EncodedData") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EncodedData") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1RiceDeltaEncoding) MarshalJSON() ([]byte, error)
type GoogleCloudWebriskV1SearchHashesResponse struct {
// NegativeExpireTime: For requested entities that did not match the threat
// list, how long to cache the response until.
NegativeExpireTime string `json:"negativeExpireTime,omitempty"`
// Threats: The full hashes that matched the requested prefixes. The hash will
// be populated in the key.
Threats []*GoogleCloudWebriskV1SearchHashesResponseThreatHash `json:"threats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NegativeExpireTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NegativeExpireTime") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1SearchHashesResponse) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1SearchHashesResponseThreatHash: Contains threat information on a matching hash.
type GoogleCloudWebriskV1SearchHashesResponseThreatHash struct {
// ExpireTime: The cache lifetime for the returned match. Clients must not
// cache this response past this timestamp to avoid false positives.
ExpireTime string `json:"expireTime,omitempty"`
// Hash: A 32 byte SHA256 hash. This field is in binary format. For JSON
// requests, hashes are base64-encoded.
Hash string `json:"hash,omitempty"`
// ThreatTypes: The ThreatList this threat belongs to. This must contain at
// least one entry.
//
// Possible values:
// "THREAT_TYPE_UNSPECIFIED" - No entries should match this threat type. This
// threat type is unused.
// "MALWARE" - Malware targeting any platform.
// "SOCIAL_ENGINEERING" - Social engineering targeting any platform.
// "UNWANTED_SOFTWARE" - Unwanted software targeting any platform.
// "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" - A list of extended coverage
// social engineering URIs targeting any platform.
ThreatTypes []string `json:"threatTypes,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExpireTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExpireTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1SearchHashesResponseThreatHash) MarshalJSON() ([]byte, error)
type GoogleCloudWebriskV1SearchUrisResponse struct {
// Threat: The threat list matches. This might be empty if the URI is on no
// list.
Threat *GoogleCloudWebriskV1SearchUrisResponseThreatUri `json:"threat,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Threat") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Threat") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1SearchUrisResponse) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1SearchUrisResponseThreatUri: Contains threat information on a matching uri.
type GoogleCloudWebriskV1SearchUrisResponseThreatUri struct {
// ExpireTime: The cache lifetime for the returned match. Clients must not
// cache this response past this timestamp to avoid false positives.
ExpireTime string `json:"expireTime,omitempty"`
// ThreatTypes: The ThreatList this threat belongs to.
//
// Possible values:
// "THREAT_TYPE_UNSPECIFIED" - No entries should match this threat type. This
// threat type is unused.
// "MALWARE" - Malware targeting any platform.
// "SOCIAL_ENGINEERING" - Social engineering targeting any platform.
// "UNWANTED_SOFTWARE" - Unwanted software targeting any platform.
// "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" - A list of extended coverage
// social engineering URIs targeting any platform.
ThreatTypes []string `json:"threatTypes,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExpireTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExpireTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1SearchUrisResponseThreatUri) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1Submission: Wraps a URI that might be displaying malicious content.
type GoogleCloudWebriskV1Submission struct {
// Uri: Required. The URI that is being reported for malicious content to be
// analyzed.
Uri string `json:"uri,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Uri") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Uri") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1Submission) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1ThreatEntryAdditions: Contains the set of entries to add to a local database. May contain a combination of compressed and raw data in a single response.
type GoogleCloudWebriskV1ThreatEntryAdditions struct {
// RawHashes: The raw SHA256-formatted entries. Repeated to allow returning
// sets of hashes with different prefix sizes.
RawHashes []*GoogleCloudWebriskV1RawHashes `json:"rawHashes,omitempty"`
// RiceHashes: 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 *GoogleCloudWebriskV1RiceDeltaEncoding `json:"riceHashes,omitempty"`
// ForceSendFields is a list of field names (e.g. "RawHashes") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RawHashes") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1ThreatEntryAdditions) MarshalJSON() ([]byte, error)
GoogleCloudWebriskV1ThreatEntryRemovals: Contains the set of entries to remove from a local database.
type GoogleCloudWebriskV1ThreatEntryRemovals struct {
// RawIndices: The raw removal indices for a local list.
RawIndices *GoogleCloudWebriskV1RawIndices `json:"rawIndices,omitempty"`
// RiceIndices: 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 *GoogleCloudWebriskV1RiceDeltaEncoding `json:"riceIndices,omitempty"`
// ForceSendFields is a list of field names (e.g. "RawIndices") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RawIndices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudWebriskV1ThreatEntryRemovals) MarshalJSON() ([]byte, error)
GoogleLongrunningCancelOperationRequest: The request message for Operations.CancelOperation.
type GoogleLongrunningCancelOperationRequest struct {
}
GoogleLongrunningListOperationsResponse: The response message for Operations.ListOperations.
type GoogleLongrunningListOperationsResponse struct {
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// Operations: A list of operations that matches the specified filter in the
// request.
Operations []*GoogleLongrunningOperation `json:"operations,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleLongrunningListOperationsResponse) MarshalJSON() ([]byte, error)
GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call.
type GoogleLongrunningOperation struct {
// Done: 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 bool `json:"done,omitempty"`
// Error: The error result of the operation in case of failure or cancellation.
Error *GoogleRpcStatus `json:"error,omitempty"`
// Metadata: Contains a `SubmitUriMetadata` object.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
// Name: Matches the `/v1/{project-name}/operations/{operation-id}` pattern.
Name string `json:"name,omitempty"`
// Response: The normal, successful response of the operation. 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 googleapi.RawMessage `json:"response,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Done") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)
GoogleProtobufEmpty: 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); }
type GoogleProtobufEmpty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
GoogleRpcStatus: 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).
type GoogleRpcStatus struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: 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 `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)
type HashesSearchCall struct {
// contains filtered or unexported fields
}
func (c *HashesSearchCall) Context(ctx context.Context) *HashesSearchCall
Context sets the context to be used in this call's Do method.
func (c *HashesSearchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudWebriskV1SearchHashesResponse, error)
Do executes the "webrisk.hashes.search" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudWebriskV1SearchHashesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *HashesSearchCall) Fields(s ...googleapi.Field) *HashesSearchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *HashesSearchCall) HashPrefix(hashPrefix string) *HashesSearchCall
HashPrefix sets the optional parameter "hashPrefix": 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).
func (c *HashesSearchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *HashesSearchCall) IfNoneMatch(entityTag string) *HashesSearchCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *HashesSearchCall) ThreatTypes(threatTypes ...string) *HashesSearchCall
ThreatTypes sets the optional parameter "threatTypes": Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
Possible values:
"THREAT_TYPE_UNSPECIFIED" - No entries should match this threat type. This
threat type is unused.
"MALWARE" - Malware targeting any platform. "SOCIAL_ENGINEERING" - Social engineering targeting any platform. "UNWANTED_SOFTWARE" - Unwanted software targeting any platform. "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" - A list of extended coverage
social engineering URIs targeting any platform.
type HashesService struct {
// contains filtered or unexported fields
}
func NewHashesService(s *Service) *HashesService
func (r *HashesService) Search() *HashesSearchCall
Search: 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.
type ProjectsOperationsCancelCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsOperationsCancelCall) Context(ctx context.Context) *ProjectsOperationsCancelCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "webrisk.projects.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsOperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsOperationsCancelCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsOperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsOperationsDeleteCall) Context(ctx context.Context) *ProjectsOperationsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "webrisk.projects.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsOperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsOperationsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "webrisk.projects.operations.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsOperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsOperationsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsOperationsListCall) Context(ctx context.Context) *ProjectsOperationsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "webrisk.projects.operations.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsOperationsListCall) Filter(filter string) *ProjectsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (c *ProjectsOperationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsOperationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsOperationsListCall) PageSize(pageSize int64) *ProjectsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (c *ProjectsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService
func (r *ProjectsOperationsService) Cancel(name string, googlelongrunningcanceloperationrequest *GoogleLongrunningCancelOperationRequest) *ProjectsOperationsCancelCall
Cancel: 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`.
- name: The name of the operation resource to be cancelled.
func (r *ProjectsOperationsService) Delete(name string) *ProjectsOperationsDeleteCall
Delete: 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`.
- name: The name of the operation resource to be deleted.
func (r *ProjectsOperationsService) Get(name string) *ProjectsOperationsGetCall
Get: 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.
- name: The name of the operation resource.
func (r *ProjectsOperationsService) List(name string) *ProjectsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
- name: The name of the operation's parent resource.
type ProjectsService struct {
Operations *ProjectsOperationsService
Submissions *ProjectsSubmissionsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
type ProjectsSubmissionsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSubmissionsCreateCall) Context(ctx context.Context) *ProjectsSubmissionsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSubmissionsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudWebriskV1Submission, error)
Do executes the "webrisk.projects.submissions.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudWebriskV1Submission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSubmissionsCreateCall) Fields(s ...googleapi.Field) *ProjectsSubmissionsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSubmissionsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSubmissionsService struct {
// contains filtered or unexported fields
}
func NewProjectsSubmissionsService(s *Service) *ProjectsSubmissionsService
func (r *ProjectsSubmissionsService) Create(parent string, googlecloudwebriskv1submission *GoogleCloudWebriskV1Submission) *ProjectsSubmissionsCreateCall
Create: 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.
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Hashes *HashesService
Projects *ProjectsService
ThreatLists *ThreatListsService
Uris *UrisService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
type ThreatListsComputeDiffCall struct {
// contains filtered or unexported fields
}
func (c *ThreatListsComputeDiffCall) ConstraintsMaxDatabaseEntries(constraintsMaxDatabaseEntries int64) *ThreatListsComputeDiffCall
ConstraintsMaxDatabaseEntries sets the optional parameter "constraints.maxDatabaseEntries": 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.
func (c *ThreatListsComputeDiffCall) ConstraintsMaxDiffEntries(constraintsMaxDiffEntries int64) *ThreatListsComputeDiffCall
ConstraintsMaxDiffEntries sets the optional parameter "constraints.maxDiffEntries": 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.
func (c *ThreatListsComputeDiffCall) ConstraintsSupportedCompressions(constraintsSupportedCompressions ...string) *ThreatListsComputeDiffCall
ConstraintsSupportedCompressions sets the optional parameter "constraints.supportedCompressions": The compression types supported by the client.
Possible values:
"COMPRESSION_TYPE_UNSPECIFIED" - Unknown. "RAW" - Raw, uncompressed data. "RICE" - Rice-Golomb encoded data.
func (c *ThreatListsComputeDiffCall) Context(ctx context.Context) *ThreatListsComputeDiffCall
Context sets the context to be used in this call's Do method.
func (c *ThreatListsComputeDiffCall) Do(opts ...googleapi.CallOption) (*GoogleCloudWebriskV1ComputeThreatListDiffResponse, error)
Do executes the "webrisk.threatLists.computeDiff" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudWebriskV1ComputeThreatListDiffResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ThreatListsComputeDiffCall) Fields(s ...googleapi.Field) *ThreatListsComputeDiffCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ThreatListsComputeDiffCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ThreatListsComputeDiffCall) IfNoneMatch(entityTag string) *ThreatListsComputeDiffCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ThreatListsComputeDiffCall) ThreatType(threatType string) *ThreatListsComputeDiffCall
ThreatType sets the optional parameter "threatType": 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.
Possible values:
"THREAT_TYPE_UNSPECIFIED" - No entries should match this threat type. This
threat type is unused.
"MALWARE" - Malware targeting any platform. "SOCIAL_ENGINEERING" - Social engineering targeting any platform. "UNWANTED_SOFTWARE" - Unwanted software targeting any platform. "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" - A list of extended coverage
social engineering URIs targeting any platform.
func (c *ThreatListsComputeDiffCall) VersionToken(versionToken string) *ThreatListsComputeDiffCall
VersionToken sets the optional parameter "versionToken": 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.
type ThreatListsService struct {
// contains filtered or unexported fields
}
func NewThreatListsService(s *Service) *ThreatListsService
func (r *ThreatListsService) ComputeDiff() *ThreatListsComputeDiffCall
ComputeDiff: 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.
type UrisSearchCall struct {
// contains filtered or unexported fields
}
func (c *UrisSearchCall) Context(ctx context.Context) *UrisSearchCall
Context sets the context to be used in this call's Do method.
func (c *UrisSearchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudWebriskV1SearchUrisResponse, error)
Do executes the "webrisk.uris.search" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudWebriskV1SearchUrisResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UrisSearchCall) Fields(s ...googleapi.Field) *UrisSearchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UrisSearchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *UrisSearchCall) IfNoneMatch(entityTag string) *UrisSearchCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *UrisSearchCall) ThreatTypes(threatTypes ...string) *UrisSearchCall
ThreatTypes sets the optional parameter "threatTypes": Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
Possible values:
"THREAT_TYPE_UNSPECIFIED" - No entries should match this threat type. This
threat type is unused.
"MALWARE" - Malware targeting any platform. "SOCIAL_ENGINEERING" - Social engineering targeting any platform. "UNWANTED_SOFTWARE" - Unwanted software targeting any platform. "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" - A list of extended coverage
social engineering URIs targeting any platform.
func (c *UrisSearchCall) Uri(uri string) *UrisSearchCall
Uri sets the optional parameter "uri": Required. The URI to be checked for matches.
type UrisService struct {
// contains filtered or unexported fields
}
func NewUrisService(s *Service) *UrisService
func (r *UrisService) Search() *UrisSearchCall
Search: 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.