Method: instances.batchValidateWatchlistEntities

Full name: projects.locations.instances.batchValidateWatchlistEntities

Validates a batch of entities that could be added into watchlist under an instance.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent resource shared by all existing entities. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent field in the ValidateWatchlistEntityRequest messages must either be empty or match this field.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (ValidateWatchlistEntityRequest)
    }
  ]
}
Fields
requests[]

object (ValidateWatchlistEntityRequest)

Required. The request message specifying the entities to validate.

Response body

Response message for validating entities that could be added into a watchlist in batch under an instance.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "responses": [
    {
      object (ValidateWatchlistEntityResponse)
    }
  ]
}
Fields
responses[]

object (ValidateWatchlistEntityResponse)

Validation responses for each entity.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.entities.batchValidate

For more information, see the IAM documentation.

ValidateWatchlistEntityRequest

Request message for validating an entity that could be added into a watchlist under an instance.

JSON representation 
{
  "parent": string,
  "entity": {
    object (Entity)
  }
}
Fields
parent

string

Required. The parent resource shared by all existing entities. Format: projects/{project}/locations/{location}/instances/{instance}
entity

object (Entity)

Required. The entity to validate.

ValidateWatchlistEntityResponse

Response message for validating an entity that could be added into a watchlist under an instance.

JSON representation 
{
  "errorType": enum (ErrorType)
}
Fields
errorType

enum (ErrorType)

The type of the error.

ErrorType

Error type encountered during validation.

Enums
ERROR_TYPE_UNSPECIFIED The default error type. It means the entity is valid under the instance.
NOT_FOUND The entity is not found under the instance.