Workload Manager API (workloadmanager:v1)

2022-12-10

9 removed methods | Removed API

Deletions

    Methods

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

      Parameter Order: name

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

      Path: v1/{+name}/operations

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

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

      HTTP Method: GET

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

        filter

          Location: query

          Description: The standard list filter.

          Type: string

        name

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

          Description: The name of the operation's parent resource.

          Location: path

          Type: string

          Required: Yes

        pageSize

          Location: query

          Type: integer

          Format: int32

          Description: The standard list page size.

  • ▼ ▲ workloadmanager.projects.locations.operations.cancel

      Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

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

      HTTP Method: POST

      Path: v1/{+name}:cancel

      Parameter Order: name

      Parameters:

        name

          Type: string

          Description: The name of the operation resource to be cancelled.

          Required: Yes

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

          Location: path

  • ▼ ▲ workloadmanager.projects.locations.operations.get

      Parameters:

        name

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

          Required: Yes

          Location: path

          Description: The name of the operation resource.

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path: v1/{+name}

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

      Parameter Order: name

      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.

  • ▼ ▲ workloadmanager.projects.locations.operations.delete

      Path: v1/{+name}

      HTTP Method: DELETE

      Parameter Order: name

      Parameters:

        name

          Description: The name of the operation resource to be deleted.

          Type: string

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

          Required: Yes

          Location: path

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

      Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

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

      Description: Lists Evaluations in a given project and location.

      Path: v1/{+parent}/evaluations

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Description: Required. Parent value for ListEvaluationsRequest

          Required: Yes

          Location: path

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

        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

        pageToken

          Location: query

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

          Type: string

        filter

          Description: Filtering results

          Location: query

          Type: string

        orderBy

          Location: query

          Description: Hint for how to order the results

          Type: string

      HTTP Method: GET

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

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

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

      HTTP Method: GET

      Path: v1/{+name}

      Parameter Order: name

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Required. Name of the resource

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

          Type: string

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

      Description: Gets details of a single Evaluation.

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

  • ▼ ▲ workloadmanager.projects.locations.evaluations.create

      Parameters:

        evaluationId

          Location: query

          Type: string

          Description: Required. Id of the requesting object If auto-generating Id server-side, remove this field and evaluation_id from the method_signature of Create RPC

        requestId

          Type: string

          Location: query

          Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

        parent

          Location: path

          Type: string

          Required: Yes

          Description: Required. The resource name of the evaluation location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.

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

      HTTP Method: POST

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

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

      Path: v1/{+parent}/evaluations

      Parameter Order: parent

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

  • ▼ ▲ workloadmanager.projects.locations.get

      Description: Gets information about a location.

      HTTP Method: GET

      Parameters:

        name

          Type: string

          Description: Resource name for the location.

          Required: Yes

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

          Location: path

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

      Parameter Order: name

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

      Path: v1/{+name}

  • ▼ ▲ workloadmanager.projects.locations.list

      Parameters:

        filter

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Location: query

          Type: string

        pageSize

          Type: integer

          Location: query

          Description: The maximum number of results to return. If not set, the service selects a default.

          Format: int32

        pageToken

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Type: string

          Location: query

        name

          Description: The resource that owns the locations collection, if applicable.

          Pattern: ^projects/[^/]+$

          Required: Yes

          Location: path

          Type: string

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

      HTTP Method: GET

      Parameter Order: name

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

      Description: Lists information about the supported locations for this service.

      Path: v1/{+name}/locations

9 new methods | New API

Additions

    Methods

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

      Parameter Order: name

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

      Path: v1/{+name}/operations

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

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

      HTTP Method: GET

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

        filter

          Location: query

          Description: The standard list filter.

          Type: string

        name

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

          Description: The name of the operation's parent resource.

          Location: path

          Type: string

          Required: Yes

        pageSize

          Location: query

          Type: integer

          Format: int32

          Description: The standard list page size.

  • ▼ ▲ workloadmanager.projects.locations.operations.cancel

      Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

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

      HTTP Method: POST

      Path: v1/{+name}:cancel

      Parameter Order: name

      Parameters:

        name

          Type: string

          Description: The name of the operation resource to be cancelled.

          Required: Yes

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

          Location: path

  • ▼ ▲ workloadmanager.projects.locations.operations.get

      Parameters:

        name

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

          Required: Yes

          Location: path

          Description: The name of the operation resource.

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path: v1/{+name}

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

      Parameter Order: name

      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.

  • ▼ ▲ workloadmanager.projects.locations.operations.delete

      Path: v1/{+name}

      HTTP Method: DELETE

      Parameter Order: name

      Parameters:

        name

          Description: The name of the operation resource to be deleted.

          Type: string

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

          Required: Yes

          Location: path

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

      Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

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

      Description: Lists Evaluations in a given project and location.

      Path: v1/{+parent}/evaluations

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Description: Required. Parent value for ListEvaluationsRequest

          Required: Yes

          Location: path

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

        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

        pageToken

          Location: query

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

          Type: string

        filter

          Description: Filtering results

          Location: query

          Type: string

        orderBy

          Location: query

          Description: Hint for how to order the results

          Type: string

      HTTP Method: GET

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

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

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

      HTTP Method: GET

      Path: v1/{+name}

      Parameter Order: name

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Required. Name of the resource

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

          Type: string

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

      Description: Gets details of a single Evaluation.

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

  • ▼ ▲ workloadmanager.projects.locations.evaluations.create

      Parameters:

        evaluationId

          Location: query

          Type: string

          Description: Required. Id of the requesting object If auto-generating Id server-side, remove this field and evaluation_id from the method_signature of Create RPC

        requestId

          Type: string

          Location: query

          Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

        parent

          Location: path

          Type: string

          Required: Yes

          Description: Required. The resource name of the evaluation location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.

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

      HTTP Method: POST

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

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

      Path: v1/{+parent}/evaluations

      Parameter Order: parent

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

  • ▼ ▲ workloadmanager.projects.locations.get

      Description: Gets information about a location.

      HTTP Method: GET

      Parameters:

        name

          Type: string

          Description: Resource name for the location.

          Required: Yes

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

          Location: path

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

      Parameter Order: name

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

      Path: v1/{+name}

  • ▼ ▲ workloadmanager.projects.locations.list

      Parameters:

        filter

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Location: query

          Type: string

        pageSize

          Type: integer

          Location: query

          Description: The maximum number of results to return. If not set, the service selects a default.

          Format: int32

        pageToken

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Type: string

          Location: query

        name

          Description: The resource that owns the locations collection, if applicable.

          Pattern: ^projects/[^/]+$

          Required: Yes

          Location: path

          Type: string

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

      HTTP Method: GET

      Parameter Order: name

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

      Description: Lists information about the supported locations for this service.

      Path: v1/{+name}/locations