replays

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

Overview

Name	replays
Type	Resource
Id	google.policysimulator.replays

Fields

The following fields are returned by SELECT queries:

projects_locations_replays_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the Replay, which has the following format: {projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}, where {resource-id} is the ID of the project, folder, or organization that owns the Replay. Example: projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36
config	object	Required. The configuration used for the Replay. (id: GoogleCloudPolicysimulatorV1ReplayConfig)
resultsSummary	object	Output only. Summary statistics about the replayed log entries. (id: GoogleCloudPolicysimulatorV1ReplayResultsSummary)
state	string	Output only. The current state of the Replay.

folders_locations_replays_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the Replay, which has the following format: {projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}, where {resource-id} is the ID of the project, folder, or organization that owns the Replay. Example: projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36
config	object	Required. The configuration used for the Replay. (id: GoogleCloudPolicysimulatorV1ReplayConfig)
resultsSummary	object	Output only. Summary statistics about the replayed log entries. (id: GoogleCloudPolicysimulatorV1ReplayResultsSummary)
state	string	Output only. The current state of the Replay.

organizations_locations_replays_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the Replay, which has the following format: {projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}, where {resource-id} is the ID of the project, folder, or organization that owns the Replay. Example: projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36
config	object	Required. The configuration used for the Replay. (id: GoogleCloudPolicysimulatorV1ReplayConfig)
resultsSummary	object	Output only. Summary statistics about the replayed log entries. (id: GoogleCloudPolicysimulatorV1ReplayResultsSummary)
state	string	Output only. The current state of the Replay.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_replays_get	select	projectsId, locationsId, replaysId		Gets the specified Replay. Each Replay is available for at least 7 days.
folders_locations_replays_get	select	foldersId, locationsId, replaysId		Gets the specified Replay. Each Replay is available for at least 7 days.
organizations_locations_replays_get	select	organizationsId, locationsId, replaysId		Gets the specified Replay. Each Replay is available for at least 7 days.
projects_locations_replays_create	insert	projectsId, locationsId		Creates and starts a Replay using the given ReplayConfig.
folders_locations_replays_create	insert	foldersId, locationsId		Creates and starts a Replay using the given ReplayConfig.
organizations_locations_replays_create	insert	organizationsId, locationsId		Creates and starts a Replay using the given ReplayConfig.

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
foldersId	string
locationsId	string
organizationsId	string
projectsId	string
replaysId	string

SELECT examples

projects_locations_replays_get

Gets the specified Replay. Each Replay is available for at least 7 days.

SELECT
name,
config,
resultsSummary,
state
FROM google.policysimulator.replays
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND replaysId = '{{ replaysId }}' -- required;

folders_locations_replays_get

Gets the specified Replay. Each Replay is available for at least 7 days.

SELECT
name,
config,
resultsSummary,
state
FROM google.policysimulator.replays
WHERE foldersId = '{{ foldersId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND replaysId = '{{ replaysId }}' -- required;

organizations_locations_replays_get

Gets the specified Replay. Each Replay is available for at least 7 days.

SELECT
name,
config,
resultsSummary,
state
FROM google.policysimulator.replays
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND replaysId = '{{ replaysId }}' -- required;

INSERT examples

projects_locations_replays_create

Creates and starts a Replay using the given ReplayConfig.

INSERT INTO google.policysimulator.replays (
data__config,
projectsId,
locationsId
)
SELECT 
'{{ config }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

folders_locations_replays_create

Creates and starts a Replay using the given ReplayConfig.

INSERT INTO google.policysimulator.replays (
data__config,
foldersId,
locationsId
)
SELECT 
'{{ config }}',
'{{ foldersId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

organizations_locations_replays_create

Creates and starts a Replay using the given ReplayConfig.

INSERT INTO google.policysimulator.replays (
data__config,
organizationsId,
locationsId
)
SELECT 
'{{ config }}',
'{{ organizationsId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: replays
  props:
    - name: projectsId
      value: string
      description: Required parameter for the replays resource.
    - name: locationsId
      value: string
      description: Required parameter for the replays resource.
    - name: foldersId
      value: string
      description: Required parameter for the replays resource.
    - name: organizationsId
      value: string
      description: Required parameter for the replays resource.
    - name: config
      value: object
      description: >
        Required. The configuration used for the `Replay`.