Network Management API (networkmanagement:v1)

▼ ▲ networkmanagement.organizations.locations.global.operations.delete

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`.

HTTP Method : DELETE

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

Parameter Order : name

Flat Path : v1/organizations/{organizationsId}/locations/global/operations/{operationsId}

Path : v1/{+name}

Parameters :

name

Required : Yes

Type : string

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

Location : path

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

▼ ▲ networkmanagement.organizations.locations.global.operations.cancel

Parameters :

name

Required : Yes

Location : path

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

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

Type : string

Path : v1/{+name}:cancel

HTTP Method : POST

Flat Path : v1/organizations/{organizationsId}/locations/global/operations/{operationsId}:cancel

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

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`.

Parameter Order : name

▼ ▲ networkmanagement.organizations.locations.global.operations.get

Path : v1/{+name}

HTTP Method : GET

Parameter Order : name

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

Description : The name of the operation resource.

Location : path

Type : string

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

Required : Yes

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

Flat Path : v1/organizations/{organizationsId}/locations/global/operations/{operationsId}

▼ ▲ networkmanagement.organizations.locations.global.operations.list

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

Path : v1/{+name}/operations

Parameter Order : name

Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

Parameters :

returnPartialSuccess

Type : boolean

Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

Location : query

pageSize

Location : query

Format : int32

Description : The standard list page size.

Type : integer

pageToken

Location : query

Type : string

Description : The standard list page token.

filter

Description : The standard list filter.

Location : query

Type : string

name

Type : string

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

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

Required : Yes

Location : path

Flat Path : v1/organizations/{organizationsId}/locations/global/operations

HTTP Method : GET

▼ ▲ networkmanagement.organizations.locations.operations.list

Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

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

Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations

HTTP Method : GET

Parameter Order : name

Parameters :

filter

Type : string

Description : The standard list filter.

Location : query

pageToken

Type : string

Location : query

Description : The standard list page token.

returnPartialSuccess

Type : boolean

Location : query

Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

name

Required : Yes

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

Location : path

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

Type : string

pageSize

Description : The standard list page size.

Type : integer

Location : query

Format : int32

Path : v1/{+name}/operations

▼ ▲ networkmanagement.organizations.locations.operations.get

Path : v1/{+name}

HTTP Method : GET

Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

Parameters :

name

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

Location : path

Type : string

Required : Yes

Description : The name of the operation resource.

Parameter Order : name

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.

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

▼ ▲ networkmanagement.organizations.locations.operations.delete

Parameters :

name

Type : string

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

Location : path

Required : Yes

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

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

Path : v1/{+name}

Parameter Order : name

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`.

HTTP Method : DELETE

Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

▼ ▲ networkmanagement.organizations.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`.

HTTP Method : POST

Parameter Order : name

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

Parameters :

name

Type : string

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

Location : path

Required : Yes

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

Path : v1/{+name}:cancel

Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel