Workload Manager API (workloadmanager:v1)

Additions

Methods


• ▼ ▲ workloadmanager.projects.locations.rules.list

  Path: v1/{+parent}/rules

  Parameters:

  parent

  Required: Yes

  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

  Type: string

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

  Location: path

  pageSize

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

  Format: int32

  Type: integer

  Location: query

  filter

  Description: Filter based on primary_category, secondary_category

  Location: query

  Type: string

  pageToken

  Type: string

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

  Location: query

  HTTP Method: GET

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

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

  Description: Lists rules in a given project.

  Parameter Order: parent

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

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

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

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

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

  Parameter Order: name

  Parameters:

  name

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

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

  Type: string

  Required: Yes

  Location: path

  HTTP Method: POST

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

  Path: v1/{+name}

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

  Parameters:

  name

  Location: path

  Required: Yes

  Type: string

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

  Description: Required. Name of the resource

  Description: Gets details of a single Execution.

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

  Parameter Order: name

  HTTP Method: GET

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

  Description: Lists Executions in a given project and location.

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

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

  Parameter Order: parent

  HTTP Method: GET

  Parameters:

  pageToken

  Type: string

  Location: query

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

  filter

  Location: query

  Description: Filtering results

  Type: string

  orderBy

  Location: query

  Type: string

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

  parent

  Required: Yes

  Location: path

  Type: string

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

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

  pageSize

  Type: integer

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

  Format: int32

  Location: query

  Path: v1/{+parent}/executions

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

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

  Path: v1/{+parent}/results

  HTTP Method: GET

  Description: List the running result of a single Execution.

  Parameter Order: parent

  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.

  pageSize

  Format: int32

  Location: query

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

  Type: integer

  parent

  Required: Yes

  Type: string

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

  Location: path

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

  filter

  Description: Filtering results

  Location: query

  Type: string

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

  Description: List all scanned resources for a single Execution.

  HTTP Method: GET

  Parameters:

  rule

  Type: string

  Description: rule name

  Location: query

  pageToken

  Location: query

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

  Type: string

  parent

  Description: Required. parent for ListScannedResourcesRequest

  Location: path

  Type: string

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

  Required: Yes

  filter

  Description: Filtering results

  Location: query

  Type: string

  pageSize

  Location: query

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

  Type: integer

  Format: int32

  orderBy

  Type: string

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

  Location: query

  Path: v1/{+parent}/scannedResources

  Parameter Order: parent

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

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