Cloud Functions Service, gRPC: NetworkService
A set of methods for managing VPC networks connected to serverless resources.
Call | Description |
---|---|
GetUsed | Returns the specified network used in serverless resources. |
ListUsed | Retrieves the list of networks in the specified scope that are used in serverless resources. |
ListConnectedResources | Retrieves the list of serverless resources connected to any network from the specified scope. |
TriggerUsedCleanup | Forces obsolete used network to start cleanup process as soon as possible. |
Calls NetworkService
GetUsed
Returns the specified network used in serverless resources.
rpc GetUsed (GetUsedNetworkRequest) returns (UsedNetwork)
GetUsedNetworkRequest
Field | Description |
---|---|
network_id | string Required. ID of the network to return. |
UsedNetwork
Field | Description |
---|---|
network_id | string ID of the VPC network. |
cloud_id | string ID of the cloud that the network belongs to. |
folder_id | string ID of the folder that the network belongs to. |
status | enum Status Status of the network.
|
will_be_cleaned_up_at | google.protobuf.Timestamp Clean-up timestamp of the obsolete network. |
connections_count | int64 Number of serverless resources connected to the network. |
ListUsed
Retrieves the list of networks in the specified scope that are used in serverless resources.
rpc ListUsed (ListUsedNetworksRequest) returns (ListUsedNetworksResponse)
ListUsedNetworksRequest
Field | Description |
---|---|
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than pageSize , the service returns a ListUsedNetworksResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set pageToken to the ListUsedNetworksResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
scope | oneof: cloud_id or folder_id |
cloud_id | string ID of the cloud to list used networks in. |
folder_id | string ID of the folder to list used networks in. |
ListUsedNetworksResponse
Field | Description |
---|---|
networks[] | UsedNetwork List of used networks in the specified scope. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListUsedNetworksRequest.page_size, use nextPageToken as the value for the ListUsedNetworksRequest.page_token parameter in the next list request. Each subsequent page will have its own nextPageToken to continue paging through the results. |
UsedNetwork
Field | Description |
---|---|
network_id | string ID of the VPC network. |
cloud_id | string ID of the cloud that the network belongs to. |
folder_id | string ID of the folder that the network belongs to. |
status | enum Status Status of the network.
|
will_be_cleaned_up_at | google.protobuf.Timestamp Clean-up timestamp of the obsolete network. |
connections_count | int64 Number of serverless resources connected to the network. |
ListConnectedResources
Retrieves the list of serverless resources connected to any network from the specified scope.
rpc ListConnectedResources (ListConnectedResourcesRequest) returns (ListConnectedResourcesResponse)
ListConnectedResourcesRequest
Field | Description |
---|---|
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than pageSize , the service returns a ListConnectedResourcesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set pageToken to the ListConnectedResourcesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
network_scope | oneof: network_id , cloud_id or folder_id |
network_id | string ID of the network to list serverless resources connected to it. |
cloud_id | string ID of the cloud to list serverless resources connected to any network from it. |
folder_id | string ID of the folder to list serverless resources connected to any network from it. |
ListConnectedResourcesResponse
Field | Description |
---|---|
resources[] | ConnectedResource List of serverless resources connected to any network from the specified scope. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListConnectedResourcesRequest.page_size, use nextPageToken as the value for the ListConnectedResourcesRequest.page_token parameter in the next list request. Each subsequent page will have its own nextPageToken to continue paging through the results. |
ConnectedResource
Field | Description |
---|---|
network_id | string ID of the network to which the resource is connected. |
resource_type | string Type of the serverless resource. |
resource_id | string ID of the serverless resource. |
subresource_type | string Type of the serverless subresource. |
subresource_id | string ID of the serverless subresource. |
resource_cloud_id | string ID of the cloud that the resource belongs to. |
resource_folder_id | string ID of the folder thar the resource belongs to. |
TriggerUsedCleanup
Forces obsolete used network to start cleanup process as soon as possible. Invocation does not wait for start or end of the cleanup process. Second invocation with the same network does nothing until network is completely cleaned-up.
rpc TriggerUsedCleanup (TriggerUsedNetworkCleanupRequest) returns (TriggerUsedNetworkCleanupResponse)
TriggerUsedNetworkCleanupRequest
Field | Description |
---|---|
network_id | string Required. ID of the obsolete network to start the cleanup process for. |
TriggerUsedNetworkCleanupResponse
Field | Description |
---|---|
network_cleanup_time | google.protobuf.Timestamp Timestamp when cleanup of the specified network will be started. |