Method: instances.getThreatCollectionFilterSet

Full name: projects.locations.instances.getThreatCollectionFilterSet

Get the set of threat collection filter options.

HTTP request


Path parameters

Parameters
name

string

Required. The resource name. Format: projects/{project}/locations/{location}/instances/{instance}/threatCollectionFilterSet

Request body

The request body must be empty.

Response body

Represents threat collection filters and their available values to be used when requesting a filtered list of threat collections.

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

JSON representation 
{
  "name": string,
  "filters": [
    {
      object (Filter)
    }
  ]
}
Fields
name

string

Output only. Identifier. Resource name for threat collection filters, in the format '.../instances/{instance}/threatCollectionFilterSet'.
filters[]

object (Filter)

Output only. List of filters that threat collections feed supports.

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 name resource:

  • chronicle.threatCollectionFilterSet.get

For more information, see the IAM documentation.

Filter

Represents a threat collection filter and its available values to be used when requesting a filtered list of threat collections.

JSON representation 
{
  "displayName": string,
  "options": [
    {
      object (FilterOption)
    }
  ]
}
Fields
displayName

string

Output only. Display name of the filter. Example: "Source Regions".
options[]

object (FilterOption)

Output only. List of options under this filter.

FilterOption

Threat collection filter option. Example: 'filter=(source_region:"US")'. "source_region" is the filterKey. "US" is the value.

JSON representation 
{
  "displayName": string,
  "filterKey": string,
  "value": string,
  "options": [
    {
      object (FilterOption)
    }
  ]
}
Fields
displayName

string

Output only. Display name of the filter option. Example: "United States".
filterKey

string

Output only. The filtering key used to use when requesting a filtered list of threat collections. Example: "source_region".
value

string

Output only. Value of the filter to use when requesting a filtered list of threat collections. Example: "US".
options[]

object (FilterOption)

Output only. Nested list of options for a given filter option.