Policy Simulator API (policysimulator:v1beta1)

2023-02-27

9 new methods | 3 removed methods

Additions

    Methods

  • ▼ ▲ policysimulator.projects.locations.replays.results.list

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results

      HTTP Method : GET

      Description : Lists the results of running a Replay.

      Parameter Order : parent

      Parameters :

        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

        parent

          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

          Pattern : ^projects/[^/]+/locations/[^/]+/replays/[^/]+$

          Required : Yes

        pageSize

          Type : integer

          Location : query

          Format : int32

          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.

      Path : v1beta1/{+parent}/results

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

  • ▼ ▲ policysimulator.projects.locations.replays.create

      Description : Creates and starts a Replay using the given ReplayConfig.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/replays

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

      Path : v1beta1/{+parent}/replays

      Parameter Order : parent

      HTTP Method : POST

      Parameters :

        parent

          Type : string

          Location : path

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+$

          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`

  • ▼ ▲ 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.

      HTTP Method : GET

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}

      Parameters :

        name

          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`

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/replays/[^/]+$

      Parameter Order : name

  • ▼ ▲ policysimulator.organizations.locations.replays.results.list

      Parameter Order : parent

      Path : v1beta1/{+parent}/results

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

      Flat Path : v1beta1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results

      Parameters :

        parent

          Pattern : ^organizations/[^/]+/locations/[^/]+/replays/[^/]+$

          Type : string

          Required : Yes

          Location : path

          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

          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

          Location : query

          Type : integer

        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.

      Description : Lists the results of running a Replay.

      HTTP Method : GET

  • ▼ ▲ policysimulator.organizations.locations.replays.get

      Flat Path : v1beta1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}

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

      Path : v1beta1/{+name}

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

      Parameter Order : name

      HTTP Method : GET

      Parameters :

        name

          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`

          Type : string

          Pattern : ^organizations/[^/]+/locations/[^/]+/replays/[^/]+$

  • ▼ ▲ policysimulator.organizations.locations.replays.create

      Flat Path : v1beta1/organizations/{organizationsId}/locations/{locationsId}/replays

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

      Parameters :

        parent

          Location : path

          Required : Yes

          Type : string

          Pattern : ^organizations/[^/]+/locations/[^/]+$

          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`

      HTTP Method : POST

      Path : v1beta1/{+parent}/replays

      Parameter Order : parent

      Description : Creates and starts a Replay using the given ReplayConfig.

  • ▼ ▲ policysimulator.folders.locations.replays.get

      HTTP Method : GET

      Path : v1beta1/{+name}

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

      Parameter Order : name

      Parameters :

        name

          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

          Pattern : ^folders/[^/]+/locations/[^/]+/replays/[^/]+$

          Required : Yes

          Location : path

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

      Flat Path : v1beta1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}

  • ▼ ▲ policysimulator.folders.locations.replays.create

      HTTP Method : POST

      Path : v1beta1/{+parent}/replays

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

      Description : Creates and starts a Replay using the given ReplayConfig.

      Flat Path : v1beta1/folders/{foldersId}/locations/{locationsId}/replays

      Parameter Order : parent

      Parameters :

        parent

          Type : string

          Location : path

          Required : Yes

          Pattern : ^folders/[^/]+/locations/[^/]+$

          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`

  • ▼ ▲ policysimulator.folders.locations.replays.results.list

      Parameter Order : parent

      Parameters :

        parent

          Required : Yes

          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

          Pattern : ^folders/[^/]+/locations/[^/]+/replays/[^/]+$

        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.

          Type : string

          Location : query

        pageSize

          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.

          Type : integer

          Location : query

          Format : int32

      Path : v1beta1/{+parent}/results

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

      Flat Path : v1beta1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results

      HTTP Method : GET

      Description : Lists the results of running a Replay.

Deletions

    Methods

  • ▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get

      Parameter Order : name

      Flat Path : v1beta1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}

      Path : v1beta1/{+name}

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

      HTTP Method : GET

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Parameters :

        name

          Required : Yes

          Pattern : ^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+/operations/.*$

          Description : The name of the operation resource.

          Location : path

          Type : string

  • ▼ ▲ policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get

      Path : v1beta1/{+name}

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

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+/operations/.*$

          Location : path

          Description : The name of the operation resource.

          Type : string

          Required : Yes

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      HTTP Method : GET

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}

      Parameter Order : name

  • ▼ ▲ policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get

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

      Flat Path : v1beta1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}

      HTTP Method : GET

      Parameter Order : name

      Parameters :

        name

          Type : string

          Description : The name of the operation resource.

          Location : path

          Pattern : ^folders/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+/operations/.*$

          Required : Yes

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Path : v1beta1/{+name}