Workload Manager API (workloadmanager:v1)

2023-04-08

6 new methods

Additions

    Methods
  • workloadmanager.projects.locations.rules.list

      Path: v1/{+parent}/rules

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/rules

      Parameters:

        pageSize

          Type: integer

          Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Location: query

          Format: int32

        filter

          Type: string

          Location: query

          Description: Filter based on primary_category, secondary_category

        pageToken

          Location: query

          Description: A token identifying a page of results the server should return.

          Type: string

        parent

          Type: string

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

          Location: path

          Description: Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions

          Required: Yes

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

      Description: Lists rules in a given project.

      Parameter Order: parent

      HTTP Method: GET

  • workloadmanager.projects.locations.evaluations.executions.scannedResources.list

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/scannedResources

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

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: A token identifying a page of results the server should return.

        parent

          Required: Yes

          Type: string

          Location: path

          Description: Required. parent for ListScannedResourcesRequest

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

        pageSize

          Location: query

          Type: integer

          Format: int32

          Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

        orderBy

          Location: query

          Type: string

          Description: Field to sort by. See https://google.aip.dev/132#ordering for more details.

        filter

          Description: Filtering results

          Location: query

          Type: string

        rule

          Location: query

          Description: rule name

          Type: string

      Description: List all scanned resources for a single Execution.

      Path: v1/{+parent}/scannedResources

      Parameter Order: parent

      HTTP Method: GET

  • workloadmanager.projects.locations.evaluations.executions.results.list

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

      Description: List the running result of a single Execution.

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/results

      Parameters:

        pageToken

          Location: query

          Description: A token identifying a page of results the server should return.

          Type: string

        parent

          Type: string

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

          Description: Required. The execution results. Format: {parent}/evaluations/*/executions/*/results

          Required: Yes

          Location: path

        filter

          Type: string

          Location: query

          Description: Filtering results

        pageSize

          Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Format: int32

          Location: query

          Type: integer

      HTTP Method: GET

      Path: v1/{+parent}/results

  • workloadmanager.projects.locations.evaluations.executions.list

      Path: v1/{+parent}/executions

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions

      Parameters:

        pageToken

          Location: query

          Description: A token identifying a page of results the server should return.

          Type: string

        filter

          Description: Filtering results

          Type: string

          Location: query

        parent

          Type: string

          Required: Yes

          Location: path

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

          Description: Required. The resource prefix of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}'

        pageSize

          Location: query

          Type: integer

          Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Format: int32

        orderBy

          Type: string

          Location: query

          Description: Field to sort by. See https://google.aip.dev/132#ordering for more details.

      Parameter Order: parent

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

      Description: Lists Executions in a given project and location.

      HTTP Method: GET

  • workloadmanager.projects.locations.evaluations.executions.get

      Path: v1/{+name}

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

      Description: Gets details of a single Execution.

      Parameters:

        name

          Type: string

          Location: path

          Description: Required. Name of the resource

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

          Required: Yes

      Parameter Order: name

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}

  • workloadmanager.projects.locations.evaluations.executions.run

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

      Description: Creates a new Execution in a given project and location.

      Parameter Order: name

      Path: v1/{+name}/executions:run

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions:run

      Parameters:

        name

          Required: Yes

          Type: string

          Location: path

          Description: Required. The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}'

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

      HTTP Method: POST