{ "fullyEncodeReservedExpansion": true, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "title": "Network Connectivity API", "id": "networkconnectivity:v1", "baseUrl": "https://networkconnectivity.s3nsapis.fr/", "description": "This API enables connectivity with and between Cloud de Confiance resources.", "ownerDomain": "google.com", "basePath": "", "name": "networkconnectivity", "documentationLink": "https://documentation.s3ns.fr/network-connectivity/docs/reference/networkconnectivity/rest", "version_module": true, "kind": "discovery#restDescription", "servicePath": "", "canonicalName": "networkconnectivity", "icons": { "x16": "", "x32": "" }, "discoveryVersion": "v1", "revision": "20260511", "version": "v1", "batchPath": "batch", "rootUrl": "https://networkconnectivity.s3nsapis.fr/", "ownerName": "Google", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "path": "v1/{+name}/locations", "parameters": { "name": { "pattern": "^projects/[^/]+$", "location": "path", "required": true, "description": "The resource that owns the locations collection, if applicable.", "type": "string" }, "filter": { "location": "query", "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).", "type": "string" }, "pageToken": { "location": "query", "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" }, "extraLocationTypes": { "location": "query", "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string" }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32" } }, "flatPath": "v1/projects/{projectsId}/locations", "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.location.Locations.ListLocations method is not available in this (s3nsapis.fr) universe.", "id": "networkconnectivity.projects.locations.list", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "description": "Resource name for the location.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "description": "The google.cloud.location.Locations.GetLocation method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.get", "httpMethod": "GET", "parameterOrder": [ "name" ] } }, "resources": { "operations": { "methods": { "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations", "parameters": { "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "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.", "type": "boolean", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "The name of the operation's parent resource.", "type": "string", "location": "path", "required": true }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.operations.list" }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "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.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.operations.get", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "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`.", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "path": "v1/{+name}:cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.operations.cancel" }, "delete": { "response": { "$ref": "Empty" }, "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`.", "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.operations.delete" } } }, "global": { "resources": { "policyBasedRoutes": { "methods": { "getIamPolicy": { "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ], "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}:getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/global/policyBasedRoutes/[^/]+$" }, "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies).", "type": "integer" } }, "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.get", "response": { "$ref": "PolicyBasedRoute" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.GetPolicyBasedRoute method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/global/policyBasedRoutes/[^/]+$", "description": "Required. Name of the PolicyBasedRoute resource to get.", "type": "string", "location": "path", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}" }, "testIamPermissions": { "httpMethod": "POST", "parameterOrder": [ "resource" ], "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}:testIamPermissions", "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/global/policyBasedRoutes/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "location": "path" } } }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.delete", "description": "The google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.DeletePolicyBasedRoute method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}", "path": "v1/{+name}", "parameters": { "requestId": { "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 knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the 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, ignores 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).", "type": "string" }, "name": { "description": "Required. Name of the policy-based route resource to delete.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/global/policyBasedRoutes/[^/]+$" } } }, "list": { "response": { "$ref": "ListPolicyBasedRoutesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.ListPolicyBasedRoutes method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+parent}/policyBasedRoutes", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/global$", "description": "Required. The parent resource's name.", "type": "string", "required": true, "location": "path" }, "pageSize": { "description": "The maximum number of results per page that should be returned.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "description": "Sort the results by a certain order.", "type": "string", "location": "query" }, "pageToken": { "description": "The page token.", "type": "string", "location": "query" }, "filter": { "description": "A filter expression that filters the results listed in the response.", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes", "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.list" }, "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.create", "request": { "$ref": "PolicyBasedRoute" }, "description": "The google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.CreatePolicyBasedRoute method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes", "path": "v1/{+parent}/policyBasedRoutes", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/global$", "description": "Required. The parent resource's name of the PolicyBasedRoute.", "type": "string", "location": "path", "required": true }, "policyBasedRouteId": { "description": "Required. Unique id for the policy-based route to create. Provided by the client when the resource is created. The name must comply with https://google.aip.dev/122#resource-id-segments. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([a-z0-9-]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", "type": "string", "location": "query" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the 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, ignores 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).", "type": "string", "location": "query" } } }, "setIamPolicy": { "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1/{+resource}:setIamPolicy", "parameters": { "resource": { "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/global/policyBasedRoutes/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}:setIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "SetIamPolicyRequest" }, "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe." } } }, "hubs": { "resources": { "groups": { "methods": { "list": { "id": "networkconnectivity.projects.locations.global.hubs.groups.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups", "path": "v1/{+parent}/groups", "parameters": { "filter": { "location": "query", "description": "An expression that filters the list of results.", "type": "string" }, "pageSize": { "location": "query", "description": "The maximum number of results to return per page.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource's name.", "type": "string" }, "pageToken": { "location": "query", "description": "The page token.", "type": "string" }, "orderBy": { "description": "Sort the results by a certain order.", "type": "string", "location": "query" } }, "description": "The google.cloud.networkconnectivity.v1.HubService.ListGroups method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "ListGroupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "id": "networkconnectivity.projects.locations.global.hubs.groups.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/groups/[^/]+$", "description": "Immutable. The name of the group. Group names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}`", "type": "string", "location": "path", "required": true }, "updateMask": { "description": "Optional. In the case of an update to an existing group, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten.", "type": "string", "format": "google-fieldmask", "location": "query" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string", "location": "query" } }, "request": { "$ref": "Group" }, "description": "The google.cloud.networkconnectivity.v1.HubService.UpdateGroup method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "SetIamPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/groups/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "id": "networkconnectivity.projects.locations.global.hubs.groups.setIamPolicy" }, "getIamPolicy": { "id": "networkconnectivity.projects.locations.global.hubs.groups.getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ], "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/groups/[^/]+$", "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}:getIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe." }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.hubs.groups.get", "response": { "$ref": "Group" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.GetGroup method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the route table resource.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/groups/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}" }, "testIamPermissions": { "id": "networkconnectivity.projects.locations.global.hubs.groups.testIamPermissions", "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/groups/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}:testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "TestIamPermissionsRequest" } } } }, "routeTables": { "methods": { "get": { "id": "networkconnectivity.projects.locations.global.hubs.routeTables.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/routeTables/[^/]+$", "description": "Required. The name of the route table resource.", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}", "response": { "$ref": "RouteTable" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.GetRouteTable method is not available in this (s3nsapis.fr) universe." }, "list": { "path": "v1/{+parent}/routeTables", "parameters": { "pageSize": { "location": "query", "description": "The maximum number of results to return per page.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource's name.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" }, "pageToken": { "location": "query", "description": "The page token.", "type": "string" }, "orderBy": { "location": "query", "description": "Sort the results by a certain order.", "type": "string" }, "filter": { "location": "query", "description": "An expression that filters the list of results.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables", "response": { "$ref": "ListRouteTablesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.ListRouteTables method is not available in this (s3nsapis.fr) universe.", "id": "networkconnectivity.projects.locations.global.hubs.routeTables.list", "httpMethod": "GET", "parameterOrder": [ "parent" ] } }, "resources": { "routes": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}/routes/{routesId}", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/routeTables/[^/]+/routes/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the route resource.", "type": "string" } }, "description": "The google.cloud.networkconnectivity.v1.HubService.GetRoute method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "Route" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.global.hubs.routeTables.routes.get", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "networkconnectivity.projects.locations.global.hubs.routeTables.routes.list", "description": "The google.cloud.networkconnectivity.v1.HubService.ListRoutes method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "ListRoutesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}/routes", "path": "v1/{+parent}/routes", "parameters": { "pageToken": { "location": "query", "description": "The page token.", "type": "string" }, "orderBy": { "location": "query", "description": "Sort the results by a certain order.", "type": "string" }, "pageSize": { "location": "query", "description": "The maximum number of results to return per page.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+/routeTables/[^/]+$", "required": true, "location": "path", "description": "Required. The parent resource's name.", "type": "string" }, "filter": { "description": "An expression that filters the list of results.", "type": "string", "location": "query" } } } } } } } }, "methods": { "rejectSpoke": { "path": "v1/{+name}:rejectSpoke", "parameters": { "name": { "description": "Required. The name of the hub from which to reject the spoke.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:rejectSpoke", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RejectHubSpokeRequest" }, "description": "The google.cloud.networkconnectivity.v1.HubService.RejectHubSpoke method is not available in this (s3nsapis.fr) universe.", "id": "networkconnectivity.projects.locations.global.hubs.rejectSpoke", "httpMethod": "POST", "parameterOrder": [ "name" ] }, "create": { "path": "v1/{+parent}/hubs", "parameters": { "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string", "location": "query" }, "hubId": { "location": "query", "description": "Required. A unique identifier for the hub.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/global$", "required": true, "location": "path", "description": "Required. The parent resource.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Hub" }, "description": "The google.cloud.networkconnectivity.v1.HubService.CreateHub method is not available in this (s3nsapis.fr) universe.", "id": "networkconnectivity.projects.locations.global.hubs.create", "httpMethod": "POST", "parameterOrder": [ "parent" ] }, "queryStatus": { "response": { "$ref": "QueryHubStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.QueryHubStatus method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}:queryStatus", "parameters": { "filter": { "location": "query", "description": "Optional. An expression that filters the list of results. The filter can be used to filter the results by the following fields: * `psc_propagation_status.source_spoke` * `psc_propagation_status.source_group` * `psc_propagation_status.source_forwarding_rule` * `psc_propagation_status.target_spoke` * `psc_propagation_status.target_group` * `psc_propagation_status.code` * `psc_propagation_status.message`", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the hub.", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of results to return per page.", "type": "integer", "format": "int32", "location": "query" }, "groupBy": { "location": "query", "description": "Optional. Aggregate the results by the specified fields. A comma-separated list of any of these fields: * `psc_propagation_status.source_spoke` * `psc_propagation_status.source_group` * `psc_propagation_status.source_forwarding_rule` * `psc_propagation_status.target_spoke` * `psc_propagation_status.target_group` * `psc_propagation_status.code`", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. Sort the results in ascending order by the specified fields. A comma-separated list of any of these fields: * `psc_propagation_status.source_spoke` * `psc_propagation_status.source_group` * `psc_propagation_status.source_forwarding_rule` * `psc_propagation_status.target_spoke` * `psc_propagation_status.target_group` * `psc_propagation_status.code` If `group_by` is set, the value of the `order_by` field must be the same as or a subset of the `group_by` field.", "type": "string" }, "pageToken": { "description": "Optional. The page token.", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:queryStatus", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.hubs.queryStatus" }, "testIamPermissions": { "httpMethod": "POST", "parameterOrder": [ "resource" ], "id": "networkconnectivity.projects.locations.global.hubs.testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "TestIamPermissionsRequest" }, "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:testIamPermissions" }, "setIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "location": "path" } }, "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "SetIamPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.global.hubs.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ] }, "acceptSpoke": { "path": "v1/{+name}:acceptSpoke", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the hub into which to accept the spoke.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:acceptSpoke", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.AcceptHubSpoke method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "AcceptHubSpokeRequest" }, "id": "networkconnectivity.projects.locations.global.hubs.acceptSpoke", "httpMethod": "POST", "parameterOrder": [ "name" ] }, "listSpokes": { "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.hubs.listSpokes", "response": { "$ref": "ListHubSpokesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.ListHubSpokes method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}:listSpokes", "parameters": { "spokeLocations": { "location": "query", "repeated": true, "description": "A list of locations. Specify one of the following: `[global]`, a single region (for example, `[us-central1]`), or a combination of values (for example, `[global, us-central1, us-west1]`). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.", "type": "string" }, "filter": { "location": "query", "description": "An expression that filters the list of results.", "type": "string" }, "view": { "location": "query", "description": "The view of the spoke to return. The view that you use determines which spoke fields are included in the response.", "type": "string", "enumDescriptions": [ "The spoke view is unspecified. When the spoke view is unspecified, the API returns the same fields as the `BASIC` view.", "Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`, and `spoke_type`. This is the default value.", "Includes all spoke fields except `labels`. You can use the `DETAILED` view only when you set the `spoke_locations` field to `[global]`." ], "enum": [ "SPOKE_VIEW_UNSPECIFIED", "BASIC", "DETAILED" ] }, "name": { "description": "Required. The name of the hub.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" }, "pageSize": { "format": "int32", "description": "The maximum number of results to return per page.", "type": "integer", "location": "query" }, "orderBy": { "description": "Sort the results by name or create_time.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "The page token.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:listSpokes" }, "acceptSpokeUpdate": { "id": "networkconnectivity.projects.locations.global.hubs.acceptSpokeUpdate", "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:acceptSpokeUpdate", "path": "v1/{+name}:acceptSpokeUpdate", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "description": "Required. The name of the hub to accept spoke update.", "type": "string", "required": true, "location": "path" } }, "request": { "$ref": "AcceptSpokeUpdateRequest" }, "description": "The google.cloud.networkconnectivity.v1.HubService.AcceptSpokeUpdate method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "rejectSpokeUpdate": { "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:rejectSpokeUpdate", "path": "v1/{+name}:rejectSpokeUpdate", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "description": "Required. The name of the hub to reject spoke update.", "type": "string", "location": "path", "required": true } }, "request": { "$ref": "RejectSpokeUpdateRequest" }, "description": "The google.cloud.networkconnectivity.v1.HubService.RejectSpokeUpdate method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.global.hubs.rejectSpokeUpdate", "httpMethod": "POST", "parameterOrder": [ "name" ] }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}", "path": "v1/{+name}", "parameters": { "name": { "location": "path", "required": true, "description": "Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}`", "type": "string", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" }, "updateMask": { "description": "Optional. In the case of an update to an existing hub, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten.", "type": "string", "format": "google-fieldmask", "location": "query" }, "requestId": { "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string" } }, "request": { "$ref": "Hub" }, "description": "The google.cloud.networkconnectivity.v1.HubService.UpdateHub method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.global.hubs.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ] }, "list": { "description": "The google.cloud.networkconnectivity.v1.HubService.ListHubs method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "ListHubsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/global/hubs", "path": "v1/{+parent}/hubs", "parameters": { "pageSize": { "location": "query", "description": "The maximum number of results per page to return.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource's name.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/global$" }, "pageToken": { "location": "query", "description": "The page token.", "type": "string" }, "orderBy": { "location": "query", "description": "Sort the results by a certain order.", "type": "string" }, "filter": { "location": "query", "description": "An expression that filters the list of results.", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "networkconnectivity.projects.locations.global.hubs.list" }, "delete": { "description": "The google.cloud.networkconnectivity.v1.HubService.DeleteHub method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}", "path": "v1/{+name}", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the hub to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" }, "requestId": { "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.hubs.delete" }, "getIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" } }, "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.global.hubs.getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ] }, "get": { "response": { "$ref": "Hub" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.GetHub method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the hub resource to get.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.hubs.get" } } } } }, "spokes": { "methods": { "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.DeleteSpoke method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name of the spoke to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.spokes.delete" }, "getIamPolicy": { "httpMethod": "GET", "parameterOrder": [ "resource" ], "id": "networkconnectivity.projects.locations.spokes.getIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "required": true }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:getIamPolicy" }, "get": { "id": "networkconnectivity.projects.locations.spokes.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name of the spoke resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}", "response": { "$ref": "Spoke" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.cloud.networkconnectivity.v1.HubService.GetSpoke method is not available in this (s3nsapis.fr) universe." }, "testIamPermissions": { "id": "networkconnectivity.projects.locations.spokes.testIamPermissions", "httpMethod": "POST", "parameterOrder": [ "resource" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:testIamPermissions", "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$" } }, "request": { "$ref": "TestIamPermissionsRequest" }, "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes", "path": "v1/{+parent}/spokes", "parameters": { "parent": { "required": true, "location": "path", "description": "Required. The parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string", "location": "query" }, "spokeId": { "location": "query", "description": "Required. Unique id for the spoke to create.", "type": "string" } }, "description": "The google.cloud.networkconnectivity.v1.HubService.CreateSpoke method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "Spoke" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.spokes.create", "httpMethod": "POST", "parameterOrder": [ "parent" ] }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Spoke" }, "description": "The google.cloud.networkconnectivity.v1.HubService.UpdateSpoke method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}", "parameters": { "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string", "location": "query" }, "name": { "description": "Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke_id}`", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$" }, "updateMask": { "format": "google-fieldmask", "description": "Optional. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten.", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.spokes.patch" }, "setIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$" } }, "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "SetIamPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.spokes.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ] }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "networkconnectivity.projects.locations.spokes.list", "description": "The google.cloud.networkconnectivity.v1.HubService.ListSpokes method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "ListSpokesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes", "path": "v1/{+parent}/spokes", "parameters": { "orderBy": { "location": "query", "description": "Sort the results by a certain order.", "type": "string" }, "pageToken": { "description": "The page token.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. The parent resource.", "type": "string" }, "pageSize": { "format": "int32", "description": "The maximum number of results to return per page.", "type": "integer", "location": "query" }, "filter": { "location": "query", "description": "An expression that filters the list of results.", "type": "string" } } } } }, "internalRanges": { "methods": { "patch": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.internalRanges.patch", "request": { "$ref": "InternalRange" }, "description": "Updates the parameters of a single internal range.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}", "path": "v1/{+name}", "parameters": { "requestId": { "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 the 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).", "type": "string", "location": "query" }, "name": { "location": "path", "required": true, "description": "Identifier. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the InternalRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "type": "string", "format": "google-fieldmask", "location": "query" } } }, "setIamPolicy": { "id": "networkconnectivity.projects.locations.internalRanges.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1/{+resource}:setIamPolicy", "parameters": { "resource": { "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:setIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "SetIamPolicyRequest" } }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges", "path": "v1/{+parent}/internalRanges", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource's name of the internal range.", "type": "string", "required": true, "location": "path" }, "internalRangeId": { "location": "query", "description": "Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.", "type": "string" }, "requestId": { "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 the 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).", "type": "string", "location": "query" } }, "request": { "$ref": "InternalRange" }, "description": "Creates a new internal range in a given project and location.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.internalRanges.create", "httpMethod": "POST", "parameterOrder": [ "parent" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges", "path": "v1/{+parent}/internalRanges", "parameters": { "pageSize": { "location": "query", "description": "The maximum number of results per page that should be returned.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource's name.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "The page token.", "type": "string", "location": "query" }, "orderBy": { "description": "Sort the results by a certain order.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "A filter expression that filters the results listed in the response.", "type": "string" } }, "description": "Lists internal ranges in a given project and location.", "response": { "$ref": "ListInternalRangesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.internalRanges.list", "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "delete": { "id": "networkconnectivity.projects.locations.internalRanges.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the internal range to delete.", "type": "string" }, "requestId": { "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 after the first request. For example, consider a situation where you make an initial request and the 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).", "type": "string" } }, "description": "Deletes a single internal range.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "description": "Required. Name of the InternalRange to get.", "type": "string", "location": "path", "required": true } }, "description": "Gets details of a single internal range.", "response": { "$ref": "InternalRange" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "networkconnectivity.projects.locations.internalRanges.get", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "testIamPermissions": { "httpMethod": "POST", "parameterOrder": [ "resource" ], "id": "networkconnectivity.projects.locations.internalRanges.testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "TestIamPermissionsRequest" }, "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:testIamPermissions" }, "getIamPolicy": { "httpMethod": "GET", "parameterOrder": [ "resource" ], "id": "networkconnectivity.projects.locations.internalRanges.getIamPolicy", "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe.", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$" }, "options.requestedPolicyVersion": { "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies).", "type": "integer", "location": "query" } } } } } } } } } }, "schemas": { "GoogleRpcStatus": { "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "details": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://documentation.s3ns.fr/apis/design/errors).", "type": "object" }, "AuditConfig": { "id": "AuditConfig", "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "type": "object", "properties": { "service": { "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" }, "auditLogConfigs": { "items": { "$ref": "AuditLogConfig" }, "description": "The configuration for logging of each type of permission.", "type": "array" } } }, "RejectSpokeUpdateRequest": { "properties": { "details": { "description": "Optional. Additional information provided by the hub administrator.", "type": "string" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string" }, "spokeUri": { "description": "Required. The URI of the spoke to reject update.", "type": "string" }, "spokeEtag": { "description": "Required. The etag of the spoke to reject update.", "type": "string" } }, "id": "RejectSpokeUpdateRequest", "description": "The request for HubService.RejectSpokeUpdate.", "type": "object" }, "SpokeTypeCount": { "properties": { "spokeType": { "description": "Output only. The type of the spokes.", "type": "string", "enumDescriptions": [ "Unspecified spoke type.", "Spokes associated with VPN tunnels.", "Spokes associated with VLAN attachments.", "Spokes associated with router appliance instances.", "Spokes associated with VPC networks.", "Spokes that are NCC gateways.", "Spokes that are backed by a producer VPC network." ], "readOnly": true, "enum": [ "SPOKE_TYPE_UNSPECIFIED", "VPN_TUNNEL", "INTERCONNECT_ATTACHMENT", "ROUTER_APPLIANCE", "VPC_NETWORK", "GATEWAY", "PRODUCER_VPC_NETWORK" ] }, "count": { "format": "int64", "description": "Output only. The total number of spokes of this type that are associated with the hub.", "type": "string", "readOnly": true } }, "id": "SpokeTypeCount", "description": "The number of spokes of a given type that are associated with a specific hub. The type indicates what kind of resource is associated with the spoke.", "type": "object" }, "Spoke": { "properties": { "spokeType": { "enumDescriptions": [ "Unspecified spoke type.", "Spokes associated with VPN tunnels.", "Spokes associated with VLAN attachments.", "Spokes associated with router appliance instances.", "Spokes associated with VPC networks.", "Spokes that are NCC gateways.", "Spokes that are backed by a producer VPC network." ], "description": "Output only. The type of resource associated with the spoke.", "type": "string", "enum": [ "SPOKE_TYPE_UNSPECIFIED", "VPN_TUNNEL", "INTERCONNECT_ATTACHMENT", "ROUTER_APPLIANCE", "VPC_NETWORK", "GATEWAY", "PRODUCER_VPC_NETWORK" ], "readOnly": true }, "uniqueId": { "readOnly": true, "description": "Output only. The Cloud de Confiance-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different `unique_id`.", "type": "string" }, "gateway": { "$ref": "Gateway", "description": "Optional. This is a gateway that can apply specialized processing to traffic going through it." }, "name": { "description": "Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke_id}`", "type": "string" }, "hub": { "description": "Immutable. The name of the hub that this spoke is attached to.", "type": "string" }, "linkedInterconnectAttachments": { "$ref": "LinkedInterconnectAttachments", "description": "Optional. VLAN attachments that are associated with the spoke." }, "linkedRouterApplianceInstances": { "$ref": "LinkedRouterApplianceInstances", "description": "Optional. Router appliance instances that are associated with the spoke." }, "fieldPathsPendingUpdate": { "description": "Optional. The list of fields waiting for hub administrator's approval.", "type": "array", "items": { "type": "string" } }, "etag": { "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "linkedVpcNetwork": { "$ref": "LinkedVpcNetwork", "description": "Optional. VPC network that is associated with the spoke." }, "state": { "description": "Output only. The current lifecycle state of this spoke.", "type": "string", "enumDescriptions": [ "No state information available", "The resource's create operation is in progress.", "The resource is active", "The resource's delete operation is in progress.", "The resource's accept operation is in progress.", "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "ACCEPTING", "REJECTING", "UPDATING", "INACTIVE", "OBSOLETE", "FAILED" ], "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://documentation.s3ns.fr/resource-manager/docs/creating-managing-labels#requirements).", "type": "object" }, "linkedProducerVpcNetwork": { "description": "Optional. The linked producer VPC that is associated with the spoke.", "$ref": "LinkedProducerVpcNetwork" }, "updateTime": { "format": "google-datetime", "description": "Output only. The time the spoke was last updated.", "type": "string", "readOnly": true }, "description": { "description": "Optional. An optional description of the spoke.", "type": "string" }, "group": { "description": "Optional. The name of the group that this spoke is associated with.", "type": "string" }, "linkedVpnTunnels": { "$ref": "LinkedVpnTunnels", "description": "Optional. VPN tunnels that are associated with the spoke." }, "createTime": { "description": "Output only. The time the spoke was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "reasons": { "description": "Output only. The reasons for current state of the spoke.", "type": "array", "readOnly": true, "items": { "$ref": "StateReason" } } }, "id": "Spoke", "description": "A Network Connectivity Center spoke represents one or more network connectivity resources. When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields: * linked_vpn_tunnels * linked_interconnect_attachments * linked_router_appliance_instances * linked_vpc_network", "type": "object" }, "LinkedVpnTunnels": { "id": "LinkedVpnTunnels", "description": "A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Cloud de Confiance. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes.", "type": "object", "properties": { "vpcNetwork": { "readOnly": true, "description": "Output only. The VPC network where these VPN tunnels are located.", "type": "string" }, "excludeImportRanges": { "description": "Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub.", "type": "array", "items": { "type": "string" } }, "uris": { "items": { "type": "string" }, "description": "The URIs of linked VPN tunnel resources.", "type": "array" }, "includeExportRanges": { "description": "Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub.", "type": "array", "items": { "type": "string" } }, "excludeExportRanges": { "items": { "type": "string" }, "description": "Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub.", "type": "array" }, "siteToSiteDataTransfer": { "description": "A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://documentation.s3ns.fr/network-connectivity/docs/network-connectivity-center/concepts/locations).", "type": "boolean" }, "includeImportRanges": { "items": { "type": "string" }, "description": "Optional. Hub routes fully encompassed by include import ranges are included during import from hub.", "type": "array" } } }, "Policy": { "properties": { "bindings": { "items": { "$ref": "Binding" }, "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array" }, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "type": "array", "items": { "$ref": "AuditConfig" } }, "etag": { "format": "byte", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string" } }, "id": "Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Cloud de Confiance resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Cloud de Confiance resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://documentation.s3ns.fr/iam/docs/).", "type": "object" }, "StateReason": { "properties": { "code": { "description": "The code associated with this reason.", "type": "string", "enum": [ "CODE_UNSPECIFIED", "PENDING_REVIEW", "REJECTED", "PAUSED", "FAILED", "UPDATE_PENDING_REVIEW", "UPDATE_REJECTED", "UPDATE_FAILED" ], "enumDescriptions": [ "No information available.", "The proposed spoke is pending review.", "The proposed spoke has been rejected by the hub administrator.", "The spoke has been deactivated internally.", "Network Connectivity Center encountered errors while accepting the spoke.", "The proposed spoke update is pending review.", "The proposed spoke update has been rejected by the hub administrator.", "Network Connectivity Center encountered errors while accepting the spoke update." ] }, "message": { "description": "Human-readable details about this reason.", "type": "string" }, "userDetails": { "description": "Additional information provided by the user in the RejectSpoke call.", "type": "string" } }, "id": "StateReason", "description": "The reason for the current state of the spoke.", "type": "object" }, "ListHubsResponse": { "properties": { "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "hubs": { "items": { "$ref": "Hub" }, "description": "The requested hubs.", "type": "array" }, "nextPageToken": { "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", "type": "string" } }, "id": "ListHubsResponse", "description": "Response for HubService.ListHubs method.", "type": "object" }, "ListLocationsResponse": { "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object" }, "RoutingVPC": { "id": "RoutingVPC", "description": "RoutingVPC contains information about the VPC networks associated with the spokes of a Network Connectivity Center hub.", "type": "object", "properties": { "uri": { "description": "The URI of the VPC network.", "type": "string" }, "requiredForNewSiteToSiteDataTransferSpokes": { "readOnly": true, "description": "Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. At most, one VPC network will have this field set to true.", "type": "boolean" } } }, "ListRouteTablesResponse": { "id": "ListRouteTablesResponse", "description": "Response for HubService.ListRouteTables method.", "type": "object", "properties": { "unreachable": { "items": { "type": "string" }, "description": "Hubs that could not be reached.", "type": "array" }, "routeTables": { "description": "The requested route tables.", "type": "array", "items": { "$ref": "RouteTable" } }, "nextPageToken": { "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", "type": "string" } } }, "IpRangeReservation": { "properties": { "ipRange": { "description": "Required. A block of IP addresses used to allocate supporting infrastructure for this gateway. This block must not overlap with subnets in any spokes or peer VPC networks that the gateway can communicate with. Example: \"10.1.2.0/24\"", "type": "string" } }, "id": "IpRangeReservation", "description": "A list of IP ranges that are reserved for this gateway's internal intfrastructure.", "type": "object" }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "requestedCancellation": { "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" }, "target": { "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "verb": { "readOnly": true, "description": "Output only. Name of the verb executed by the operation.", "type": "string" } } }, "Hub": { "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. The time the hub was last updated.", "type": "string", "readOnly": true }, "routingVpcs": { "description": "Output only. The VPC networks associated with this hub's spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.", "type": "array", "readOnly": true, "items": { "$ref": "RoutingVPC" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "ACCEPTING", "REJECTING", "UPDATING", "INACTIVE", "OBSOLETE", "FAILED" ], "readOnly": true, "enumDescriptions": [ "No state information available", "The resource's create operation is in progress.", "The resource is active", "The resource's delete operation is in progress.", "The resource's accept operation is in progress.", "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "description": "Output only. The current lifecycle state of this hub.", "type": "string" }, "exportPsc": { "description": "Optional. Whether Private Service Connect connection propagation is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.", "type": "boolean" }, "labels": { "description": "Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://documentation.s3ns.fr/resource-manager/docs/creating-managing-labels#requirements).", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "description": "Output only. The time the hub was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "description": { "description": "Optional. An optional description of the hub.", "type": "string" }, "policyMode": { "description": "Optional. The policy mode of this hub. This field can be either PRESET or CUSTOM. If unspecified, the policy_mode defaults to PRESET.", "type": "string", "enum": [ "POLICY_MODE_UNSPECIFIED", "PRESET" ], "enumDescriptions": [ "Policy mode is unspecified. It defaults to PRESET with preset_topology = MESH.", "Hub uses one of the preset topologies." ] }, "name": { "description": "Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}`", "type": "string" }, "spokeSummary": { "readOnly": true, "description": "Output only. A summary of the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.", "$ref": "SpokeSummary" }, "uniqueId": { "description": "Output only. The Cloud de Confiance-generated UUID for the hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id.", "type": "string", "readOnly": true }, "routeTables": { "description": "Output only. The route tables that belong to this hub. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}` This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub.", "type": "array", "readOnly": true, "items": { "type": "string" } }, "presetTopology": { "description": "Optional. The topology implemented in this hub. Currently, this field is only used when policy_mode = PRESET. The available preset topologies are MESH and STAR. If preset_topology is unspecified and policy_mode = PRESET, the preset_topology defaults to MESH. When policy_mode = CUSTOM, the preset_topology is set to PRESET_TOPOLOGY_UNSPECIFIED.", "type": "string", "enum": [ "PRESET_TOPOLOGY_UNSPECIFIED", "MESH", "STAR", "HYBRID_INSPECTION" ], "enumDescriptions": [ "Preset topology is unspecified. When policy_mode = PRESET, it defaults to MESH.", "Mesh topology is implemented. Group `default` is automatically created. All spokes in the hub are added to group `default`.", "Star topology is implemented. Two groups, `center` and `edge`, are automatically created along with hub creation. Spokes have to join one of the groups during creation.", "Hybrid inspection has 4 groups ('non-prod', 'prod', 'services', and 'untrusted') that are automatically created along with hub creation." ] } }, "id": "Hub", "description": "A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project.", "type": "object" }, "Gateway": { "id": "Gateway", "description": "A gateway that can apply specialized traffic processing.", "type": "object", "properties": { "capacity": { "enumDescriptions": [ "The gateway capacity is unspecified.", "The gateway has 1 Gbps of aggregate processing capacity", "The gateway has 10 Gbps of aggregate processing capacity", "The gateway has 100 Gbps of aggregate processing capacity" ], "description": "Optional. The aggregate processing capacity of this gateway.", "type": "string", "enum": [ "GATEWAY_CAPACITY_UNSPECIFIED", "CAPACITY_1_GBPS", "CAPACITY_10_GBPS", "CAPACITY_100_GBPS" ] }, "sacAttachment": { "description": "Output only. The URI of the connected SACAttachment. Should be in the form: projects/{project}/locations/{location}/sacAttachments/{sac_attachment}", "type": "string", "readOnly": true }, "ipRangeReservations": { "items": { "$ref": "IpRangeReservation" }, "description": "Optional. A list of IP ranges that are reserved for this gateway's internal intfrastructure.", "type": "array" }, "cloudRouters": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The list of Cloud Routers that are connected to this gateway. Should be in the form: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/routers/{router}", "type": "array" } } }, "NextHopRouterApplianceInstance": { "id": "NextHopRouterApplianceInstance", "description": "A route next hop that leads to a Router appliance instance.", "type": "object", "properties": { "siteToSiteDataTransfer": { "description": "A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://documentation.s3ns.fr/network-connectivity/docs/network-connectivity-center/concepts/locations).", "type": "boolean" }, "uri": { "description": "The URI of the Router appliance instance.", "type": "string" }, "vpcNetwork": { "description": "The VPC network where this VM is located.", "type": "string" } } }, "Warnings": { "properties": { "code": { "enumDescriptions": [ "Default value.", "The policy-based route is not active and functioning. Common causes are that the dependent network was deleted or the resource project was turned off.", "The policy-based route is being modified (e.g. created/deleted) at this time." ], "description": "Output only. A warning code, if applicable.", "type": "string", "readOnly": true, "enum": [ "WARNING_UNSPECIFIED", "RESOURCE_NOT_ACTIVE", "RESOURCE_BEING_MODIFIED" ] }, "warningMessage": { "description": "Output only. A human-readable description of the warning code.", "type": "string", "readOnly": true }, "data": { "description": "Output only. Metadata about this warning in key: value format. The key should provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement.", "type": "object", "readOnly": true, "additionalProperties": { "type": "string" } } }, "id": "Warnings", "description": "Informational warning message.", "type": "object" }, "RouterApplianceInstance": { "id": "RouterApplianceInstance", "description": "A router appliance instance is a Compute Engine virtual machine (VM) instance that acts as a BGP speaker. A router appliance instance is specified by the URI of the VM and the internal IP address of one of the VM's network interfaces.", "type": "object", "properties": { "ipAddress": { "description": "The IP address on the VM to use for peering.", "type": "string" }, "virtualMachine": { "description": "The URI of the VM.", "type": "string" } } }, "LinkedRouterApplianceInstances": { "id": "LinkedRouterApplianceInstances", "description": "A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Cloud de Confiance, we recommend that you associate those instances with the same spoke.", "type": "object", "properties": { "instances": { "description": "The list of router appliance instances.", "type": "array", "items": { "$ref": "RouterApplianceInstance" } }, "siteToSiteDataTransfer": { "description": "A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://documentation.s3ns.fr/network-connectivity/docs/network-connectivity-center/concepts/locations).", "type": "boolean" }, "includeImportRanges": { "items": { "type": "string" }, "description": "Optional. Hub routes fully encompassed by include import ranges are included during import from hub.", "type": "array" }, "vpcNetwork": { "readOnly": true, "description": "Output only. The VPC network where these router appliance instances are located.", "type": "string" }, "excludeImportRanges": { "items": { "type": "string" }, "description": "Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub.", "type": "array" }, "includeExportRanges": { "items": { "type": "string" }, "description": "Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub.", "type": "array" }, "excludeExportRanges": { "description": "Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub.", "type": "array", "items": { "type": "string" } } } }, "VirtualMachine": { "id": "VirtualMachine", "description": "VM instances that this policy-based route applies to.", "type": "object", "properties": { "tags": { "description": "Optional. A list of VM instance tags that this policy-based route applies to. VM instances that have ANY of tags specified here installs this PBR.", "type": "array", "items": { "type": "string" } } } }, "RejectHubSpokeResponse": { "properties": { "spoke": { "description": "The spoke that was operated on.", "$ref": "Spoke" } }, "id": "RejectHubSpokeResponse", "description": "The response for HubService.RejectHubSpoke.", "type": "object" }, "AcceptSpokeUpdateRequest": { "properties": { "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string" }, "spokeUri": { "description": "Required. The URI of the spoke to accept update.", "type": "string" }, "spokeEtag": { "description": "Required. The etag of the spoke to accept update.", "type": "string" } }, "id": "AcceptSpokeUpdateRequest", "description": "The request for HubService.AcceptSpokeUpdate.", "type": "object" }, "LinkedVpcNetwork": { "properties": { "producerVpcSpokes": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected through VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub.", "type": "array" }, "proposedExcludeExportRanges": { "description": "Output only. The proposed exclude export IP ranges waiting for hub administrator's approval.", "type": "array", "readOnly": true, "items": { "type": "string" } }, "proposedIncludeExportRanges": { "description": "Output only. The proposed include export IP ranges waiting for hub administrator's approval.", "type": "array", "readOnly": true, "items": { "type": "string" } }, "excludeExportRanges": { "description": "Optional. IP ranges encompassing the subnets to be excluded from peering.", "type": "array", "items": { "type": "string" } }, "includeExportRanges": { "items": { "type": "string" }, "description": "Optional. IP ranges allowed to be included from peering.", "type": "array" }, "uri": { "description": "Required. The URI of the VPC network resource.", "type": "string" } }, "id": "LinkedVpcNetwork", "description": "An existing VPC network.", "type": "object" }, "NextHopInterconnectAttachment": { "properties": { "siteToSiteDataTransfer": { "description": "A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://documentation.s3ns.fr/network-connectivity/docs/network-connectivity-center/concepts/locations).", "type": "boolean" }, "uri": { "description": "The URI of the interconnect attachment resource.", "type": "string" }, "vpcNetwork": { "description": "The VPC network where this interconnect attachment is located.", "type": "string" } }, "id": "NextHopInterconnectAttachment", "description": "A route next hop that leads to an interconnect attachment resource.", "type": "object" }, "LocationMetadata": { "id": "LocationMetadata", "description": "Metadata about locations", "type": "object", "properties": { "locationFeatures": { "description": "List of supported features", "type": "array", "items": { "type": "string", "enum": [ "LOCATION_FEATURE_UNSPECIFIED", "SITE_TO_CLOUD_SPOKES", "SITE_TO_SITE_SPOKES", "GATEWAY_SPOKES", "TRANSPORTS" ], "enumDescriptions": [ "No publicly supported feature in this location", "Site-to-cloud spokes are supported in this location", "Site-to-site spokes are supported in this location", "Gateway spokes are supported in this location.", "Supports transports in this location." ] } } } }, "AcceptHubSpokeResponse": { "properties": { "spoke": { "$ref": "Spoke", "description": "The spoke that was operated on." } }, "id": "AcceptHubSpokeResponse", "description": "The response for HubService.AcceptHubSpoke.", "type": "object" }, "HubStatusEntry": { "properties": { "count": { "description": "The number of propagated Private Service Connect connections with this status. If the `group_by` field was not set in the request message, the value of this field is 1.", "type": "integer", "format": "int32" }, "groupBy": { "description": "The fields that this entry is grouped by. This has the same value as the `group_by` field in the request message.", "type": "string" }, "pscPropagationStatus": { "$ref": "PscPropagationStatus", "description": "The Private Service Connect propagation status." } }, "id": "HubStatusEntry", "description": "A hub status entry represents the status of a set of propagated Private Service Connect connections grouped by certain fields.", "type": "object" }, "Route": { "id": "Route", "description": "A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.", "type": "object", "properties": { "ipCidrRange": { "description": "The destination IP address range.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time the route was created.", "type": "string", "format": "google-datetime" }, "priority": { "format": "int64", "description": "Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.", "type": "string", "readOnly": true }, "nextHopSpoke": { "$ref": "NextHopSpoke", "description": "Immutable. The next-hop spoke for packets on this route." }, "type": { "enumDescriptions": [ "No route type information specified", "The route leads to a destination within the primary address range of the VPC network's subnet.", "The route leads to a destination within the secondary address range of the VPC network's subnet.", "The route leads to a destination in a dynamic route. Dynamic routes are derived from Border Gateway Protocol (BGP) advertisements received from an NCC hybrid spoke." ], "description": "Output only. The route's type. Its type is determined by the properties of its IP address range.", "type": "string", "readOnly": true, "enum": [ "ROUTE_TYPE_UNSPECIFIED", "VPC_PRIMARY_SUBNET", "VPC_SECONDARY_SUBNET", "DYNAMIC_ROUTE" ] }, "description": { "description": "An optional description of the route.", "type": "string" }, "uid": { "description": "Output only. The Cloud de Confiance-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`.", "type": "string", "readOnly": true }, "updateTime": { "description": "Output only. The time the route was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "nextHopVpcNetwork": { "description": "Immutable. The destination VPC network for packets on this route.", "$ref": "NextHopVpcNetwork" }, "nextHopInterconnectAttachment": { "description": "Immutable. The next-hop VLAN attachment for packets on this route.", "$ref": "NextHopInterconnectAttachment" }, "nextHopVpnTunnel": { "description": "Immutable. The next-hop VPN tunnel for packets on this route.", "$ref": "NextHopVPNTunnel" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://documentation.s3ns.fr/resource-manager/docs/creating-managing-labels#requirements).", "type": "object" }, "location": { "description": "Output only. The origin location of the route. Uses the following form: \"projects/{project}/locations/{location}\" Example: projects/1234/locations/us-central1", "type": "string", "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "ACCEPTING", "REJECTING", "UPDATING", "INACTIVE", "OBSOLETE", "FAILED" ], "readOnly": true, "enumDescriptions": [ "No state information available", "The resource's create operation is in progress.", "The resource is active", "The resource's delete operation is in progress.", "The resource's accept operation is in progress.", "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "description": "Output only. The current lifecycle state of the route.", "type": "string" }, "nextHopRouterApplianceInstance": { "$ref": "NextHopRouterApplianceInstance", "description": "Immutable. The next-hop Router appliance instance for packets on this route." }, "spoke": { "description": "Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE", "type": "string" }, "name": { "description": "Immutable. The name of the route. Route names must be unique. Route names use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`", "type": "string" } } }, "ListRoutesResponse": { "id": "ListRoutesResponse", "description": "Response for HubService.ListRoutes method.", "type": "object", "properties": { "routes": { "description": "The requested routes.", "type": "array", "items": { "$ref": "Route" } }, "nextPageToken": { "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "RouteTables that could not be reached.", "type": "array" } } }, "AcceptHubSpokeRequest": { "properties": { "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string" }, "spokeUri": { "description": "Required. The URI of the spoke to accept into the hub.", "type": "string" } }, "id": "AcceptHubSpokeRequest", "description": "The request for HubService.AcceptHubSpoke.", "type": "object" }, "SpokeSummary": { "id": "SpokeSummary", "description": "Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.", "type": "object", "properties": { "spokeStateCounts": { "description": "Output only. Counts the number of spokes that are in each state and associated with a given hub.", "type": "array", "readOnly": true, "items": { "$ref": "SpokeStateCount" } }, "spokeTypeCounts": { "readOnly": true, "items": { "$ref": "SpokeTypeCount" }, "description": "Output only. Counts the number of spokes of each type that are associated with a specific hub.", "type": "array" }, "spokeStateReasonCounts": { "description": "Output only. Counts the number of spokes that are inactive for each possible reason and associated with a given hub.", "type": "array", "readOnly": true, "items": { "$ref": "SpokeStateReasonCount" } } } }, "Expr": { "id": "Expr", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object", "properties": { "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" } } }, "QueryHubStatusResponse": { "id": "QueryHubStatusResponse", "description": "The response for HubService.QueryHubStatus.", "type": "object", "properties": { "hubStatusEntries": { "items": { "$ref": "HubStatusEntry" }, "description": "The list of hub status.", "type": "array" }, "nextPageToken": { "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", "type": "string" } } }, "PolicyBasedRoute": { "properties": { "nextHopIlbIp": { "description": "Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.", "type": "string" }, "name": { "description": "Immutable. Identifier. A unique name of the resource in the form of `projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}`", "type": "string" }, "virtualMachine": { "$ref": "VirtualMachine", "description": "Optional. VM instances that this policy-based route applies to." }, "warnings": { "description": "Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.", "type": "array", "readOnly": true, "items": { "$ref": "Warnings" } }, "network": { "description": "Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.", "type": "string" }, "selfLink": { "readOnly": true, "description": "Output only. Server-defined fully-qualified URL for this resource.", "type": "string" }, "kind": { "description": "Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.", "type": "string", "readOnly": true }, "filter": { "$ref": "Filter", "description": "Required. The filter to match L4 traffic." }, "interconnectAttachment": { "description": "Optional. The interconnect attachments that this policy-based route applies to.", "$ref": "InterconnectAttachment" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time when the policy-based route was updated.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "User-defined labels.", "type": "object" }, "nextHopOtherRoutes": { "description": "Optional. Other routes that will be referenced to determine the next hop of the packet.", "type": "string", "enum": [ "OTHER_ROUTES_UNSPECIFIED", "DEFAULT_ROUTING" ], "enumDescriptions": [ "Default value.", "Use the routes from the default routing tables (system-generated routes, custom routes, peering route) to determine the next hop. This effectively excludes matching packets being applied on other PBRs with a lower priority." ] }, "createTime": { "format": "google-datetime", "description": "Output only. Time when the policy-based route was created.", "type": "string", "readOnly": true }, "priority": { "description": "Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.", "type": "integer", "format": "int32" }, "description": { "description": "Optional. An optional description of this resource. Provide this field when you create the resource.", "type": "string" } }, "id": "PolicyBasedRoute", "description": "Policy-based routes route L4 network traffic based on not just destination IP address, but also source IP address, protocol, and more. If a policy-based route conflicts with other types of routes, the policy-based route always takes precedence.", "type": "object" }, "ListSpokesResponse": { "id": "ListSpokesResponse", "description": "The response for HubService.ListSpokes.", "type": "object", "properties": { "spokes": { "description": "The requested spokes.", "type": "array", "items": { "$ref": "Spoke" } }, "nextPageToken": { "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "SetIamPolicyRequest": { "id": "SetIamPolicyRequest", "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "$ref": "Policy", "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud de Confiance services (such as Projects) might reject them." }, "updateMask": { "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "type": "string" } } }, "SpokeStateReasonCount": { "id": "SpokeStateReasonCount", "description": "The number of spokes in the hub that are inactive for this reason.", "type": "object", "properties": { "stateReasonCode": { "description": "Output only. The reason that a spoke is inactive.", "type": "string", "enumDescriptions": [ "No information available.", "The proposed spoke is pending review.", "The proposed spoke has been rejected by the hub administrator.", "The spoke has been deactivated internally.", "Network Connectivity Center encountered errors while accepting the spoke.", "The proposed spoke update is pending review.", "The proposed spoke update has been rejected by the hub administrator.", "Network Connectivity Center encountered errors while accepting the spoke update." ], "enum": [ "CODE_UNSPECIFIED", "PENDING_REVIEW", "REJECTED", "PAUSED", "FAILED", "UPDATE_PENDING_REVIEW", "UPDATE_REJECTED", "UPDATE_FAILED" ], "readOnly": true }, "count": { "readOnly": true, "description": "Output only. The total number of spokes that are inactive for a particular reason and associated with a given hub.", "type": "string", "format": "int64" } } }, "PscPropagationStatus": { "id": "PscPropagationStatus", "description": "The status of one or more propagated Private Service Connect connections in a hub.", "type": "object", "properties": { "code": { "enumDescriptions": [ "The code is unspecified.", "The propagated Private Service Connect connection is ready.", "The Private Service Connect connection is propagating. This is a transient state.", "The Private Service Connect connection propagation failed because the VPC network or the project of the target spoke has exceeded the connection limit set by the producer.", "The Private Service Connect connection propagation failed because the NAT IP subnet space has been exhausted. It is equivalent to the `Needs attention` status of the Private Service Connect connection. See https://documentation.s3ns.fr/vpc/docs/about-accessing-vpc-hosted-services-endpoints#connection-statuses.", "The Private Service Connect connection propagation failed because the `PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK` quota in the producer VPC network has been exceeded.", "The Private Service Connect connection propagation failed because the `PSC_PROPAGATED_CONNECTIONS_PER_VPC_NETWORK` quota in the consumer VPC network has been exceeded." ], "description": "The propagation status.", "type": "string", "enum": [ "CODE_UNSPECIFIED", "READY", "PROPAGATING", "ERROR_PRODUCER_PROPAGATED_CONNECTION_LIMIT_EXCEEDED", "ERROR_PRODUCER_NAT_IP_SPACE_EXHAUSTED", "ERROR_PRODUCER_QUOTA_EXCEEDED", "ERROR_CONSUMER_QUOTA_EXCEEDED" ] }, "sourceForwardingRule": { "description": "The name of the forwarding rule exported to the hub.", "type": "string" }, "targetSpoke": { "description": "The name of the spoke that the source forwarding rule propagates to.", "type": "string" }, "targetGroup": { "description": "The name of the group that the target spoke belongs to.", "type": "string" }, "message": { "description": "The human-readable summary of the Private Service Connect connection propagation status.", "type": "string" }, "sourceSpoke": { "description": "The name of the spoke that the source forwarding rule belongs to.", "type": "string" }, "sourceGroup": { "description": "The name of the group that the source spoke belongs to.", "type": "string" } } }, "GoogleLongrunningOperation": { "properties": { "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object" }, "RejectHubSpokeRequest": { "properties": { "spokeUri": { "description": "Required. The URI of the spoke to reject from the hub.", "type": "string" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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).", "type": "string" }, "details": { "description": "Optional. Additional information provided by the hub administrator.", "type": "string" } }, "id": "RejectHubSpokeRequest", "description": "The request for HubService.RejectHubSpoke.", "type": "object" }, "TestIamPermissionsResponse": { "id": "TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } } }, "NextHopVPNTunnel": { "properties": { "uri": { "description": "The URI of the VPN tunnel resource.", "type": "string" }, "vpcNetwork": { "description": "The VPC network where this VPN tunnel is located.", "type": "string" }, "siteToSiteDataTransfer": { "description": "A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://documentation.s3ns.fr/network-connectivity/docs/network-connectivity-center/concepts/locations).", "type": "boolean" } }, "id": "NextHopVPNTunnel", "description": "A route next hop that leads to a VPN tunnel resource.", "type": "object" }, "InternalRange": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "User-defined labels.", "type": "object" }, "peering": { "description": "Optional. The type of peering set for this internal range.", "type": "string", "enum": [ "PEERING_UNSPECIFIED", "FOR_SELF", "FOR_PEER", "NOT_SHARED" ], "enumDescriptions": [ "If Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.", "This is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.", "This behavior can be set when the internal range is being reserved for usage by peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.", "This behavior can be set when the internal range is being reserved for usage by the VPC in which it is created, but not shared with peers. In a sense, it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too." ] }, "overlaps": { "description": "Optional. Types of resources that are allowed to overlap with the current internal range.", "type": "array", "items": { "enumDescriptions": [ "No overlap overrides.", "Allow creation of static routes more specific that the current internal range.", "Allow creation of internal ranges that overlap with existing subnets." ], "type": "string", "enum": [ "OVERLAP_UNSPECIFIED", "OVERLAP_ROUTE_RANGE", "OVERLAP_EXISTING_SUBNET_RANGE" ] } }, "allocationOptions": { "description": "Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).", "$ref": "AllocationOptions" }, "targetCidrRange": { "items": { "type": "string" }, "description": "Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the [\"10.0.0.0/8\", \"172.16.0.0/12\", \"192.168.0.0/16\"] address space (for auto-mode networks, the \"10.0.0.0/9\" range is used instead of \"10.0.0.0/8\"). This can be used to target the search in other rfc-1918 address spaces like \"172.16.0.0/12\" and \"192.168.0.0/16\" or non-rfc-1918 address spaces used in the VPC.", "type": "array" }, "updateTime": { "readOnly": true, "description": "Output only. Time when the internal range was updated.", "type": "string", "format": "google-datetime" }, "migration": { "$ref": "Migration", "description": "Optional. Must be present if usage is set to FOR_MIGRATION." }, "description": { "description": "Optional. A description of this resource.", "type": "string" }, "users": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.", "type": "array" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time when the internal range was created.", "type": "string" }, "ipCidrRange": { "description": "Optional. The IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly.", "type": "string" }, "name": { "description": "Identifier. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names", "type": "string" }, "prefixLength": { "format": "int32", "description": "Optional. An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter.", "type": "integer" }, "usage": { "enumDescriptions": [ "Unspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.", "A VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.", "Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases, like for example, usage on-prem, with dynamic route announcements via interconnect.", "Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION, the peering value has to be set to FOR_SELF or default to FOR_SELF when unset." ], "description": "Optional. The type of usage set for this InternalRange.", "type": "string", "enum": [ "USAGE_UNSPECIFIED", "FOR_VPC", "EXTERNAL_TO_VPC", "FOR_MIGRATION" ] }, "excludeCidrRanges": { "description": "Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks", "type": "array", "items": { "type": "string" } }, "network": { "description": "Immutable. The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network}", "type": "string" }, "immutable": { "description": "Optional. Immutable ranges cannot have their fields modified, except for labels and description.", "type": "boolean" } }, "id": "InternalRange", "description": "The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it.", "type": "object" }, "Migration": { "properties": { "source": { "description": "Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}", "type": "string" }, "target": { "description": "Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. For example: /projects/{project}/regions/{region}/subnetworks/{subnet}", "type": "string" } }, "id": "Migration", "description": "Specification for migration with source and target resource names.", "type": "object" }, "AutoAccept": { "id": "AutoAccept", "description": "The auto-accept setting for a group controls whether proposed spokes are automatically attached to the hub. If auto-accept is enabled, the spoke immediately is attached to the hub and becomes part of the group. In this case, the new spoke is in the ACTIVE state. If auto-accept is disabled, the spoke goes to the INACTIVE state, and it must be reviewed and accepted by a hub administrator.", "type": "object", "properties": { "autoAcceptProjects": { "items": { "type": "string" }, "description": "Optional. A list of project ids or project numbers for which you want to enable auto-accept. The auto-accept setting is applied to spokes being created or updated in these projects.", "type": "array" } } }, "GoogleLongrunningListOperationsResponse": { "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" } } }, "Group": { "id": "Group", "description": "A group represents a subset of spokes attached to a hub.", "type": "object", "properties": { "state": { "description": "Output only. The current lifecycle state of this group.", "type": "string", "enumDescriptions": [ "No state information available", "The resource's create operation is in progress.", "The resource is active", "The resource's delete operation is in progress.", "The resource's accept operation is in progress.", "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "ACCEPTING", "REJECTING", "UPDATING", "INACTIVE", "OBSOLETE", "FAILED" ], "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://documentation.s3ns.fr/resource-manager/docs/creating-managing-labels#requirements).", "type": "object" }, "routeTable": { "readOnly": true, "description": "Output only. The name of the route table that corresponds to this group. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}`", "type": "string" }, "name": { "description": "Immutable. The name of the group. Group names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}`", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The time the group was last updated.", "type": "string", "format": "google-datetime" }, "uid": { "readOnly": true, "description": "Output only. The Cloud de Confiance-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id.", "type": "string" }, "description": { "description": "Optional. The description of the group.", "type": "string" }, "autoAccept": { "$ref": "AutoAccept", "description": "Optional. The auto-accept setting for this group." }, "createTime": { "description": "Output only. The time the group was created.", "type": "string", "format": "google-datetime", "readOnly": true } } }, "Empty": { "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "NextHopSpoke": { "id": "NextHopSpoke", "description": "A route next hop that leads to a spoke resource.", "type": "object", "properties": { "siteToSiteDataTransfer": { "description": "A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://documentation.s3ns.fr/network-connectivity/docs/network-connectivity-center/concepts/locations).", "type": "boolean" }, "uri": { "description": "The URI of the spoke resource.", "type": "string" } } }, "ListGroupsResponse": { "properties": { "unreachable": { "description": "Hubs that could not be reached.", "type": "array", "items": { "type": "string" } }, "groups": { "description": "The requested groups.", "type": "array", "items": { "$ref": "Group" } }, "nextPageToken": { "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", "type": "string" } }, "id": "ListGroupsResponse", "description": "Response for HubService.ListGroups method.", "type": "object" }, "Binding": { "id": "Binding", "description": "Associates `members`, or principals, with a `role`.", "type": "object", "properties": { "members": { "items": { "type": "string" }, "description": "Specifies the principals requesting access for a Cloud de Confiance resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Cloud de Confiance account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Cloud de Confiance account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Cloud de Confiance account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://documentation.s3ns.fr/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array" }, "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://documentation.s3ns.fr/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://documentation.s3ns.fr/iam/docs/understanding-roles).", "type": "string" }, "condition": { "$ref": "Expr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies)." } } }, "LinkedProducerVpcNetwork": { "id": "LinkedProducerVpcNetwork", "type": "object", "properties": { "network": { "description": "Immutable. The URI of the Service Consumer VPC that the Producer VPC is peered with.", "type": "string" }, "serviceConsumerVpcSpoke": { "readOnly": true, "description": "Output only. The Service Consumer Network spoke.", "type": "string" }, "excludeExportRanges": { "items": { "type": "string" }, "description": "Optional. IP ranges encompassing the subnets to be excluded from peering.", "type": "array" }, "includeExportRanges": { "items": { "type": "string" }, "description": "Optional. IP ranges allowed to be included from peering.", "type": "array" }, "proposedIncludeExportRanges": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The proposed include export IP ranges waiting for hub administrator's approval.", "type": "array" }, "peering": { "description": "Immutable. The name of the VPC peering between the Service Consumer VPC and the Producer VPC (defined in the Tenant project) which is added to the NCC hub. This peering must be in ACTIVE state.", "type": "string" }, "producerNetwork": { "description": "Output only. The URI of the Producer VPC.", "type": "string", "readOnly": true }, "proposedExcludeExportRanges": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The proposed exclude export IP ranges waiting for hub administrator's approval.", "type": "array" } } }, "LinkedInterconnectAttachments": { "id": "LinkedInterconnectAttachments", "description": "A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Cloud de Confiance. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes.", "type": "object", "properties": { "includeImportRanges": { "items": { "type": "string" }, "description": "Optional. Hub routes fully encompassed by include import ranges are included during import from hub.", "type": "array" }, "siteToSiteDataTransfer": { "description": "A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://documentation.s3ns.fr/network-connectivity/docs/network-connectivity-center/concepts/locations).", "type": "boolean" }, "includeExportRanges": { "description": "Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub.", "type": "array", "items": { "type": "string" } }, "excludeExportRanges": { "items": { "type": "string" }, "description": "Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub.", "type": "array" }, "uris": { "items": { "type": "string" }, "description": "The URIs of linked interconnect attachment resources", "type": "array" }, "vpcNetwork": { "readOnly": true, "description": "Output only. The VPC network where these VLAN attachments are located.", "type": "string" }, "excludeImportRanges": { "description": "Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub.", "type": "array", "items": { "type": "string" } } } }, "ListHubSpokesResponse": { "id": "ListHubSpokesResponse", "description": "The response for HubService.ListHubSpokes.", "type": "object", "properties": { "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "spokes": { "items": { "$ref": "Spoke" }, "description": "The requested spokes. The spoke fields can be partially populated based on the `view` field in the request message.", "type": "array" }, "nextPageToken": { "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", "type": "string" } } }, "ListInternalRangesResponse": { "id": "ListInternalRangesResponse", "description": "Response for InternalRange.ListInternalRanges", "type": "object", "properties": { "nextPageToken": { "description": "The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.", "type": "string" }, "internalRanges": { "description": "Internal ranges to be returned.", "type": "array", "items": { "$ref": "InternalRange" } }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "SpokeStateCount": { "id": "SpokeStateCount", "description": "The number of spokes that are in a particular state and associated with a given hub.", "type": "object", "properties": { "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "ACCEPTING", "REJECTING", "UPDATING", "INACTIVE", "OBSOLETE", "FAILED" ], "enumDescriptions": [ "No state information available", "The resource's create operation is in progress.", "The resource is active", "The resource's delete operation is in progress.", "The resource's accept operation is in progress.", "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "description": "Output only. The state of the spokes.", "type": "string" }, "count": { "readOnly": true, "format": "int64", "description": "Output only. The total number of spokes that are in this state and associated with a given hub.", "type": "string" } } }, "InterconnectAttachment": { "properties": { "region": { "description": "Optional. Cloud region to install this policy-based route on interconnect attachment. Use `all` to install it on all interconnect attachments.", "type": "string" } }, "id": "InterconnectAttachment", "description": "InterconnectAttachment that this route applies to.", "type": "object" }, "Filter": { "id": "Filter", "description": "Filter matches L4 traffic.", "type": "object", "properties": { "srcRange": { "description": "Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4 and \"::/0\" if protocol version is IPv6.", "type": "string" }, "protocolVersion": { "description": "Required. Internet protocol versions this policy-based route applies to. IPV4 and IPV6 is supported.", "type": "string", "enum": [ "PROTOCOL_VERSION_UNSPECIFIED", "IPV4", "IPV6" ], "enumDescriptions": [ "Default value.", "The PBR is for IPv4 internet protocol traffic.", "The PBR is for IPv6 internet protocol traffic." ] }, "ipProtocol": { "description": "Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.", "type": "string" }, "destRange": { "description": "Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4 and \"::/0\" if protocol version is IPv6.", "type": "string" } } }, "TestIamPermissionsRequest": { "id": "TestIamPermissionsRequest", "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://documentation.s3ns.fr/iam/docs/overview#permissions).", "type": "array" } } }, "NextHopVpcNetwork": { "properties": { "uri": { "description": "The URI of the VPC network resource", "type": "string" } }, "id": "NextHopVpcNetwork", "type": "object" }, "ListPolicyBasedRoutesResponse": { "id": "ListPolicyBasedRoutesResponse", "description": "Response for PolicyBasedRoutingService.ListPolicyBasedRoutes method.", "type": "object", "properties": { "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "policyBasedRoutes": { "description": "Policy-based routes to be returned.", "type": "array", "items": { "$ref": "PolicyBasedRoute" } }, "nextPageToken": { "description": "The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.", "type": "string" } } }, "RouteTable": { "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. The time the route table was last updated.", "type": "string", "readOnly": true }, "name": { "description": "Immutable. The name of the route table. Route table names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}`", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the route table was created.", "type": "string", "readOnly": true }, "description": { "description": "An optional description of the route table.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://documentation.s3ns.fr/resource-manager/docs/creating-managing-labels#requirements).", "type": "object" }, "uid": { "description": "Output only. The Cloud de Confiance-generated UUID for the route table. This value is unique across all route table resources. If a route table is deleted and another with the same name is created, the new route table is assigned a different `uid`.", "type": "string", "readOnly": true }, "state": { "enumDescriptions": [ "No state information available", "The resource's create operation is in progress.", "The resource is active", "The resource's delete operation is in progress.", "The resource's accept operation is in progress.", "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "description": "Output only. The current lifecycle state of this route table.", "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "ACCEPTING", "REJECTING", "UPDATING", "INACTIVE", "OBSOLETE", "FAILED" ] } }, "id": "RouteTable", "type": "object" }, "GoogleLongrunningCancelOperationRequest": { "properties": {}, "id": "GoogleLongrunningCancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object" }, "AllocationOptions": { "id": "AllocationOptions", "description": "Range auto-allocation options, to be optionally used when CIDR block is not explicitly set.", "type": "object", "properties": { "allocationStrategy": { "enumDescriptions": [ "Unspecified is the only valid option when the range is specified explicitly by ip_cidr_range field. Otherwise unspefified means using the default strategy.", "Random strategy, the legacy algorithm, used for backwards compatibility. This allocation strategy remains efficient in the case of concurrent allocation requests in the same peered network space and doesn't require providing the level of concurrency in an explicit parameter, but it is prone to fragmenting available address space.", "Pick the first available address range. This strategy is deterministic and the result is easy to predict.", "Pick an arbitrary range out of the first N available ones. The N will be set in the first_available_ranges_lookup_size field. This strategy should be used when concurrent allocation requests are made in the same space of peered networks while the fragmentation of the addrress space is reduced.", "Pick the smallest but fitting available range. This deterministic strategy minimizes fragmentation of the address space." ], "description": "Optional. Allocation strategy Not setting this field when the allocation is requested means an implementation defined strategy is used.", "type": "string", "enum": [ "ALLOCATION_STRATEGY_UNSPECIFIED", "RANDOM", "FIRST_AVAILABLE", "RANDOM_FIRST_N_AVAILABLE", "FIRST_SMALLEST_FITTING" ] }, "firstAvailableRangesLookupSize": { "description": "Optional. This field must be set only when allocation_strategy is set to RANDOM_FIRST_N_AVAILABLE. The value should be the maximum expected parallelism of range creation requests issued to the same space of peered netwroks.", "type": "integer", "format": "int32" } } }, "Location": { "id": "Location", "description": "A resource that represents a Cloud de Confiance location.", "type": "object", "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } } }, "AuditLogConfig": { "properties": { "logType": { "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "description": "The log type that this config enables.", "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ] }, "exemptedMembers": { "items": { "type": "string" }, "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array" } }, "id": "AuditLogConfig", "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "type": "object" } }, "protocol": "rest", "parameters": { "$.xgafv": { "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format." }, "alt": { "enum": [ "json", "media", "proto" ], "default": "json", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "description": "Data format for response." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "prettyPrint": { "default": "true", "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." } } }