configurations

Creates, updates, deletes, gets or lists a configurations resource.

Overview

Name	configurations
Type	Resource
Id	google.threatintelligence.configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration}
audit	object	Output only. Audit information for the configuration. (id: Audit)
description	string	Optional. A description of the configuration.
detail	object	Required. Domain specific details for the configuration. (id: ConfigurationDetail)
displayName	string	Output only. Human readable name for the configuration.
etag	string	If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned.
provider	string	Required. Name of the service that provides the configuration.
state	string	Optional. State of the configuration. (STATE_UNSPECIFIED, ENABLED, DISABLED, DEPRECATED)
version	string	Optional. A user-manipulatable version. Does not adhere to a specific format

list

Name	Datatype	Description
name	string	Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration}
audit	object	Output only. Audit information for the configuration. (id: Audit)
description	string	Optional. A description of the configuration.
detail	object	Required. Domain specific details for the configuration. (id: ConfigurationDetail)
displayName	string	Output only. Human readable name for the configuration.
etag	string	If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned.
provider	string	Required. Name of the service that provides the configuration.
state	string	Optional. State of the configuration. (STATE_UNSPECIFIED, ENABLED, DISABLED, DEPRECATED)
version	string	Optional. A user-manipulatable version. Does not adhere to a specific format

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, configurationsId		Get a configuration by name.
list	select	projectsId	filter, pageToken, pageSize, orderBy	Get a list of configurations that meet the filter criteria.
upsert	exec	projectsId	publishTime	Creates or updates a configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
configurationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
publishTime	string (google-datetime)

SELECT examples

get

Get a configuration by name.

SELECT
name,
audit,
description,
detail,
displayName,
etag,
provider,
state,
version
FROM google.threatintelligence.configurations
WHERE projectsId = '{{ projectsId }}' -- required
AND configurationsId = '{{ configurationsId }}' -- required
;

list

Get a list of configurations that meet the filter criteria.

SELECT
name,
audit,
description,
detail,
displayName,
etag,
provider,
state,
version
FROM google.threatintelligence.configurations
WHERE projectsId = '{{ projectsId }}' -- required
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

Lifecycle Methods

upsert

Creates or updates a configuration.

EXEC google.threatintelligence.configurations.upsert 
@projectsId='{{ projectsId }}' --required, 
@publishTime='{{ publishTime }}' 
@@json=
'{
"provider": "{{ provider }}", 
"state": "{{ state }}", 
"version": "{{ version }}", 
"description": "{{ description }}", 
"detail": "{{ detail }}", 
"etag": "{{ etag }}", 
"name": "{{ name }}"
}'
;