2025-03-27
▼ ▲ policysimulator.folders.locations.replays.get
Description : Gets the specified Replay. Each `Replay` is available for at least 7 days.
Path : v1alpha/{+name}
Flat Path : v1alpha/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Parameters :
name
Type : string
Location : path
Required : Yes
Description : Required. The name of the Replay to retrieve, in 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`
Pattern : ^folders/[^/]+/locations/[^/]+/replays/[^/]+$
▼ ▲ policysimulator.folders.locations.replays.list
Parameter Order : parent
Parameters :
pageSize
Format : int32
Description : The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.
Location : query
Type : integer
pageToken
Description : A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.
Location : query
Type : string
parent
Required : Yes
Type : string
Pattern : ^folders/[^/]+/locations/[^/]+$
Location : path
Description : Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.
Description : Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.
HTTP Method : GET
Flat Path : v1alpha/folders/{foldersId}/locations/{locationsId}/replays
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/replays
▼ ▲ policysimulator.folders.locations.replays.create
HTTP Method : POST
Parameters :
parent
Pattern : ^folders/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`
Location : path
Flat Path : v1alpha/folders/{foldersId}/locations/{locationsId}/replays
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : Creates and starts a Replay using the given ReplayConfig.
Path : v1alpha/{+parent}/replays
▼ ▲ policysimulator.folders.locations.replays.results.list
Description : Lists the results of running a Replay.
HTTP Method : GET
Path : v1alpha/{+parent}/results
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results
Parameters :
parent
Required : Yes
Description : Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
Pattern : ^folders/[^/]+/locations/[^/]+/replays/[^/]+$
Type : string
Location : path
pageSize
Type : integer
Location : query
Description : The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.
Format : int32
pageToken
Location : query
Description : A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.
Type : string
Parameter Order : parent
▼ ▲ policysimulator.organizations.locations.replays.results.list
Path : v1alpha/{+parent}/results
Parameters :
pageToken
Description : A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.
Location : query
Type : string
pageSize
Type : integer
Description : The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.
Location : query
Format : int32
parent
Pattern : ^organizations/[^/]+/locations/[^/]+/replays/[^/]+$
Type : string
Description : Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
Location : path
Required : Yes
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the results of running a Replay.
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results
HTTP Method : GET
▼ ▲ policysimulator.organizations.locations.replays.list
Parameters :
parent
Location : path
Type : string
Pattern : ^organizations/[^/]+/locations/[^/]+$
Description : Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.
Required : Yes
pageSize
Description : The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.
Format : int32
Location : query
Type : integer
pageToken
Type : string
Description : A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.
Location : query
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.
Path : v1alpha/{+parent}/replays
HTTP Method : GET
▼ ▲ policysimulator.organizations.locations.replays.create
Path : v1alpha/{+parent}/replays
Parameter Order : parent
HTTP Method : POST
Parameters :
parent
Pattern : ^organizations/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates and starts a Replay using the given ReplayConfig.
▼ ▲ policysimulator.organizations.locations.replays.get
Parameters :
name
Type : string
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+/replays/[^/]+$
Required : Yes
Description : Required. The name of the Replay to retrieve, in 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`
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}
Parameter Order : name
Description : Gets the specified Replay. Each `Replay` is available for at least 7 days.
Path : v1alpha/{+name}
HTTP Method : GET
▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
parent
Description : Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}
Required : Yes
Pattern : ^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$
Location : path
Type : string
pageToken
Description : Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.
Location : query
Type : string
pageSize
Type : integer
Description : Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format : int32
Location : query
Path : v1alpha/{+parent}/orgPolicyViolations
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations
Parameter Order : parent
Description : ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview.
▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.generate
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Location : path
Description : Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`
Pattern : ^organizations/[^/]+/locations/[^/]+$
Required : Yes
Type : string
HTTP Method : POST
Description : GenerateOrgPolicyViolationsPreview generates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The resources to scan are inferred from these specified changes.
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews:generate
Parameter Order : parent
Path : v1alpha/{+parent}/orgPolicyViolationsPreviews:generate
▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.get
HTTP Method : GET
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.
Parameters :
name
Location : path
Type : string
Description : Required. The name of the OrgPolicyViolationsPreview to get.
Required : Yes
Pattern : ^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$
▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.create
Path : v1alpha/{+parent}/orgPolicyViolationsPreviews
Parameters :
orgPolicyViolationsPreviewId
Type : string
Location : query
Description : Optional. An optional user-specified ID for the OrgPolicyViolationsPreview. If not provided, a random ID will be generated.
parent
Required : Yes
Location : path
Description : Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`
Pattern : ^organizations/[^/]+/locations/[^/]+$
Type : string
Parameter Order : parent
Description : CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The resources to scan are inferred from these specified changes.
HTTP Method : POST
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews
▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.list
Description : ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.
Parameters :
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 5 items will be returned. The maximum value is 10; values above 10 will be coerced to 10.
pageToken
Location : query
Description : Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.
Type : string
parent
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent the violations are scoped to. Format: `organizations/{organization}/locations/{location}` Example: `organizations/my-example-org/locations/global`
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : parent
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews
Path : v1alpha/{+parent}/orgPolicyViolationsPreviews
▼ ▲ policysimulator.projects.locations.replays.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the specified Replay. Each `Replay` is available for at least 7 days.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}
Path : v1alpha/{+name}
HTTP Method : GET
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/replays/[^/]+$
Location : path
Description : Required. The name of the Replay to retrieve, in 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`
Type : string
Required : Yes
Parameter Order : name
▼ ▲ policysimulator.projects.locations.replays.list
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/replays
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.
Parameter Order : parent
Parameters :
pageToken
Description : A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.
Type : string
Location : query
pageSize
Type : integer
Location : query
Description : The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.
Format : int32
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.
Type : string
Location : path
Path : v1alpha/{+parent}/replays
▼ ▲ policysimulator.projects.locations.replays.create
Path : v1alpha/{+parent}/replays
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`
Type : string
HTTP Method : POST
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/replays
Description : Creates and starts a Replay using the given ReplayConfig.
▼ ▲ policysimulator.projects.locations.replays.results.list
HTTP Method : GET
Parameters :
pageToken
Type : string
Location : query
Description : A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/replays/[^/]+$
Required : Yes
Description : Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
pageSize
Type : integer
Description : The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.
Location : query
Format : int32
Description : Lists the results of running a Replay.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1alpha/{+parent}/results