Assured Workloads API (assuredworkloads:v1)

2022-09-22

3 new methods

Additions

    Methods
  • assuredworkloads.organizations.locations.workloads.violations.acknowledge

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

      Path : v1/{+name}:acknowledge

      Description : Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.

      HTTP Method : POST

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge

      Parameters :

        name

          Type : string

          Description : Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}

          Required : Yes

          Location : path

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

      Parameter Order : name

  • assuredworkloads.organizations.locations.workloads.violations.get

      Parameter Order : name

      HTTP Method : GET

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}

      Path : v1/{+name}

      Description : Retrieves Assured Workload Violation based on ID.

      Parameters :

        name

          Type : string

          Location : path

          Description : Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}

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

          Required : Yes

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

  • assuredworkloads.organizations.locations.workloads.violations.list

      Description : Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`

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

      Parameters :

        parent

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

          Required : Yes

          Description : Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.

          Location : path

          Type : string

        filter

          Description : Optional. A custom filter for filtering by the Violations properties.

          Type : string

          Location : query

        interval.endTime

          Format : google-datetime

          Location : query

          Type : string

          Description : The end of the time window.

        pageSize

          Type : integer

          Description : Optional. Page size.

          Format : int32

          Location : query

        interval.startTime

          Format : google-datetime

          Type : string

          Location : query

          Description : The start of the time window.

        pageToken

          Location : query

          Description : Optional. Page token returned from previous request.

          Type : string

      Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations

      Path : v1/{+parent}/violations

      HTTP Method : GET

      Parameter Order : parent